diff --git a/AUTHORS.txt b/AUTHORS.txt new file mode 100644 index 0000000..6ac8449 --- /dev/null +++ b/AUTHORS.txt @@ -0,0 +1,3 @@ +Sylwester Wysocki +Lukasz Bienczyk - LibLock, LibProcess, LibThread +Radoslaw Kolodziejczyk - LibLock, LibProcess, LibThread diff --git a/Doc/content.html b/Doc/content.html new file mode 100644 index 0000000..29bdbf9 --- /dev/null +++ b/Doc/content.html @@ -0,0 +1,2972 @@ +

DO NOT EDIT! This file was generated automatically by 'qcbuild --makedoc' tool. +

Tegenaria project - technical documentation

+

Table of content:

I. Overview:

Core
+LibArgs
+LibDebug
+LibError
+LibFile
+LibIO
+LibIpc
+LibJob
+LibLock
+LibProcess
+LibReg
+LibRuntime
+LibService
+LibSSMap
+LibStr
+LibSystem
+LibThread
+LibVariant
+
Net
+LibCGI
+LibNet
+LibNetEx
+LibSecure
+LibSftp
+
+

Examples:

Core
+
Net
+
+

II. Components diagram:

+This file was automatically generated by qcbuild --diagram. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +LibCGI + +LibNet + +LibNetEx + +LibSecure + +LibSftp + +LibArgs + +LibDebug + +LibError + +LibFile + +LibIO + +LibIpc + +LibJob + +LibLock + +LibProcess + +LibReg + +LibRuntime + +LibService + +LibSSMap + +LibStr + +LibSystem + +LibThread + +LibVariant + +

III. Components specifications:

LibCGI component

Title:LibCGI
Type:LIBRARY
Author(s):Sylwester Wysocki <sw143@wp.pl>
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Set up environment for CGI/C++ program.
Description:It handles _GET[], _POST[] and _COOKIE[] arrays like PHP.
Dependences:LibSSMap LibStr LibFile LibDebug
Used by:

Functions list:

+
CGI
+CgiUrlDecode
+CgiUrlEncode
+CgiDecodeUserVars
+CgiEncodeUserVars
+CgiInit
+CgiGet
+CgiHashAdd
+CgiHashAdd
+CgiHashArgs
+

Functions protos:

+

CGI.cpp

+ +

CgiUrlDecode

+
string  CgiUrlDecode
(
  string  SRC
); 

 
  Decode URL string.
 
  SRC - URL encoded string (IN).
 
  RETURNS: Decoded string.
 
+
+

CgiUrlEncode

+
string  CgiUrlEncode
(
  string  str
); 

 
  Encode arbitral string to URL.
 
  str - string to encode (IN).
 
  RETURNS: URL encoded string.
 
+
+

CgiDecodeUserVars

+
int  CgiDecodeUserVars
(
  SSMap       &ssmap,
  char *      userData,
  const char  delim
); 

 
  Decode QUERY string to {lvalue |-> rvalue} map.
 
  ssmap    - {lvalue |-> rvalue} map with decoded variables (OUT)
  userData - raw url encoded query get string (IN).
  delim    - what is delim char to use (default '&') (IN/OPT).
 
  RETURNS: 0 if OK.
 
+
+

CgiEncodeUserVars

+
string  CgiEncodeUserVars
(
  SSMap  &ssmap
); 

 
  Create QUERY string from string |-> string map.
 
+
+

CgiInit

+
int  CgiInit
(
); 

 
  Init CGI library.
  MUST be called one time before first use.
 
  RETURNS: 0 if OK.
 
+
+

CgiGet

+
const char * CgiGet
(
  const char * lvalue
); 

 
  Retrieve value of given GET variable.
 
  lvalue - name of variable to found (IN).
 
  RETURNS: Pointer to variable value or NULL if not found.
 
+
+

CgiHashAdd

+
void  CgiHashAdd
(
  string        &hash,
  const string  &str
); 

 
 
 
+
+

CgiHashAdd

+
void  CgiHashAdd
(
  string  &hash,
  int     value
); 
Don't be sucker! Describe your function in source code.
+

CgiHashArgs

+
void  CgiHashArgs
(
  string  &hash
); 

 
  Default hash function.
  Works always, but may be ineficient in general case.
  Should be reimplemented in derived to fit case sensitive,
  local characters, arguments order etc.
 
  RETURNS: none.
 
+

LibNet component

Title:LibNet
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:General mid-level and high-level network functions.
Description:-
Dependences:LibDebug LibThread LibMath
Used by: Tegenaria-net LibSftp LibSftp-example01-sftp-client LibSecure-example01-callbacks LibSecure-example02-socket LibSecure-example04-hp-server LibNet-example01-thread-server LibNet-example02-single LibNet-example05-HP-server libnet-example07-echo-server libnet-example08-echo-client libnet-example09-smtp-client libnet-example10-statistics LibIO-example02-network-mixer

Functions list:

+
NetConnection class
+NetConnection::NetConnection
+NetConnection::~NetConnection
+NetConnection::write
+NetConnection::read
+NetConnection::cancel
+NetConnection::shutdown
+NetConnection::join
+NetConnection::readCallback
+NetConnection::writeCallback
+NetConnection::cancelCallback
+NetConnection::request
+NetConnection::getContext
+NetConnection::getProtocol
+NetConnection::getSocket
+NetConnection::getHandler
+NetConnection::getClientInfo
+NetConnection::addRef
+NetConnection::release
+NetConnection::setState
+NetConnection::getState
+NetConnection::waitForState
+NetConnection::setNoDelay
+NetConnection::setKeepAlive
+NetConnection::getThread
+NetConnection::setThread
+NetConnection::authorize
+NetConnection::getAuthData
+NetConnection::disableInherit
+NetConnection::isPointerCorrect
+NetConnection::setQuietMode
+
General utils
+NetParseAddress
+NetGetPortState
+NetIsPortOpen
+NetGetFreePort
+NetIsPortClosed
+NetSetFDsLimit
+NetGetCpuNumber
+NetGetLocalIp
+NetSetNonBlockMode
+NetSetBlockMode
+NetResolveIp
+NetBase64
+
Server side API
+NetServerLoop
+NetServerCreate
+NetAccept
+NetTryBind
+NetCreateListenSocket
+
Client side API
+NetConnect
+NetRequest
+
Callback TCP server
+NetHpServerLoop
+NetHpWrite
+
SMTP client (email)
+NetSmtpReadServerAnswer
+NetSmtpSendMail
+
Manage firewall rules (Windows only)
+NetFirewallRuleAdd
+NetFirewallRuleDel
+

TODO:

+
- Hide NetStatistics implementation.
+

Functions protos:

+

NetConnection.cpp

+ +

NetConnection::NetConnection

+
NetConnection::NetConnection
(
  const void *        ctx,
  const char *        protocol,
  int                 socket,
  NetHandleConnProto  handler,
  ThreadHandle_t *    thread
); 

 
  Constructor.
 
  ctx      - caller specified context (IN).
  protocol - artbitrary protocol name e.g. "TCP/IP" (IN).
  socket   - asociatet socket number, can be -1 if not needed (IN/OPT).
  handler  - callback to handle incoming connections (IN/OPT).
  thread   - asociated thread handle (IN/OPT).
 
+
+

NetConnection::~NetConnection

+
NetConnection::~NetConnection
(
); 

 
  Desctructor. Shutdown connection to force flush.
 
+
+

NetConnection::write

+
int  NetConnection::write
(
  const void * buf,
  int          count,
  int          timeout
); 

 
  Send <count> bytes stored in <buf>.
 
  buf     - source buffer where data to write stored (IN).
  count   - number of bytes to send (IN).
  timeout - timeout in miliseconds (IN).
 
  RETURNS: Number of bytes written or
           -1 if error.
 
+
+

NetConnection::read

+
int  NetConnection::read
(
  void * buf,
  int    count,
  int    timeout
); 

 
  Reveive up to <count> bytes and store them in <buf>.
 
  buf     - destination buffer where to store readed data (OUT).
  count   - expecting number of bytes to be readed (IN).
  timeout - timeout in miliseconds (IN).
 
  RETURNS: Number of bytes readed or
           -1 if error.
 
+
+

NetConnection::cancel

+
void  NetConnection::cancel
(
); 

 
  Cancel all pending I/O associated with connection (if any).
 
+
+

NetConnection::shutdown

+
int  NetConnection::shutdown
(
  int  how
); 

 
  Shutdown connection.
 
+
+

NetConnection::join

+
int  NetConnection::join
(
); 

 
  Wait until connection finished work.
 
+
+

NetConnection::readCallback

+
int  NetConnection::readCallback
(
  void * buf,
  int    count,
  int    timeout,
  void * ctx
); 

 
  Static wrappers for read/write methods to be compatible with pure C code.
  Ctx means this pointer (NetConnection object).
  Used to pass read/write callback to IOMixer without adding dependency
  on LibNet.
 
  To pass read/write method to another C code we need to pass 2 values:
 
  - this pointer ('this')
  - pointer to NetConnection::readCallback ('callback')
 
  After that third C code can use it by calling:
 
  callback(buf, count, timeout, this)
 
+
+

NetConnection::writeCallback

+
int  NetConnection::writeCallback
(
  void * buf,
  int    count,
  int    timeout,
  void * ctx
); 
Don't be sucker! Describe your function in source code.
+

NetConnection::cancelCallback

+
void  NetConnection::cancelCallback
(
  void * ctx
); 
Don't be sucker! Describe your function in source code.
+

NetConnection::request

+
int  NetConnection::request
(
  int *        serverCode,
  char *       serverMsg,
  int          serverMsgSize,
  int          timeout,
  const char * fmt
); 

 
  - Send single, printf like formatted request to server
  - read answer in format 'XYZ > message'
  - split answer to <XYZ> code and <message> parts.
 
  Example usage:
 
  request(&serverCode, serverMsg, sizeof(serverMsg),
              "share --alias %s --path %s", alias, path);
 
  TIP: If only exit code is needed <answer> can be set to NULL.
 
  serverCode    - exit code returned by server (OUT).
  serverMsg     - ASCIZ message returned by server (OUT/OPT).
  serverMsgSize - size of answer buffer in bytes (IN).
  timeout       - timeout in ms, defaulted to infinite if -1 (IN/OPT).
  fmt           - printf like parameters to format command to send (IN).
 
  RETURNS: 0 if request sucessfuly sent and asnwer from server received.
          -1 otherwise.
 
  WARNING!: Request could still failed on server side.
            To get server's side exit code use 'answerCode' parameter.
 
+
+

NetConnection::getContext

+
const void * NetConnection::getContext
(
); 

 
  Get back caller context passed to constructor if any.
 
+
+

NetConnection::getProtocol

+
const char * NetConnection::getProtocol
(
); 

 
  Get back protocol passed to constructor if any.
 
+
+

NetConnection::getSocket

+
int  NetConnection::getSocket
(
); 

 
  Get back socket passed to constructor if any.
 
+
+

NetConnection::getHandler

+
NetHandleConnProto  NetConnection::getHandler
(
); 

 
  Get back handler function passed to constructor if any.
 
+
+

NetConnection::getClientInfo

+
const char * NetConnection::getClientInfo
(
); 

 
  Get string with information about remote client.
 
+
+

NetConnection::addRef

+
void  NetConnection::addRef
(
); 

 
  Increase refference counter.
 
  WARNING! Every call to addRef() MUSTS be followed by one release() call.
 
  TIP #1: Object will not be destroyed until refference counter is greater
          than 0.
 
  TIP #2: Don't call destructor directly, use release() instead. If
          refference counter achieve 0, object will be destroyed
          automatically.
 
+
+

NetConnection::release

+
void  NetConnection::release
(
); 

 
  Decrease refference counter increased by addRef() before.
 
+
+

NetConnection::setState

+
int  NetConnection::setState
(
  int  state
); 

 
  Set connection state. See NET_STATE_XXX defines in LibNet.h for
  possible states.
 
  state - one of NET_STATE_XXX state defined in LibNet.h (IN).
 
  RETURNS: 0 if OK.
 
+
+

NetConnection::getState

+
int  NetConnection::getState
(
); 

 
  Get back current connection state set by setState() before.
 
+
+

NetConnection::waitForState

+
int  NetConnection::waitForState
(
  int  state,
  int  timeout
); 

 
  Wait until connection reach given state or timeout.
 
  state   - target state, which should be set (IN).
  timeout - timeout limit in ms. Defaulted to infinite if -1. (IN/OPT).
 
  RETURNS: 0 if target status reached,
          -1 otherwise.
 
+
+

NetConnection::setNoDelay

+
void  NetConnection::setNoDelay
(
  int  value
); 

 
  Disable nagle algorithm on given connection if possible.
 
  value - 1 to disable algo, 0 to enable it back (IN).
 
+
+

NetConnection::setKeepAlive

+
void  NetConnection::setKeepAlive
(
  int  interval
); 

 
  Enable SO_KEEPALIVE flag, it keeps connections active by
  enabling the periodic transmission of messages.
 
  interval - -1 to disable SO_KEEPALIVE, above 0 will set time
             in seconds between individual keepalive probes.
 
+
+

NetConnection::getThread

+
ThreadHandle_t * NetConnection::getThread
(
); 

 
  Get back thread handle set in costructor or by setThread() later.
 
+
+

NetConnection::setThread

+
void  NetConnection::setThread
(
  ThreadHandle_t * thread
); 

 
  Set thread handle associated with object.
 
  thread - thread handle created by threadCreate() before (IN).
 
+
+

NetConnection::authorize

+
int  NetConnection::authorize
(
  const void * authData,
  int          authDataSize
); 

 
  Authroize connection if needed.
 
  RETURNS: 0 if OK.
 
+
+

NetConnection::getAuthData

+
int  NetConnection::getAuthData
(
  void * authData,
  int    authDataSize
); 

 
  Get authorization data needed to be passed to another side if needed.
 
  RETURNS: 0 if OK.
 
+
+

NetConnection::disableInherit

+
int  NetConnection::disableInherit
(
); 

 
  Disable inherit to child process (exec).
 
  RETURNS: 0 if OK.
 
+
+

NetConnection::isPointerCorrect

+
int  NetConnection::isPointerCorrect
(
  NetConnection * ptr
); 

 
  Check is given this pointer points to correct NetConnection *object.
 
  ptr - this pointer to check (IN).
 
  RETURNS: 1 if given pointer points to correct net connection object,
           0 otherwise.
 
+
+

NetConnection::setQuietMode

+
void  NetConnection::setQuietMode
(
  int  value
); 

 
  Set quiet mode to avoid printing error message longer.
 
+

Utils.cpp

+ +

NetParseAddress

+
int  NetParseAddress
(
  char *       ip1,
  char *       ip2,
  int *        port,
  const char * address
); 

 
  Split network address string into ip and port parts.
 
  WARNING: ip1, ip2 buffers MUST have at least 16 bytes length
           if specified.
 
  ip1     - buffer, where to store recognized ip (eg. "1.2.3.4").
            Can be NULL. (OUT/OPT).
 
  ip2     - buffer where to store second ip if UPNP scheme detected.
            Set to empty string if UPNP not detected. Can be NULL. (OUT/OPT).
 
  port    - recognized port number. Can be NULL. (OUT/OPT).
 
  address - input address to parse e.g. "127.0.0.1:80" (IN).
 
  RETURNS: 0 if OK,
          -1 if string not recognized as net address.
 
+
+

NetGetPortState

+
const string  NetGetPortState
(
  int          port,
  const char * protocol
); 

 
  Run underlying netstat command and return state string of
  given network port.
 
  port     - port number check e.g. 80 (IN).
  protocol - protocol string, defaulted to TCP (IN/OPT).
 
  RETURNS: Status string e.g. TIME_WAIT or
           "-" if port not opened or error.
 
+
+

NetIsPortOpen

+
int  NetIsPortOpen
(
  int          port,
  const char * protocol
); 

 
  Check is given port opened in any state.
 
  port     - port number to check e.g. 80 (IN).
  protocol - protocol string, defaulted to TCP (IN/OPT).
 
  RETURNS: 1 if port opened,
           0 if port NOT opened or error.
 
+
+

NetGetFreePort

+
int  NetGetFreePort
(
  const char * protocol
); 

 
  Find random unused port.
 
  protocol - protocol string, defaulted to "TCP" if skipped (IN/OPT).
 
  RETURNS: First found unused port or
           -1 if error.
 
+
+

NetIsPortClosed

+
int  NetIsPortClosed
(
  int          port,
  const char * protocol
); 

 
  Check is given port closed in any state.
 
  port     - port number to check e.g. 80 (IN).
  protocol - protocol string, defaulted to TCP (IN/OPT).
 
  RETURNS: 1 if port opened,
           0 if port NOT opened or error.
 
+
+

NetSetFDsLimit

+
int  NetSetFDsLimit
(
  int  limit
); 

 
  Set limit of maximum opened FD for current user.
 
  limit - new limit to set (IN).
 
  RETURNS: 0 if OK.
 
+
+

NetGetCpuNumber

+
int  NetGetCpuNumber
(
); 

 
  Return number of CPU cores installed on system.
 
+
+

NetGetLocalIp

+
int  NetGetLocalIp
(
  char * ip,
  int    ipSize
); 

 
  Retrieve IP of current running machine e.g. 10.0.0.14.
 
  ip     - buffer, where to store retrieved ip of local machine (OUT).
  ipSize - size of ip[] buffer in bytes (IN).
 
  RETURNS: 0 if OK.
 
+
+

NetSetNonBlockMode

+
int  NetSetNonBlockMode
(
  int  sock
); 

 
  Switch socket to non-block mode.
 
  RETURNS: 0 if OK.
+
+

NetSetBlockMode

+
int  NetSetBlockMode
(
  int  sock
); 

 
  Switch socket to block mode.
 
  RETURNS: 0 if OK.
+
+

NetResolveIp

+
int  NetResolveIp
(
  vector<string>  &ips,
  const char *    host
); 

 
  Resolve ip adresses for given host name.
 
  ips  - list of found IP addresses (OUT).
  host - host name to resolve e.g. "google.pl" (IN).
 
  RETURNS: 0 if OK,
          -1 otherwise.
 
+
+

NetBase64

+
string  NetBase64
(
  const char * data,
  int          size
); 

 
  Encode data to base64 string.
 
  data - binary data to encode (IN).
  size - size of data[] buffer in bytes (IN).
 
  RETURNS: base64 string.
 
+

Server.cpp

+ +

NetServerLoop

+
int  NetServerLoop
(
  NetConnection * nc
); 
Don't be sucker! Describe your function in source code.
+

NetServerCreate

+
NetConnection * NetServerCreate
(
  int                 port,
  NetHandleConnProto  handler,
  void *              custom
); 

 
  Start up TCP server in background thread.
 
  handler - callback routine to handle incoming connections (IN).
 
  custom  - custom, caller specified data passed to handler directly
            inside NetConnection struct as 'ctx' (IN/OPT).
 
  port    - listening port (IN).
 
  RETURNS: Pointer to server side connection,
           or NULL if error.
 
+
+

NetAccept

+
NetConnection * NetAccept
(
  int  port,
  int  timeout
); 

 
  Create listening TCP/IP4 socket and wait for one client.
  After connection negociated, listening socket is shutted down.
 
  WARNING: Caller MUST release received net connection object by
           calling nc -> release() method on it.
 
  port    - listening port (IN).
  timeout - maximum listening time in miliseconds. Defaulted to infinite if -1 (IN/OPT).
 
  RETURNS: Pointer to server side connection,
           or NULL if error.
 
+
+

NetTryBind

+
int  NetTryBind
(
  int  port
); 

 
  Try create listening socket on given port.
 
  port    - listening port (IN).
 
  RETURNS: 0 if socket can be created (port free)
           -1 otherwise.
 
+
+

NetCreateListenSocket

+
int  NetCreateListenSocket
(
  int  port,
  int  maxConnections,
  int  nonBlock
); 

 
  Create listening socket on given port.
  queue.
 
  port           - port number, where to start litsening (IN).
  maxConnections - maximum allowed number of incoming connections (IN).
  nonBlock       - create non-blocking socket if set to 1 (IN).
 
  RETURNS: Listening socket
           or -1 if error.
 
+

Client.cpp

+ +

NetConnect

+
NetConnection * NetConnect
(
  const char * host,
  int          port,
  int          timeout
); 

 
  Open connection to server.
 
  host    - server's ip address or hostname eg. "google.pl" (IN).
  port    - port, on which server is listening (IN).
  timeout - timeout in miliseconds (IN/OPT).
 
  RETURNS: Pointer to new allocated NetConnection or
           NULL if error.
 
  WARNING: Caller MUST delete returned NetConnection object.
 
  TIP: Use read/write method fro NetConnection to communicate with
       remote host.
 
+
+

NetRequest

+
int  NetRequest
(
  int          fd[2],
  int *        serverCode,
  char *       serverMsg,
  int          serverMsgSize,
  const char * fmt
); 
Don't be sucker! Describe your function in source code.

NetHpServer.cpp

+ +

NetHpServerLoop

+
int  NetHpServerLoop
(
  int              port,
  NetHpOpenProto   openHandler,
  NetHpCloseProto  closeHandler,
  NetHpDataProto   dataHandler
); 

 
  Create TCP server based on IO Completion Ports (WIndows)
  or epoll (Linux).
 
  port         - listening port (IN).
  openHandler  - handler called when new connection arrived (IN/OPT).
  closeHandler - handler called when existing connection closed (IN/OPT).
 
  dataHandler  - handler called when something to read on one of existing
                 connection (IN).
 
  TIP #1: Use NetHpWrite() to write data inside data handler. Don't
          use write() or send() directly.
 
  RETURNS: 0 if terminated correctly by NetIocpServerKill(),
          -1 if error.
 
+
+

NetHpWrite

+
int  NetHpWrite
(
  NetHpContext * ctx,
  int            fd,
  void *         buf,
  int            len
); 

 
  Write <len> bytes to FD received inside NetHpData handler called
  from NetHpServerLoop().
 
  TIP #1: Caller should use this function to write data
          to client inside data handler specified to
          NetIocpServerLoop(). Don't use write() or send() directly.
 
  ctx - context received in data handler parameters (IN).
  fd  - related FD where to write data (IN).
  buf - buffer with data to write (IN).
  len - how many bytes to write (IN).
 
  RETURNS: Number of bytes written or
           -1 if error.
 
+

SMTP.cpp

+ +

NetSmtpReadServerAnswer

+
int  NetSmtpReadServerAnswer
(
  int *           smtpCode,
  char *          msg,
  int             msgSize,
  NetConnection * nc
); 

 
  Read SMTP server response in 'XXX message' format.
 
  smtpCode - SMTP response code (OUT).
  msg      - buffer, where to put server message (OUT).
  msgSize  - size of msg[] buffer in bytes (IN).
  nc       - pointer NetConnection object connected to SMTP server (IN).
 
  RETURNS: 0 if OK.
 
+
+

NetSmtpSendMail

+
int  NetSmtpSendMail
(
  const char *    smtpHost,
  int             smtpPort,
  const char *    from,
  const char *    fromFull,
  const char *    subject,
  vector<string>  receivers,
  const char *    message,
  const char *    login,
  const char *    password
); 

 
  Send email using existing SMTP server.
 
  smtpHost  - hostname of smtp server to use e.g. "smtp.wp.pl" (IN).
  smtpPort  - port, where smtp server listening. Default is 25. (IN).
  from      - from field in email e.g. login@wp.pl (IN).
  subject   - subject field in email (IN).
  receivers - list of destination email addresses (IN).
  message   - message field in email (IN).
  login     - login to authenticate on smtp server (IN).
  password  - password to authenticate on smtp server (IN).
 
  RETURNS: 0 if OK,
          -1 otherwise.
 
+

Firewall.cpp

+ +

NetFirewallRuleAdd

+
int  NetFirewallRuleAdd
(
  const char * name,
  const char * group,
  const char * desc,
  const char * appPath,
  int          protocol
); 

 
  Add firewall rule.
 
  WARNING: Function needs admin privileges.
 
  name    - name of rule (IN).
  group   - name of rule's group (IN).
  desc    - rule's description (IN).
  appPath - full path to target application (IN).
 
  RETURNS: 0 if OK.
 
+
+

NetFirewallRuleDel

+
int  NetFirewallRuleDel
(
  const char * name
); 

 
  Remove firewall rule.
 
  WARNING: Function needs admin privileges.
 
  name - name of rule to remove (IN).
 
  RETURNS: 0 if OK.
 
+

LibNetEx component

Title:LibNetEx
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:High-level network functions depending on third part libraries.
Description:-
Dependences:libevent LibDebug LibLock LibThread LibSecure
Used by: LibNetEx-example01-hp-server LibNetEx-example02-tls-server

Functions list:

+
NetExHpServer
+NetExHpServerWorkerLoop
+NetExHpSecureServerLoop
+NetExHpServerLoop
+NetExHpWrite
+NetExHpOpenCallback
+NetExHpReadCallback
+NetExHpEventCallback
+NetExHpExitCallback
+
Utils
+NetExGetCpuNumber
+

Functions protos:

+

NetExHpServer.cpp

+ +

NetExHpServerWorkerLoop

+
int  NetExHpServerWorkerLoop
(
  NetExHpContext * ctx
); 

 
  Internal use only. Thread function falling into main libevent loop.
  We create one libevent loop for every CPU core inside NetExHpServerLoop().
 
  ctx - HP context created inside NetExHpServerLoop() (IN).
 
+
+

NetExHpSecureServerLoop

+
int  NetExHpSecureServerLoop
(
  int                port,
  NetExHpOpenProto   openHandler,
  NetExHpCloseProto  closeHandler,
  NetExHpDataProto   dataHandler,
  const char *       secureCert,
  const char *       securePrivKey,
  const char *       securePrivKeyPass
); 

 
  Create TCP server based on libevent library. Traffic is encrypted
  basing on TLS protocol.
 
  port              - listening port (IN).
  openHandler       - handler called when new connection arrived (IN/OPT).
  closeHandler      - handler called when existing connection closed (IN/OPT).
 
  dataHandler       - handler called when something to read on one of existing
                      connection (IN).
 
  secureCert        - filename, where server certificate is stored (IN).
 
  securePrivKey     - filename, where server private key is stored (server side
                      only) (IN/OPT).
 
  securePrivKeyPass - passphrase to decode private key. Readed from keyboard
                      if skipped (IN/OPT).
 
 
  TIP #1: Use NetExHpWrite() to write data inside data handler. Don't
          use write() or send() directly.
 
  RETURNS: never reached in correct work,
          -1 if error.
 
+
+

NetExHpServerLoop

+
int  NetExHpServerLoop
(
  int                port,
  NetExHpOpenProto   openHandler,
  NetExHpCloseProto  closeHandler,
  NetExHpDataProto   dataHandler
); 

 
  Create TCP server based on libevent library.
 
  port         - listening port (IN).
  openHandler  - handler called when new connection arrived (IN/OPT).
  closeHandler - handler called when existing connection closed (IN/OPT).
 
  dataHandler  - handler called when something to read on one of existing
                 connection (IN).
 
  TIP #1: Use NetExHpWrite() to write data inside data handler. Don't
          use write() or send() directly.
 
  TIP #2: Use NetExHpSecureServerLoop() to create TLS encrypted server.
 
  RETURNS: never reached in correct work,
          -1 if error.
 
+
+

NetExHpWrite

+
int  NetExHpWrite
(
  NetExHpContext * ctx,
  void *           buf,
  int              len
); 

 
  Write <len> bytes remote client related with given NetExHpContext.
 
  TIP #1: Caller should use this function to write data
          to remote client inside data handler specified to
          NetExServerLoop(). Don't use write() or send() directly.
 
  ctx - context received in data handler parameters (IN).
  buf - buffer with data to write (IN).
  len - how many bytes to write (IN).
 
  RETURNS: Number of bytes written or
           -1 if error.
 
+
+

NetExHpOpenCallback

+
static void  NetExHpOpenCallback
(
  evutil_socket_t  fd,
  short            ev,
  void *           data
); 

 
  Callback called when new connection arrived.
 
+
+

NetExHpReadCallback

+
static void  NetExHpReadCallback
(
  struct bufferevent * bev,
  void *               data
); 

 
  Callback called when new data arrived.
 
+
+

NetExHpEventCallback

+
static void  NetExHpEventCallback
(
  struct bufferevent * bev,
  short                events,
  void *               data
); 

 
  Callback called when connection closed.
 
+
+

NetExHpExitCallback

+
static void  NetExHpExitCallback
(
  evutil_socket_t  sig,
  short            events,
  void *           data
); 

 
  Callback called when SIGINT handled.
 
+

Utils.cpp

+ +

NetExGetCpuNumber

+
int  NetExGetCpuNumber
(
); 

 
  Return number of CPU cores installed on system.
 
+

LibSecure component

Title:LibSecure
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Wrap unsecure connection into secure one, generate cryptografically strong random numbers, encrypt/decrypt raw buffers.
Description:-
Dependences:OpenSSL LibDebug LibLock
Used by: Tegenaria-core LibNetEx LibSecure-example01-callbacks LibSecure-example02-socket LibSecure-example03-random LibSecure-example04-hp-server LibSecure-example05-encrypt LibSecure-example06-hash LibSecure-example07-read-pass LibSecure-example08-acl libnet-example09-smtp-client

Functions list:

+
Connection
+Win64NotImportedError
+SecureConnection::writeRaw
+SecureConnection::readRaw
+SecureConnection::encrypt
+SecureConnection::decrypt
+SecureConnection::write
+SecureConnection::read
+SecureConnection::request
+SecureConnection::~SecureConnection
+SecureConnection::handshakeStep
+SecureConnection::handshakeStep
+SecureConnection::SecureConnection
+SecureConnection::initSSL
+SecureConnection::addRef
+SecureConnection::release
+SecureConnection::getState
+SecureConnectionCreate
+SecureConnectionCreate
+SecureConnectionCreate
+SecureConnectionCreate
+
Acl
+SecureAcl::SecureAcl
+SecureAcl::initFromString
+SecureAcl::setRights
+SecureAcl::setRights
+SecureAcl::setOthersRights
+SecureAcl::setOthersRights
+SecureAcl::revokeAll
+SecureAcl::getRights
+SecureAcl::getRightsString
+SecureAcl::toString
+SecureAcl::clear
+SecureAcl::encodeRights
+SecureAcl::decodeRights
+
Random
+Win64NotImportedError
+SecureRandom
+SecureRandomInt32
+SecureRandomInt64
+SecureRandomByte
+SecureRandomText
+SecureRandomHexText
+
Cipher
+Win64NotImportedError
+SecureEncrypt
+SecureDecrypt
+SecureCipherCreate
+SecureCipherDestroy
+
Password
+SecureDisableEcho
+SecureEnableEcho
+SecureReadPassword
+SecurePassAuthorize
+
Hash
+Win64NotImportedError
+SecureHashSha256
+

README:

+
-------------------------------------------------------------------------------
+
+                                Secure connection
+
+-------------------------------------------------------------------------------
+
+1. Init
+-------
+
+1. To wrap existing non-encrypted connection into encrypted one (TLS) use
+   one of SecureConnectionCreate() functions family.
+
+  Input non-encrypted connection can be defined as:
+  - FD pair
+  - socket
+  - {read, write} callbacks
+  
+
+2. To start TLS session:
+------------------------
+
+   Server needs:
+   - certificate file (cert parameter) 
+   - private key file (privKey paramter)
+   
+   Client needs:
+   - nothing (cert and privKey parameters should be NULL)
+   
+
+3. Server skeleton code:
+------------------------
+
+   sc = SecureConnectionCreate(SECURE_INTENT_SERVER, ..., cert, privateKey);
+
+   sc -> read(...);
+   sc -> write(...);   
+   
+   sc -> release();
+   
+
+4. Client skeleton code:
+------------------------
+
+   sc = SecureConnectionCreate(SECURE_INTENT_CLIENT, ..., NULL, NULL);
+   
+   sc -> write(...);
+   sc -> read(...);
+   
+   sc -> release();
+
+

Functions protos:

+

Connection.cpp

+ +

Win64NotImportedError

+
static int  Win64NotImportedError
(
); 
Don't be sucker! Describe your function in source code.
+

SecureConnection::writeRaw

+
int  SecureConnection::writeRaw
(
  const void * buf,
  int          len,
  int          timeout
); 

 
  Write <len> bytes directly to underlying IO skipping SSL object beetwen.
 
  Used internally only.
 
  buf     - source buffer with data, which we want to write (IN).
  len     - number of bytes to write (IN).
  timeout - timeout in ms, set to -1 for infinite (IN).
 
  RETURNS: Number of bytes written or
           -1 if error.
 
+
+

SecureConnection::readRaw

+
int  SecureConnection::readRaw
(
  void * buf,
  int    len,
  int    timeout
); 

 
  Read data directly from underlying IO (without parsing it via SSL
  object).
 
  Used internally only.
 
  buf     - destination buffer, where to write readed data (OUT).
  len     - number of bytes to read (IN).
  timeout - timeout in ms, set -1 to infinity (IN).
 
  RETURNS: Number of bytes readed or
           -1 if error.
 
+
+

SecureConnection::encrypt

+
int  SecureConnection::encrypt
(
  void *       encrypted,
  int          encryptedSize,
  const void * buffer,
  int          bufferSize
); 

 
  Encrypt message.
 
  encrypted     - buffer, where to store encrypted message (OUT).
  encryptedSize - size of encrypted[] buffer in bytes (IN).
  buffer        - source buffer with data to encrypt (IN).
  bufferSize    - number of bytes to be encrypted (IN).
 
  RETURNS: Length of encrypted data written to encrypted[] in bytes or
           -1 if error.
 
+
+

SecureConnection::decrypt

+
int  SecureConnection::decrypt
(
  void *       decrypted,
  int          decryptedSize,
  const void * buffer,
  int          bufferSize
); 

 
  Decrypt message.
 
  decrypted     - buffer, where to store decrypted message (OUT).
  decryptedSize - size of decrypted[] buffer in bytes (IN).
  buffer        - source buffer with data to be decrypt (IN).
  bufferSize    - number of bytes to be decrypted (IN).
 
  RETURNS: Length of decrypted data written to decrypted[] in bytes or
           -1 if error.
 
+
+

SecureConnection::write

+
int  SecureConnection::write
(
  const void * buf,
  int          len,
  int          timeout
); 

 
  Write <len> bytes throught secure connection.
 
  buf     - source buffer with data, which we want to write (IN).
  len     - number of bytes to write (IN).
  timeout - timeout in ms, set to -1 for infinite (IN).
 
  RETURNS: Number of bytes written or
           -1 if error.
 
+
+

SecureConnection::read

+
int  SecureConnection::read
(
  void * buf,
  int    len,
  int    timeout
); 

 
  Read data from secure connection.
 
  buf     - destination buffer, where to write readed data (OUT).
  len     - number of bytes to read (IN).
  timeout - timeout in ms, set -1 to infinite (IN)
 
  RETURNS: Number of bytes readed or
           -1 if error.
 
+
+

SecureConnection::request

+
int  SecureConnection::request
(
  int *        serverCode,
  char *       serverMsg,
  int          serverMsgSize,
  int          timeout,
  const char * fmt
); 

 
  - Send single, printf like formatted request to server
  - read answer in format 'XYZ > message'
  - split answer to <XYZ> code and <message> parts.
 
  Example usage:
 
  request(&serverCode, serverMsg, sizeof(serverMsg),
              "share --alias %s --path %s", alias, path);
 
  TIP: If only exit code is needed <answer> can be set to NULL.
 
  sc            - pointer to SecureConnection object connected to server (IN).
  serverCode    - exit code returned by server (OUT).
  serverMsg     - ASCIZ message returned by server (OUT/OPT).
  serverMsgSize - size of answer buffer in bytes (IN).
  timeout       - timeout in ms, defaulted to infinite if -1 (IN/OPT).
  fmt           - printf like parameters to format command to send (IN).
 
  RETURNS: 0 if request sucessfuly sent and asnwer from server received.
          -1 otherwise.
 
  WARNING!: Request could still failed on server side.
            To get server's side exit code use 'answerCode' parameter.
 
+
+

SecureConnection::~SecureConnection

+
SecureConnection::~SecureConnection
(
); 

 
  Desctroy secure connection created by SecureConnectionCreate() before.
 
+
+

SecureConnection::handshakeStep

+
int  SecureConnection::handshakeStep
(
  void * customBuffer,
  int *  customSize
); 

 
  Perform underlying SSL handshake to init encrypted secure connection.
 
  Internal use only.
 
  TIP#1: For custom connection use 5-parameter SecureHandshakeStep.
 
  TIP#2: For non-custom connections (underlying IO is set to callbacks,
         socket or FDs pair} handshake is performed automatically in
         SecureConnectionCreate. No manually work needed.
 
 
  WARNING! Handshake must be performed before any data would be send
           via SecureWrite() or read via SecureRead() functions.
 
  Parameters:
 
  customBuffer  - on input data treated as readed from underlying IO if IOMODE
                  set to NONE. On output data needed to be written to
                  underlying IO. (IN/OUT/OPT).
 
  customSize    - on input size of customBuffer[] in bytes if IOMODE set to
                  NONE. On output number of bytes returned in customBuffer[]
                  and needed to be written back to underlying IO (IN/OUT/OPT).
 
  RETURNS: 0 if OK.
 
+
+

SecureConnection::handshakeStep

+
int  SecureConnection::handshakeStep
(
  void * outputBuffer,
  int *  outputSize,
  void * inputBuffer,
  int    inputSize
); 

 
  Handshake step for custom connection (iomode set to none).
 
  TIP#1: This function should be used to perform manually handshake when
         underlying IO is set to NONE (i.e. custom secure connection).
 
  TIP#2: Before call, caller should read data from underlying IO manually
         and pass it in {inputBuffer, inputSize} parameters.
 
  TIP#3: After call, caller should write data returned in
         {outputBuffer, outputSize} to underlying IO manually.
 
  Caller algorithm to do handshake manually:
 
  while(sc -> state != SECURE_STATE_ESTABLISHED)
  {
    Read data from underlying IO to inputBuffer[].
    Call SecureHandshakeStep(inputBuffer, ..., outputBuffer, ...)
    Write data from outputBuffer[] to underlying IO.
  }
 
 
  sc           - secure connection object returned from SecureConnectionCreate() (IN).
  outputBuffer - data needed to be written to underlying IO by caller (OUT).
 
  outputSize   - on input size of outputBuffer[] in bytes, on output number
                 of bytes written to outputBuffer[] (IN/OUT).
 
  inputBuffer  - data readed from underlying IO (IN).
  inputSize    - size of inputBuffer[] in bytes (IN).
 
  RETURNS: 0 if OK.
 
+
+

SecureConnection::SecureConnection

+
SecureConnection::SecureConnection
(
); 

 
  Create empty secure connection object.
  Used internally only.
 
  TIP#1: Don't create SecureConnection object directly.
         Use one of SecureConnectionCreate() function instead.
 
+
+

SecureConnection::initSSL

+
int  SecureConnection::initSSL
(
  int          intent,
  const char * cert,
  const char * privKey,
  const char * privKeyPass
); 

 
  Initialize SSL DTLS connection inside secure connection object.
 
  Internal use only by SecureConnectionCreate().
 
  RETURNS: 0 if OK.
 
+
+

SecureConnection::addRef

+
void  SecureConnection::addRef
(
); 

 
  Increase refference counter.
 
  WARNING! Every call to addRef() MUSTS be followed by one release() call.
 
  TIP #1: Object will not be destroyed until refference counter is greater
          than 0.
 
  TIP #2: Don't call destructor directly, use release() instead. If
          refference counter achieve 0, object will be destroyed
          automatically.
 
+
+

SecureConnection::release

+
void  SecureConnection::release
(
); 

 
  Decrease refference counter increased by addRef() before and
  desroy object when it's refference counter reach 0.
 
+
+

SecureConnection::getState

+
int  SecureConnection::getState
(
); 
Don't be sucker! Describe your function in source code.
+

SecureConnectionCreate

+
SecureConnection * SecureConnectionCreate
(
  int               intent,
  SecureReadProto   readCallback,
  SecureWriteProto  writeCallback,
  void *            ioCtx,
  const char *      cert,
  const char *      privKey,
  const char *      privKeyPass
); 

 
  Wrap abstract read/write callbacks into secure connection.
 
  intent         - set to SECURE_INTENT_CLIENT or SECURE_INTENT_SERVER (IN).
  readCallback   - callback used to read from underlying unsecure IO (IN).
  writeCallback  - callback used to write to underlying unsecure IO (IN).
  cancelCallback - callback used to cancel pending read on underlying IO (IN).
  ioCtx          - caller specified context passed to IO callbacks directly (IN).
  cert           - filename, where server certificate is stored (IN/OPT).
  privKey        - filename, where server private key is stored (server side
                   only) (IN/OPT).
  privKeyPass    - passphrase to decode private key. Readed from keyboard
                   if skipped (IN/OPT).
 
  WARNING! Returned pointer MUSTS be freed by SecureConnectionDestroy() if not
           needed longer.
 
  TIP#1: Use SecureHandshake() to init encrypted SSL connection before
         attemp to read or write via created connection.
 
  TIP#2: Use SecureWrite to send data via secure connection.
 
  TIP#3: Use SecureRead to read data from secure connection.
 
 
  RETURNS: Pointer to new allocated SecureConnectionCreate object
           or NULL if error.
 
+
+

SecureConnectionCreate

+
SecureConnection * SecureConnectionCreate
(
  int          intent,
  int          fdin,
  int          fdout,
  const char * cert,
  const char * privKey,
  const char * privKeyPass
); 

 
  Wrap FD pair into secure connection.
 
  intent      - set to SECURE_INTENT_CLIENT or SECURE_INTENT_SERVER (IN).
  fdin        - FD used to read data from underlying unsecure IO (IN).
  fdout       - FD used to write data into underlying unsecure IO (IN).
  cert        - filename, where server certificate is stored (IN/OPT).
 
  privKey     - filename, where server private key is stored (server side
                only) (IN/OPT).
 
  privKeyPass - passphrase to decode private key, readed from keyboard if
                skipped (IN/OPT).
 
  WARNING! Returned pointer MUSTS be released release() method when not
           needed longer.
 
  TIP#1: Use SecureHandshake() to init encrypted SSL connection before
         attemp to read or write via created connection.
 
  TIP#2: Use SecureWrite to send data via secure connection.
 
  TIP#3: Use SecureRead to read data from secure connection.
 
 
  RETURNS: Pointer to new allocated SecureConnectionCreate object
           or NULL if error.
 
+
+

SecureConnectionCreate

+
SecureConnection * SecureConnectionCreate
(
  int          intent,
  int          sock,
  const char * cert,
  const char * privKey,
  const char * privKeyPass
); 

 
  Wrap socket into secure connection.
 
  intent      - set to SECURE_INTENT_CLIENT or SECURE_INTENT_SERVER (IN).
  sock        - socket connected to remote machine (IN)
  cert        - filename, where server certificate is stored (IN/OPT).
 
  privKey     - filename, where server private key is stored (server
                side only) (IN/OPT).
 
  privKeyPass - passphrase to decode private key, readed from keyboard if
                skipped (IN/OPT).
 
  WARNING! Returned pointer MUSTS be released release() method when not
           needed longer.
 
  TIP#1: Use SecureHandshake() to init encrypted SSL connection before
         attemp to read or write via created connection.
 
  TIP#2: Use SecureWrite to send data via secure connection.
 
  TIP#3: Use SecureRead to read data from secure connection.
 
 
  RETURNS: Pointer to new allocated SecureConnectionCreate object
           or NULL if error.
 
+
+

SecureConnectionCreate

+
SecureConnection * SecureConnectionCreate
(
  int          intent,
  const char * cert,
  const char * privKey,
  const char * privKeyPass
); 

 
  Custom secure connection.
 
  intent      - set to SECURE_INTENT_CLIENT or SECURE_INTENT_SERVER (IN).
 
  cert        - filename, where server certificate is stored (IN/OPT).
 
  privKey     - filename, where server private key is stored (server
                side only) (IN/OPT).
 
  privKeyPass - passphrase to decode private key, readed from keyboard if
                skipped (IN/OPT).
 
  WARNING! Returned pointer MUSTS be released release() method when not
           needed longer.
 
  TIP#1: Use SecureHandshake() to init encrypted SSL connection before
         attemp to read or write via created connection.
 
  TIP#2: Use SecureWrite to send data via secure connection.
 
  TIP#3: Use SecureRead to read data from secure connection.
 
 
  RETURNS: Pointer to new allocated SecureConnectionCreate object
           or NULL if error.
 
+

Acl.cpp

+ +

SecureAcl::SecureAcl

+
SecureAcl::SecureAcl
(
); 

 
  Create empty, NULL access list.
 
+
+

SecureAcl::initFromString

+
int  SecureAcl::initFromString
(
  const char * acl
); 

 
  Init access list from raw string.
 
  String format is: "user1:rights1;user2:rights2...*:otherRights"
 
  Example lists are:
 
    "jan:R;jozek:F;*:D" - jan can read, jozek can read and write, others have no access
    "jan:F;*:R"         - jan can read and write, others can read only
    "*:F"               - all can read and write
    "*:D"               - nobody have access
    ""                  - invalid data, * terminator missing.
 
    R = read only
    F = full access
    D = access denied
 
    * = others users not included in list explicite. SHOULD be the
    last entry on the access list.
 
  Parameters:
 
  acl - string containing correct access list in format describet above (IN).
 
  RETURNS: 0 if OK,
          -1 otherwise.
 
+
+

SecureAcl::setRights

+
int  SecureAcl::setRights
(
  const char * user,
  int          rights
); 

 
  Set user rights to given value.
 
  WARNING#1: If user has already some rights granted function will OVERWRITE
             them with new one.
 
  TIP#1: To read back rights granted to user use getRights() method.
 
  user   - username, which we want grant rights to (IN).
 
  rights - rights, which we want to grant in binary representation i.e.
           combination of SECURE_ACL_XXX flags defined in Secure.h (IN).
 
  RETURNS: 0 if OK.
 
+
+

SecureAcl::setRights

+
int  SecureAcl::setRights
(
  const char * user,
  const char * rights
); 

 
  Set user rights to given value.
 
  WARNING#1: If user has already some rights granted function will OVERWRITE
             them with new one.
 
  TIP#1: To read back rights granted to user use getRights() method.
 
  user   - username, which we want grant rights to (IN).
 
  rights - rights, which we want to grant as human readable string i.e.
           combination of SECURE_ACL_SYMBOL_XXX chars defined in Secure.h.
           Example string is "D" (deny) or "F" (Full access) (IN).
 
  RETURNS: 0 if OK.
 
+
+

SecureAcl::setOthersRights

+
int  SecureAcl::setOthersRights
(
  int  rights
); 

 
  Set rights granted to others users to given value. Others means all users
  not mentioned in ACL explicite.
 
  WARNING#1: If others has already some rights granted function will OVERWRITE
             them with new one.
 
  rights - rights, which we want to grant in binary representation i.e.
           combination of SECURE_ACL_XXX flags defined in Secure.h (IN).
 
  RETURNS: 0 if OK.
 
+
+

SecureAcl::setOthersRights

+
int  SecureAcl::setOthersRights
(
  const char * rights
); 

 
  Set rights granted to others users to given value. Others means all users
  not mentioned in ACL explicite.
 
  WARNING#1: If others has already some rights granted function will OVERWRITE
             them with new one.
 
  rights - rights, which we want to grant as human readable string i.e.
           combination of SECURE_ACL_SYMBOL_XXX chars defined in Secure.h.
           Example string is "D" (deny) or "F" (Full access) (IN).
 
  RETURNS: 0 if OK.
 
+
+

SecureAcl::revokeAll

+
int  SecureAcl::revokeAll
(
  const char * user
); 

 
  Remove user from accesslist. After that user has no any rights granted.
 
  user - user, which we want revoke rights for (IN).
 
  RETURNS: 0 if OK.
 
+
+

SecureAcl::getRights

+
int  SecureAcl::getRights
(
  const char * user
); 

 
  Gather rights for given users.
 
  user - name of user, which we want rights for (IN).
 
  RETURNS: Rights granted to given user.
 
+
+

SecureAcl::getRightsString

+
string  SecureAcl::getRightsString
(
  const char * user
); 

 
  Gather rights for given users.
 
  user - name of user, which we want rights for (IN).
 
  RETURNS: Rights granted to given user as human readable string.
 
+
+

SecureAcl::toString

+
string  SecureAcl::toString
(
); 

 
  Convert access list stored inside object into ACL string.
 
+
+

SecureAcl::clear

+
void  SecureAcl::clear
(
); 

 
  Revoke all grant from all users stored accesslist.
 
+
+

SecureAcl::encodeRights

+
int  SecureAcl::encodeRights
(
  const char * str
); 

 
  Encode rights string into its binary representation.
  Rights in binary representation is combination of SECURE_ACL_XXX flags
  defined in Secure.h file.
 
  WARNING#1: If input rights string is incorrect function assign SECURE_ACL_DENY
             rights value.
 
  rights - human readable string representing rights to encode, for list of
           allowed chars see SECURE_ACL_SYMBOL_XXX defines in Secure.h (IN).
 
  RETURNS: Binary representation of rights.
 
+
+

SecureAcl::decodeRights

+
string  SecureAcl::decodeRights
(
  int  rights
); 

 
  Decode rights value into string.
  String contains chars representing single rights eg. "RW" means READ+WRITE.
  Full list of allowed rights chars is defined at SECURE_ACL_SYMBOL_XXX defines
  in Secure.h file
 
  WARNING#1: If input rights value is incorrect function assign "D" (access denied)
             rights.
 
  rights - binary encoded rights i.e. combination of SECURE_ACL_XXX flags
           defined in Secure.h (IN).
 
  RETURNS: Human readable string representing rights.
 
+

Random.cpp

+ +

Win64NotImportedError

+
static int  Win64NotImportedError
(
); 
Don't be sucker! Describe your function in source code.
+

SecureRandom

+
int  SecureRandom
(
  void * buf,
  int    len
); 

 
  Generate random buffer.
 
  buf - buffer, where to store generated data (OUT).
  len - number of butes to generate (IN).
 
  RETURNS: 0 if OK.
 
+
+

SecureRandomInt32

+
uint32_t  SecureRandomInt32
(
); 

 
  Generate random 32-bit integer.
 
+
+

SecureRandomInt64

+
uint64_t  SecureRandomInt64
(
); 

 
  Generate random 64-bit integer.
 
+
+

SecureRandomByte

+
uint8_t  SecureRandomByte
(
); 

 
  Generate random byte.
 
+
+

SecureRandomText

+
int  SecureRandomText
(
  char * buf,
  int    len
); 

 
  Generate random text.
  Example: K1aCK1bC0=38]8GM9ggk5=K836@yee5M
 
  buf - buffer, where to store generated text (OUT).
  len - size of buf[] buffer in bytes (IN).
 
  RETURNS: 0 if OK.
 
+
+

SecureRandomHexText

+
int  SecureRandomHexText
(
  char * buf,
  int    len
); 

 
  Generate random hex asciz text.
  Example: 23c02a8b7c7
 
  buf - buffer, where to store generated hex text (OUT).
  len - size of buf[] buffer in bytes (IN).
 
  RETURNS: 0 if OK.
 
+

Cipher.cpp

+ +

Win64NotImportedError

+
static int  Win64NotImportedError
(
); 
Don't be sucker! Describe your function in source code.
+

SecureEncrypt

+
void  SecureEncrypt
(
  SecureCipher * ctx,
  void *         buffer,
  int            size
); 

 
  Encrypt data.
 
  ctx    - secure context containing cipher state created by
           SecureCipherCreate before (IN/OUT).
 
  buffer - buffer to encrypt (IN/OUT).
 
  size   - size of buffer[] in bytes (IN).
 
+
+

SecureDecrypt

+
void  SecureDecrypt
(
  SecureCipher * ctx,
  void *         buffer,
  int            size
); 

 
  Decrypt data.
 
  ctx    - secure context containing cipher state created by
           SecureCipherCreate before (IN/OUT).
 
  buffer - buffer to decrypt (IN/OUT).
 
  size   - size of buffer[] in bytes (IN).
 
+
+

SecureCipherCreate

+
SecureCipher * SecureCipherCreate
(
  int          cipher,
  int          cipherMode,
  const char * key,
  int          keySize,
  const char * iv,
  int          ivSize
); 

 
  Create secure context object to track state of encrypt/decrypt process.
 
  TIP#1: Use SecureEncrypt to encrypt data using created context.
  TIP#2: Use SecureDecrypt to decrypt data using created context.
 
  cipher     - cipher to use, see SECURE_CIPHER_XXX defines in Secure.h (IN).
 
  cipherMode - the way how encrpted blocks are joined into stream,
               see SECURE_CIPHER_MODE_XXX defines in Secure.h (IN).
 
  key        - symmetric key to use (IN).
  keySize    - size of key[] buffer in bytes (IN).
  iv         - init vector, can be treated as second part of key (IN).
  ivSize     - size of iv[] buffer in bytes (IN).
 
+
+

SecureCipherDestroy

+
void  SecureCipherDestroy
(
  SecureCipher * ctx
); 

 
  Free secure context created by SecureCipherCreate() before.
 
+

Password.cpp

+ +

SecureDisableEcho

+
int  SecureDisableEcho
(
); 

 
  Disable echo on stdin.
 
  RETURNS: 0 if OK.
 
+
+

SecureEnableEcho

+
int  SecureEnableEcho
(
); 

 
  Enable echo on stdin.
 
  RETURNS: 0 if OK.
 
+
+

SecureReadPassword

+
int  SecureReadPassword
(
  char *       pass,
  int          passSize,
  const char * prompt
); 

 
  Disable echo and read password from stdin.
 
  pass     - buffer, where to store readed password (OUT).
  passSize - size of pass[] buffer in bytes (IN).
  prompt   - optional prompt to show before ask for pass (IN/OPT).
 
  RETURNS: 0 if OK.
 
+
+

SecurePassAuthorize

+
int  SecurePassAuthorize
(
  const char * expectedHash,
  const char * password,
  const char * salt
); 

 
  Verify password stored as SHA256(pass + salt).
  Function compute SHA256(pass + salt) by own and compare result with
  expectedHash parameter.
 
  expectedHash - expected SHA256(pass + salt) hash computed in register time (IN).
  password     - plain text password (IN).
  salt         - salt generated in register time (IN).
 
  RETURNS: 0 if SHA256(pass + salt) matches expectedHash (authorization ok),
           1 if hashes does not matches (authorization failed)
          -1 if unexpected error occures.
 
+

Hash.cpp

+ +

Win64NotImportedError

+
static int  Win64NotImportedError
(
); 
Don't be sucker! Describe your function in source code.
+

SecureHashSha256

+
int  SecureHashSha256
(
  char *       hash,
  int          hashSize,
  const char * data,
  int          dataSize,
  const char * salt,
  int          saltSize
); 

 
  Compute sha256 hash. Function compute hash = SHA256(data + salt).
  Salt is optional, set to NULL if not needed.
 
  WARNING! Hash[] buffer MUST have at least 65 bytes length.
 
 
  hash     - buffer, where to store computed hash (OUT).
  hashSize - size of hash[] buffer in bytes (IN).
  data     - data to hash (IN).
  dataSize - size of data[] buffer in bytes (IN).
  salt     - optional salt data to add. Can be NULL (IN/OPT).
  saltSize - size of salt[] buffer in bytes. Can be 0. (IN/OPT).
 
  RETURNS: 0 if OK.
 
+

LibSftp component

Title:LibSftp
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:SSHFS client library.
Description:-
Dependences:LibDebug LibStr LibThread LibLock LibMath LibNet
Used by: Tegenaria-net LibSftp-example01-sftp-client

Functions list:

+
SftpClient
+SftpClient::SftpClient
+SftpClient::~SftpClient
+SftpClient::connect
+SftpClient::disconnect
+SftpClient::reconnect
+SftpClient::open
+SftpClient::opendir
+SftpClient::close
+SftpClient::multiclose
+SftpClient::resetdir
+SftpClient::read
+SftpClient::write
+SftpClient::append
+SftpClient::stat
+SftpClient::readdir
+SftpClient::stat
+SftpClient::readdir
+SftpClient::statvfs
+SftpClient::mkdir
+SftpClient::remove
+SftpClient::rmdir
+SftpClient::rename
+SftpClient::createfile
+SftpClient::open
+SftpClient::opendir
+SftpClient::stat
+SftpClient::mkdir
+SftpClient::remove
+SftpClient::rmdir
+SftpClient::rename
+SftpClient::createfile
+SftpClient::statvfs
+SftpClient::popAttribs
+SftpClient::popAttribs
+SftpClient::processPacketSimple
+SftpClient::processPacket
+SftpClient::readLoop
+SftpClient::popStatusPacket
+SftpClient::setSectorSize
+SftpClient::packetComplete
+SftpClient::decodePacketHead
+SftpClient::DownloadFileWorker
+SftpClient::downloadFile
+SftpClient::UploadFileWorker
+SftpClient::uploadFile
+SftpClient::ListFilesWorker
+SftpClient::listFiles
+SftpClient::setNetStatTick
+SftpClient::registerNetStatCallback
+SftpClient::setPartialThreshold
+SftpClient::registerConnectionDroppedCallback
+SftpClient::shutdown
+
SftpJob
+SftpJob::SftpJob
+SftpJob::~SftpJob
+SftpJob::getTimeMs
+SftpJob::addRef
+SftpJob::release
+SftpJob::setState
+SftpJob::setThread
+SftpJob::getState
+SftpJob::getStateString
+SftpJob::wait
+SftpJob::cancel
+SftpJob::getSftpClient
+SftpJob::getRemoteName
+SftpJob::getLocalName
+SftpJob::updateStatistics
+SftpJob::getType
+SftpJob::getAvgRate
+SftpJob::getTotalBytes
+SftpJob::getProcessedBytes
+SftpJob::getPercentCompleted
+SftpJob::clearFiles
+SftpJob::addFile
+SftpJob::getFiles
+SftpJob::triggerNotifyCallback
+
Utils
+GenerateUniqueId
+GetSftpFlagFromWinapi
+TranslateSftpStatus
+GetTimeMs
+

README:

+
1. Init
+-------
+
+  To wrap existing FDs pair or socket connected to SFTP server
+  create new SftpClient object.
+     
+  SftpClient *sftp = new SftpClient(fdin, fdout);
+     
+  sftp -> connect();
+  
+  ... some work here ...
+     
+  delete sftp;
+  
+
+2. Synchronous requests (low-level API)  
+---------------------------------------
+
+  Below methods maps to related basic SFTP requests:
+  
+  SSH2_FXP_OPEN     |-> sftp -> open()
+  SSH2_FXP_CLOSE    |-> sftp -> close()
+  SSH2_FXP_READ     |-> sftp -> read()
+  SSH2_FXP_WRITE    |-> sftp -> write()
+  SSH2_FXP_OPENDIR  |-> sftp -> opendir()
+  SSH2_FXP_READDIR  |-> sftp -> readiir()
+  SSH2_FXP_REMOVE   |-> sftp -> remove()
+  SSH2_FXP_MKDIR    |-> sftp -> mkdir()
+  SSH2_FXP_RMDIR    |-> sftp -> rmdir()
+  SSH2_FXP_STAT     |-> sftp -> stat()
+  SSH2_FXP_RENAME   |-> sftp -> rename()
+  
+3. Asynchronous requests (high-level API)
+-----------------------------------------
+
+  There high-level API on top of basic SFTP requests from [2] to run SFTP job
+  asynchronous in background threads.
+  
+  A. Download job: sftp -> downloadFile(..., callback)
+  B. Upload job:   sftp -> uploadFile(..., callback)
+  C. List job:     sftp -> listFiles(..., callback)
+  
+  Callback function is called when:
+  
+  - job changed its states (e.g. job finished or error occured)
+  - new transfer statistics arrived (upload/download jobs)
+  - new portion of file list arrived (list job)
+  
+  To cancel pending job use job -> cancel() method.
+  
+  WARNING: All SftpJob objects MUSTS be freed by job -> release() when no
+  needed longer.
+
+

TODO:

+
- Where are ThreadJoin / ThreadWait ?
+

Functions protos:

+

SftpClient.cpp

+ +

SftpClient::SftpClient

+
SftpClient::SftpClient
(
  int  fdin,
  int  fdout,
  int  timeout,
  int  fdType
); 

 
  Create SFTP client over given CRT FD pair.
 
  TIP: To initiate session with server on other side
       use connect() method.
 
  fdin    - FD for input data (IN).
  fdout   - FD for output data (IN).
  timeout - I/O timeout in ms, -1 means infinite (IN).
 
  fdType  - set SFTP_CLIENT_FD if fdin/fdout are CRT FDs and
            SFTP_CLIENT_SOCKET if fdin/fdout are sockets.
            Defaulted to SFTP_CLIENT_FD if skipped (IN/OPT).
 
+
+

SftpClient::~SftpClient

+
SftpClient::~SftpClient
(
); 

 
  Shutdown connection if any.
 
+
+

SftpClient::connect

+
int  SftpClient::connect
(
); 

 
  Establish connection with sftp-server.
 
  Sends   : SSH2_FXP_INIT packet.
  Expects : SSH2_VERSION packet.
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::disconnect

+
void  SftpClient::disconnect
(
); 

 
  Disconnect existing connection with sftp server.
 
+
+

SftpClient::reconnect

+
int  SftpClient::reconnect
(
); 

 
  Close existing connection with server and reinit it once again
  from begin.
 
+
+

SftpClient::open

+
int64_t  SftpClient::open
(
  const char * path,
  int          mode,
  int          isDir
); 

 
  Open remote file or directory.
 
  Sends  : SSH2_FXP_OPEN or SSH2_FXP_OPENDIR packet.
  Expect : SSH2_FXP_HANDLE or SSSH2_FXP_STATUS packet.
 
  path  - path to remote file or directory (IN).
  mode  - sftp access mode (IN).
  isDir - set to 1 for directory, 0 otherwise (IN).
 
  RETURNS: handle assigned by sftp-server
           or -1 if error.
 
+
+

SftpClient::opendir

+
int64_t  SftpClient::opendir
(
  const char * path
); 

 
  Open remote directory.
  Works as open with isDir set to 1.
  See SftpClient::open().
 
+
+

SftpClient::close

+
int  SftpClient::close
(
  int64_t  handle
); 

 
  Close remote handle on server.
 
  Sends  : SSH2_FXP_CLOSE packet.
  Expect : SSH2_FXP_STATUS packet.
 
  handle - handle value retrieved from open() before (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::multiclose

+
int  SftpClient::multiclose
(
  vector<int64_t>  &handles
); 

 
  Close many remote handles in one request.
 
  Sends  : SSH2_FXP_DIRLIGO_MULTICLOSE packet.
  Expect : SSH2_FXP_STATUS packet.
 
  handle - list of handles value retrieved from open() before (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::resetdir

+
int  SftpClient::resetdir
(
  int64_t  handle
); 

 
  Reset directory handle. If readdir() finished with EOF on given handle
  resetdir() request will reopen directory on server to make the same handle
  possible to reuse in another readdir() request.
 
  Sends  : SSH2_FXP_DIRLIGO_RESETDIR packet.
  Expect : SSH2_FXP_STATUS packet.
 
  handle - handle value retrieved from opendir() before (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::read

+
int  SftpClient::read
(
  int64_t   handle,
  char *    buffer,
  uint64_t  offset,
  int       bytesToRead
); 

 
  Read data from remote file.
 
  Sends  : many SSH2_FXP_READ.
  Expect : many SSH2_FXP_DATA and one SSH2_FXP_STATUS for EOF signal.
 
  handle      - handle retrieved from open() before (IN).
  buffer      - buffer, where to store readed data (OUT).
  offset      - file position of first byte to read (IN).
  bytesToRead - number of bytes to read (IN).
 
  RETURNS: Number of bytes readed,
           or -1 if error.
 
+
+

SftpClient::write

+
int  SftpClient::write
(
  int64_t   handle,
  char *    buffer,
  uint64_t  offset,
  int       bytesToWrite
); 

 
  Write data to remote file.
 
  Sends  : many SSH2_FXP_WRITE packets.
  Expect : many SSH2_FXP_STATUS packets.
 
  handle       - handle retrieved from open() before (IN).
  buffer       - buffer with data, which we want to write (IN).
  offset       - file position, where to start writing (IN).
  bytesToWrite - number of bytes to write (IN).
 
  RETURNS: Number of bytes written,
           or -1 if error.
 
+
+

SftpClient::append

+
int  SftpClient::append
(
  int64_t  handle,
  char *   buffer,
  int      bytesToWrite
); 

 
  Append data to remote file.
 
  Sends  : many SSH2_FXP_DIRLIGO_APPEND packets.
  Expect : many SSH2_FXP_STATUS packets.
 
  handle       - handle retrieved from open() before (IN).
  buffer       - buffer with data, which we want to write (IN).
  bytesToWrite - number of bytes to write (IN).
 
  RETURNS: Number of bytes written,
           or -1 if error.
 
+
+

SftpClient::stat

+
int  SftpClient::stat
(
  const char *                 path,
  BY_HANDLE_FILE_INFORMATION * info
); 

 
  Windows implementation of stat() command.
  Check is file exists and optionally retrieve file attributes.
 
  Sends   : SSH2_FXP_STAT_VERSION_0 packet.
  Expects : SSH2_FXP_ATTR or SSH2_FXP_STATUS.
 
  path - full remote path on server (IN).
  info - info about remote file. (OUT).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::readdir

+
int  SftpClient::readdir
(
  vector<WIN32_FIND_DATAW>  &data,
  int64_t                   handle
); 

 
  Windows implementation of readdir().
  List content of remote directory.
 
  Sends   : many SSH2_FXP_DIRLIGO_READDIR_SHORT packets.
  Expects : many SSH2_FXP_NAME and one SSH2_FXP_STATUS for EOF.
 
  data   - list of files/dirs living inside selected directory (OUT).
  handle - value retrieved from open() function before (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::stat

+
int  SftpClient::stat
(
  const char *   path,
  SftpFileAttr * attr
); 

  Generic implementation of stat() command.
  Check is file exists and optionally retrieve file attributes.
 
  Sends   : SSH2_FXP_STAT_VERSION_0 packet.
  Expects : SSH2_FXP_ATTR or SSH2_FXP_STATUS.
 
  path - full remote path on server (IN).
  attr - info about remote file. (OUT).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::readdir

+
int  SftpClient::readdir
(
  vector<SftpFileInfo>  &files,
  int64_t               handle
); 

 
  Generic implementation of readdir().
  List content of remote directory.
 
  Sends   : many SSH2_FXP_DIRLIGO_READDIR_SHORT packets.
  Expects : many SSH2_FXP_NAME and one SSH2_FXP_STATUS for EOF.
 
  files  - list of files/dirs living inside selected directory (OUT).
  handle - value retrieved from open() function before (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::statvfs

+
int  SftpClient::statvfs
(
  Statvfs_t *  stvfs,
  const char * path
); 

 
  Retrieve info about remote disk.
 
  WARNING: Server MUST support "statvfs@openssh.com" extension.
 
  stvfs - buffer to store info about disk (see Sftp.h) (OUT)
  path  - remote path to check (IN)
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::mkdir

+
int  SftpClient::mkdir
(
  const char * path
); 

 
  Create new directory on server.
 
  Sends   : SSH2_FXP_MKDIR packet.
  Expects : SSH2_FXP_STATUS packet.
 
  path - path to craete (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::remove

+
int  SftpClient::remove
(
  const char * path
); 

 
  Remove file on server.
 
  Sends   : SSH2_FXP_REMOVE packet.
  Expects : SSH2_FXP_STATUS packet.
 
  path  - path to craete (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::rmdir

+
int  SftpClient::rmdir
(
  const char * path
); 

 
  Remove empty directory on server.
 
  Sends   : SSH2_FXP_RMDIR packet.
  Expects : SSH2_FXP_STATUS packet.
 
  path - path to craete (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::rename

+
int  SftpClient::rename
(
  const char * path1,
  const char * path2
); 

 
  Rename remote file or directory.
 
  Sends  : SSH2_FXP_RENAME packet.
  Expects: SSH2_FXP_STATUS packet.
 
  path1 - existing, old path to rename (IN).
  path2 - new name to set (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::createfile

+
int64_t  SftpClient::createfile
(
  const char * path,
  uint32_t     access,
  uint32_t     shared,
  uint32_t     create,
  uint32_t     flags,
  int *        isDir
); 

 
  Open remote file using {access, shared, create, flags} masks
  used with CreateFile() on Windows.
 
  Sends   : SSH2_FXP_DIRLIGO_CREATEFILE packet.
  Expects : SSH2_FXP_HANDLE packet.
 
  path       - path to remote file (IN).
  accesMode  - the same as dwSharedAccess in CreateFile (IN).
  sharedMode - the same as dwShareShared in CreateFile (IN).
  create     - the same as dwCreateDisposition in CreateFile (IN).
  flags      - the same as dwFlags in CreateFile (IN).
  isDIr      - on output set to 1 if opened file is a directory (OUT/OPT).
 
  RETURNS: remote file handle,
           or -winapi error if error (e.g. -ERROR_FILE_NOT_FOUND).
 
+
+

SftpClient::open

+
int64_t  SftpClient::open
(
  const wchar_t * path16,
  int             mode,
  int             isDir
); 

 
  Widechar wrapper for open().
  See utf8 version of SftpClient::open().
 
+
+

SftpClient::opendir

+
int64_t  SftpClient::opendir
(
  const wchar_t * path16
); 

 
  Widechar wrapper for opendir().
  See utf8 version of SftpClient::opendir().
 
+
+

SftpClient::stat

+
int  SftpClient::stat
(
  const wchar_t *              path16,
  BY_HANDLE_FILE_INFORMATION * info
); 

 
  Widechar wrapper for stat().
  See utf8 version of SftpClient::stat().
 
+
+

SftpClient::mkdir

+
int  SftpClient::mkdir
(
  const wchar_t * path16
); 

 
  Widechar wrapper for mkdir().
  See utf8 version of SftpClient::mkdir().
 
+
+

SftpClient::remove

+
int  SftpClient::remove
(
  const wchar_t * path16
); 

 
  Widechar wrapper for remove().
  See utf8 version of SftpClient::remove().
 
+
+

SftpClient::rmdir

+
int  SftpClient::rmdir
(
  const wchar_t * path16
); 

 
  Widechar wrapper for rmdir().
  See utf8 version of SftpClient::rmdir().
 
+
+

SftpClient::rename

+
int  SftpClient::rename
(
  const wchar_t * path1_16,
  const wchar_t * path2_16
); 

 
  Widechar wrapper for rename().
  See utf8 version of SftpClient::rename().
 
+
+

SftpClient::createfile

+
int64_t  SftpClient::createfile
(
  const wchar_t * path16,
  uint32_t        access,
  uint32_t        shared,
  uint32_t        create,
  uint32_t        flags,
  int *           isDir
); 

 
  Widechar wrapper for createfile().
  See utf8 version of SftpClient::createfile().
 
+
+

SftpClient::statvfs

+
int  SftpClient::statvfs
(
  Statvfs_t *     stvfs,
  const wchar_t * path16
); 

 
  Widechar wrapper for statvfs().
  See utf8 version of SftpClient::statvfs().
 
+
+

SftpClient::popAttribs

+
int  SftpClient::popAttribs
(
  BY_HANDLE_FILE_INFORMATION * info,
  string                       &packet
); 
Don't be sucker! Describe your function in source code.
+

SftpClient::popAttribs

+
int  SftpClient::popAttribs
(
  SftpFileAttr * info,
  string         &packet
); 

 
  Decode attributes sent by SFTP server.
 
  info   - struct, where to write decoded atributes (OUT).
  packet - raw packet received from SFTP server (IN).
 
+
+

SftpClient::processPacketSimple

+
int  SftpClient::processPacketSimple
(
  string  &answer,
  string  &packet
); 

 
  Send <packet> to server and receive <answer> packet.
 
  TIP: You can use the same buffers for answer and packet to send.
 
  answer - buffer, where to store received answer paceket (OUT).
  packet - buffer with packet to send (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::processPacket

+
int  SftpClient::processPacket
(
  string  &answer,
  string  &packet
); 

 
  Send <packet> to server and receive <answer> packet.
 
  TIP: You can use the same buffers for answer and packet to send.
 
  answer - buffer, where to store received answer paceket (OUT).
  packet - buffer with packet to send (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::readLoop

+
int  SftpClient::readLoop
(
  void * data
); 

 
  Thread reading incoming packets.
 
  data - pointer to related SftpClient object (this pointer) (IN)
 
+
+

SftpClient::popStatusPacket

+
uint32_t  SftpClient::popStatusPacket
(
  string    &packet,
  uint32_t  id
); 

 
  Pop and decode SSH2_FXP_STATUS packet from buffer.
 
  packet - buffer, where status packet is stored (IN/OUT).
 
  id     - expected packet's id. Status packet is a server's response
           for one of packet sent by client. Id for send and received
           packet must be the same (IN).
 
  RETURNS: Decoded serverStatus code.
 
+
+

SftpClient::setSectorSize

+
void  SftpClient::setSectorSize
(
  int  size
); 

 
  Change used sector size.
 
  size - sector size in bytes (IN).
 
+
+

SftpClient::packetComplete

+
int  SftpClient::packetComplete
(
  string  &packet,
  int     realSize
); 

 
  Check is given SFTP packet completem.
  Needed to handle partial read.
 
  packet   - SFTP packet data to check (IN).
  realSize - real packet size i.e. number of useful bytes in packet[] buffer (IN).
 
  RETURNS: 1 if given packet is a full, complete SFTP packet,
           0 otherwise (partial packet).
 
+
+

SftpClient::decodePacketHead

+
int  SftpClient::decodePacketHead
(
  uint32_t * size,
  uint32_t * id,
  uint8_t *  type,
  string     &packet,
  int        realSize
); 

 
  Decode packet {size, type, ID} head from packet buffer without
  destroying it.
 
  size     - decoded packet size (OUT).
  id       - decoded packet ID (OUT).
  type     - decoded packet type (OUT).
  packet   - SFTP packet data to check (IN).
  realSize - real packet size i.e. number of useful bytes in packet[] buffer (IN).
 
  RETURNS: 0 if OK.
+
+

SftpClient::DownloadFileWorker

+
int  SftpClient::DownloadFileWorker
(
  void * data
); 

 
  Download file from sftp server in background thread.
  Internal use only. See downloadFile() method.
 
  data - pointer to related SftpJob object (this pointer) (IN/OUT).
 
+
+

SftpClient::downloadFile

+
SftpJob * SftpClient::downloadFile
(
  const char *                localPath,
  const char *                remotePath,
  SftpJobNotifyCallbackProto  notifyCallback
); 

  notifyCallback - function to be called when new transfer statistics arrives
                   or job's state changed. Optional, can be NULL (IN/OPT).
 
 
  RETURNS: Pointer to new allocated SftpJob object,
           or NULL if error.
 
+
+

SftpClient::UploadFileWorker

+
int  SftpClient::UploadFileWorker
(
  void * data
); 

 
  Upload file to sftp server in background thread.
  Internal use only. See uploadFile() method.
 
  data - pointer to related SftpJob object (this pointer) (IN/OUT).
 
+
+

SftpClient::uploadFile

+
SftpJob * SftpClient::uploadFile
(
  const char *                remotePath,
  const char *                localPath,
  SftpJobNotifyCallbackProto  notifyCallback
); 

 
  Upload file to sftp server.
 
  WARNING: Returned SftpJob object MUST be free by calling job -> release()
           method.
 
  TIP#1 : Use job -> wait() method to wait until job finished.
  TIP#2 : Use job -> stop() method to stop job before finished.
 
  remotePath     - full remote path on server side, where to put file
                   (containing file name too) (IN).
 
  localPath      - local path, with file to upload (IN).
 
  notifyCallback - function to be called when new transfer statistics arrives
                   or job's state changed. Optional, can be NULL (IN/OPT).
 
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::ListFilesWorker

+
int  SftpClient::ListFilesWorker
(
  void * data
); 

 
  List content of remote directory in background thread.
  Internal use only. See listFiles() method.
 
  data - pointer to related SftpJob object (this pointer) (IN/OUT).
 
+
+

SftpClient::listFiles

+
SftpJob * SftpClient::listFiles
(
  const char *                remotePath,
  SftpJobNotifyCallbackProto  notifyCallback
); 

 
  Asynchronous list content of remote directory.
 
  WARNING: Returned SftpJob object MUST be free by calling job -> release()
           method.
 
  TIP#1 : Use job -> wait() method to wait until job finished.
  TIP#2 : Use job -> stop() method to stop job before finished.
 
  TIP#3 : Use job -> getFiles() method inside notifyCallback to receive next
          part of files, wchich was listed.
 
  Parameters:
 
  remotePath     - full remote directory to list e.g. "/home" (IN).
 
  notifyCallback - function to be called when new part of file list arrived
                   from network (IN).
 
  RETURNS: 0 if OK.
 
+
+

SftpClient::setNetStatTick

+
void  SftpClient::setNetStatTick
(
  int  tick
); 

 
  Change interval telling how often network statistics are computed.
 
  tick - statistics tick in number of processed packets (IN).
 
+
+

SftpClient::registerNetStatCallback

+
void  SftpClient::registerNetStatCallback
(
  SftpNetStatCallbackProto  callback,
  void *                    ctx
); 

 
  Register callback function called when number of packets touch
  net statistics tick set by setNetStatTick() function.
 
  callback - function to be called when new statistics arrived (IN).
  ctx      - caller context passed to callback function directly (IN/OPT).
 
+
+

SftpClient::setPartialThreshold

+
void  SftpClient::setPartialThreshold
(
  int  readThreshold,
  int  writeThreshold
); 

 
  Set timeout in seconds after, which read/write operation is stopped
  and only partial result is returned (e.g. readed 1024 bytes, when
  caller wanted 2048).
 
  readThreshold - read threshold in seconds (IN).
  writeThreshold - write threshold in seconds (IN).
 
+
+

SftpClient::registerConnectionDroppedCallback

+
void  SftpClient::registerConnectionDroppedCallback
(
  SftpConnectionDroppedProto  callback,
  void *                      ctx
); 

 
  Set callback function called when underlying connection dead.
 
+
+

SftpClient::shutdown

+
void  SftpClient::shutdown
(
); 
Don't be sucker! Describe your function in source code.

SftpJob.cpp

+ +

SftpJob::SftpJob

+
SftpJob::SftpJob
(
  int                         type,
  SftpClient *                sftp,
  const char *                localName,
  const char *                remoteName,
  SftpJobNotifyCallbackProto  notifyCallback
); 

 
  SftpJob constructor.
 
  type           - job's type, see SFTP_JOB_TYPE_XXX defines in SftpJob.h (IN).
  sftp           - related SFTP Client object (IN).
  localName      - related local path, e.g. source local file in upload job (IN).
  remoteName     - related remote path e.g. destination remote path in upload job (IN).
 
  notifyCallback - function to be called when new transfer statistics arrives
                   or job's state changed. Optional, can be NULL (IN/OPT).
 
+
+

SftpJob::~SftpJob

+
SftpJob::~SftpJob
(
); 

 
  SftpJob destructor.
 
+
+

SftpJob::getTimeMs

+
double  SftpJob::getTimeMs
(
); 

 
  Get current time in ms.
 
+
+

SftpJob::addRef

+
void  SftpJob::addRef
(
); 

 
  Increase refference counter.
 
  WARNING! Every call to addRef() MUSTS be followed by one release() call.
 
  TIP #1: Object will not be destroyed until refference counter is greater
          than 0.
 
  TIP #2: Don't call destructor directly, use release() instead. If
          refference counter achieve 0, object will be destroyed
          automatically.
 
+
+

SftpJob::release

+
void  SftpJob::release
(
); 

 
  Decrease refference counter increased by addRef() before.
 
+
+

SftpJob::setState

+
void  SftpJob::setState
(
  int  state
); 

 
  Change current state. See SFTP_STATE_XXX defines in SftpJob.h.
 
  state - new state to set (IN).
 
+
+

SftpJob::setThread

+
void  SftpJob::setThread
(
  ThreadHandle_t * thread
); 

 
  Set thread handle related with job.
 
  thread - thread handle to set (IN).
 
+
+

SftpJob::getState

+
int  SftpJob::getState
(
); 

 
  Get current state code. See SFTP_JOB_STATE_XXX defines in SftpJob.h.
 
  RETURNS: Current state code.
 
+
+

SftpJob::getStateString

+
const char * SftpJob::getStateString
(
); 

 
  Get current state as human readable string.
 
  RETURNS: Name of current job's state.
 
+
+

SftpJob::wait

+
int  SftpJob::wait
(
  int  timeout
); 

 
  Wait until job finished or stopped with error.
 
  timeout - maximum time to wait in ms. Set to -1 for infinite (IN).
 
  RETURNS: 0 if OK (job finished/stopped on exit),
          -1 otherwise (job still active on exit).
+
+

SftpJob::cancel

+
void  SftpJob::cancel
(
); 

 
  Send stop signal for pending SFTP job.
  After that related thread should stop working and state
  should change to SFTP_JOB_STATE_STOPPED.
 
  WARNING#1: SFTP job object MUSTS be still released with release() method.
 
  TIP#1: To stop and release resources related with SFTP job use below code:
 
         job -> cancel();
         job -> release();
 
+
+

SftpJob::getSftpClient

+
SftpClient * SftpJob::getSftpClient
(
); 

 
  Retrieve SftpClient object related with job.
 
+
+

SftpJob::getRemoteName

+
const char * SftpJob::getRemoteName
(
); 

 
  Retrieve remote name related with job.
 
+
+

SftpJob::getLocalName

+
const char * SftpJob::getLocalName
(
); 

 
  Retrieve local name related with job.
 
+
+

SftpJob::updateStatistics

+
void  SftpJob::updateStatistics
(
  double  processedBytes,
  double  totalBytes
); 

 
  Update transfer statistics for job.
  Internal use only.
 
  processedBytes - number of bytes already processed (IN).
  totalBytes     - number of total bytes to process (IN).
 
+
+

SftpJob::getType

+
int  SftpJob::getType
(
); 

 
  Retrieve job type. See SFTP_JOB_TYPE_XXX defines in SftpJob.h.
 
+
+

SftpJob::getAvgRate

+
double  SftpJob::getAvgRate
(
); 

 
  Get averange job's rate in bytes per seconds.
 
+
+

SftpJob::getTotalBytes

+
int64_t  SftpJob::getTotalBytes
(
); 

 
  Get total bytes needed to be processed to finish job e.g. total size
  of file to download in bytes.
 
+
+

SftpJob::getProcessedBytes

+
int64_t  SftpJob::getProcessedBytes
(
); 

 
  Get number of bytes already processed by job.
 
+
+

SftpJob::getPercentCompleted

+
double  SftpJob::getPercentCompleted
(
); 

 
  Get completion status in percentes (0-100%).
 
+
+

SftpJob::clearFiles

+
void  SftpJob::clearFiles
(
); 

 
  Clear list of files stored inside job object.
  Used internally only.
 
+
+

SftpJob::addFile

+
void  SftpJob::addFile
(
  SftpFileInfo  &file
); 

 
  Add file to files list stored inside job object.
  Used internally only.
 
+
+

SftpJob::getFiles

+
vector<SftpFileInfo> & SftpJob::getFiles
(
); 

 
  Retrieve list of files stored inside job object.
 
  TIP#1: Use this function to retrieve next part of files while performing
         SFTP_JOB_TYPE_LIST job. This function should be called inside
         notify callback passed to SftpClient::listFiles() function.
 
  RETURNS: Refference to files list currently stored inside job object.
 
+
+

SftpJob::triggerNotifyCallback

+
void  SftpJob::triggerNotifyCallback
(
  int  code
); 

 
  Tell sftp job object to call underlying notify callback set in constructor.
  Used internally only.
 
  code - one of SFTP_JOB_NOTIFY_XXX code passed to callback notify (IN).
 
+

Utils.cpp

+ +

GenerateUniqueId

+
int  GenerateUniqueId
(
); 

 
  Generate thread-safe, unique number.
  Used internally to generate handles and session IDs.
 
  RETURNS: Number unique inside process.
 
+
+

GetSftpFlagFromWinapi

+
int  GetSftpFlagFromWinapi
(
  DWORD  access,
  DWORD  shared,
  DWORD  create,
  DWORD  flags
); 

 
  Translate {access, create, flags} masks passed to CreateFile()
  into SFTP access mask.
 
  access - dwDesiredAccess mask passed used with CreateFile (IN).
  share  - dwShareMode mask passed used with CreateFile (IN).
  create - dwCreationDisposition parameter used with CreateFile (IN).
  flags  - dwFlagsAndAttributes parameter used with CreateFile (IN).
 
  RETURNS: SFTP access mask.
 
+
+

TranslateSftpStatus

+
const char * TranslateSftpStatus
(
  int  code
); 

 
  Translate SSH2_FX_XXX code into human readable string.
 
  code - one of SSH2_FX_XXX code defined in Sftp.h (IN).
 
  RETURNS: Error string related to given code,
           or "Unknown" if code not recognized.
 
+
+

GetTimeMs

+
double  GetTimeMs
(
); 

 
  Get current time in ms.
 
+

LibArgs component

Title:LibArgs
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Parse command line arguments.
Description:-
Dependences:LibDebug LibStr
Used by: Tegenaria-core qcbuild LibArgs-example LibArgs-example-shell

Functions list:

+
Args
+ArgsParse
+ArgsParse
+ArgsAlloc
+ArgsFree
+

Functions protos:

+

Args.cpp

+ +

ArgsParse

+
int  ArgsParse
(
  ArgsObj * ao,
  int       argc,
  char **   argv
); 

 
  Process arguments.
 
+
+

ArgsParse

+
int  ArgsParse
(
  ArgsObj *    ao,
  const char * cmd
); 

 
  Wrapper for ArgsParse() working with one continous
  string on input.
 
  RETURNS: 0 if OK.
 
+
+

ArgsAlloc

+
int  ArgsAlloc
(
  int *        argc,
  char ***     argv,
  const char * cmd
); 

 
  Allocate argv[] table from continous string.
 
  WARNING: Output argv[] MUST be free by caller via ArgsFree().
 
  argc   - number of elements in argv[] (OUT).
  argv   - table with tokenized arguments (OUT).
  argStr - command line string to tokenize (IN).
 
  RETURNS: 0 if OK.
 
+
+

ArgsFree

+
void  ArgsFree
(
  int     argc,
  char ** argv
); 

 
  Free argv[] table allocated by ArgsAlloc().
 
+

LibDebug component

Title:LibDebug
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Write logs to file/stderr and ships common macros to catch errors.
Description:-
Dependences:
Used by: Tegenaria-core qcbuild LibCGI LibNet LibNetEx LibSecure LibSftp LibSecure-example01-callbacks LibSecure-example02-socket LibSecure-example03-random LibSecure-example04-hp-server LibSecure-example05-encrypt LibSecure-example06-hash LibSecure-example07-read-pass LibSecure-example08-acl LibNet-example01-thread-server LibNet-example02-single LibNet-example05-HP-server libnet-example07-echo-server libnet-example08-echo-client libnet-example09-smtp-client ZLib-example libevent-example-server LibArgs LibFile LibIO LibIpc LibJob LibLock LibMath LibObject LibProcess LibReg LibService LibSSMap LibStr LibSystem LibThread LibVariant LibStr-example01-binary-packet LibStr-example02-verify LibStr-example03-date LibReg-example01-simple LibReg-example02-list-subkeys LibLock-example01-mutex LibLock-example02-semaphore liblock-example03-requestpool LibIO-example01-file-mixer LibIO-example02-network-mixer LibIO-example03-timeout-read LibDebug-example-simple LibDebug-example02-monitor LibDebug-example-level LibDebug-example-io LibArgs-example LibArgs-example-shell

Functions list:

+
Debug
+DbgInit
+DbgInit
+DbgGetPrefix
+DbgMsg
+DbgIoMsg
+DbgHead
+DbgDump
+DbgEnterEx
+DbgSetLevel
+DbgTranslateLevelName
+DbgSetLevel
+DbgIoDumpOperation
+
State
+GetCurrentThreadId
+DbgSetDump
+DbgSetAdd
+DbgSetAdd
+DbgSetDel
+DbgSetMove
+DbgSetRename
+DbgSetRename
+

README:

+
I. Init
+=======
+
+  Call DBG_INIT or DBG_INIT_EX at startup.
+
+  If not called:
+
+  - Log fd defaulted to stderr
+  - Log level defaulted to DBG_LEVEL_DEFAULT (see Debug.h)
+
+  TIP#1: You can adjust extra features by setting flags parameter
+         to DBG_INIT_EX. See Debug.h for possible values.
+
+  Examples:
+
+    DBG_INIT("dirligo.log")
+    DBG_INIT_EX(NULL, "debug3", -1)
+    DBG_INIT_EX("dirligo.log", DBG_LEVEL_INFO, DBG_STATE_ENABLE)
+
+II. System error codes
+======================
+
+  GetLastError() can be used:
+
+  - Returns native GetLastError() on Windows.
+  - Returns errno value on Linux.
+
+  No #ifdef needed.
+
+III. Tracing code
+=================
+
+  Use DBG_ENTER or DBG_ENTER_EX to mark begin of function calls.
+  Use DBG_LEAVE to mark end of function calls.
+
+  TIP#1: DBG_ENTER2, DBG_ENTER3 etc. are enabled under DEBUG2, DEBUG3 levels
+         only. Use them to avoid flooding log with a lot of enter/leaves
+         messages if one of function is called very often.
+
+IV. Log levels
+==============
+
+  Defined in Debug.h.
+
+  To set log level at init use DBG_INIT_EX at startup.
+
+  To set log level after init use DBG_SET_LEVEL or DBG_INIT_EX with
+  DBG_REINIT flag.
+
+  Level name       | Enabled macros
+  =================+===================================================
+  DBG_LEVEL_NONE   | Fatal quits without message
+  -----------------+---------------------------------------------------
+  DBG_LEVEL_ERROR  | Error, Fatal
+  -----------------+---------------------------------------------------
+  DBG_LEVEL_INFO   | DBG_INFO, DBG_HEAD
+  -----------------+---------------------------------------------------
+  DBG_LEVEL_DEBUG1 | DEBUG1, DBG_MSG, DBG_MSG1, DBG_HEAD1, DBG_ENTER,
+                   | DBG_ENTER1, DBG_LEAVE, DBG_LEAVE1
+  -----------------+---------------------------------------------------
+  DBG_LEVEL_DEBUG2 | DEBUG2, DBG_MSG2, DBG_HEAD2, DBG_ENTER2, DBG_LEAVE2
+  -----------------+---------------------------------------------------
+  DBG_LEVEL_DEBUG3 | DEBUG3, DBG_MSG3, DBG_HEAD3 DBG_ENTER3, DBG_LEAVE3
+  -----------------+---------------------------------------------------
+  DBG_LEVEL_DEBUG4 | DEBUG4, DBG_MSG4, DBG_HEAD4 DBG_ENTER4, DBG_LEAVE4
+  -----------------+---------------------------------------------------
+  DBG_LEVEL_DEBUG5 | DEBUG5, DBG_MSG5, DBG_HEAD5 DBG_ENTER5, DBG_LEAVE5
+                   | DBG_DUMP
+
+V. Monitoring process resources
+===============================
+
+  1. To enable state monitor init log using DBG_INIT_EX with
+     DBG_STATE_ENABLE flag.
+
+  2. To add/delete resources to monitor use DBG_SET_XXX marcos.
+
+     DBG_SET_ADD  - add object to monitor
+     DBG_SET_DEL  - remove object from monitor
+     DBG_SET_MOVE - move object from one set to another (e.g. move
+                    mutex from locking to locked).
+
+     Example: See example02-monitor.
+
+  TIP#1: You can assign arbitar names to object ID to debug code easier.
+         To do it see at:
+
+         DBG_SET_ADD_EX - Add named object to monitor
+         DBG_SET_RENAME - Rename anonymous object or change existing one
+
+VI. Monitoring I/O activity
+===========================
+
+  1. To enable I/O logs use DBG_IO_ENABLE flag in DBG_INIT_EX.
+
+  2. I/O log is written to *.io.<pid>.log file.
+
+  3. To monitor I/O use DBG_IO_XXX macros:
+
+     DBG_IO_WRITE_BEGIN(TYPE, ID, BUF, COUNT)
+     DBG_IO_WRITE_END(TYPE, ID, BUF, COUNT)
+
+     DBG_IO_READ_BEGIN(TYPE, ID, BUF, COUNT)
+     DBG_IO_READ_END(TYPE, ID, BUF, COUNT)
+
+     DBG_IO_CLOSE_BEGIN(TYPE, ID)
+     DBG_IO_CLOSE_END(TYPE, ID)
+
+     where TYPE is arbirtar string e.g. "socket".
+
+  4. Examples:
+
+     //
+     // Write some data to FD.
+     //
+
+     DBG_IO_WRITE_BEGIN("fd", fd, buf, count);
+     written = write(fd, buf, count);
+     DBG_IO_WRITE_END("fd", fd, buf, written);
+
+     //
+     // Read some data from socket.
+     //
+
+     DBG_IO_READ_BEGIN("socket", sock, buf, count);
+     readed = recv(sock, buf, count, 0);
+     DBG_IO_READ_END("fd", fd, buf, readed);
+
+     //
+     // Close stdio file.
+     //
+
+     DBG_IO_CLOSE_BEGIN("FILE*", f);
+     fclose(f);
+     DBG_IO_CLOSE_END("FILE*", f);
+
+     See example04-io for full working code.
+
+VII. Catching errors
+====================
+
+  You can use *FAIL* family macros:
+
+  FAIL(X)        - if X true jump to fail
+  FAILEX(X, ...) - if X true write formatted messages at DBG_LEVEL_ERROR
+                   and jump to fail
+
+
+  TIP#1: FAIL and FAILEX does NOT affect OS error code.
+         You can catch it just after fail label.
+
+  Example:
+
+  {
+    int exitCode = -1;
+
+    ...
+
+    FAIL(write(fd, buf, count) < 0);
+
+    FAILEX(ptr == NULL, "ERROR: Ptr cannot be NULL.");
+
+    ...
+
+    //
+    // Error handler.
+    //
+
+    exitCode = 0;
+
+    fail:
+
+    if (exitCode)
+    {
+      //
+      // We fall here if function fail in middle.
+      //
+
+      Error("Fail with code : %d.\n", GetLastError());
+    }
+
+    ...
+  }
+
+
+

Functions protos:

+

Debug.cpp

+ +

DbgInit

+
void  DbgInit
(
  const char * fname,
  int          logLevel,
  int          flags
); 

 
  Initialize:
 
  - main log file
  - state.<pid> file.
  - state-history.<pid> file.
  - save pid of current process.
 
  fname - file path, where to store main log file.
          Defaulted to stderr if NULL or file cannot be created (IN/OPT).
 
 
  level - one of DBG_LEVEL_XXX (see Debug.h) level to set.
          Defaulted to DBG_LEVEL_DEFAULT if -1. (IN/OPT).
 
  flags - combination of DBG_XXX flags degined in Debug.h.
          Defaulted to DBG_FLAGS_DEFAULT if -1. (IN/OPT).
 
+
+

DbgInit

+
void  DbgInit
(
  const char * fname,
  const char * levelName,
  int          flags
); 

 
  Wrapper for DbgInit() working with human readable string
  as log level name.
  See DbgInit() and TranslateLogName() for more.
 
+
+

DbgGetPrefix

+
void  DbgGetPrefix
(
  char * prefix,
  int    prefixSize,
  int    level
); 

 
  Generate '[pid][threadID] time' prefix.
 
  prefix     - buffer, where to store created prefix (OUT).
  prefixSize - size of buffer[] in bytes (IN).
  level      - log level to generate prefix if DBG_LOGLEVEL_PREFIX
               flag set (IN).
 
+
+

DbgMsg

+
void  DbgMsg
(
  int          level,
  const char * fmt
); 

 
  Put formatted message into main log.
 
  TIP#1: Default log file is stderr. To redirect it to file,
         use DBG_INIT(logfile).
 
  TIP#2: To change log level in current process use
         DBG_INIT_EX(logfile, level, flags) instead of DBG_INIT.
 
  level    - requested log level, if less than log level for current
             process nothing happen. See DBG_LEVEL_XXX in Debug.h (IN).
 
  fmt, ... - printf like arguments to format message (IN).
 
+
+

DbgIoMsg

+
void  DbgIoMsg
(
  int          level,
  const char * fmt
); 

 
  Put formatted message into I/O log.
 
  TIP#1: Disabled as default, use DBG_IO_ENABLE flag in DBG_INIT_EX.
 
  TIP#2: IO log is written to io.<pid> file.
 
  TIP#3: Use DBG_IO_XXX() macros.
 
  level    - requested log level, if less than log level for current
             process nothing happen. See DBG_LEVEL_XXX in Debug.h (IN).
 
  fmt, ... - printf like arguments to format message (IN).
 
+
+

DbgHead

+
void  DbgHead
(
  int          level,
  const char * fmt
); 

 
  Put formatted header into log file in form:
 
  ------------------------------------------------
  -    some printf like formatted message here   -
  ------------------------------------------------
 
  level - requested log level, if current level is less nothing happen (IN).
  fmt   - printf like args to fomat message (IN).
 
+
+

DbgDump

+
void  DbgDump
(
  void * buf,
  int    size
); 

 
  Dump raw buffer to log as hex values.
 
  buf  - buffer to dump (IN).
  size - size of buffer in bytes (IN).
 
+
+

DbgEnterEx

+
void  DbgEnterEx
(
  int          level,
  const char * fname,
  const char * fmt
); 

 
 
 
+
+

DbgSetLevel

+
int  DbgSetLevel
(
  int  level
); 

 
  Change log level for current running process.
 
  level - one of DBG_LEVEL_XXX values from Debug.h. (IN).
 
  RETURNS: 0 if OK.
 
+
+

DbgTranslateLevelName

+
int  DbgTranslateLevelName
(
  const char * levelName
); 

 
  Translate human readable log level value.
 
  levelName - Name of log level to set. Supported values are:
              none, error, info, debug1, debug2 or debug3 or
              number. Names are case insensitve - INFO and info are
              the same (IN).
 
  Examples:
    DbgTranslateLevelName("info") gives 2
    DbgTranslateLevelName("2")    gives 2
    DbgTranslateLevelName("bla")  gives -1
 
  RETURNS: One of DBG_LEVEL_XXX values from Debug.h,
           or -1 if unknown level name.
 
+
+

DbgSetLevel

+
int  DbgSetLevel
(
  const char * levelName
); 

 
  Wrapper for DbgSetLevel(int) working with human readable names.
  It can be used with name readed from text config file directly.
 
  levelName - Name of log level to set. Supported values are:
              none, error, info, debug1, debug2 or debug3.
              Names are case insensitve - INFO and info are the same (IN).
 
  RETURNS: 0 if OK.
 
+
+

DbgIoDumpOperation

+
void  DbgIoDumpOperation
(
  int          level,
  int          operationCode,
  const char * fdType,
  uint64_t     fdId64,
  const void * buf,
  int          count,
  const char * sourceFile,
  int          sourceLine
); 

 
  Dump read/write operation into IO log.
 
  level      - requested log level, if less than log level for current
               process nothing happen. See DBG_LEVEL_XXX in Debug.h (IN).
 
  operation  - one of DBG_IO_OPERATION_XXX code defined in Debug.h (IN)
 
  fdType     - type of underlying IO object eg. "FD", "Socket" (IN).
 
  fdId64     - 64-bit ID of related IO object eg. socket number or pointer
               to NetConnection object (IN).
 
  buf        - buffer related with operation (IN).
 
  count      - size of operation in bytes (IN).
 
  sourceFile - source file name, where operation is called (IN).
 
  sourceLine - number of code line in source file (IN).
 
+

State.cpp

+ +

GetCurrentThreadId

+
inline int  GetCurrentThreadId
(
); 
Don't be sucker! Describe your function in source code.
+

DbgSetDump

+
void  DbgSetDump
(
); 

 
  Dump state of all monitored objects to state.<pid> file.
 
+
+

DbgSetAdd

+
void  DbgSetAdd
(
  const char * setName,
  uint64_t     id,
  const char * fmtName
); 

 
  Add object with given ID to objects set.
 
  setName - name of target set, eg. 'socket' (IN).
  id      - object id (IN).
  fmtName - optional, human readable name e.g. NETAPI#2/Mutex,
            or printf like list to format name in runtime (IN/OPT).
 
  Examples:
   DbgSetAdd("socket", 1234);
   DbgSetAdd("mutex", 0x1000, "LogFile");
   DbgSetAdd("session", this, "NETAPI #%d/%d, id, ownerId);
 
+
+

DbgSetAdd

+
void  DbgSetAdd
(
  const char * setName,
  void *       ptr,
  const char * fmt
); 
Don't be sucker! Describe your function in source code.
+

DbgSetDel

+
void  DbgSetDel
(
  const char * setName,
  uint64_t     id
); 

 
  Remove object with given ID from objects set.
 
  setName - name of target set, eg. 'socket' (IN).
  id      - object id (IN).
 
  Examples:
   DbgSetDel("socket", 1234);
   DbgSetDel("session", this);
 
+
+

DbgSetMove

+
void  DbgSetMove
(
  const char * dstSet,
  const char * srcSet,
  uint64_t     id
); 

 
  Move object with given ID from source set to destination set.
 
  dstSet - name of destination set (IN).
  srcSet - name of source set (IN).
  id     - object id (IN).
 
+
+

DbgSetRename

+
void  DbgSetRename
(
  const char * setName,
  uint64_t     id,
  const char * fmtName
); 

 
  Assign human readable string to object.
 
  setName - name of object set used in DbgSetAdd() before (IN).
  id      - object id (IN).
 
  fmtName - new object's name to assign e.g. 'Session ID#5' or
            printf like list to format new name. See DbgSetAdd()
            for examples (IN).
 
+
+

DbgSetRename

+
void  DbgSetRename
(
  const char * setName,
  void *       ptr,
  const char * fmt
); 
Don't be sucker! Describe your function in source code.

LibError component

Title:LibError
Type:LIBRARY
Author(s):Sylwester Wysocki (sw143@wp.pl)
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Unify error codes, translate error codes to human readable strings.
Description:-
Dependences:
Used by: Tegenaria-core LibLock LibStr LibError-example01-system-codes

Functions list:

+
Error
+ErrGetString
+ErrGetSystemError
+ErrGetSystemErrorString
+

Functions protos:

+

Error.cpp

+ +

ErrGetString

+
const char * ErrGetString
(
  int  code
); 

 
  Translate ERR_XXX codes into human readable
  string.
 
  code - one of ERR_XXX codes defined in LibServer.h (IN).
 
  RETURNS: Human readable message or empty string if
           unknown code.
 
+
+

ErrGetSystemError

+
int  ErrGetSystemError
(
); 

 
  Get last saved system error code.
  It calls internally:
  - GetLastError() on Windows
  - errno() on Linux
 
  RETURNS: System error code saved from last system function.
 
+
+

ErrGetSystemErrorString

+
const string  ErrGetSystemErrorString
(
); 

 
  Get last saved system error as human readable string.
  It calls internally:
  - GetLastError() on Windows
  - errno on Linux
 
  RETURNS: System error code saved from last system function converted
           to human readable string (eg. "access denied").
 
+

LibFile component

Title:LibFile
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Process files and pathes. Ships transacted I/O.
Description:-
Dependences:LibDebug
Used by: Tegenaria-core qcbuild LibCGI

Functions list:

+
File
+FileLoad
+ListFiles
+ListDirs
+FileCompare
+FileExists
+FileWait
+FileDelete
+FileCreateRecursiveDir
+FileCreateDir
+FileSave
+FileGetDir
+FileSetDir
+FileGetRootName
+FileCreateTempName
+CanonizePath
+FileSize
+FileNormalizeSlash
+FileNormalizeSlash
+FileGetFirstFreeLetter
+FileWriteString
+FileReadString
+FileGetTempDir
+FileReadInt16
+FileReadInt32
+FileReadInt64
+FileReadFloat
+FileSkipBytes
+FileReadDouble
+FileGetLine
+FilePathGetTopDir
+FilePathGetDirAtDeep
+FileGetLastModificationTimestamp
+
TFile
+tfopen
+tfclose
+FileRecoverFailedIO
+

TODO:

+
= Change tfwrite() like macros into pure functions to hide implementation.
+

Functions protos:

+

File.cpp

+ +

FileLoad

+
char * FileLoad
(
  const char * fname,
  int *        readed
); 

 
  Load file to new allocate buffer.
 
  fname  - name of file to load (IN).
  readed - number of bytes allocated and readed (OUT/OPT).
 
  RETURNS: New allocated buffer or NULL if fail.
 
+
+

ListFiles

+
int  ListFiles
(
  string           path,
  string           mask,
  vector<string>&  files,
  bool             recursive,
  unsigned int     flags
); 

 
  Make file list in given directory.
 
  path      - directory where to search (IN)
  mask      - file mask (e.g. '*.dat') (IN)
  files     - output file list (OUT)
  recursive - search also in subdirs, if set to true (IN)
  flags     - combination of FILE_XXX flags defined in File.h (IN/OPT).
 
  RETURNS: 0 if OK
 
+
+

ListDirs

+
int  ListDirs
(
  string           path,
  string           mask,
  vector<string>&  dirs,
  bool             recursive,
  unsigned int     flags
); 

 
  Make directories list in given directory.
 
  path      - directory where to search (IN)
  mask      - file mask (IN)
  files     - output file list (OUT)
  recursive - list subdirs if true (IN)
  flags     - combination of FILE_XXX flags defined in File.h (IN/OPT).
 
  RETURNS: 0 if OK
 
+
+

FileCompare

+
int  FileCompare
(
  int           &stat,
  const string  &fname1,
  const string  &fname2
); 

 
  Compare two files.
 
  stat   - result of comparison (1 if equal, 0 if not) (OUT).
  fname1 - first file to compare (IN).
  fname2 - second file to compare (IN).
 
  RETURNS: 0 if OK.
 
+
+

FileExists

+
int  FileExists
(
  const string  &path
); 

 
  Check does file or directory exists on disk.
 
  path - path to check (IN).
 
  RETURNS: 1 if file exists.
 
+
+

FileWait

+
int  FileWait
(
  const char * fname,
  int          timeout
); 

 
  Wait until given file exists on disk.
 
  fname   - file name to wait (IN).
 
  timeout - maximum allowed wait time in ms. Defaulted to
            infinite if skipped (IN/OPT).
 
  RETURNS: 0 if file found within timeout,
          -1 if timeout reached.
 
+
+

FileDelete

+
int  FileDelete
(
  const char * fname
); 

 
  Remove file from disk.
 
  fname - path to file which we want to delete (IN).
 
  RETURNS: 0 if OK.
 
+
+

FileCreateRecursiveDir

+
int  FileCreateRecursiveDir
(
  const string  &target
); 

 
  Create directory recursively at one call.
 
  target - path to create (e.g. 'A/B/C/D') (IN).
 
  RETURNS: 0 if OK.
 
+
+

FileCreateDir

+
int  FileCreateDir
(
  const string  &path,
  int           quiet
); 

 
  Create single directory.
  TIP#1: Use FileCreateRecursiveDir() to create whole path recursively.
 
  path  - target path to create (IN).
  quiet - do not write error message if set to 1 (IN).
 
  RETURNS: 0 if OK.
 
+
+

FileSave

+
int  FileSave
(
  const char * fname,
  const char * buf,
  int          size
); 

 
  Save buffer to file. If file already exists will be overwritten.
 
  fname - path to output file (IN).
  buf   - buffer to dump (IN).
  size  - size of buf[] buffer in bytes (IN).
 
  RETURNS: 0 if OK.
 
+
+

FileGetDir

+
int  FileGetDir
(
  char * path,
  int    pathSize
); 

 
  Get current working directory.
 
  path     - buffer where to store retrieved directory (OUT).
  pathSize - size of path[] buffer in bytes (IN).
 
  RETURNS: 0 if OK.
 
+
+

FileSetDir

+
int  FileSetDir
(
  const char * path
); 

 
  Change current working directory.
 
  path - new working directory to set (e.g. 'c:/tmp') (IN).
 
  RETURN: 0 if OK.
 
+
+

FileGetRootName

+
string  FileGetRootName
(
  const string  &path
); 

 
  Get root filename from path, eg. it retrieve
  'file' from 'c:/tmp/file.dat'.
 
  path - path to split (IN).
 
  RETURNS: Root filename part or empty string if error.
 
+
+

FileCreateTempName

+
string  FileCreateTempName
(
  const char * baseDir,
  const char * prefix
); 

 
  Genearete temporary filename (WITHOUT creating the file).
  Ouput path has format : '<BaseDir>/<prefix>XXX.YYY',
  where XXX.YYY are generated unique name and extension.
 
  baseDir - directory, where to store file. System temp will be
            used if skipped (IN/OPT).
 
  prefix  - prefix to add before filename (IN/OPT).
 
  RETURNS: Abosolute path to temporary file or
           empty string if error.
 
 
+
+

CanonizePath

+
int  CanonizePath
(
  string  &path
); 
Don't be sucker! Describe your function in source code.
+

FileSize

+
int  FileSize
(
  const char * fname
); 

 
  Retrieve size of given file.
 
  fname - path to check (e.g. 'c:/tmp/test.dat') (IN).
 
  RETURNS: Size of file in bytes or -1 if error.
 
+
+

FileNormalizeSlash

+
void  FileNormalizeSlash
(
  char * path,
  char   slash
); 

 
  Normalize slashes in path to '/' or '\\'.
 
  path  - path to normalize (IN/OUT).
  slash - new slash character to use ('/' or '\\') (IN).
 
+
+

FileNormalizeSlash

+
void  FileNormalizeSlash
(
  wchar_t * path,
  wchar_t   slash
); 

 
  Normalize slashes in widechar path to L'/' or L'\\'.
 
  path  - path to normalize (IN/OUT).
  slash - new slash character to use (L'/' or L'\\') (IN).
 
+
+

FileGetFirstFreeLetter

+
const char  FileGetFirstFreeLetter
(
); 

 
  Retrieve first free drive letter.
 
  RETURNS: First available letter (e.g. 'J'),
           or 0 if error.
 
+
+

FileWriteString

+
int  FileWriteString
(
  FILE *        f,
  const string  &str
); 

 
  Dump C++ string to binary file.
  It writes to file xx xx xx xx ss ss ss ss ss ....
  where:
 
  xx - little endian dword (4 bytes) length of string without 0
  ss - variable string data
 
  f   - C stream, where to write data (IN).
  str - C++ string to dump (IN).
 
  RETURNS: 0 if OK.
 
+
+

FileReadString

+
int  FileReadString
(
  FILE *  f,
  string  &str
); 

 
  Load C++ string from binary file, stored by FileWriteString() before.
 
  f   - C stream, where to read data from (IN).
  str - C++ string where to load data (IN).
 
  RETURNS: 0 if OK.
 
+
+

FileGetTempDir

+
const string  FileGetTempDir
(
); 

 
  Return system TEMP directory.
 
+
+

FileReadInt16

+
int  FileReadInt16
(
  FILE *    f,
  int16_t * rv
); 

 
 
 
+
+

FileReadInt32

+
int  FileReadInt32
(
  FILE *    f,
  int32_t * rv
); 
Don't be sucker! Describe your function in source code.
+

FileReadInt64

+
int  FileReadInt64
(
  FILE *    f,
  int64_t * rv
); 
Don't be sucker! Describe your function in source code.
+

FileReadFloat

+
int  FileReadFloat
(
  FILE *  f,
  float * rv
); 
Don't be sucker! Describe your function in source code.
+

FileSkipBytes

+
int  FileSkipBytes
(
  FILE * f,
  int    numberOfBytesToSkip
); 
Don't be sucker! Describe your function in source code.
+

FileReadDouble

+
int  FileReadDouble
(
  FILE *   f,
  double * rv
); 
Don't be sucker! Describe your function in source code.
+

FileGetLine

+
char * FileGetLine
(
  char * buf,
  int    bufSize,
  FILE * f,
  int *  readed,
  int    trim
); 

 
  Read line from C stream WITHOUT end of line character.
 
  buf     - destination buffer, where to put readed data (OUT).
  bufSize - buf[] size in bytes (IN).
  f       - C stream retrievead from fopen before (IN).
  readed  - number of bytes readed (without end of line) (OUT/OPT).
  trim    - remove white space from left and right side if set to 1 (IN/OPT).
 
  RETURNS: pointer to first byte of line
           or NULL if error.
 
+
+

FilePathGetTopDir

+
string  FilePathGetTopDir
(
  const string  &path
); 

 
  Get root directory from path.
 
  Example input  : "Lib/LibFile"
  Example output : "Lib"
 
+
+

FilePathGetDirAtDeep

+
string  FilePathGetDirAtDeep
(
  const string  &path,
  int           deep
); 

 
  Get directory name at given deep level inside path.
 
  Example path    : "Source/Lib/LibFile"
  Example deep    : 1
  Example returns : Lib
 
+
+

FileGetLastModificationTimestamp

+
int  FileGetLastModificationTimestamp
(
  const char * path
); 

 
  Returns UNIX timestamp of last file modification or -1 if error.
 
+

TFile.cpp

+ +

tfopen

+
TFILE * tfopen
(
  const char * fname,
  const char * mode
); 

 
  Open file in transacted mode.
 
  fname - file path to open (IN).
  mode  - C style open mode (see fopen) (IN).
 
  RETURNS: File handle or NULL if error.
 
+
+

tfclose

+
void  tfclose
(
  TFILE * f
); 

 
  Close transacted file.
 
  f - handle retrieved from tfopen function (IN).
 
+
+

FileRecoverFailedIO

+
int  FileRecoverFailedIO
(
  const char * directory
); 

 
  Recover corrupted I/O operations in given directory.
 
  directory - path, where scan for corrupted operations (IN).
 
  RETURNS: 0 if OK.
 
+

LibIO component

Title:LibIO
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Ships common patterns to perform I/O tasks.
Description:-
Dependences:LibDebug LibLock LibThread ZLib
Used by: Tegenaria-core LibIO-example01-file-mixer LibIO-example02-network-mixer LibIO-example03-timeout-read

Functions list:

+
IOMixer
+IOMixer::addSlave
+IOMixer::IOMixer
+IOMixer::IOMixer
+IOMixer::getSlave
+IOMixer::removeSlave
+IOMixer::start
+IOMixer::stop
+IOMixer::slaveLoop
+IOMixer::masterLoop
+IOMixer::join
+IOMixer::~IOMixer
+IOMixer::masterEncode
+IOMixer::masterDecode
+IOMixer::masterWrite
+IOMixer::masterRead
+IOMixer::slaveWrite
+IOMixer::shutdown
+IOMixer::flush
+IOMixer::setSlaveDeadCallback
+IOMixer::setQuietMode
+IOMixer::isPointerCorrect
+IOMixer::setSlaveCompression
+IOMixer::initZLib
+IOMixer::objectName
+IOMixer::addRef
+IOMixer::release
+
IOFifo
+IOFifo::IOFifo
+IOFifo::~IOFifo
+IOFifo::push
+IOFifo::pop
+IOFifo::eat
+IOFifo::peek
+IOFifo::peekQword
+IOFifo::peekDword
+IOFifo::peekByte
+IOFifo::lock
+IOFifo::unlock
+IOFifo::bytesLeft
+IOFifo::size
+IOFifo::capacity
+
Utils
+CreatePipeEx
+
IOLoop
+IOLoop
+
IOTime
+IOTimeoutRead
+

README:

+
-------------------------------------------------------------------------------
+-                                                                             -
+-                                 IOFifo class                                -
+-                                                                             -
+------------------------------------------------------------------------------- 
+
+I. Cyclic buffer to storing I/O data.
+   Incoming data is appended to the end of buffer.
+   Outcoming data is popped from the begin of buffer.
+   (First in first out order).
+
+          xx xx xx xx xx xx xx ... yy yy yy yy yy 
+ 
+          ^^^                                 ^^^
+      Read position.                     Write position.
+      Pop data from here.                Push data here.
+      (Begin of buffer)                  (End of buffer).
+      
+II. Read/write
+==============
+
+  To add data to FIFO use push().
+  To pop data from FIFO use pop().
+  To eat data (pop, but don't write anywhere) use eat().
+
+III. Multithread
+================
+
+  IOFifo is NOT thread safe itself.
+  Use lock() and unlock() to synchronize access from many threads.
+
+-------------------------------------------------------------------------------
+-                                                                             -
+-                               IOMixer class                                 -
+-                                                                             -
+-------------------------------------------------------------------------------
+
+IOMixer to multiplex one master connection into many slave channels.
+
+I. Master thread:
+=================
+
+  One IOMixer = one master thread = one IOMixer::masterLoop().
+  
+           / [slave1/IN] - ...
+  [Master] - [slave2/IN] - ...
+           \ [slave3/IN] - ...
+
+
+  Master loop does:
+  -----------------
+  
+    1. Read <id><len><data> packet from master.
+    2. Send <len> bytes of <data> to slave with ID <id>.
+ 
+  
+                                                       <data1> -> slave1/IN
+                                                     / 
+  master/OUT -> <1><len1><data1><2><len2><data2> ... -> <data2> -> slave2/IN
+                                                     \ 
+                                                       ...
+                                                      
+  Master loop is created in IOMixer::start().
+  Master loop is deleted in IOMixer::stop().
+  
+  
+II. Slave threads:
+==================
+
+  One IOMixer = many slaves threads = many IOMixer::slaveLoop().
+  
+  ... -> [slave1/OUT] \
+  ... -> [slave2/OUT] -> [Master/IN] ->
+  ... -> [slave3/OUT] /
+  
+  Slave loop does:
+  ----------------
+  
+  1. Read <data> from slave with given <id>.
+  2. Write <id><len><data> to master.
+  
+  
+  Slave1/OUT -> <data1>
+                        \
+  Slave2/OUT -> <data2> -> <1><len1><data1> <2><len2><data2> ... -> master/IN
+                        /
+                    ...
+  
+  
+  Slave thread is created in IOMixer::addSlave(...)
+  Slave thread is deleted in IOMixer::removeSlave(..)
+  
+
+III. Slave IDs:
+===============
+
+  Slave 0         : Reserved for internal IOMixer usage.
+  Slave 1, 2, ... : Created by caller in IOMixer::addSlave().
+  
+
+IV. EOF packets:
+================
+
+  Used internally by IOMixer only.
+
+  Zero length data means EOF, i.e. packet <id><0>.
+
+  If slave loop received EOF it means slave with given <id> is dead
+  and should be shutted down.
+
+  EOF on slave ID#0 is reserved for master EOF.
+  It signal to shutdown whole connection.
+
+
+VI. Shutdown protocol:
+======================
+  
+  1. Send EOF for every slaves, i.e. <id><0>.
+  2. Send master EOF, i.e. <0><0>.
+  3. Wait for master EOF from remote or connection broken.
+  
+  Implemented in IOMixer::shutdown().
+  Called internally from destructor.
+
+

TODO:

+
- Review performance when TCP_NO_DELAY enabled.
+

Functions protos:

+

IOMixer.cpp

+ +

IOMixer::addSlave

+
int  IOMixer::addSlave
(
  int  callerFds[2],
  int  slaveId
); 

 
  Create new slave fd pair.
 
  All <data> written to 'slaveOut' will be wrapped to <slaveId> <len> <data>
  inside slave thread. One slave = one 'slave thread'.
 
 
  -> <data1> -> [Slave1] \
                         -> <1><len1><data1> <2><len2><data2> -> [master] ->
  -> <data3> -> [Slave3] /
 
 
  All <slaveId> <len> <data> readed from 'masterIn' will be dispatched
  into 'slaveIn' with given ID inside 'master thread'.
  One master thread is common to all slaves.
 
                                               <data1> ->
                                              /
  <1><len1><data1><2><len2><data2> -> [Master]
                                              \
                                               <data2> ->
 
 
  callerFds[] - input/output CRT fds valid in caller context (OUT).
 
  slaveId     - ID for new slave. Optional, if skipped new unique ID
                will be generated (IN/OPT).
 
  RETURNS: ID assigned to slave or -1 if error.
 
+
+

IOMixer::IOMixer

+
IOMixer::IOMixer
(
  int  masterOut,
  int  masterIn,
  int  masterOutType,
  int  masterInType
); 

 
  Constructor using socket/FDs pair.
 
+
+

IOMixer::IOMixer

+
IOMixer::IOMixer
(
  IOReadProto    readCallback,
  IOWriteProto   writeCallback,
  void *         readCtx,
  void *         writeCtx,
  IOCancelProto  ioCancelCallback
); 

 
  Constructor using two caller specified read/write functions.
 
  readCallback     - function used to read data from master (IN).
  writeCallback    - function used to write data to master (IN).
  readCtx          - caller defined data passed to readCallback() (IN/OPT).
  writeCtx         - caller defined data passed to writeCallback() (IN/OPT).
  ioCancelCallback - function used to cancel pending IO on master (IN/OPT)
 
+
+

IOMixer::getSlave

+
IOMixerSlave * IOMixer::getSlave
(
  int  id
); 

 
  Retrieve pointer to slave object with given ID,
  added by addSlave() before.
 
  RETURNS: Pointer to slave object or NULL if wrong ID.
 
+
+

IOMixer::removeSlave

+
int  IOMixer::removeSlave
(
  int  id
); 

 
  Remove slave with given ID.
 
  id - ID of slave to remove, retrieved from addSlave() before (IN).
 
  RETURNS: 0 if OK.
 
+
+

IOMixer::start

+
int  IOMixer::start
(
); 

 
  Start up master thread, which reading from <master>
  and dispatching readed data to slaves.
 
  WARNING: If master thread will be started BEFORE registering
           needed slaves via addSlave(), all incoming data
           will be ignored with "ERROR: Unknown slave ID.".
 
  RETURNS: 0 if OK.
 
+
+

IOMixer::stop

+
int  IOMixer::stop
(
); 

 
  Stop master thread started before by start() method.
 
  RETURNS: 0 if OK.
 
+
+

IOMixer::slaveLoop

+
int  IOMixer::slaveLoop
(
  IOMixerSlave * slave
); 

 
  Thread routine to mix many <slave-outputs> into one <master-input>.
  Used internally only.
  One slave = one slave loop = one slave thread.
 
  -> slave1 \
  -> slave2 -> master
  -> slave3 /
 
  slave - pointer to related I/O slave (IN/OUT).
 
  RETURNS: 0 if OK.
 
+
+

IOMixer::masterLoop

+
int  IOMixer::masterLoop
(
  IOMixer * this_
); 

 
  Thread routine to split one <master-input> into many <slave-outputs>.
  Used internally only.
 
            / slave1
  -> master - slave2
            \ slave3
 
  this_ - pointer to related IOMixer object (IN/OUT).
 
  RETURNS: 0 if OK.
 
+
+

IOMixer::join

+
int  IOMixer::join
(
); 

 
  Wait until 'master thread' and every 'slave threads' finished works.
 
  RETURNS: 0 if OK.
 
+
+

IOMixer::~IOMixer

+
IOMixer::~IOMixer
(
); 

 
  Desctructor.
  Kill master thread and all slaves.
 
+
+

IOMixer::masterEncode

+
int  IOMixer::masterEncode
(
  int      id,
  void *   buf,
  int      size,
  uint8_t  flags
); 

 
  Encode <data> into <id><flags><size><data> and write it into master OUT.
 
  TIP: If <size> is <= 0, then <data> part will be skipped.
       It's equal to sending EOF/error to other side, where remote
       read() will return -1/0.
 
  id    - channel id where to send data (IN).
  buf   - buffer to send (IN).
  size  - size of buf[] buffer in bytes (IN).
  flags - combination of IOMIXER_FLAG_XXX flags (IN).
 
  RETURNS: 0 if OK.
 
+
+

IOMixer::masterDecode

+
int  IOMixer::masterDecode
(
  int *  id,
  int *  size,
  void * data,
  int    dataSize
); 

 
  Pop <id><flags><size><data> packet from master IN.
 
  id       - buffer where to store decoded <id> (OUT).
  size     - buffer where to store decoded <size> (OUT).
  data     - buffer where to store decoded <data> (OUT).
  dataSize - size of data[] buffer in bytes (IN).
 
  RETURNS: Number of decoded <data> bytes of -1 if error.
 
+
+

IOMixer::masterWrite

+
int  IOMixer::masterWrite
(
  void * buf,
  int    bytesToWrite
); 

 
  Atomic write <size> bytes from <buf> to master OUT.
 
  Wrapper to system write() to hide difference beetwen socket
  and CRT FD on windows.
 
  buf          - buffer with data to write (IN).
  bytesToWrite - number of bytes to be written (IN).
 
  RETURNS: 0 if all data written
          -1 if otherwise.
 
+
+

IOMixer::masterRead

+
int  IOMixer::masterRead
(
  void * buf,
  int    bytesToRead
); 

 
  Atomic read <size> bytes from master IN to <buf>.
 
  Wrapper to system read() to hide difference beetwen socket
  and CRT FD on windows.
 
  buf         - buffer with data to write (IN).
  bytesToRead - number of bytes to be readed (IN).
 
  RETURNS: 0 if all data readed
          -1 if otherwise.
 
+
+

IOMixer::slaveWrite

+
int  IOMixer::slaveWrite
(
  int    id,
  void * buf,
  int    size
); 

 
  Write <size> bytes from <buf> to slave with id <id>.
 
  id   - id of target slave (IN).
  buf  - source buffer to write (IN).
  size - number of bytes to be written (IN).
 
  RETURNS: 0 if all data written,
          -1 otherwise.
 
+
+

IOMixer::shutdown

+
int  IOMixer::shutdown
(
); 

 
  Shutdown master FD. It sends EOF for ID #0,
  where ID #0 is reserved for master.
 
+
+

IOMixer::flush

+
int  IOMixer::flush
(
); 

 
  Wait until all slave threads finished work.
 
+
+

IOMixer::setSlaveDeadCallback

+
void  IOMixer::setSlaveDeadCallback
(
  IOSlaveDeadProto  callback,
  void *            ctx
); 

 
  Register callback to inform caller when slave with given ID dead.
 
  callback - pointer to function, which will be called if one
             of slave dead (IN).
 
  ctx      - custom, caller specified data passed directly
             into callback (IN/OPT).
 
  RETURNS: none.
 
+
+

IOMixer::setQuietMode

+
void  IOMixer::setQuietMode
(
  int  value
); 

 
  Enable/disble quiet mode to avoid printint error messages longer.
 
+
+

IOMixer::isPointerCorrect

+
int  IOMixer::isPointerCorrect
(
  IOMixer * ptr
); 

 
  Check is given this pointer points to correct IOMixer *object.
 
  ptr - this pointer to check (IN).
 
  RETURNS: 1 if given pointer points to correct IOMixer object,
           0 otherwise.
 
+
+

IOMixer::setSlaveCompression

+
int  IOMixer::setSlaveCompression
(
  int  id,
  int  enabled
); 

 
  Enable or disable IOMIXER_FLAG_COMPRESSION_ON flag on selected
  channel. After that outcoming data on this channel will be
  compressed/uncompressed.
 
  id      - slave ID to change (IN).
  enabled - set to 1 to enable compression, 0 to disable (IN).
 
  RETURNS: 0 if OK.
 
+
+

IOMixer::initZLib

+
int  IOMixer::initZLib
(
); 

 
  Initialize ZLib library.
  Called internally only.
 
  RETURNS: 0 if OK.
 
+
+

IOMixer::objectName

+
const char * IOMixer::objectName
(
); 

 
  Get object name generated in constructor.
 
+
+

IOMixer::addRef

+
void  IOMixer::addRef
(
); 

 
  Increase refference counter.
 
  WARNING! Every call to addRef() MUSTS be followed by one release() call.
 
  TIP #1: Object will not be destroyed until refference counter is greater
          than 0.
 
  TIP #2: Don't call destructor directly, use release() instead. If
          refference counter achieve 0, object will be destroyed
          automatically.
 
+
+

IOMixer::release

+
void  IOMixer::release
(
); 

 
  Decrease refference counter increased by addRef() before.
 
+

IOFifo.cpp

+ +

IOFifo::IOFifo

+
IOFifo::IOFifo
(
  unsigned int  capacity
); 

 
  Create new IOFifo with given capacity.
 
  capacity - size of fifo in bytes (IN).
 
+
+

IOFifo::~IOFifo

+
IOFifo::~IOFifo
(
); 

 
  Free buffers allocated in constructor.
 
+
+

IOFifo::push

+
int  IOFifo::push
(
  void * source,
  int    len
); 

 
  Add data to the end of FIFO.
 
  Buffer before: xx xx xx xx xx
  Buffer after : xx xx xx xx xx yy yy yy yy ...
 
  source - source buffer with data to append (IN).
  len    - number of bytes to append (IN).
 
  RETURNS: 0 if all bytes appended,
           -1 otherwise.
 
+
+

IOFifo::pop

+
int  IOFifo::pop
(
  void * dest,
  int    len,
  int    peekOnly
); 

 
  Pop data from the begin of FIFO.
 
  Buffer before: xx xx xx xx yy yy yy yy ...
  Buffer after :             yy yy yy yy ...
 
 
  TIP#1: If dest buffer is NULL, data are popped from FIFO,
         but don't written anywhere.
 
  TIP#2: Skip len parameter or set to -1 if you want to pop up
         all data stored in queue.
 
  TIP#3: Use peekOnly flag to get data WITHOUT removing it from FIFO.
 
 
  dest     - buffer where to write popped data (OUT/OPT).
 
  len      - number of bytes to pop, if set to -1 all available data
             will be popped (IN/OPT).
 
  peekOnly - set to 1 if you want copy data to dest buffer WITHOUT
             remove it from buffer (IN/OPT).
 
  RETURNS: 0 if all bytes popped,
           -1 otherwise..
 
+
+

IOFifo::eat

+
int  IOFifo::eat
(
  int  len
); 

 
  Eat data from the begin of FIFO.
 
  Buffer before: xx xx xx xx yy yy yy yy ...
  Buffer after :             yy yy yy yy ...
 
 
  Works as pop() method with destination set to NULL.
 
  len - number of bytes to eat (IN).
 
  RETURNS: 0 if all bytes eated,
          -1 otherwise..
 
+
+

IOFifo::peek

+
int  IOFifo::peek
(
  void * dest,
  int    len
); 

 
  Copy <len> bytes from begin of FIFO to <dest>, but
  do NOT remove them from FIFO.
 
  Works as pop() with peekOnly flag set to 1.
 
 
  dest - buffer where to store readed data (OUT).
 
  len  - number of bytes to read. If set to -1 all
         available data will be copied (IN/OPT).
 
 
  RETURNS: 0 if all bytes copied,
          -1 otherwise.
 
 
+
+

IOFifo::peekQword

+
uint64_t  IOFifo::peekQword
(
  int  endian
); 

 
  Peek QWORD from fifo begin, but do NOT remove it from buffer.
 
  WARNING: If there is less than 8 bytes in buffer, return value
           is always zero.
 
  endian - set to IO_BIG_ENDIAN or IO_LITTLE_ENDIAN (IN).
 
  RETURNS: First QWORD in queue.
 
+
+

IOFifo::peekDword

+
uint32_t  IOFifo::peekDword
(
  int  endian
); 

 
  Peek DWORD from fifo begin, but do NOT remove it from buffer.
 
  WARNING: If there is less than 4 bytes in buffer, return value
           is always zero.
 
  endian - set to IO_BIG_ENDIAN or IO_LITTLE_ENDIAN (IN).
 
  RETURNS: First DWORD in queue.
 
+
+

IOFifo::peekByte

+
uint8_t  IOFifo::peekByte
(
); 

 
  Peek byte from fifo begin, but do NOT remove it from buffer.
 
  WARNING: If there is less than 1 bytes in buffer, return value
           is always zero.
 
  RETURNS: First byte in queue.
 
+
+

IOFifo::lock

+
void  IOFifo::lock
(
); 

 
  Lock access to fifo.
 
+
+

IOFifo::unlock

+
void  IOFifo::unlock
(
); 

 
  Unlock access to fifo blocked by lock() before.
 
+
+

IOFifo::bytesLeft

+
unsigned int  IOFifo::bytesLeft
(
); 

 
  Return number of free bytes, which can be append to fifo.
 
+
+

IOFifo::size

+
unsigned int  IOFifo::size
(
); 

 
  Return number of bytes already stored inside fifo.
 
+
+

IOFifo::capacity

+
unsigned int  IOFifo::capacity
(
); 

 
  Return total fifo capacity in bytes.
 
+

Utils.cpp

+ +

CreatePipeEx

+
int  CreatePipeEx
(
  int                  pipe[2],
  SECURITY_ATTRIBUTES  sa[2],
  int                  bufSize,
  DWORD                readMode,
  DWORD                writeMode,
  int                  timeout
); 

 
  Create fake anonymous pipe pair ready for asynchronous read.
 
  pipe      - buffer to store read and write instances of pipe (OUT).
  sa        - security attributes to set (IN).
  bufSize   - buffer size in bytes (IN).
  readMode  - flags for read pipe (IN).
  writeMode - flags for write pipe (IN).
 
  RETURNS: 0 if OK.
 
+

IOLoop.cpp

+ +

IOLoop

+
int  IOLoop
(
  int               count,
  int *             fd,
  int *             direct,
  IOFifo *          queue,
  IOCompletedProto  callback
); 

 
  Template routine for main I/O loop.
 
  count    - number of FDs to read/write. MUST much with number of
             elements in fd[], direct[] and queue[] tables (IN).
 
  fd       - table with FDs to read or write (IN).
 
  direct   - 0 at index i menns fd[i] is input device,
             1 at index i means fd[i] is output device (IN).
 
  queue    - table with IOFifo objects related with related fd.
             Used to collect data incoming from fd (direct=0),
             or as data source written to fd (direct=1) (IN/OUT).
 
  callback - routine called when portion of data received or send.
             Can be NULL if not needed. (IN/OPT).
 
  RETURNS: 0 if loop finished in usual way,
          -1 if abnormal exit.
 
+

IOTime.cpp

+ +

IOTimeoutRead

+
int  IOTimeoutRead
(
  int    fd,
  void * buf,
  int    size,
  int    timeout
); 

 
  Works like standard CRT read(), but with timeout functionality.
 
  fd      - CRT file descriptor (received from open()) (IN)
  buf     - buffer where to store readed data (OUT)
  size    - number of bytes to read (IN)
  timeout - timeout in ms or -1 for infinite (IN)
 
  RETURNS: number of bytes readed or
           -1 if error.
 
+

LibIpc component

Title:LibIpc
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Inter-process comunication.
Description:-
Dependences:LibDebug LibThread LibLock
Used by: Tegenaria-core LibIpc-example LibIpc-example2

Functions list:

+
Ipc
+IpcServerLoop
+IpcServerThreadLoop
+IpcServerCreate
+IpcServerKill
+IpcServerMarkLastRequest
+IpcOpenHandle
+IpcOpen
+IpcRequest
+IpcSendAnswer
+
Utils
+TimeoutReadSelect
+TimeoutReadFileOv
+SetUpSecurityAttributesEverybody
+FreeSecurityAttributes
+

TODO:

+
- Handle timeout
+
+- Move processing connection into another thread
+

Functions protos:

+

Ipc.cpp

+ +

IpcServerLoop

+
int  IpcServerLoop
(
  const char *    nameIn,
  IpcWorkerProto  callback,
  void *          ctx,
  int *           ready
); 

 
  Main loop for named pipe server.
  Can be used to set up blocking server loop in user app.
 
  TIP #1: To create server loop in another thread ('non-blocking') use
          IpcServerCreate() instead.
 
  TIP #2: Use IpcServerKill to close server.
 
  name     - pipe name to create (IN).
  callback - handler function to process incoming connections (IN).
  timeout  - maximum allow time to process one connection in ms (IN).
  ctx      - caller context passed to callback function (IN/OPT).
  ready    - set to 1 when server loop initialized (OUT/OPT).
 
  RETURNS: 0 if OK.
 
+
+

IpcServerThreadLoop

+
int  IpcServerThreadLoop
(
  IpcJob * job
); 

 
  Wrapper to pass IpcServerLoop() to threadCreate.
  Used internally only by IpcServerCreate.
 
+
+

IpcServerCreate

+
int  IpcServerCreate
(
  const char *    name,
  IpcWorkerProto  callback,
  void *          ctx
); 

 
  Create IPC server in another thread. Works as non-blocking IpcServerLoop().
 
  name     - pipe name to create (IN).
  callback - handler function to process incoming connections (IN).
  ctx      - caller context passed to callback function directly (IN/OPT).
 
  TIP #1: Use IpcServerKill to close server.
 
  RETURNS: 0 if OK.
 
+
+

IpcServerKill

+
int  IpcServerKill
(
  const char * name
); 

 
  Close server loop started by IpcServerLoop() or IpcServerCreate() before.
 
  WARNING! Do not use this function inside IPC request handler (passed
           to IpcServerCreate as callback). It can causes deadlock.
 
  TIP#1: To finish server inside IPC request handler use IpcServerFinish()
         instead.
 
  name - name passed to IpcServerXXX function before (IN).
 
  RETURNS: 0 if OK.
 
+
+

IpcServerMarkLastRequest

+
int  IpcServerMarkLastRequest
(
  const char * name
); 

 
  Mark pipe loop started by IpcServerLoop() or IpcServerCreate() as
  finished. After exit from last pending IPC request server should exit
  from server loop.
 
  WARNING! This function should be called from IPC Request handler (passed
           to IpcServerCreate as callback). It means that current IPC
           request is last request in loop.
 
  TIP#1: If you want to finish IPC loop outside IPC request handler use
         IpcServerKill() instead.
 
  name - name passed to IpcServerXXX function before (IN).
 
  RETURNS: 0 if OK.
 
+
+

IpcOpenHandle

+
HANDLE  IpcOpenHandle
(
  const char *   name,
  int timeout =  IPC_DEFAULT_TIMEOUT
); 

 
  Open connection to existing named pipe server.
 
  name    - pipe name passed to IpcServer() in server process (IN).
  timeout - maximum allow wait time in ms (IN/OPT).
 
  RETURNS: Pipe HANDLE use with WriteFile/ReadFile functions,
           or INVALID_HANDLE_VALUE if error.
 
+
+

IpcOpen

+
int  IpcOpen
(
  const char * name,
  int          timeout
); 

 
  Open connection to existing pipe server.
 
  name    - pipe name passed to IpcServer() in server process (IN).
  timeout - maximum allow wait time in ms (IN/OPT).
 
  RETURNS: CRT descriptor (fd) ready to use with write/read funcions,
           or -1 if error.
 
+
+

IpcRequest

+
int  IpcRequest
(
  const char * pipeName,
  int *        serverCode,
  char *       serverMsg,
  int          serverMsgSize,
  const char * fmt
); 

 
  - Send single request to pipe server
  - read answer in format 'XYZ > message'
  - split answer to <XYZ> code and <message> parts.
 
  Example usage:
 
  IpcRequest(PIPENAME, &code, answer, sizeof(answer),
                 "share --alias %s --path %s", alias, path);
 
  TIP: If only exit code is needed <answer> can be set to NULL.
 
  pipeName      - pipe name, where to send command (IN).
  serverCode    - exit code returned by server (OUT/OPT).
  serverMsg     - ASCIZ message returned by server (OUT/OPT).
  serverMsgSize - size of answer buffer in bytes (IN/OPT).
  fmt           - printf like parameters to format command to send (IN).
 
  RETURNS: 0 if request sucessfuly sent and asnwer from server received.
          -1 otherwise.
 
  WARNING!: Request could still failed on server side.
            To get server's side exit code use 'answerCode' parameter.
 
+
+

IpcSendAnswer

+
int  IpcSendAnswer
(
  int          fd,
  int          code,
  const char * msg
); 

 
  Format 'XYZ> message' string and send it to given CRT FD.
 
  fd   - CRT FD, where to send answer (IN).
  code - 3 digit answer code (e.g. 100) (IN).
  msg  - Optional, ASCIZ message to send, can be NULL (IN/OPT).
 
  RETURNS: 0 if OK.
 
+

Utils.cpp

+ +

TimeoutReadSelect

+
int  TimeoutReadSelect
(
  int    fd,
  void * buf,
  int    len,
  int    timeout
); 

 
  Work like system read(), but with timeout functionality.
 
  fd      - CRT file descriptor where to read from (IN).
  buf     - destination buffer (OUT).
  len     - number of bytes to read (IN).
  timeout - timeout in seconds (IN).
 
  RETURNS: Number of bytes readed or
           -1 if error.
 
+
+

TimeoutReadFileOv

+
int  TimeoutReadFileOv
(
  HANDLE  handle,
  void *  buf,
  int     len,
  int *   readed,
  int     timeout
); 

 
  Work like system ReadFile(), but with timeout functionality.
 
  WARNING: Handle MUST be opened in overlapped mode.
 
  handle  - native HANDLE to input device e.g. named pipe or socket (IN).
  buf     - destination buffer (OUT).
  len     - number of bytes to read (IN).
  readed  - number of bytes readed (OUT).
  timeout - timeout in miliseconds (IN).
 
  RETURNS: 1 if success and still something to read,
           0 otherwise.
 
+
+

SetUpSecurityAttributesEverybody

+
int  SetUpSecurityAttributesEverybody
(
  SECURITY_ATTRIBUTES * sa
); 

 
  Allocating security attributes giving READ+WRITE rights to
  everybody, and maximum allowed rights to administartors.
 
  WARNING: Output struct need to be uninitialized by
  FreeSecurityAttributes() function!
 
  sa - security attributes struct to fill (OUT).
 
  RETURNS: 0 if OK.
 
+
+

FreeSecurityAttributes

+
void  FreeSecurityAttributes
(
  SECURITY_ATTRIBUTES * sa
); 

 
  Free Security Attributes struct allocated by
  SetUpSecurityAttributes() function.
 
+

LibJob component

Title:LibJob
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Template to performing asynchronous jobs like downloading file from network or compressing data.
Description:-
Dependences:LibDebug LibThread LibLock
Used by: Tegenaria-core libjob-example01-simple

Functions list:

+
Job
+Job::Job
+Job::triggerNotifyCallback
+Job::addRef
+Job::release
+Job::workerLoop
+Job::setState
+Job::getState
+Job::getStateString
+Job::wait
+Job::cancel
+Job::getTitle
+Job::~Job
+Job::getPercentCompleted
+Job::getErrorCode
+Job::setErrorCode
+Job::setPercentCompleted
+

Functions protos:

+

Job.cpp

+ +

Job::Job

+
Job::Job
(
  const char *            title,
  JobNotifyCallbackProto  notifyCallback,
  void *                  notifyCallbackCtx,
  JobWorkerCallbackProto  workerCallback,
  void *                  workerCallbackCtx
); 

 
  Create job object.
 
  title             - job's title (IN/OPT).
  notifyCallback    - callback called when job changed state or progress meter (IN/OPT).
  notifyCallbackCtx - caller context passed to notifyCallback() directly (IN/OPT).
  workerCallback    - callback function performing real job work (IN).
  workerCallbackCtx - caller context passed to workerCallback() directly (IN/OPT).
 
+
+

Job::triggerNotifyCallback

+
void  Job::triggerNotifyCallback
(
  int  code
); 

 
  Call underlying notify callback set in constructor.
 
  code - one of JOB_NOTIFY_XXX codes (IN).
 
+
+

Job::addRef

+
void  Job::addRef
(
); 

 
  Increase refference counter.
 
  WARNING! Every call to addRef() MUSTS be followed by one release() call.
 
  TIP #1: Object will not be destroyed until refference counter is greater
          than 0.
 
  TIP #2: Don't call destructor directly, use release() instead. If
          refference counter achieve 0, object will be destroyed
          automatically.
 
+
+

Job::release

+
void  Job::release
(
); 

 
  Decrease refference counter increased by addRef() before.
 
+
+

Job::workerLoop

+
int  Job::workerLoop
(
  void * jobPtr
); 

 
  Worker loop performing real job in background thread.
  This function calls underlying doTheJob() function implemented in child class.
 
  jobPtr - pointer to related Job object (this pointer) (IN/OUT).
 
+
+

Job::setState

+
void  Job::setState
(
  int  state
); 

 
  Change current state. See JOB_STATE_XXX defines in Job.h.
 
  state - new state to set (IN).
 
+
+

Job::getState

+
int  Job::getState
(
); 

 
  Get current state code. See JOB_STATE_XXX defines in Job.h.
 
  RETURNS: Current state code.
 
+
+

Job::getStateString

+
const char * Job::getStateString
(
); 

 
  Get current state as human readable string.
 
  RETURNS: Name of current job's state.
 
+
+

Job::wait

+
int  Job::wait
(
  int  timeout
); 

 
  Wait until job finished or stopped with error.
 
  timeout - maximum time to wait in ms. Set to -1 for infinite (IN).
 
  RETURNS: 0 if OK (job finished/stopped on exit),
          -1 otherwise (job still active on exit).
+
+

Job::cancel

+
void  Job::cancel
(
); 

 
  Send stop signal for pending job object.
  After that related thread should stop working and state
  should change to JOB_STATE_STOPPED.
 
  WARNING#1: Job object MUSTS be still released with release() method.
 
  TIP#1: To stop and release resources related with job use below code:
 
         job -> cancel();
         job -> release();
 
+
+

Job::getTitle

+
const char * Job::getTitle
(
); 

 
  Retrieve job's title set in constructor before.
 
+
+

Job::~Job

+
Job::~Job
(
); 
Don't be sucker! Describe your function in source code.
+

Job::getPercentCompleted

+
double  Job::getPercentCompleted
(
); 

 
  Get current job's progress in percentages (0-100%).
 
+
+

Job::getErrorCode

+
int  Job::getErrorCode
(
); 

 
  Get error code related with object.
  This function should be used when job finished with error state.
 
+
+

Job::setErrorCode

+
void  Job::setErrorCode
(
  int  code
); 

 
  Set current error code related with job.
  This function should be used to inform caller why job object
  finished with error state.
 
+
+

Job::setPercentCompleted

+
void  Job::setPercentCompleted
(
  double  percentCompleted
); 

 
  Set current job's progress in percentages (0-100%).
 
+

LibLock component

Title:LibLock
Type:LIBRARY
Author(s):Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), Lukasz Bienczyk (lukasz.bienczyk@gmail.com), Sylwester Wysocki (sw143@wp.pl)
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Locks
Description:-
Dependences:LibDebug LibError
Used by: Tegenaria-core LibNetEx LibSecure LibSftp LibNet-example01-thread-server LibNet-example02-single LibNet-example05-HP-server LibIO LibIpc LibJob LibObject LibProcess LibProcess-example03-monitor LibProcess-example04-wait-for-parent LibLock-example01-mutex LibLock-example02-semaphore liblock-example03-requestpool LibIpc-example LibIpc-example2 LibIO-example01-file-mixer LibIO-example02-network-mixer LibIO-example03-timeout-read

Functions list:

+
RequestPool
+RequestPool::RequestPool
+RequestPool::~RequestPool
+RequestPool::getName
+RequestPool::find
+RequestPool::findFree
+RequestPool::wait
+RequestPool::serve
+RequestPool::serve
+RequestPool::push
+RequestPool::lock
+RequestPool::unlock
+Request::lockData
+Request::unlockData
+Request::serve
+
Semaphore
+Semaphore::Semaphore
+Semaphore::~Semaphore
+Semaphore::wait
+Semaphore::signal
+Semaphore::tryWait
+Semaphore::getState
+Semaphore::unwind
+Semaphore::unwoundWait
+Semaphore::setName
+
Mutex
+Mutex::Mutex
+Mutex::~Mutex
+Mutex::lock
+Mutex::unlock
+Mutex::getState
+Mutex::setName
+

Functions protos:

+

RequestPool.cpp

+ +

RequestPool::RequestPool

+
RequestPool::RequestPool
(
  int          size,
  const char * name
); 

 
  Constructor.
  Allocate and zero pending request table.
 
  size - maximum number of pending request in one time (IN/OPT).
  name - arbitrary request pool name to debug code easier (IN/OPT).
 
+
+

RequestPool::~RequestPool

+
RequestPool::~RequestPool
(
); 

 
  Destructor.
  Free request table created in constructor.
 
+
+

RequestPool::getName

+
const char * RequestPool::getName
(
); 

 
  Get object name.
 
+
+

RequestPool::find

+
Request * RequestPool::find
(
  int  id
); 

 
  Find request with given ID.
 
  WARNING: Function is not thread safe itselt. Caller MUSTS use lock()/unlock()
           by own.
 
  id - request's ID set int RequestPush() time before (IN).
 
  RETURNS: Pointer to found Request object,
           NULL if request with given ID does not exists.
 
+
+

RequestPool::findFree

+
Request * RequestPool::findFree
(
); 

 
  Find first not used request in requests table.
 
  WARNING: Function is not thread safe itselt. Caller MUSTS use lock()/unlock()
           by own.
 
  RETURNS: Pointer to first not used request,
           NULL if too many requests.
 
+
+

RequestPool::wait

+
int  RequestPool::wait
(
  int  id,
  int  timeout
); 

 
  Wait until given request served by serve() function.
 
  WARNING#1: This function pop request from table even if timeout reached.
  WARNING#2: Only one thread can wait for request at one time.
 
  TIP#1: Use serve() method from another thread to serve pending request.
         After that wait() will finished with code 0.
 
  Parameters:
 
  id      - request ID passed to push() before (IN).
  timeout - timeout in ms, -1 for infinity (IN).
 
  RETURNS: 0 if OK,
           ERR_WRONG_PARAMETER if there is no request with given ID,
           ERR_TIMEOUT if timeout reached.
+
+

RequestPool::serve

+
int  RequestPool::serve
(
  int  id
); 

 
  Mark request with given ID as served. After that thread wait() from
  another thead will be finished.
 
  id - request ID to serve, set in push() time (IN).
 
  RETURNS: 0 if OK,
           ERR_WRONG_PARAMETER if request with given id does not exist.
 
+
+

RequestPool::serve

+
int  RequestPool::serve
(
  Request * r
); 

 
  Mark request as served. After that thread wait() from another
  thread will be finished.
 
  r - pointer to request retrieved from find() function (IN).
 
  RETURNS: 0 if OK,
           ERR_WRONG_PARAMETER if request with given id does not exist.
 
+
+

RequestPool::push

+
int  RequestPool::push
(
  int    id,
  void * inputData,
  void * outputData
); 

 
  Push new request to pending table.
 
  TIP#1: Another thread should use serve() to finalize (serve) request.
 
  TIP#2: Use wait() to wait until request served.
 
  WARNING#1: Every call to push() MUSTS be followed by one call to serve()
             with the same ID.
 
  id         - request ID to assign, MUSTS be unique (IN).
  inputData  - pointer to arbitrary input data, can be NULL (IN/OUT).
  outputData - pointer to arbitrary output data, can be NULL (IN/OUT).
 
  RETURNS: 0 if OK,
          -1 otherwise.
 
+
+

RequestPool::lock

+
void  RequestPool::lock
(
); 

 
  Lock request pool object.
 
  WARNING: Every call to lock() MUSTS be followed by one unlock() call.
 
+
+

RequestPool::unlock

+
void  RequestPool::unlock
(
); 

 
  Unlock request pool object locked by lock() function before.
 
+
+

Request::lockData

+
void  Request::lockData
(
); 

 
  Lock data pointers stored inside Request struct.
 
  WARNING: Every calls to lockData() MUSTS be followed by one unlockData()
           call.
 
+
+

Request::unlockData

+
void  Request::unlockData
(
); 

 
  Unlock data pointers stored inside Request struct locked by lockData()
  before.
 
+
+

Request::serve

+
void  Request::serve
(
); 

 
  Mark request as served.
 
+

Semaphore.cpp

+ +

Semaphore::Semaphore

+
Semaphore::Semaphore
(
  int          initValue,
  const char * name
); 
Don't be sucker! Describe your function in source code.
+

Semaphore::~Semaphore

+
Semaphore::~Semaphore
(
); 
Don't be sucker! Describe your function in source code.
+

Semaphore::wait

+
int  Semaphore::wait
(
  int  timeout
); 

 
  Wait until semafore reach signaled state.
 
  TIP#1: Use signal() function to change object into signaled state.
 
  TIP#2: Use isSignaled() to check is semaphore signaled without falling into
         waiting loop.
 
  timeout - timeout in ms, -1 for infinite (IN/OPT).
 
  RETURNS:  0 on success,
            1 on timeout,
           -1 if error.
 
+
+

Semaphore::signal

+
void  Semaphore::signal
(
); 
Don't be sucker! Describe your function in source code.
+

Semaphore::tryWait

+
int  Semaphore::tryWait
(
); 

 
  Decrement the counter of the semaphore. Do not block if traditional
  wait() would block.
 
+
+

Semaphore::getState

+
int  Semaphore::getState
(
); 

 
  Retrieve currect semaphore counter.
 
+
+

Semaphore::unwind

+
int  Semaphore::unwind
(
); 

 
  Decrement the counter untill the wait call would block.
 
+
+

Semaphore::unwoundWait

+
int  Semaphore::unwoundWait
(
  int  timeout
); 
Don't be sucker! Describe your function in source code.
+

Semaphore::setName

+
void  Semaphore::setName
(
  const char * name
); 
Don't be sucker! Describe your function in source code.

Mutex.cpp

+ +

Mutex::Mutex

+
Mutex::Mutex
(
  const char * name
); 

 
  Constructor. Create named or anonymous mutex object.
 
  name - optional, human readable name (IN/OPT).
 
+
+

Mutex::~Mutex

+
Mutex::~Mutex
(
); 

 
  Destructor.
 
+
+

Mutex::lock

+
void  Mutex::lock
(
); 

 
  Get ownership of the mutex.
 
  TIP#1: Every call to lock() MUSTS be followed by one call to unlock().
 
+
+

Mutex::unlock

+
void  Mutex::unlock
(
); 

 
  Releae mutex locked by lock() method before.
 
  WARNING: Only thread, that called lock() can free mutex.
 
+
+

Mutex::getState

+
int  Mutex::getState
(
); 

 
  Get current mutex state.
 
  Unimplemented.
 
+
+

Mutex::setName

+
void  Mutex::setName
(
  const char * fmt
); 

 
  Change mutex name.
 
  fmt - C printf like format (IN).
 
+

LibProcess component

Title:LibProcess
Type:LIBRARY
Author(s):Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), Lukasz Bienczyk (lukasz.bienczyk@gmail.com), Sylwester Wysocki (sw143@wp.pl)
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Creating and monitoring processes
Description:-
Dependences:LibDebug LibLock LibThread LibStr
Used by: Tegenaria-core LibNet-example01-thread-server LibNet-example02-single LibProcess-example01-sshd LibProcess-example02-wrapper LibProcess-example03-monitor LibProcess-example04-wait-for-parent LibProcess-example05-daemon LibLock-example01-mutex LibLock-example02-semaphore LibIO-example02-network-mixer

Functions list:

+
Utils
+ProcessCreate
+ProcessIsRunning
+ProcessKill
+ProcessWait
+ProcessGetParentPid
+ProcessGetCurrentPid
+ProcessGetModulePath
+ProcessExpandRelativePath
+ProcessDaemonize
+ProcessGetBinaryPathByPid
+
ApiHandle
+ProcessClose
+ProcessIsRunning
+ProcessKill
+ProcessWait
+ProcessWatch
+ProcessCancelWatch
+ProcessGetPidByHandle
+
ApiPid
+ProcessIsRunningById
+ProcessKillByPid
+ProcessWaitByPid
+ProcessWatchByPid
+ProcessCancelWatchByPid
+
Sleep
+ProcessSleepUs
+ProcessSleepMs
+ProcessSleepSec
+
Create
+ProcessCreate
+

Functions protos:

+

Utils.cpp

+ +

ProcessCreate

+
int  ProcessCreate
(
  const char * argv[],
  int          fdin,
  int          fdout,
  int          fderr,
  int          fdType,
  int          options
); 

 
  USE:
    const char *argv[3 + argv_count];
    argv[0] = "path_to_process";
    argv[1] = "parameter#1";
    argv[2] = "parameter#2";
    argv[3] = "parameter#3";
    argv[4] = NULL;
 
  argv[]  - NULL terminated parameter list (IN).
  fdin    - FD to set for std input (IN/OPT).
  fdout   - FD to set for std output (IN/OPT).
  fderr   - FD to set for std error (IN/OPT).
 
  fdType  - type of specified fdin/fdout/fderr values. One of
            PROCESS_TYPE_XXX values defined in LibProcess.h. Defaulted
            to PROCESS_TYPE_CRT if skipped. (IN/OPT).
 
  options - combination of PROCESS_OPTIONS_XXX flags (IN/OPT).
 
  TIP #1: Set fdin/fdout/fderr to -1 to inherit handle from parent.
  TIP #2: Set fdin/fdout/fderr to -2 to redirect handle to nul.
  TIP #3: Set fdType to PROCESS_TYPE_HANDLE if you have raw win32 handle on windows.
 
  RETURNS: pid of new process
           or -1 if error.
 
+
+

ProcessIsRunning

+
int  ProcessIsRunning
(
  int  pid
); 

 
  Check does given proces live.
 
  pid - pid of process to check (IN).
 
  RETURNS: 1 if process is running,
           0 if dead or error.
 
+
+

ProcessKill

+
void  ProcessKill
(
  int  pid,
  int  force
); 
Don't be sucker! Describe your function in source code.
+

ProcessWait

+
int  ProcessWait
(
  int   pid,
  int   timeout,
  int * resultCode
); 

 
  Wait until process finished or timeout reached.
 
  WARNING#1: Function does NOT detect zoombi processes on Linux as long
             as resultCode parameter is NULL. Process become zoombi when
             finished its work, but parent didn't call waitpid to pop
             result code from it.
 
  pid        - pid of process to wait (IN).
 
  timeout    - maximum allowed wait time in miliseconds or -1 for inifinity (IN).
 
  resultCode - if process died before the timeout, this value returns
               its result code. Can be NULL if not needed. (OUT/OPT).
 
  RETURNS: 0 if process dead until timeout,
           1 if timeout reached,
          -1 if error.
 
  TIP #1: you can get resultCode only for child process.
 
+
+

ProcessGetParentPid

+
int  ProcessGetParentPid
(
); 

 
  Find PID of parent process.
 
  RETURNS: PID of parent of current running process,
           or -1 if error.
 
+
+

ProcessGetCurrentPid

+
int  ProcessGetCurrentPid
(
); 

 
  Find PID of own process.
 
  RETURNS: PID of current running process,
           or -1 if error.
 
+
+

ProcessGetModulePath

+
int  ProcessGetModulePath
(
  char * path,
  int    pathSize
); 

 
  Retrieve full, absolute path to current running binary
  (e.g. c:/dirligo/dirligo.exe)
 
  path     - buffer, where to store retrieved path (OUT).
  pathSize - size of path[] buffer in bytes (IN).
 
  RETURNS: 0 if OK.
 
+
+

ProcessExpandRelativePath

+
int  ProcessExpandRelativePath
(
  char *       normPath,
  int          pathSize,
  const char * relative
); 

 
  Transform relative (to where current binary stored) path into full path.
  E.g. it transforms "/somedir" into "<where current process live>/somedir".
  We use it becouse daemon (service) doesn't start in path, where current binary
  stored until we don't set current directory manually.
 
  WARNING: If passed path is already absolute it returns the same string.
 
  normPath - full, generated path (OUT).
  pathSize - size of path buffer in bytes (IN).
  relative - relative path postfix to add to base path (IN).
  quiet    - do not write logs if set to 1 (IN).
 
  RETURNS: 0 if OK.
 
+
+

ProcessDaemonize

+
int  ProcessDaemonize
(
); 

 
  Create duplicate of current running process and leave it alone in background,
  while parent procses (current running) is going to quit.
 
  WARNING#1: Linux only.
 
  Child process  : function exits with code 0
  Parent process : end of function never reached, process exits in the middle.
 
  RETURNS: 0 for child when success,
          -1 for parent if error.
 
+
+

ProcessGetBinaryPathByPid

+
int  ProcessGetBinaryPathByPid
(
  char * binaryPath,
  int    binaryPathSize,
  int    pid
); 

 
  Retrieve full, absolute path to binary related with running process.
 
  WARNING#1: Caller MUSTS have PROCESS_VM_READ right to target process
             on Windows OS. In other case function will fail with system code
             ACCESS_DENIED (5).
 
  Parameters:
 
  binaryPath     - buffer, where to store full path to binary file related with
                   given running process (e.g. c:\windows\explorer.exe) (OUT)
 
  binaryPathSize - size of binaryPath[] buffer in bytes (IN).
 
  pid            - pid of process to check (IN).
 
  RETURNS: 0 if OK.
 
+

ApiHandle.cpp

+ +

ProcessClose

+
int  ProcessClose
(
  ProcessHandle_t * proc
); 

 
  Close handle retrieved from ProcessCreate() before.
 
  WARNING: Function does NOT terminate process if still running.
 
  proc - handle to process retrieved from ProcessCreate() before (IN).
 
  RETURNS: 0 if success,
          -1 otherwise.
 
+
+

ProcessIsRunning

+
int  ProcessIsRunning
(
  ProcessHandle_t * proc
); 

 
  Check does given proces live.
 
  proc - process handle retrievied from ProcessCreate() function before (IN).
 
  RETURNS:  1 if process is running,
            0 if dead,
           -1 if error.
 
+
+

ProcessKill

+
int  ProcessKill
(
  ProcessHandle_t * proc
); 

 
  Unconditional terminate process.
 
  proc - process handle retrievied from ProcessCreate() function before (IN).
 
  RETURNS:  0 if success,
           -1 otherwise.
+
+

ProcessWait

+
int  ProcessWait
(
  ProcessHandle_t * proc,
  int               timeout,
  int *             resultCode
); 

 
  Wait until process finished or timeout reached.
 
  proc       - process handle retrievied from ProcessCreate() function before (IN).
 
  timeout    - maximum allowed wait time in miliseconds or -1 for inifinity (IN).
 
  resultCode - if process died before the timeout, this value returns
               its result code. Can be NULL if not needed. (OUT/OPT).
 
  RETURNS: 0 if process dead until timeout,
           1 if timeout reached,
          -1 if error.
 
  TIP #1: On Linux you can get resultCode only for child process.
 
+
+

ProcessWatch

+
int  ProcessWatch
(
  ProcessHandle_t *    proc,
  ProcessWatchCbProto  callback,
  int                  timeout,
  void *               ctx
); 

 
  Add process to monitored processes.
  After that process monitor will inform caller when process dead
  or specified timeout reached.
 
  TIP#1: Use ProcessCancelWatch() to remove process from monitor.
 
 
  proc     - process handle retrieved from ProcessCreate() before (IN).
 
  callback - callback function to notify user when process dead or
             timeout reached (IN).
 
  timeout  - maximum allowed life time for process in ms or -1 to infinite (IN).
 
  ctx      - caller specified context passed directly to callback (IN).
 
  RETURNS: 0 if OK.
 
+
+

ProcessCancelWatch

+
int  ProcessCancelWatch
(
  ProcessHandle_t * proc
); 

 
  Remove process from monitored processes (added by ProcessWatch() before).
 
  proc - process handle retrieved from ProcessCreate() before (IN).
 
  RETURNS: 0 if OK.
 
+
+

ProcessGetPidByHandle

+
int  ProcessGetPidByHandle
(
  ProcessHandle_t * proc
); 

 
  Return pid of given process.
 
  proc - process handle retrieved from ProcessCreate() before (IN).
 
  RETURNS: PID of process given as proc parameter,
           or -1 if error.
 
+

ApiPid.cpp

+ +

ProcessIsRunningById

+
int  ProcessIsRunningById
(
  int  pid
); 

 
  Check does given proces live.
 
  pid - pid of process to check (IN).
 
  RETURNS:  1 if process is running,
            0 if dead,
           -1 if error.
 
+
+

ProcessKillByPid

+
int  ProcessKillByPid
(
  int  pid
); 

 
  Unconditional terminate process.
 
  pid - pid of process, which we want to kill (IN)
 
  RETURNS:  0 if success,
           -1 otherwise.
 
+
+

ProcessWaitByPid

+
int  ProcessWaitByPid
(
  int   pid,
  int   timeout,
  int * resultCode
); 

 
  Wait until process finished or timeout reached.
 
  WARNING#1: Function does NOT detect zoombi processes on Linux as long
             as resultCode parameter is NULL. Process become zoombi when
             finished its work, but parent didn't call waitpid to pop
             result code from it.
 
  pid        - pid of process to wait (IN).
 
  timeout    - maximum allowed wait time in miliseconds or -1 for inifinity (IN).
 
  resultCode - if process died before the timeout, this value returns
               its result code. Can be NULL if not needed. (OUT/OPT).
 
  RETURNS: 0 if process dead until timeout,
           1 if timeout reached,
          -1 if error.
 
  TIP #1: you can get resultCode only for child process.
 
+
+

ProcessWatchByPid

+
int  ProcessWatchByPid
(
  int                  pid,
  ProcessWatchCbProto  callback,
  int                  timeout,
  void *               ctx
); 

 
  Add process to monitored processes.
  After that process monitor will inform caller when process dead
  or specified timeout reached.
 
  pid      - process ID to monitor (IN).
 
  callback - callback function to notify user when process dead or
             timeout reached (IN).
 
  timeout  - maximum allowed life time for process in ms or -1 to infinite (IN).
 
  ctx      - caller specified context passed directly to callback (IN).
 
  RETURNS: 0 if OK.
 
+
+

ProcessCancelWatchByPid

+
int  ProcessCancelWatchByPid
(
  int  pid
); 

 
  Remove process from monitored processes (added by ProcessWatchByPid() before).
 
  pid - process ID passed to ProcessWatchByPid() before (IN).
 
  RETURNS: 0 if OK.
 
+

Sleep.cpp

+ +

ProcessSleepUs

+
void  ProcessSleepUs
(
  int  us
); 

 
  Sleep current thread for given number of microseconds.
 
+
+

ProcessSleepMs

+
void  ProcessSleepMs
(
  int  ms
); 

 
  Sleep current thread for given number of miliseconds.
 
+
+

ProcessSleepSec

+
void  ProcessSleepSec
(
  double  seconds
); 

 
  Sleep current thread for given number of seconds.
 
+

Create.cpp

+ +

ProcessCreate

+
ProcessHandle_t * ProcessCreate
(
  const char *const  argv[],
  int                fdin,
  int                fdout,
  int                fderr,
  int                fdType,
  int                options
); 

 
  USE:
    const char *argv[5]
    argv[0] = "path_to_process"
    argv[1] = "parameter#1"
    argv[2] = "parameter#2"
    argv[3] = "parameter#3"
    argv[4] = NULL
 
  argv[]  - NULL terminated parameter list (IN).
  fdin    - FD to set for std input (IN/OPT).
  fdout   - FD to set for std output (IN/OPT).
  fderr   - FD to set for std error (IN/OPT).
 
  fdType  - type of specified fdin/fdout/fderr values. One of
            PROCESS_TYPE_XXX values defined in LibProcess.h. Defaulted
            to PROCESS_FDTYPE_CRT if skipped. (IN/OPT).
 
  options - combination of PROCESS_OPTIONS_XXX flags (IN/OPT).
 
  TIP #1: Set fdin/fdout/fderr to PROCESS_FD_PARENT to inherit handle from parent.
  TIP #2: Set fdin/fdout/fderr to PROCESS_FD_NULL to redirect handle to nul.
  TIP #3: Set fdType to PROCESS_FD_TYPE_WINAPI_HANDLE if you have raw windows handle.
 
  RETURNS: Pointer to ProcessHandle_t structure,
           or NULL if error.
 
+

LibReg component

Title:LibReg
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:High-level API to query and modify windows registry.
Description:-
Dependences:LibDebug
Used by: Tegenaria-core LibReg-example01-simple LibReg-example02-list-subkeys

Functions list:

+
Write
+RegSetDword
+RegSetString
+RegSetStringW
+RegSetStringList
+RegRemove
+
Query
+RegGetDword
+RegGetString
+RegGetStringList
+RegListSubkeys
+
Utils
+RegGetTypeName
+RegGetRootKeyName
+

Functions protos:

+

Write.cpp

+ +

RegSetDword

+
int  RegSetDword
(
  HKEY         rootKey,
  const char * path,
  const char * element,
  DWORD        value,
  DWORD        flags
); 

 
  Write DWORD value to registry. If key not exist yet, function creates new one.
 
  rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN).
  path    - key path (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN).
  element - element name (e.g. Win95TruncatedExtensions) (IN).
  value   - DWORD value to set (IN).
  flags   - combination of REG_OPTION_XXX flags (e.g. REG_OPTION_VOLATILE) (IN/OPT).
 
  RETURNS: 0 if OK,
           WINAPI error code otherwise.
 
+
+

RegSetString

+
int  RegSetString
(
  HKEY         rootKey,
  const char * path,
  const char * element,
  const char * value,
  DWORD        flags
); 

 
  Write string value to registry. If key not exist yet, function creates new one.
 
  rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN).
  path    - key path (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN).
  element - element name (e.g. Win95TruncatedExtensions) (IN).
  value   - ASCIZ string to set (IN).
  flags   - combination of REG_OPTION_XXX flags (e.g. REG_OPTION_VOLATILE) (IN/OPT).
 
  RETURNS: 0 if OK,
           WINAPI error code otherwise.
 
+
+

RegSetStringW

+
int  RegSetStringW
(
  HKEY            rootKey,
  const char *    path,
  const char *    element,
  const wchar_t * value,
  DWORD           flags
); 

 
  Write string value to registry. If key not exist yet, function creates new one.
 
  rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN).
  path    - key path (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN).
  element - element name (e.g. Win95TruncatedExtensions) (IN).
  value   - ASCIZ string to set (IN).
  flags   - combination of REG_OPTION_XXX flags (e.g. REG_OPTION_VOLATILE) (IN/OPT).
 
  RETURNS: 0 if OK,
           WINAPI error code otherwise.
 
+
+

RegSetStringList

+
int  RegSetStringList
(
  HKEY          rootKey,
  const char *  path,
  const char *  element,
  list<string>  values,
  DWORD         flags
); 

 
  Write string list to registry. If key not exist yet, function creates new one.
 
  rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN).
  path    - key path (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN).
  element - element name (e.g. Win95TruncatedExtensions) (IN).
  values  - list of strings to set (IN).
  flags   - combination of REG_OPTION_XXX flags (e.g. REG_OPTION_VOLATILE) (IN/OPT).
 
  RETURNS: 0 if OK,
           WINAPI error code otherwise.
 
+
+

RegRemove

+
int  RegRemove
(
  HKEY         rootKey,
  const char * path
); 

 
  Remove given key from registry.
 
  rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN).
  path    - key path to remove (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN).
 
  RETURNS: 0 if OK,
           WINAPI error code otherwise.
 
+

Query.cpp

+ +

RegGetDword

+
int  RegGetDword
(
  DWORD *      value,
  HKEY         rootKey,
  const char * path,
  const char * element
); 

 
  Read DWORD value from registry. Quered key should be REG_DWORD type.
 
  value   - output buffer, where to store readed value (OUT).
  rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN).
  path    - key path (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN).
  element - element name (e.g. Win95TruncatedExtensions) (IN).
 
  RETURNS: 0 if OK,
           WINAPI error code otherwise.
 
+
+

RegGetString

+
int  RegGetString
(
  char *       value,
  int          valueSize,
  HKEY         rootKey,
  const char * path,
  const char * element
); 

 
  Read ASCIZ string value from registry. Quered key should be REG_SZ type.
 
  value     - output buffer, where to store readed string (OUT).
  valueSize - size of value[] buffer in bytes (IN).
  rootKey   - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN).
  path      - key path (e.g SYSTEM\CurrentControlSet\Control\BiosInfo) (IN).
  element   - element name (e.g. SystemBiosDate) (IN).
 
  RETURNS: 0 if OK,
           WINAPI error code otherwise.
 
+
+

RegGetStringList

+
int  RegGetStringList
(
  list<string>  &values,
  HKEY          rootKey,
  const char *  path,
  const char *  element
); 

  Read ASCIZ string list from registry. Quered key should be REG_MULTI_SZ type.
 
  values    - string list where to store readed list (OUT).
  rootKey   - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN).
  path      - key path (e.g SYSTEM\CurrentControlSet\Control\ContentIndex) (IN).
  element   - element name (e.g. DllsToRegister) (IN).
 
  RETURNS: 0 if OK,
           WINAPI error code otherwise.
 
+
+

RegListSubkeys

+
int  RegListSubkeys
(
  vector<string>  &subkeys,
  HKEY            rootKey,
  const char *    path
); 

 
  List subkeys inside given key.
 
 
 
+

Utils.cpp

+ +

RegGetTypeName

+
const char * RegGetTypeName
(
  DWORD  type
); 

 
  Translate REG_XXX registry type into human readable string.
 
  type - one of REG_XXX (e.g. REG_DWORD) value (IN).
 
  RETURNS: human readable type's name
           or "UNKNOWN" if type not recognized.
 
+
+

RegGetRootKeyName

+
const char * RegGetRootKeyName
(
  HKEY  key
); 

 
  Retrieve human readable name for one of HKEY_XXX predefined root keys
  (e.g. HKEY_LOCAL_MACHINE).
 
  key - one of HKEY_XXX predefined keys (IN).
 
  RETURNS: Human readable key name
           or "UNKNOWN" if key not recognized.
 
+

LibRuntime component

Title:LibRuntime
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Manage runtime loaded code.
Description:-
Dependences:
Used by: Tegenaria-core

LibService component

Title:LibService
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:High level API to manage windows services.
Description:-
Dependences:LibDebug
Used by: Tegenaria-core

Functions list:

+
Service
+ServiceGetTypeCode
+ServiceGetStartTypeCode
+ServiceOpen
+ServiceAdd
+ServiceChange
+ServiceDelete
+ServiceGetStatus
+ServiceStart
+ServiceStop
+ServiceGetConfig
+ServiceExists
+ServiceWaitUntilRunning
+ServiceKill
+ServiceGetPid
+
Utils
+ExpandRelativePath
+SetPrivilege
+

Functions protos:

+

Service.cpp

+ +

ServiceGetTypeCode

+
int  ServiceGetTypeCode
(
  const char * serviceType
); 

 
  Convert service type string to int code.
  serviceType - string with start type (eg. "FILE_SYSTEM") (IN).
 
  RETURNS: Service type code or -1 if error.
 
+
+

ServiceGetStartTypeCode

+
int  ServiceGetStartTypeCode
(
  const char * startType
); 

 
  Convert service start type string to int code.
 
  serviceStartType - string with start type (IN).
 
  RETURNS: Start type code or -1 if error.
 
+
+

ServiceOpen

+
int  ServiceOpen
(
  SC_HANDLE *  serviceManager,
  SC_HANDLE *  service,
  const char * name,
  DWORD        rights,
  int          quiet
); 

 
  Open service manager and given service.
 
  WARNING! serviceManager and service MUST be closed by
  CloseServiceHandle() function.
 
  serviceManager - handle to service manager (IN/OUT).
                   If NULL, new handle opened, otherside
                   given handle used as manager.
 
  service        - handle to opened service with given name (OUT).
  name           - name of service to open (IN).
  rights         - requested access right for opened service (IN).
  quiet          - don't write error messages if set to 1 (IN).
 
  RETURNS: 0 if OK.
 
+
+

ServiceAdd

+
int  ServiceAdd
(
  const char * name,
  const char * displayName,
  int          type,
  int          startType,
  const char * path,
  bool         failIfExists,
  const char * obj,
  const char * pass,
  int          startAfter,
  int          quiet
); 

 
  Install and start new service.
 
  name         - service name (IN)
  displayName  - service "long" name. Can be NULL. (IN)
  type         - service type (IN).
  startType    - start type (IN).
  path         - path to executable file with service's code (IN).
  failIfExists - function will fail if service already exists (IN).
  obj          - target account name e.g. ".\\nx" (IN).
  pass         - account's password if obj parameter specified (IN).
  startAfter   - start service after add (default set to 1) (IN/OPT).
  quiet        - do not write error messages if 1 (IN/OPT).
 
  RETURNS: 0 if OK.
 
+
+

ServiceChange

+
int  ServiceChange
(
  const char * name,
  const char * displayName,
  int          type,
  int          startType,
  const char * path
); 

 
  Change parameters for existing service.
 
  name        - service name (IN)
  displayName - service "long" name. Can be NULL. (IN)
  type        - service type (IN).
  startType   - start type (IN).
  path        - path to executable file with service's code (IN).
 
  RETURNS: 0 if OK.
 
+
+

ServiceDelete

+
int  ServiceDelete
(
  const char * name,
  int          quiet
); 

 
  Stop and delete existing service.
 
  name  - service name to delete (IN).
  quiet - do not write error messages if 1 (IN/OPT).
 
  RETURNS: 0 if OK.
 
+
+

ServiceGetStatus

+
int  ServiceGetStatus
(
  SERVICE_STATUS * status,
  const char *     name,
  int              quiet
); 

 
  Retrieve status of given service.
 
  status - buffer, where to store retrieved status (OUT).
  name   - service name to query (IN).
  quiet  - don't write log on errors if 1 (IN).
 
  RETURNS: 0 if OK.
 
+
+

ServiceStart

+
int  ServiceStart
(
  const char *  name,
  int           argc,
  const char ** argv
); 

 
  Start service.
 
  name - name of service to start (IN).
  argc - number of elements in argv table (IN).
  argv - table with input arguments for service binary (IN).
 
  RETURNS: 0 if OK.
 
+
+

ServiceStop

+
int  ServiceStop
(
  const char * name,
  int          timeout
); 

 
  Send stop signal to given service and optionally
  wait until service reach stopped.
 
  name    - name of service to stop (IN).
  timeout - maximum time in ms to wait. If service not stopped before
            we kill it manually (IN/OPT).
 
  RETURNS: 0 if OK.
 
+
+

ServiceGetConfig

+
int  ServiceGetConfig
(
  QUERY_SERVICE_CONFIG ** config,
  const char *            name,
  int                     quiet
); 

 
  Retrieve config of given service.
 
  WARNING: Output config buffer MUST be free by caller.
 
  config     - pointer to new allocated config struct (OUT).
  name       - service name to query (IN).
  quiet      - don't write log on errors if 1 (IN).
 
  RETURNS: 0 if OK.
 
+
+

ServiceExists

+
int  ServiceExists
(
  const char * name
); 

 
  Check does service already exists.
 
  name - short name of service (IN)
 
  RETURNS: 1 if exists,
           0 if not exists or error.
 
+
+

ServiceWaitUntilRunning

+
int  ServiceWaitUntilRunning
(
  SC_HANDLE  service,
  DWORD      initState,
  DWORD      targetState,
  int        timeout,
  int        quiet
); 

 
  Wait up to <timeout> ms until given service change state from <initState>
  to <targetState> state.
  We use it to wait until start/stop operations finished.
 
  WARNING: Input handle MUST have SERVICE_QUERY_STATUS right.
 
  service     - handle to opened service (IN).
  targetState - expected state, when reached we quit with success (IN).
  timeout     - maximum time limit in ms. If missed default one used. (IN/OPT).
  quiet       - do not write errors on stderr if 1 (IN/OPT).
 
  RETURNS: 0 if service is running on function's exit.
 
+
+

ServiceKill

+
int  ServiceKill
(
  SC_HANDLE  service,
  int        quiet
); 

 
  Retrieve PID for opened process and terminate it.
 
  WARNING: Handle MUSTS have SERVICE_QUERY_STATE right.
  WARNING: Caller user MUSTS have SE_DEBUG right to open not-own processes.
 
  service - handle to opened service (IN).
  quiet   - do not write errors on stderr if 1 (IN/OPT).
 
  RETURNS: 0 if OK.
 
+
+

ServiceGetPid

+
int  ServiceGetPid
(
  const char * name
); 

 
  Retrieve PID of service process.
 
  name - service name (IN).
 
  RETURNS: PID of service process,
           or -1 if error.
 
+

Utils.cpp

+ +

ExpandRelativePath

+
int  ExpandRelativePath
(
  char *       normPath,
  int          pathSize,
  const char * relative,
  int          quiet
); 

  Transform relative (to where dlsetup stored) path into full path.
  E.g. it transforms "/somedir" into "<where is dlsetup.exe>/somedir".
 
  WARNING: If passed path is already absolute it returns the same string.
 
  normPath - full, generated path (OUT).
  pathSize - size of path buffer in bytes (IN).
  relative - relative path postfix to add to base path (IN).
  quiet    - do not write logs if set to 1 (IN).
 
  RETURNS: 0 if OK.
 
+
+

SetPrivilege

+
int  SetPrivilege
(
  const char * privName,
  int          enabled
); 

 
  Enable or disable privilege for current running process
 
  privName - privilege name (IN)
  enabled  - 1 for enabling, 0 for disabling (IN)
 
  RETURNS: 0 if OK.
 
+

LibSSMap component

Title:LibSSMap
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Wrapper for map<string, string> class to read/write content from/to external file easly.
Description:-
Dependences:LibDebug
Used by: Tegenaria-core LibCGI LibSSMap-example01-simple LibSSMap-example02-serialize

Functions list:

+
SSMap
+SSMap::saveToFile
+SSMap::saveToFileEx
+SSMap::loadFromFile
+SSMap::saveToString
+SSMap::loadFromString
+SSMap::set
+SSMap::setInt
+SSMap::setPtr
+SSMap::get
+SSMap::get
+SSMap::safeGet
+SSMap::safeGet
+SSMap::getInt
+SSMap::getInt
+SSMap::getPtr
+SSMap::isset
+SSMap::isset
+SSMap::setStringList
+SSMap::getStringList
+

Functions protos:

+

SSMap.cpp

+ +

SSMap::saveToFile

+
int  SSMap::saveToFile
(
  const string  &fname
); 

 
  Save SSMap to file.
 
  fname - destination filename, where to dump map (IN).
 
  RETURNS: 0 if OK.
 
+
+

SSMap::saveToFileEx

+
int  SSMap::saveToFileEx
(
  const string  &fname,
  int           flags
); 

 
  Save SSMap to file.
 
  fname - destination filename, where to dump map (IN).
  flags - extra flags to format output file, see SSMap.h SSMAP_FLAGS_XXX defines (IN).
 
  RETURNS: 0 if OK.
 
+
+

SSMap::loadFromFile

+
int  SSMap::loadFromFile
(
  const string  &fname
); 

 
  Load SSMap from file.
 
  fname - source filename, where to load map from (IN).
 
  RETURNS: 0 if OK.
 
+
+

SSMap::saveToString

+
void  SSMap::saveToString
(
  string  &data
); 

 
  Serialize SSMap object into one continuos string.
 
  data - string, where to write serialized data (OUT).
 
+
+

SSMap::loadFromString

+
int  SSMap::loadFromString
(
  char * data
); 

 
  Load SSMap object from one continous string created by saveToString()
  method before.
 
  WARNING: Function destroys input data[] string.
 
  data - source, single continous string created by saveToString() before (IN).
 
  RETURNS: 0 if OK.
 
+
+

SSMap::set

+
void  SSMap::set
(
  const char * lvalue,
  const char * rvalue
); 

 
  Set lvalue key to rvalue string.
 
  lvalue - key, where to assign data (IN).
  rvalue - string value to assign (IN).
 
  TIP#1: Use getXXX() methods to get back set value.
 
+
+

SSMap::setInt

+
void  SSMap::setInt
(
  const char * lvalue,
  int          rvalue
); 

  WARNING: rvalue will be converted to string internally.
 
  TIP#1: Use getXXX() methods to get back set value.
 
+
+

SSMap::setPtr

+
void  SSMap::setPtr
(
  const char * lvalue,
  const void * rvalue
); 

 
  Set lvalue key to rvalue pointer.
 
  WARNING: rvalue will be converted to string internally.
 
  lvalue - key, where to assign data (IN).
  rvalue - pointer value to assign (IN).
 
  TIP#1: Use getXXX() methods to get back set value.
 
+
+

SSMap::get

+
const char * SSMap::get
(
  const char * lvalue
); 

 
  Get value assigned to lvalue key as string.
 
  rvalue - key, where to search data (IN).
 
  RETURNS: String value assigned to key lvalue or
           NULL if key does not exist.
 
+
+

SSMap::get

+
const char * SSMap::get
(
  const string  &lvalue
); 

 
  Get value assigned to lvalue key as string.
 
  rvalue - key, where to search data (IN).
 
  RETURNS: String value assigned to key lvalue or
           NULL if key does not exist.
 
+
+

SSMap::safeGet

+
const char * SSMap::safeGet
(
  const char * lvalue
); 

 
  Get value assigned to lvalue key as string with not-null warranty.
 
  rvalue - key, where to search data (IN).
 
  RETURNS: String value assigned to key lvalue or
           empty string if key does not exist.
 
+
+

SSMap::safeGet

+
const char * SSMap::safeGet
(
  const string  &lvalue
); 

 
  Get value assigned to lvalue key as string with not-null warranty.
 
  rvalue - key, where to search data (IN).
 
  RETURNS: String value assigned to key lvalue or
           empty string if key does not exist.
 
+
+

SSMap::getInt

+
int  SSMap::getInt
(
  const char * lvalue
); 

 
  Get value assigned to lvalue key and convert it to integer.
 
  rvalue - key, where to search data (IN).
 
  RETURNS: Integer value assigned to key lvalue or
           0 if key does not exist.
 
+
+

SSMap::getInt

+
int  SSMap::getInt
(
  const string  &lvalue
); 

 
  Get value assigned to lvalue key and convert it to integer.
 
  rvalue - key, where to search data (IN).
 
  RETURNS: Integer value assigned to key lvalue or
           0 if key does not exist.
 
+
+

SSMap::getPtr

+
void * SSMap::getPtr
(
  const char * lvalue
); 

 
  Get value assigned to lvalue key and convert it to hex pointer format.
 
  rvalue - key, where to search data (IN).
 
  RETURNS: Pointer value assigned to key lvalue or
           NULL if key does not exist.
 
+
+

SSMap::isset

+
int  SSMap::isset
(
  const char * lvalue
); 

 
  Check is lvalue key exist in map.
 
  rvalue - key, where to search data (IN).
 
  RETURNS: 1 if key exist,
           0 otherwise.
 
+
+

SSMap::isset

+
int  SSMap::isset
(
  const string  &lvalue
); 

 
  Check is lvalue key exist in map.
 
  rvalue - key, where to search data (IN).
 
  RETURNS: 1 if key exist,
           0 otherwise.
 
+
+

SSMap::setStringList

+
void  SSMap::setStringList
(
  const char *    lvalue,
  vector<string>  &stringList
); 

 
  Assign string list to given lvalue.
 
  lvalue     - key, where to assign data (IN).
  stringList - string's list to assign (IN).
 
+
+

SSMap::getStringList

+
void  SSMap::getStringList
(
  vector<string>  &stringList,
  const char *    lvalue
); 

 
  Get value assigned to lvalue key and convert it to string's list.
  WARNING: Stored value must be in token1;token2;token3... format.
 
  stringList - stl vector, where to store readed list (OUT).
  lvalue     - key, where to search data (IN).
 
  RETURNS: Pointer value assigned to key lvalue or
           NULL if key does not exist.
 
+

LibStr component

Title:LibStr
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Process strings and binary buffers.
Description:-
Dependences:LibDebug LibError libstrptime
Used by: Tegenaria-core qcbuild LibCGI LibSftp LibSftp-example01-sftp-client LibArgs LibProcess LibSystem LibStr-example01-binary-packet LibStr-example02-verify LibStr-example03-date LibProcess-example02-wrapper LibLock-example01-mutex LibLock-example02-semaphore

Functions list:

+
Parser
+StrCountChar
+StrCountDigits
+StrCountAlpha
+StrPopInt
+StrPopDouble
+StrMatchChar
+StrPopChar
+StrPopAlphaWord
+StrPopAlphaWordBound
+StrPopInt
+StrPopChar
+StrPopDouble
+StrMatchChar
+StrPopAlphaWord
+StrPopAlphaWordBound
+StrSkipWhites
+StrMatch
+
Str
+StringSet
+StringAdd
+StringReset
+StrReplace
+StrReplace
+StrRemoveChar
+StrRemoveChar
+StrRemoveString
+StrRemoveCaseString
+StrRemoveDeclensionPostfixPL
+StrReplaceString
+StrMaskPhone
+StrMaskEmail
+StrEncodeToHtml
+StrNormalizeWhiteSpaces
+StrRemoveWhiteSpaces
+StrFormatMoney
+
BinaryString
+StrPopRaw
+StrPopQword
+StrPopDword
+StrPopByte
+StrPushRaw
+StrPushQword
+StrPushDword
+StrPushByte
+StrPushString
+
Tokenize
+StrIsDelim
+StrTokenize
+StrTokenize
+StrTokenize
+StrTokenize
+StrTokenize
+StrStrTokenize
+StrStrTokenize
+StrSplit
+
Find
+stristr
+StrFindIWord
+StrFindWord
+StrGetTextBeetwen
+strstrex
+strchrex
+StrFindCharMulti
+
Local
+GetUtf8
+stristr_utf8
+StrFindIWord_utf8
+StrRemovePlChars_utf8
+StrCyr2Lat
+StrConvertCodePage
+StrRemovePlChars
+
Binary
+StrPopRaw
+StrPopQword
+StrPopDword
+StrPopByte
+StrPopString
+
Convert
+StringToInt
+StringToInt
+StringToDouble
+StringFromInt
+StringFromDouble
+
StringList
+StrListSplit
+StrListInit
+StrListAdd
+StrListRemove
+StrListExists
+
Capitalize
+StrCapitalize
+StrCapitalize
+StrLowerize
+StrLowerize
+
Verify
+StrEmailVerify
+StrLoginVerify
+StrPassVerify
+StrPassStrength
+
Date
+StrDateGetToday
+StrDateGetTodayUTC0
+StrDateAddDays
+StrDateAddDaysUTC0
+
SourceCode
+StrMinifyCode
+StrRemoveSingleLineComments
+StrRemoveMultiLineComments
+
Random
+RandomIntString
+RandomString
+

Functions protos:

+

Parser.cpp

+ +

StrCountChar

+
int  StrCountChar
(
  const char * s,
  char         c
); 

 
  Count how many time given char <c> exist in string.
 
  s - input string to scan (IN).
  c - character to be counted (IN).
 
  RETURNS: How many times char <c> exist in string <s>
 
+
+

StrCountDigits

+
int  StrCountDigits
(
  const char * s
); 

 
  Count how many digit character (0-9) exists in string.
 
  s - input string to scan (IN).
 
  RETURNS: How many digits exist in string <s>
 
+
+

StrCountAlpha

+
int  StrCountAlpha
(
  const char * s
); 

 
  Count how many alpha (a-z and A-Z) characters exist in string.
 
  s - input string to scan (IN).
 
  RETURNS: How many alpha characters exist in string <s>
 
+
+

StrPopInt

+
int  StrPopInt
(
  const char ** it
); 

 
  Pop integer (%d) value from string.
 
  it - pointer source string (IN/OUT).
 
  RETURNS: Popped integer.
 
+
+

StrPopDouble

+
double  StrPopDouble
(
  const char ** it
); 

 
  Pop double (%lf) value from string.
 
  it - pointer source string (IN/OUT).
 
  RETURNS: Popped integer.
 
+
+

StrMatchChar

+
int  StrMatchChar
(
  const char ** it,
  char          expected
); 

 
  Peek first character in string and pop it if it's match with
  expected character.
 
  NOTE #1: Character is popped only if matches with <expected> parameter.
 
  NOTE #2: Input string <*it> is NOT changed if first character NOT matches
           to <expected> parameter.
 
  EXAMPLE 1:
  ----------
 
    Before call:
      *it      = "jozek"
      expected = 'j'
 
    After call:
      *it      = "ozek"
      expected = 'j'
 
    RETURNS: 0
 
  EXAMPLE2:
  ---------
 
    Before call:
      *it      = "jozek"
      expected = 'x'
 
    After call:
      *it      = "jozek"
      expected = 'x'
 
    RETURNS: -1
 
  it       - pointer source string (IN/OUT).
  expected - character to match (IN).
 
  RETURNS: 0 if character matched and popped
          -1 otherwise.
 
+
+

StrPopChar

+
char  StrPopChar
(
  const char ** it
); 

 
  Pop first character from string.
 
  it - pointer input string (IN/OUT).
 
  RETURNS: Popped character.
 
+
+

StrPopAlphaWord

+
void  StrPopAlphaWord
(
  const char ** it,
  char *        word,
  int           wordSize
); 

 
  Pop alpha (a-z and A-Z) only word from string.
  Functin stops reading on first non alpha character.
 
  it       - pointer to input string (IN/OUT).
  word     - buffer where to store readed word (OUT).
  wordSize - size of word[] buffer in bytes (IN).
 
+
+

StrPopAlphaWordBound

+
void  StrPopAlphaWordBound
(
  const char ** it,
  char *        word,
  int           wordSize
); 

 
  Pop bound/alpha (a-z and A-Z and [] and $) only word from string.
  Functin stops reading on first characer other than alpha, [] or $.
 
  it       - pointer to input string (IN/OUT).
  word     - buffer where to store readed word (OUT).
  wordSize - size of word[] buffer in bytes (IN).
 
+
+

StrPopInt

+
int  StrPopInt
(
  char ** it
); 

 
  Pop integer (%d) value from string.
 
  it - pointer source string (IN/OUT).
 
  RETURNS: Popped integer.
 
+
+

StrPopChar

+
char  StrPopChar
(
  char ** it
); 

 
  Pop first character from string.
 
  it - pointer input string (IN/OUT).
 
  RETURNS: Popped character.
 
+
+

StrPopDouble

+
double  StrPopDouble
(
  char ** it
); 

 
  Pop double (%lf) value from string.
 
  it - pointer source string (IN/OUT).
 
  RETURNS: Popped integer.
 
+
+

StrMatchChar

+
int  StrMatchChar
(
  char ** it,
  char    expected
); 

 
  Peek first character in string and pop it if it's match with
  expected character.
 
  NOTE #1: Character is popped only if matches with <expected> parameter.
 
  NOTE #2: Input string <*it> is NOT changed if first character NOT matches
           to <expected> parameter.
 
  EXAMPLE 1:
  ----------
 
    Before call:            After call:
      *it      = "jozek"      *it      = "ozek"
      expected = 'j'          expected = 'j'
 
    Return value : 0
 
  EXAMPLE2:
  ---------
 
    Before call:            After call:
      *it      = "jozek"      *it      = "jozek"
      expected = 'x'          expected = 'x'
 
    Return value: -1
 
  it       - pointer source string (IN/OUT).
  expected - character to match (IN).
 
  RETURNS: 0 if character matched and popped
          -1 otherwise.
 
+
+

StrPopAlphaWord

+
void  StrPopAlphaWord
(
  char ** it,
  char *  word,
  int     wordSize
); 

 
  Pop alpha (a-z and A-Z) only word from string.
  Functin stops reading on first non alpha character.
 
  it       - pointer to input string (IN/OUT).
  word     - buffer where to store readed word (OUT).
  wordSize - size of word[] buffer in bytes (IN).
 
+
+

StrPopAlphaWordBound

+
void  StrPopAlphaWordBound
(
  char ** it,
  char *  word,
  int     wordSize
); 

 
  Pop bound/alpha (a-z and A-Z and [] and $) only word from string.
  Functin stops reading on first characer other than alpha, [] or $.
 
  it       - pointer to input string (IN/OUT).
  word     - buffer where to store readed word (OUT).
  wordSize - size of word[] buffer in bytes (IN).
 
+
+

StrSkipWhites

+
const char * StrSkipWhites
(
  const char * s
); 

 
  Skip whites characters.
 
  s - input string (IN).
 
  RETURNS: Pointer to first non-white character in string.
 
+
+

StrMatch

+
const char * StrMatch
(
  const char ** it,
  const char *  pattern
); 

 
  Peek begin of string and pop it if matches with input <pattern>.
 
  Example 1:
  ----------
 
   Before call:             After call:
     *it     = "dirligo"      *it     = "ligo"
     pattern = "dir"          pattern = "dir"
 
 
   Return value: "ligo"
 
  Example 2:
  ----------
 
   Before call:             After call:
     *it     = "dirligo"      *it     = "dirligo"
     pattern = "xxx"          pattern = "xxx"
 
   Return value: NULL
 
  it      - pointer to input string (IN/OUT).
  pattern - pattern word to be matched (IN).
 
  RETURNS: Pointer to begin of patter found in string
           or NULL if pattern not found.
 
+

Str.cpp

+ +

StringSet

+
void  StringSet
(
  char *       &destination,
  const char * source
); 
Don't be sucker! Describe your function in source code.
+

StringAdd

+
void  StringAdd
(
  char *       &destination,
  const char * source1,
  const char * source2,
  const char * source3,
  const char * source4
); 
Don't be sucker! Describe your function in source code.
+

StringReset

+
void  StringReset
(
  char * &destination
); 
Don't be sucker! Describe your function in source code.
+

StrReplace

+
void  StrReplace
(
  char * str,
  char   oldChar,
  char   newChar
); 

 
  Replace all occurences of character <oldChar> by <newChar>.
 
  str     - string to modify (IN/OUT).
  oldChar - character to be replaced (IN).
  newChar - character to use for replacement (IN).
 
  RETURNS: Pointer to str[] parameter,
           or NULL if error.
 
+
+

StrReplace

+
void  StrReplace
(
  string  &str,
  char    oldChar,
  char    newChar
); 

 
  Replace all occurences of character <oldChar> by <newChar>.
 
  str     - string to modify (IN/OUT).
  oldChar - character to be replaced (IN).
  newChar - character to use for replacement (IN).
 
  RETURNS: Pointer to str[] parameter,
           or NULL if error.
 
+
+

StrRemoveChar

+
char * StrRemoveChar
(
  char * str,
  char   c
); 

 
  Remove all occurences of character <c> from string <str>.
 
  str - string to modify (IN/OUT).
  c   - character to be removed (IN).
 
  RETURNS: Pointer to str[] parameter,
           or NULL if error.
 
+
+

StrRemoveChar

+
string  StrRemoveChar
(
  const string  &str,
  char          c
); 

 
  Remove all occurences of character <c> from string <str>.
 
  str - string to modify (IN).
  c   - character to be removed (IN).
 
  RETURNS: new string with removed characters.
 
+
+

StrRemoveString

+
char * StrRemoveString
(
  char *       buf,
  const char * pattern
); 

 
  Remove all occurences of given <pattern> from string e.g.
 
    Before call:
      buf[]     = "hello world hello!"
      pattern[] = "hello"
 
    After call:
      buf[]     = "world!"
      pattern[] = "hello"
 
  buf     - buffer to change (IN/OUT).
  pattern - pattern to remove (IN).
 
  RETURNS: Pointer to buf[] parameter,
           or NULL if error.
 
+
+

StrRemoveCaseString

+
char * StrRemoveCaseString
(
  char *       buf,
  const char * pattern
); 

 
  Remove all occurences of given <pattern> without case sensity
  from string e.g.
 
    Before call:
      buf[]     = "HeLLo world hello!"
      pattern[] = "hello"
 
    After call:
      buf[]     = "world!"
      pattern[] = "hello"
 
  buf     - buffer to change (IN/OUT).
  pattern - pattern to remove (IN).
 
  RETURNS: Pointer to buf[] parameter,
           or NULL if error.
 
+
+

StrRemoveDeclensionPostfixPL

+
string  StrRemoveDeclensionPostfixPL
(
  string  word
); 

 
  Remove declination postfix if any.
 
  WARNING: Function need pure ASCII text on input (i.e. with already
           tarnslated polish chars to coresponding ASCII eg. ¥ to a).
 
  Example:
    Input : domy
    Output: dom
 
    Input : samochodow
    Output: samochod
 
+
+

StrReplaceString

+
string & StrReplaceString
(
  string       &s,
  const char * oldStr,
  const char * newStr
); 

 
  Replace all <oldStr> occurences by <newStr> one.
 
  s      - string to modify (IN/OUT).
  oldStr - pattern to be replaced (IN).
  newStr - new pattern for replacement (IN).
 
  RETURNS: Refference to input/output <s> parmatere.
 
+
+

StrMaskPhone

+
int  StrMaskPhone
(
  char * p
); 

 
  Mask last digits in phone number by 'x' characters e.g.
 
  Before call : 123-456-789
  After call  : 123-456-xxx
 
  p - buffer where telefone number to change (IN/OUT).
 
  RETURNS: 0 if OK,
           -1 otherwise.
 
+
+

StrMaskEmail

+
int  StrMaskEmail
(
  char * p
); 

 
  Mask email address e.g.
 
  Before call : sucker@dirligo.com
  After call  : xxxxxx@xxxxxxx.xxx
 
  p - buffer where mail to mask is stored (IN/OUT).
 
  RETURNS: 0 if OK,
          -1 otherwise.
 
+
+

StrEncodeToHtml

+
string  StrEncodeToHtml
(
  const string  &str,
  unsigned int  flags
); 

 
  Encode special chars e.g. '<' into HTML data.
 
  str   - text to encode (IN).
  flags - combination of STR_HTML_XXX flags defines in Str.h (IN/OPT).
 
  RETURNS: Text encoded to html.
 
+
+

StrNormalizeWhiteSpaces

+
string  StrNormalizeWhiteSpaces
(
  string  s
); 
Don't be sucker! Describe your function in source code.
+

StrRemoveWhiteSpaces

+
string  StrRemoveWhiteSpaces
(
  const string  &str
); 

 
  Remove all whitespaces from string.
 
+
+

StrFormatMoney

+
int  StrFormatMoney
(
  char *       money,
  int          moneySize,
  const char * value
); 

 
  Format money string by adding extra space per every 3 digits.
  For example it converts 5000000 into 5 000 000.
 
  money     - output buffer, where to put formatted string (OUT).
  moneySize - size of money[] buffer in bytes (IN).
  value     - input value string to format (IN).
 
  RETURNS: 0 if OK.
 
+

BinaryString.cpp

+ +

StrPopRaw

+
int  StrPopRaw
(
  void *  raw,
  int     rawSize,
  string  &buf
); 

 
  Pop <rawSize> bytes from begin of string.
 
  Buffer before: xx xx xx xx xx xx ... yy yy yy yy
  Buffer after : ... yy yy yy yy
 
  raw     - buffer, where to write popped data (OUT).
  rawSize - how much bytes to pop (IN).
  string  - buffer from pop data (IN/OUT).
 
  RETURNS: 0 if all bytes popped,
           -1 if error.
 
+
+

StrPopQword

+
int  StrPopQword
(
  uint64_t * value,
  string     &buf,
  int        flags
); 

 
  Pop QWORD from begin of string.
 
  Buffer before: 01 02 03 04 05 06 07 08 xx xx xx xx
  Buffer after : xx xx xx xx
 
  value   - buffer, where to write popped QWORD (OUT).
  string  - buffer from pop data (IN/OUT).
  flags   - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN).
 
  RETURNS: 0 if all 8 bytes popped,
           -1 if error.
 
+
+

StrPopDword

+
int  StrPopDword
(
  uint32_t * value,
  string     &buf,
  int        flags
); 

 
  Pop DWORD from begin of string.
 
  Buffer before: 01 02 03 04 xx xx xx xx
  Buffer after : xx xx xx xx
 
  value   - buffer, where to write popped DWORD (OUT).
  string  - buffer from pop data (IN/OUT).
  flags   - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN).
 
  RETURNS: 0 if all 4 bytes popped,
           -1 if error.
 
+
+

StrPopByte

+
int  StrPopByte
(
  uint8_t * value,
  string    &buf
); 

 
  Pop one byte from begin of string.
 
  Buffer before: 01 xx xx xx xx
  Buffer after : xx xx xx xx
 
  value   - buffer, where to write popped byte (OUT).
  string  - buffer from pop data (IN/OUT).
 
  RETURNS: 0 if byte popped,
           -1 if error.
 
+
+

StrPushRaw

+
int  StrPushRaw
(
  string       &buf,
  const void * raw,
  int          rawSize
); 

 
  Append <rawSize> buffer to the end of string.
 
  Buffer before: xx xx xx xx
  Buffer after : xx xx xx xx yy yy yy yy yy ...
 
  buf     - buffer, where to append data (IN/OUT).
  rawSize - how much bytes to append (IN).
  raw     - source buffer with data to append (IN).
 
  RETURNS: 0 if all data appended,
           -1 if error.
 
+
+

StrPushQword

+
int  StrPushQword
(
  string    &buf,
  uint64_t  value,
  int       flags
); 

 
  Append QWORD value to the end of string.
 
  Buffer before: xx xx xx xx
  Buffer after : xx xx xx xx 01 02 03 04 05 06 07 08
 
  buf   - buffer, where to append data (IN/OUT).
  value - QWORD value to append (IN).
  flags - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN).
 
  RETURNS: 0 if all data appended,
           -1 if error.
 
+
+

StrPushDword

+
int  StrPushDword
(
  string    &buf,
  uint32_t  value,
  int       flags
); 

 
  Append DWORD value to the end of string.
 
  Buffer before: xx xx xx xx
  Buffer after : xx xx xx xx 01 02 03 04
 
  buf   - buffer, where to append data (IN/OUT).
  value - DWORD value to append (IN).
  flags - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN).
 
  RETURNS: 0 if all data appended,
           -1 if error.
 
+
+

StrPushByte

+
int  StrPushByte
(
  string   &buf,
  uint8_t  value
); 

 
  Append one byte to the end of string.
 
  Buffer before: xx xx xx xx
  Buffer after : xx xx xx xx 01
 
  buf   - buffer, where to append data (IN/OUT).
  value - byte to append (IN).
 
  RETURNS: 0 if byte appended,
           -1 if error.
 
+
+

StrPushString

+
int  StrPushString
(
  string       &buf,
  const char * str
); 

 
  Append string to the end of string buffer.
 
  Buffer before: xx xx xx xx
  Buffer after : xx xx xx xx ll ll ll ll ss ss ss ss ss ... 00
 
  WHERE:
 
  ll - little endian size of string including zero terminator
  ss - string data
  00 - zero terminator
 
  buf - buffer, where to append data (IN/OUT).
  str - C-style string to append (IN).
 
  RETURNS: 0 if byte appended,
           -1 if error.
 
+

Tokenize.cpp

+ +

StrIsDelim

+
inline char  StrIsDelim
(
  char *       p,
  const char * delims
); 

 
  Peek first character from input <p> string and check is it one of
  allowed delimer character from <delims> set.
 
  p      - input string (IN).
  delims - list of allowed delims e.g. "\t\n " (IN)
 
  RETURNS: Delim character if detected or
           0 if delim character NOT found.
 
+
+

StrTokenize

+
void  StrTokenize
(
  vector<string>  &tokens,
  const string    &inputStr,
  const char *    delims
); 

 
  Tokenize string.
 
  tokens   - std::vector containing generated tokens (OUT).
  inputStr - string to tokenize (IN).
  delims   - list of delim characters e.g. "\t " (IN).
 
+
+

StrTokenize

+
void  StrTokenize
(
  set<string>   &tokens,
  const string  &inputStr,
  const char *  delims
); 

 
  Tokenize string.
 
  tokens   - std::set containing generated tokens (OUT).
  inputStr - string to tokenize (IN).
  delims   - list of delim characters e.g. "\t " (IN).
 
+
+

StrTokenize

+
void  StrTokenize
(
  vector<char *>  &tokens,
  char *          inputStr,
  const char *    delims,
  const char *    delimsExtra
); 

 
  Tokenize string.
 
  TIP #1: Set <delimsExtra> to '"' if your string containing quoted "words",
          which should NOT be tokenized.
 
  tokens      - vector containing generated tokens (OUT).
  inputStr    - string to tokenize (IN).
  delims      - list of delim characters e.g. "\t " (IN).
  delimsExtra - quatation characters to mark words should NOT be processed
                by tokenizer (IN).
 
+
+

StrTokenize

+
void  StrTokenize
(
  vector<string>  &tokens,
  const string    &inputStr,
  const char *    delims,
  const char *    delimsExtra
); 

 
  Tokenize string.
 
  TIP #1: Set <delimsExtra> to '"' if your string containing quoted "words",
          which should NOT be tokenized.
 
  tokens      - vector containing generated tokens (OUT).
  inputStr    - string to tokenize (IN).
  delims      - list of delim characters e.g. "\t " (IN).
  delimsExtra - quatation characters to mark words should NOT be processed
                by tokenizer (IN).
 
+
+

StrTokenize

+
void  StrTokenize
(
  set<string>   &tokens,
  const string  &inputStr,
  const char *  delims,
  const char *  delimsExtra
); 

 
  Tokenize string.
 
  TIP #1: Set <delimsExtra> to '"' if your string containing quoted "words",
          which should NOT be tokenized.
 
  tokens      - std:set containing generated tokens (OUT).
  inputStr    - string to tokenize (IN).
  delims      - list of delim characters e.g. "\t " (IN).
  delimsExtra - quatation characters to mark words should NOT be processed
                by tokenizer (IN).
 
+
+

StrStrTokenize

+
void  StrStrTokenize
(
  vector<char *>  &tokens,
  char *          str,
  const char *    delim
); 

 
  Tokenize string with multiple characters delimiter.
 
  TIP #1: Set <delimsExtra> to '"' if your string containing quoted "words",
          which should NOT be tokenized.
 
  tokens      - vector containing generated tokens (OUT).
  inputStr    - string to tokenize (IN).
  delims      - multiple character delimiter e.g. "<end>" (IN).
  delimsExtra - quatation characters to mark words should NOT be processed
                by tokenizer (IN).
 
+
+

StrStrTokenize

+
void  StrStrTokenize
(
  vector<string>  &tokens,
  const string    &inputStr,
  const char *    delim
); 

 
  Tokenize string with multiple characters delimiter.
 
  TIP #1: Set <delimsExtra> to '"' if your string containing quoted "words",
          which should NOT be tokenized.
 
  tokens      - vector containing generated tokens (OUT).
  inputStr    - string to tokenize (IN).
  delims      - multiple character delimiter e.g. "<end>" (IN).
  delimsExtra - quatation characters to mark words should NOT be processed
                by tokenizer (IN).
 
+
+

StrSplit

+
int  StrSplit
(
  char *  token,
  char ** left,
  char ** right,
  char    splitChar
); 

 
  Split input string into <left> and <right> parts separated by <spliChar>.
  Eg. it can splits "variable=value" string into "variable" and "value" tokens.
 
  token - input string to split. Warning input token will be destroyed (IN/OUT).
  left  - pointer to left token (OUT).
  right - pointer to right token (first character after splitChar) (OUT).
 
  RETURNS: 0 if <splitChar> found and string are splitteng sucessfuly,
           -1 otherwise.
 
+

Find.cpp

+ +

stristr

+
char * stristr
(
  const char * arg1,
  const char * arg2
); 
Don't be sucker! Describe your function in source code.
+

StrFindIWord

+
char * StrFindIWord
(
  const char * arg1,
  const char * arg2
); 
Don't be sucker! Describe your function in source code.
+

StrFindWord

+
char * StrFindWord
(
  const char * arg1,
  const char * arg2
); 
Don't be sucker! Describe your function in source code.
+

StrGetTextBeetwen

+
string  StrGetTextBeetwen
(
  const char * buf,
  const char * startStr,
  const char * endStr
); 
Don't be sucker! Describe your function in source code.
+

strstrex

+
char * strstrex
(
  const char * s,
  const char * pattern
); 
Don't be sucker! Describe your function in source code.
+

strchrex

+
char * strchrex
(
  const char * s,
  char         pattern
); 
Don't be sucker! Describe your function in source code.
+

StrFindCharMulti

+
const char * StrFindCharMulti
(
  const char * p,
  const char * chars,
  int          zeroByteMatch
); 

 
  Multi character version of strchr.
 
  p             - pointer to begin of buffer string (IN).
  chars         - string containing list of characters to find (IN).
  zeroByteMatch - treat zero terminator as matching character if set to 1 (IN).
 
  RETURNS: Pointer to first character matching any of chars[] character
           or NULL if character not found.
 
+

Local.cpp

+ +

GetUtf8

+
inline unsigned int  GetUtf8
(
  unsigned const char *  zIn,
  unsigned const char ** pzNext
); 

 
  Pop next UTF8 character from string.
 
+
+

stristr_utf8

+
char * stristr_utf8
(
  const char * arg1,
  const char * arg2,
  int *        byteLen
); 

 
  Case insensitive UTF-8 version of C strstr().
 
+
+

StrFindIWord_utf8

+
char * StrFindIWord_utf8
(
  const char * arg1,
  const char * arg2
); 

 
 
 
+
+

StrRemovePlChars_utf8

+
int  StrRemovePlChars_utf8
(
  unsigned char * dst,
  unsigned char * src
); 

 
  Change polish local characters into pure ASCII equivalent.
 
  dst - buffer where to store pure ASCIIZ string (OUT).
  src - source utf8 string potentially containing polish chars (IN).
 
  RETURNS: 0 if OK.
 
+
+

StrCyr2Lat

+
string  StrCyr2Lat
(
  const string  &cyrtext
); 
Don't be sucker! Describe your function in source code.
+

StrConvertCodePage

+
int  StrConvertCodePage
(
  string  &str,
  int     sourceCP,
  int     targetCP
); 

 
  Convert code page from <sourceCP> to <targetCP>.
 
  str      - string to convert (IN/OUT).
  sourceCP - original code page of input string (IN).
  targetCP - destination code page, we want convert to (IN).
 
  RETURNS: 0 if OK.
 
+
+

StrRemovePlChars

+
int  StrRemovePlChars
(
  string  &str,
  DWORD   sourceCP
); 

 
  Replace all polish non-lating characters by lating equvalent.
 
  str      - string to convert (IN/OUT).
  sourceCP - code page of input string (IN).
 
  RETURNS: 0 if OK.
 
+

Binary.cpp

+ +

StrPopRaw

+
int  StrPopRaw
(
  void *  raw,
  int     rawSize,
  char ** it,
  int *   bytesLeft
); 

 
  Pop <rawSize> bytes from begin of buffer.
 
  raw       - buffer, where to write popped data (OUT).
  rawSize   - how much bytes to pop (IN).
  it        - pointer inside raw buffer, where to read data from (IN/OUT).
  bytesLeft - number of bytes left in buffer (IN/OUT).
 
  RETURNS: 0 if all bytes popped,
           -1 if error.
 
+
+

StrPopQword

+
int  StrPopQword
(
  uint64_t * value,
  char **    it,
  int *      bytesLeft,
  int        flags
); 

 
  Pop QWORD from begin of string.
 
  value     - buffer, where to write popped QWORD (OUT).
  it        - pointer inside raw buffer, where to read data from (IN/OUT).
  bytesLeft - number of bytes left in buffer (IN/OUT).
  flags     - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN).
 
  RETURNS: 0 if all 8 bytes popped,
          -1 if error.
 
+
+

StrPopDword

+
int  StrPopDword
(
  uint32_t * value,
  char **    it,
  int *      bytesLeft,
  int        flags
); 

 
  Pop DWORD from begin of string.
 
  value     - buffer, where to write popped DWORD (OUT).
  it        - pointer inside raw buffer, where to read data from (IN/OUT).
  bytesLeft - number of bytes left in buffer (IN/OUT).
  flags     - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN).
 
  RETURNS: 0 if all 4 bytes popped,
           -1 if error.
 
+
+

StrPopByte

+
int  StrPopByte
(
  uint8_t * value,
  char **   it,
  int *     bytesLeft
); 

 
  Pop one byte from begin of string.
 
  value     - buffer, where to write popped byte (OUT).
  it        - pointer inside raw buffer, where to read data from (IN/OUT).
  bytesLeft - number of bytes left in buffer (IN/OUT).
 
  RETURNS: 0 if byte popped,
          -1 if error.
 
+
+

StrPopString

+
int  StrPopString
(
  const char ** str,
  int *         strLen,
  char **       it,
  int *         bytesLeft
); 

 
  Pop C string from buffer.
 
  str       - pointer to begin of string (OUT).
  len       - length of string in bytes, can be NULL if not needed (OUT/OPT).
  it        - pointer inside raw buffer, where to read data from (IN/OUT).
  bytesLeft - number of bytes left in buffer (IN/OUT).
 
  RETURNS: 0 if byte popped,
          -1 if error.
 
+

Convert.cpp

+ +

StringToInt

+
int  StringToInt
(
  const string          &str,
  StringToIntAlgorithm  algorithm
); 

 
  Convert std::string to integer.
 
  str       - input string e.g. "1234" (IN).
  algorithm - algorithm to use for conversion (IN).
 
  Possible <algorithms> are:
 
  - SimpleAtoi  : Call C atoi() function on string.
 
  - EveryDigits : Skip all non-decimal number e.g. it converts "1-234xx-56"
                  into 123456 number.
 
  - UntilAlpha  : stop converting on first alpha charcter e.g. it
                  converts "123-456xxx789" into 123456.
 
  RETURNS: Decoded integer.
 
+
+

StringToInt

+
int  StringToInt
(
  const char *          str,
  StringToIntAlgorithm  algorithm
); 

 
  Convert std::string to integer.
 
  str       - input string e.g. "1234" (IN).
  algorithm - algorithm to use for conversion (IN).
 
  Possible <algorithms> are:
 
  - SimpleAtoi  : Call C atoi() function on string.
 
  - EveryDigits : Skip all non-decimal number e.g. it converts "1-234xx-56"
                  into 123456 number.
 
  - UntilAlpha  : stop converting on first alpha charcter e.g. it
                  converts "123-456xxx789" into 123456.
 
  RETURNS: Decoded integer.
 
+
+

StringToDouble

+
double  StringToDouble
(
  const string  &str
); 

 
  Convert std::string into double value.
 
  RETURNS: Double value stored in input string.
 
+
+

StringFromInt

+
string  StringFromInt
(
  int  x
); 

 
  Create std::string from input integer value.
 
+
+

StringFromDouble

+
string  StringFromDouble
(
  double  x
); 

 
  Create std::string from input double value.
 
+

StringList.cpp

+ +

StrListSplit

+
void  StrListSplit
(
  vector<string>  &vec,
  const char *    str
); 

 
  Split input string list in format "elem1;elem2;..." into STL vector
  containig [elem1,elem2,...] strings.
 
  vec - STL string vector, where to store retrieved elements list (OUT).
  str - string list in "elem1;elem2;..." format (IN).
 
+
+

StrListInit

+
void  StrListInit
(
  string          &str,
  vector<string>  &vec
); 

 
  Create one conitous "elem1;elem2;..." string from stl vector
  containig [elem1,elem2,...].
 
  str - STL string, where to store created list (OUT).
  vec - STL vector containing string elements (IN).
 
+
+

StrListAdd

+
int  StrListAdd
(
  string       &str,
  const char * elem
); 

 
  Add element to list.
 
  Example:
 
    Input str  : "jozek;janek;"
    Input elem : "maciek"
    Output str : "jozek;janek;maciek;"
 
 
  TIP#1: Element is added only if not exists on list yet.
 
  Parameters:
 
  str  - string containing list in format "elem1;elem2;...", where to add
         new element (IN/OUT).
 
  elem - element to add (IN).
 
  RETURNS: 0 if element added,
           ERR_XXX code otherwise.
 
+
+

StrListRemove

+
int  StrListRemove
(
  string       &str,
  const char * elem
); 

 
  Remove element from list.
 
  Example:
 
    Input str  : "jozek;janek;maciek;"
    Input elem : "janek"
    Output str : "jozek;maciek;"
 
  Parameters:
 
  str  - string containing list in format "elem1;elem2;...", which we want
         to modify (IN/OUT).
 
  elem - element to remove (IN).
 
  RETURNS: 0 if element removed,
           ERR_XXX code otherwise.
 
+
+

StrListExists

+
int  StrListExists
(
  const string  &str,
  const char *  elem
); 

 
  Check is elem exists on list.
 
  str  - string containing list in format "elem1;elem2;...", which we want
         search (IN).
 
  elem - element to found (IN).
 
  RETURNS: 1 if element exists in the list,
           0 otherwise.
 
+

Capitalize.cpp

+ +

StrCapitalize

+
void  StrCapitalize
(
  string  &str
); 

 
  Capitalize string.
 
  str - string to captalize (IN/OUT).
 
+
+

StrCapitalize

+
void  StrCapitalize
(
  char * str
); 

 
  Capitalize string.
 
  str - string to captalize (IN/OUT).
 
+
+

StrLowerize

+
string & StrLowerize
(
  string  &s
); 

 
  Lowerize string.
 
  s - string to captalize (IN/OUT).
 
+
+

StrLowerize

+
void  StrLowerize
(
  char * s
); 

 
  Lowerize string.
 
  s - string to captalize (IN/OUT).
 
+

Verify.cpp

+ +

StrEmailVerify

+
int  StrEmailVerify
(
  const char * email
); 

 
  Check is given email is in correct X@Y format.
 
  email - email address to verify (IN).
 
  RETURNS: 0 if email seems correct,
           one of ERR_VERIFY_XXX code otherwise.
 
+
+

StrLoginVerify

+
int  StrLoginVerify
(
  const char * login
); 

 
  Check is given login correct.
 
  Allowed chars are: A-Z a-z 0-9 -_@.
  (No space allowed, dot allowed).
 
  Minimum login length is STR_MIN_LOGIN_LEN.
  Maximum login length is STR_MAX_LOGIN_LEN.
 
  login - login to verify (IN).
 
  RETURNS: 0 if login seems correct,
           one of ERR_VERIFY_XXX code otherwise.
 
+
+

StrPassVerify

+
int  StrPassVerify
(
  const char * pass
); 

  Minimum login length is STR_MIN_PASS_LEN.
  Maximum login length is STR_MAX_PASS_LEN.
 
  pass - password to verify (IN).
 
  RETURNS: 0 if password seems correct,
           one of ERR_VERIFY_XXX code otherwise.
 
+
+

StrPassStrength

+
int  StrPassStrength
(
  const char * pass
); 

 
  Compute password strength in <0;6> scale.
 
  pass - password to check (IN).
 
  RETURNS: Password strength in <0;6> scale.
 
+

Date.cpp

+ +

StrDateGetToday

+
const string  StrDateGetToday
(
); 

 
  Get local today date string in format: YYYY-MM-DD.
 
  RETURNS: String containing today date e.g. "2014-10-14".
 
+
+

StrDateGetTodayUTC0

+
const string  StrDateGetTodayUTC0
(
); 

 
  Get UTC0 today date string in format: YYYY-MM-DD.
 
  RETURNS: String containing today date e.g. "2014-10-14".
 
+
+

StrDateAddDays

+
const string  StrDateAddDays
(
  string  date,
  int     nDays
); 

 
  Add N days to date string.
 
  Example: "2014-10-14" + 1 day = "2014-10-15"
 
  date  - input date string to increase (IN).
  nDays - how many days to add (IN).
 
  RETURNS: Date string increased by given number of days.
 
+
+

StrDateAddDaysUTC0

+
const string  StrDateAddDaysUTC0
(
  string  date,
  int     nDays
); 

 
  Add N days to UTC0 date string.
 
  Example: "2014-10-14" + 1 day = "2014-10-15"
 
  date  - input date string to increase (IN).
  nDays - how many days to add (IN).
 
  RETURNS: Date string increased by given number of days.
 
+

SourceCode.cpp

+ +

StrMinifyCode

+
string  StrMinifyCode
(
  const string  &code,
  const char *  singleComment,
  const char *  multiCommentBegin,
  const char *  multiCommentEnd,
  int           removeWhites
); 

 
  Minimalize source code (e.g. JS/CSS) by removing whitespaces and comments.
 
  code              - source code to minify (IN).
  singleComment     - string used as comment line e.g. '//' in C/C++ (IN/OPT).
  multiCommentBegin - string used to begin comment e.g. '/*' in C/C++ (IN/OPT).
  multiCommentEnd   - string used to close comment e.g. '*/' in C/C++ (IN/OPT).
  removeWhites      - remove redundant whites if set to 1 (IN/OPT).
 
  RETURNS: New string containing minimalized code.
 
+
+

StrRemoveSingleLineComments

+
string  StrRemoveSingleLineComments
(
  string       code,
  const char * commentString
); 

 
  Remove single line comments from string.
 
  code          - string containg source code (IN).
  commentString - string used as comment line e.g. '//' in C/C++ (IN).
 
  RETURNS: New string with removed comments.
 
+
+

StrRemoveMultiLineComments

+
string  StrRemoveMultiLineComments
(
  const string  &code,
  const char *  commentBegin,
  const char *  commentEnd
); 

 
  Remove multiline comments from string.
 
  code         - string containg source code (IN).
  commentBegin - string used to begin comment e.g. '/*' in C/C++ (IN).
  commentEnd   - string used to close comment e.g. '*/' in C/C++ (IN).
 
  RETURNS: New string with removed comments.
 
+

Random.cpp

+ +

RandomIntString

+
string  RandomIntString
(
); 

 
  Generate random 64-byte decimal only string.
 
  RETURNS: Random decimal-only string.
 
+
+

RandomString

+
string  RandomString
(
  int  len,
  int  minChar,
  int  maxChar
); 

 
  Generate general random string.
 
  len     - length of string to generate (IN).
  minChar - minimum character to use e.g. 'a' (IN).
  maxChar - maximum character to use e.g. 'z' (IN).
 
  RETURNS: Random string containing characters from <minChar, maxChar>
           range.
 
+

LibSystem component

Title:LibSystem
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Platform independend API to retrieve info about system and OS.
Description:-
Dependences:LibStr LibDebug
Used by: Tegenaria-core LibSystem-example01-simple

Functions list:

+
Cpu
+SystemGetCpuCores
+SystemCpuId
+SystemCpuHasSSE3
+SystemCpuHasSSE2
+SystemCpuHasMMX
+
OS
+SystemGetOsName
+SystemGetOsVersionString
+SystemGetMachineName
+SystemGenerateClientId
+SystemParseClientId
+
Memory
+SystemGetFreeMemory
+SystemGetUsedMemory
+
File
+SystemGetFdLimit
+SystemSetFdLimit
+
User
+SystemCheckForAdmin
+SystemGetCurrentUser
+
Environment
+SystemGetEnvironmentBlock
+

Functions protos:

+

Cpu.cpp

+ +

SystemGetCpuCores

+
int  SystemGetCpuCores
(
); 

 
  Retrieve number of CPU cores installed on system.
 
+
+

SystemCpuId

+
void  SystemCpuId
(
  unsigned int   func,
  unsigned int * eax,
  unsigned int * ebx,
  unsigned int * ecx,
  unsigned int * edx
); 

 
  Run native cpuid instruction.
 
  func - CPU id function, see INTEL or AMD manual for more (IN).
  eax  - copy of returned eax register (OUT).
  ebx  - copy of returned ebx register (OUT).
  ecx  - copy of returned ecx register (OUT).
  edx  - copy of returned edx register (OUT).
 
+
+

SystemCpuHasSSE3

+
int  SystemCpuHasSSE3
(
); 

 
  Check does current running CPU has SSE3 extension.
 
+
+

SystemCpuHasSSE2

+
int  SystemCpuHasSSE2
(
); 

 
  Check does current running CPU has SSE2 extension.
 
+
+

SystemCpuHasMMX

+
int  SystemCpuHasMMX
(
); 

 
  Check does current running CPU has MMX extension.
 
+

OS.cpp

+ +

SystemGetOsName

+
const char * SystemGetOsName
(
); 

 
  Retrieve name of current running OS (e.g. Windows).
 
+
+

SystemGetOsVersionString

+
const char * SystemGetOsVersionString
(
); 

 
  Get version string of current running OS (e.g. XP 5.1.2600).
 
+
+

SystemGetMachineName

+
int  SystemGetMachineName
(
  char * machineName,
  int    machineNameSize
); 

 
  Get name of current running machine.
 
  machineName     - buffer, where to store retrieved machine name (OUT).
  machineNameSize - size of machineName[] buffer in bytes (IN).
 
  RETURNS: 0 if OK.
 
+
+

SystemGenerateClientId

+
int  SystemGenerateClientId
(
  char * clientId,
  int    clientIdSize
); 

 
  Generate unique string identyfing current running machine.
  Output string has format:
 
  X:<machine-name>:<random-id>,
 
  where:
  - X is 'W' for Windows, 'L' for Linux, 'M' for MacOS,
   'A' for Android, 'i' for iOS, 'U' for unknown.
 
  - machineName is name of current machine retreved from
    SystemGetMachineName()
 
  - random-id is random 4 characters
 
  Example: W:Office-12345678:fsd2
 
  clientId     - buffer, where to store generated client ID (OUT).
  clientIdSize - size of clientId[] buffer in bytes (IN).
 
  RETURNS: 0 if OK.
 
+
+

SystemParseClientId

+
int  SystemParseClientId
(
  string       &os,
  string       &machineName,
  string       &id,
  const char * clientId
); 

 
  Split client ID into OS (operating system), machine name and ID part.
  See SystemGenerateClientId() for more about client ID.
 
  os          - OS part found in given client ID (OUT).
  machineName - machine name found in given client ID (OUT).
  id          - random ID part found in given client ID (OUT).
  clientId    - client ID to parse, generated by SystemGenerateClientId() before (IN).
 
  RETURNS: 0 if OK,
           -1 if error.
 
+

Memory.cpp

+ +

SystemGetFreeMemory

+
int64_t  SystemGetFreeMemory
(
); 

 
  Retrieve number of free bytes available in system.
 
+
+

SystemGetUsedMemory

+
int64_t  SystemGetUsedMemory
(
); 

 
  Retrieve numer of bytes allocated by current running process.
 
+

File.cpp

+ +

SystemGetFdLimit

+
int  SystemGetFdLimit
(
); 

 
  Retrieve current limit of allowed opened FD for current user.
 
  RETURNS: Current set FD limit
           or -1 if error.
 
+
+

SystemSetFdLimit

+
int  SystemSetFdLimit
(
  int  limit
); 

  Set limit of maximum opened FD for current user.
 
  limit - new limit to set (IN).
 
  RETURNS: 0 if OK.
 
+

User.cpp

+ +

SystemCheckForAdmin

+
int  SystemCheckForAdmin
(
); 

 
  Check does current process has admin privilege.
 
  RETURNS: 0 if current process has admin privilege,
           1 if current process has NO admin privilege,
          -1 if error.
 
+
+

SystemGetCurrentUser

+
int  SystemGetCurrentUser
(
  char * user,
  int    userSize
); 

 
  Retrieve name of current running user.
 
  user     - buffer, where to store retrieved username (OUT).
  userSize - size of user[] buffer in bytes (IN).
 
  RETURNS: 0 if OK.
 
+

Environment.cpp

+ +

SystemGetEnvironmentBlock

+
int  SystemGetEnvironmentBlock
(
  map<string ,
  string>    &env
); 

 
  Retrieve all environment variables as string |-> string map.
 
  env - std string to string map, where to store retrieved
        environment block (OUT).
 
  RETURNS: 0 if OK.
 
+

LibThread component

Title:LibThread
Type:LIBRARY
Author(s):Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), Lukasz Bienczyk (lukasz.bienczyk@gmail.com)
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Creating threads
Description:-
Dependences:LibDebug
Used by: Tegenaria-core LibNet LibNetEx LibSftp LibNet-example01-thread-server LibNet-example02-single LibNet-example05-HP-server LibIO LibIpc LibJob LibProcess LibThread-example01-simple LibThread-example02-wait LibProcess-example03-monitor LibProcess-example04-wait-for-parent LibLock-example01-mutex LibLock-example02-semaphore liblock-example03-requestpool LibIO-example01-file-mixer LibIO-example02-network-mixer LibIO-example03-timeout-read

Functions list:

+
Thread
+_ThreadHandleAlloc
+_ThreadEntryWrapperLinux
+ThreadCreate
+ThreadIsRunning
+ThreadClose
+ThreadKill
+ThreadWait
+ThreadGetCurrentId
+
Sleep
+ThreadSleepUs
+ThreadSleepMs
+ThreadSleepSec
+

Functions protos:

+

Thread.cpp

+ +

_ThreadHandleAlloc

+
static ThreadHandle_t * _ThreadHandleAlloc
(
  void * handle,
  int    id
); 

 
  Allocate new ProcessHandle_t struct basing on system handle/pid data.
 
  handle - underlying system handle (IN).
  id     - underlying thread id (IN).
 
  RETURNS: Pointer to new allocated handle,
           or NULL if error.
 
+
+

_ThreadEntryWrapperLinux

+
static void * _ThreadEntryWrapperLinux
(
  void * rawCtx
); 

 
  Internal wrapper over caller entry point to:
  - hide OS differences (entry point on Linux has different proto)
  - get signal, when thread finished in easy way
 
 
 
+
+

ThreadCreate

+
ThreadHandle_t * ThreadCreate
(
  ThreadEntryProto  entry,
  void *            ctx
); 

 
  Create new thread.
 
  entry - thread entry point i.e. pointer to function, where code execution
          will be started (MUST be static) (IN).
 
  ctx   - arbitrary data passed directly to the thread entry point. Can
          be NULL if not needed (IN/OPT).
 
  RETURNS: handle to new thread,
           or NULL if error.
 
+
+

ThreadIsRunning

+
int  ThreadIsRunning
(
  ThreadHandle_t * th
); 

 
  Check is thread running.
 
  handle - thread handle returned by threadCreate() before (IN).
 
  RETURN:  1 if thread running,
           0 if thread dead,
          -1 if error.
 
+
+

ThreadClose

+
int  ThreadClose
(
  ThreadHandle_t * th
); 

 
  Close handle retrieved from ThreadCreate() before.
 
  WARNING: Function does NOT terminate thread if it still running.
 
  TIP#1: Use ThreadKill() if you want to terminate thread before close.
  TIP#2: Use ThreadWait() if you want to wait until thread finished before close.
 
  th - handle to thread retrieved from ThreadCreate() before (IN).
 
  RETURNS:  0 if thread finished before timeout,
           -1 if thread still working.
 
+
+

ThreadKill

+
int  ThreadKill
(
  ThreadHandle_t * th
); 

 
  Unconditionaly terminate thread.
 
  th - thread handle retrieved from ThreadCrate() before (IN).
 
  RETURNS:  0 if thread terminated,
           -1 otherwise.
 
+
+

ThreadWait

+
int  ThreadWait
(
  ThreadHandle_t * th,
  int *            result,
  int              timeoutMs
); 

 
  Wait until thread finished work or timeout.
 
  WARNING: Function DOES not clear resources allocated by thread event
            if thread terminated before funtion return. Use ThreadClose()
           to free thread handle, when no needed longer.
 
  th      - thread handle retrieved from ThreadCreate() before (IN).
 
  result  - buffer, where to store exit code returned by thread.
            Can be NULL if not needed (OUT/OPT).
 
  timeout - maximum time to wait im milisecond. Defaulted to infinite if
            skipped or set to -1. (IN/OPT).
 
  RETURNS: 0 if thread finished before timeout,
           1 if thread still working,
          -1 if error.
 
+
+

ThreadGetCurrentId

+
int  ThreadGetCurrentId
(
); 

 
  Get id of current running thread.
 
+

Sleep.cpp

+ +

ThreadSleepUs

+
void  ThreadSleepUs
(
  int  us
); 

 
  Sleep current thread for given number of microseconds.
 
+
+

ThreadSleepMs

+
void  ThreadSleepMs
(
  int  ms
); 

 
  Sleep current thread for given number of miliseconds.
 
+
+

ThreadSleepSec

+
void  ThreadSleepSec
(
  double  seconds
); 

 
  Sleep current thread for given number of seconds.
 
+

LibVariant component

Title:LibVariant
Type:LIBRARY
Author(s):Sylwester Wysocki
Copyright:(C) Sylwester Wysocki 2010, 2014 (inherited from project's root)
License:MIT (See LICENSE.txt file) (inherited from project's root)
Purpose:Variant (mutable) variables
Description:-
Dependences:LibDebug LibObject
Used by: Tegenaria-core

Functions list:

+
Variant
+Variant::printAsText
+Variant::getTypeName
+Variant::vaprint
+Variant::toStdString
+Variant::toString
+Variant::toStringEscapedForC
+

Functions protos:

+

Variant.cpp

+ +

Variant::printAsText

+
Variant::printAsText
(
  FILE *        f,
  unsigned int  flags
); 
Don't be sucker! Describe your function in source code.
+

Variant::getTypeName

+
const char * Variant::getTypeName
(
); 
Don't be sucker! Describe your function in source code.
+

Variant::vaprint

+
int  Variant::vaprint
(
  FILE *        f,
  unsigned int  flags,
  int           count
); 
Don't be sucker! Describe your function in source code.
+

Variant::toStdString

+
const string  Variant::toStdString
(
); 
Don't be sucker! Describe your function in source code.
+

Variant::toString

+
const Variant  Variant::toString
(
); 
Don't be sucker! Describe your function in source code.
+

Variant::toStringEscapedForC

+
const Variant  Variant::toStringEscapedForC
(
); 
Don't be sucker! Describe your function in source code.
\ No newline at end of file diff --git a/Doc/index.html b/Doc/index.html new file mode 100644 index 0000000..cc32e69 --- /dev/null +++ b/Doc/index.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/Doc/toc.html b/Doc/toc.html new file mode 100644 index 0000000..e3e78a5 --- /dev/null +++ b/Doc/toc.html @@ -0,0 +1,681 @@ + + +

Tegenaria Project

+

I. Overview

+

II. Diagram

+

III. Specifications

+

Main components:

+
    +

    Examples:

    +
\ No newline at end of file diff --git a/LICENSE b/LICENSE.txt similarity index 79% rename from LICENSE rename to LICENSE.txt index b0b1b21..270c97f 100644 --- a/LICENSE +++ b/LICENSE.txt @@ -1,6 +1,11 @@ MIT License -Copyright (c) 2020 Sylwester Wysocki +Copyright (c) 2010, 2014 Sylwester Wysocki + +LibLock, LibProcess, LibThread: + Copyright (c) 2010, 2014 Lukasz Bienczyk , + Radoslaw Kolodziejczyk , + Sylwester Wysocki Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +23,4 @@ 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. +SOFTWARE. \ No newline at end of file diff --git a/Source/Core/LibArgs/Args.cpp b/Source/Core/LibArgs/Args.cpp new file mode 100644 index 0000000..def9231 --- /dev/null +++ b/Source/Core/LibArgs/Args.cpp @@ -0,0 +1,265 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#undef DEBUG + +#include +#include +#include + +#include +#include + +#include "Args.h" + +namespace Tegenaria +{ + // + // Process arguments. + // + + int ArgsParse(ArgsObj *ao, int argc, char **argv) + { + DBG_ENTER("ArgsParse"); + + int exitCode = -1; + + for (int i = 1; i < argc; i++) + { + int argsToEnd = argc - i - 1; + + int found = 0; + + DBG_MSG("Checking [%s]...\n", argv[i]); + + for (int j = 0; ao[j].type_ != ARGS_NULL; j++) + { + // + // Matching pattern found. + // + + if (strcmp(ao[j].pattern_, argv[i]) == 0) + { + found = 1; + + // + // --mode. + // + + if (ao[j].type_ == ARGS_MODE) + { + DBG_MSG("Setting mode [%d]...\n", ao[j].intVal_); + + *((int *) ao[j].target_) = ao[j].intVal_; + } + + // + // --flag. + // + + else if (ao[j].type_ == ARGS_FLAG) + { + *((int *) ao[j].target_) = 1; + } + + // + // --option arg + // + + else + { + FAILEX(argsToEnd == 0, "ERROR: Missing argument for [%s].\n", argv[i]); + + i ++; + + DBG_MSG("Setting [%s] to [%s]...\n", ao[j].pattern_, argv[i]); + + switch(ao[j].type_) + { + case ARGS_INT: *((int *) (ao[j].target_)) = atoi(argv[i]); break; + case ARGS_DOUBLE: *((double *)(ao[j].target_)) = atof(argv[i]); break; + case ARGS_FLOAT: *((float *) (ao[j].target_)) = atof(argv[i]); break; + case ARGS_STRING: *((char **) (ao[j].target_)) = argv[i]; break; + case ARGS_CHAR: *((char *) (ao[j].target_)) = argv[i][0]; break; + } + } + } + } + + // + // Unknown option. + // + + FAILEX(!found, "ERROR: Unknown option at [%s].\n", argv[i]); + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot process input arguments.\n"); + } + + DBG_LEAVE("ArgsParse"); + + return exitCode; + } + + // + // Wrapper for ArgsParse() working with one continous + // string on input. + // + // RETURNS: 0 if OK. + // + + int ArgsParse(ArgsObj *ao, const char *cmd) + { + DBG_ENTER("ArgsParse"); + + int exitCode = -1; + + int argc = 0; + + char **argv = NULL; + + // + // Convert one continous string argStr into {argc, argv[]}. + // + + FAIL(ArgsAlloc(&argc, &argv, cmd)); + + // + // Pass control to oryginal function working on {argc, argv[]}. + // + + FAIL(ArgsParse(ao, argc, argv)); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (argv) + { + ArgsFree(argc, argv); + } + + DBG_LEAVE("ArgsParse"); + + return exitCode; + } + + // + // Allocate argv[] table from continous string. + // + // WARNING: Output argv[] MUST be free by caller via ArgsFree(). + // + // argc - number of elements in argv[] (OUT). + // argv - table with tokenized arguments (OUT). + // argStr - command line string to tokenize (IN). + // + // RETURNS: 0 if OK. + // + + int ArgsAlloc(int *argc, char ***argv, const char *cmd) + { + DBG_ENTER("ArgsAlloc"); + + int exitCode = -1; + + vector tokens; + + string cmdStr = cmd; + + // + // Split command into tokens. + // + + StrTokenize(tokens, (char *) cmd, " \t\n\r", "\"'"); + + // + // Allocate argv[]. + // + + *argc = tokens.size() + 1; + + *argv = (char **) calloc(*argc + 2, sizeof(char *)); + + FAILEX(*argv == NULL, "ERROR: Out of memory.\n"); + + // + // Put tokens into argv[]. + // + + for (int i = 0; i < tokens.size(); i++) + { + DBG_MSG("ArgsAlloc : Putting [%s] at argv[%d]...\n", tokens[i], i); + + (*argv)[i + 1] = tokens[i]; + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + DBG_LEAVE("ArgsAlloc"); + + return exitCode; + } + + // + // Free argv[] table allocated by ArgsAlloc(). + // + + void ArgsFree(int argc, char **argv) + { + if (argv) + { + /* + for (int i = 0; i < argc; i++) + { + if (argv[i]) + { + free(argv[i]); + } + } + */ + + free(argv); + } + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibArgs/Args.h b/Source/Core/LibArgs/Args.h new file mode 100644 index 0000000..07ca0e9 --- /dev/null +++ b/Source/Core/LibArgs/Args.h @@ -0,0 +1,82 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Args_H +#define Tegenaria_Core_Args_H + +#include + +namespace Tegenaria +{ + using std::string; + + enum ArgsType + { + ARGS_INT, + ARGS_DOUBLE, + ARGS_FLOAT, + ARGS_STRING, + ARGS_CHAR, + ARGS_MODE, + ARGS_FLAG, + ARGS_NULL + }; + + struct ArgsObj + { + ArgsType type_; + + const char *pattern_; + + void *target_; + + union + { + int intVal_; + + char charVal_; + + char *stringVal_; + + double doubleVal_; + + float floatVal_; + }; + }; + + // + // Process arguments. + // + + int ArgsParse(ArgsObj *ao, int argc, char **argv); + + int ArgsParse(ArgsObj *ao, const char *cmd); + + int ArgsAlloc(int *argc, char ***argv, const char *cmd); + + void ArgsFree(int argc, char **argv); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Args_H */ diff --git a/Source/Core/LibArgs/Example01/Example01.cpp b/Source/Core/LibArgs/Example01/Example01.cpp new file mode 100644 index 0000000..02526ea --- /dev/null +++ b/Source/Core/LibArgs/Example01/Example01.cpp @@ -0,0 +1,86 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +int main(int argc, char **argv) +{ + #define MODE_ERROR -1 + #define MODE_1 1 + #define MODE_2 2 + #define MODE_3 3 + + int mode = MODE_ERROR; + + double thre = 0.0; + + int n_vars = 0; + + char *name = NULL; + + int quiet = 0; + + // + // Declare known options. + // + + ArgsObj ao[] = + { + {ARGS_MODE, "--mode1", &mode, MODE_1}, + {ARGS_MODE, "--mode2", &mode, MODE_2}, + {ARGS_MODE, "--mode3", &mode, MODE_3}, + + {ARGS_INT, "--nvars", &n_vars}, + {ARGS_DOUBLE, "--thre", &thre}, + {ARGS_STRING, "--name", &name}, + {ARGS_FLAG, "--quiet", &quiet}, + + // + // End of table terminator. + // + + {ARGS_NULL, NULL, NULL} + }; + + // + // Parse options. + // + + ArgsParse(ao, argc, argv); + + // + // Show parsed result. + // + + printf("mode : [%d]\n", mode); + printf("nvars : [%d]\n", n_vars); + printf("threshold : [%lf]\n", thre); + printf("name : [%s]\n", name); + printf("quiet : [%d]\n", quiet); + + return 0; +} diff --git a/Source/Core/LibArgs/Example01/qcbuild.src b/Source/Core/LibArgs/Example01/qcbuild.src new file mode 100644 index 0000000..a9a8287 --- /dev/null +++ b/Source/Core/LibArgs/Example01/qcbuild.src @@ -0,0 +1,30 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibArgs-example +CXXSRC = Example01.cpp + +LIBS = -largs -ldebug -lstr +DEPENDS = LibArgs LibDebug diff --git a/Source/Core/LibArgs/Example02/Shell.cpp b/Source/Core/LibArgs/Example02/Shell.cpp new file mode 100644 index 0000000..84aae02 --- /dev/null +++ b/Source/Core/LibArgs/Example02/Shell.cpp @@ -0,0 +1,188 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include + +using namespace Tegenaria; + +#define MODE_ERROR -1 + +#define MODE_SHARE 1 +#define MODE_UNSHARE 2 +#define MODE_VERSION 4 +#define MODE_HELP 5 +#define MODE_EXIT 6 + + +int InterpreterLoop(FILE *fout, FILE *fin, FILE *ferr) +{ + int exitCode = -1; + + int mode = MODE_ERROR; + + char *alias = NULL; + char *path = NULL; + + int goOn = 1; + + char line[1024] = {0}; + + // + // Declare known commands. + // + + ArgsObj ao[] = + { + // + // share --alias --path + // + + {ARGS_MODE, "share", &mode, MODE_SHARE}, + {ARGS_STRING, "--alias", &alias }, + {ARGS_STRING, "--path", &path }, + + // + // unshare --alias + // + + {ARGS_MODE, "unshare", &mode, MODE_UNSHARE}, + + // + // version + // + + {ARGS_MODE, "version", &mode, MODE_VERSION}, + + // + // help + // + + {ARGS_MODE, "help", &mode, MODE_HELP}, + + // + // exit + // + + {ARGS_MODE, "exit", &mode, MODE_EXIT}, + + // + // End of table terminator. + // + + {ARGS_NULL} + }; + + // + // Fall into main interpreter loop. + // + + while(goOn) + { + mode = MODE_ERROR; + + // + // Parse next command line. + // + + printf(">"); + + FAILEX(fgets(line, sizeof(line), fin) == NULL, + "ERROR: Cannot read command from stdin.\n"); + + if (ArgsParse(ao, line) == 0) + { + // + // If command sucessfully parsed dispatch control + // depending on received 'work mode'. + // + + switch(mode) + { + case MODE_VERSION: + { + fprintf(fout, "ARGS-EXAMPLE-SHELL 0.1\n"); + + break; + } + + case MODE_SHARE: + { + fprintf(fout, "Shared path [%s] as alias [%s].\n", path, alias); + + break; + } + + case MODE_UNSHARE: + { + fprintf(fout, "Unshared alias [%s].\n", alias); + + break; + } + + case MODE_HELP: + { + fprintf + ( + fout, + "\n" + "help : show this help message\n" + "version : show intepreter version\n" + "share --path --alias : Share as alias \n" + "unshare --alias : Unshare alias \n" + "exit : Finish session\n" + "\n" + ); + + break; + } + + case MODE_EXIT: + { + fprintf(fout, "Logout.\n"); + + goOn = 0; + + break; + } + } + } + } + + // + // Clean up. + // + + fail: + + return exitCode; +} + +int main(int argc, char **argv) +{ + InterpreterLoop(stdout, stdin, stderr); + + return 0; +} diff --git a/Source/Core/LibArgs/Example02/qcbuild.src b/Source/Core/LibArgs/Example02/qcbuild.src new file mode 100644 index 0000000..1101ff3 --- /dev/null +++ b/Source/Core/LibArgs/Example02/qcbuild.src @@ -0,0 +1,31 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibArgs-example-shell +CXXSRC = Shell.cpp + +LIBS = -largs -ldebug -lstr + +DEPENDS = LibArgs LibDebug diff --git a/Source/Core/LibArgs/qcbuild.src b/Source/Core/LibArgs/qcbuild.src new file mode 100644 index 0000000..1a0dcf3 --- /dev/null +++ b/Source/Core/LibArgs/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibArgs + +CXXSRC = Args.cpp +INC_DIR = Tegenaria +ISRC = Args.h +LIBS = -ldebug -lstr + +AUTHOR = Sylwester Wysocki + +PURPOSE = Parse command line arguments. + +DEPENDS = LibDebug LibStr diff --git a/Source/Core/LibDebug/Config.cpp b/Source/Core/LibDebug/Config.cpp new file mode 100644 index 0000000..ad111bb --- /dev/null +++ b/Source/Core/LibDebug/Config.cpp @@ -0,0 +1,287 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Store debug configuration for current running process +// inside shared, temporary file ".debugConfig.". +// We need it to, force the same configuration even inside +// external DLLs linked statically with -debug-static. +// + +#pragma qcbuild_set_private(1) + +#undef DEBUG + +#include "Debug.h" +#include "Config.h" + +namespace Tegenaria +{ + // + // Used to debug LibDebug itself. + // Needed for LibDebug developing only. + // + + #undef SELF_DEBUG + + #ifdef SELF_DEBUG + # undef DBG_ENTER + # undef DBG_LEAVE + # undef DBG_MSG + + # define DBG_ENTER(X) fprintf(stderr, "-> " X "()...\n") + # define DBG_LEAVE(X) fprintf(stderr, "<- " X "()...\n") + # define DBG_MSG(...) fprintf(stderr, __VA_ARGS__) + #endif + + using namespace Tegenaria; + + // + // Global variable where config for current process stored. + // + + DebugConfig_t DebugConfig = {0}; + + // + // Helper function to retrieve temp directory. + // + + const char *DbgGetTempDir() + { + static char temp[1024] = {0}; + + if (temp[0] == 0) + { + #ifdef WIN32 + GetTempPath(MAX_PATH, temp); + #else + strcpy(temp, "/tmp"); + #endif + } + + return temp; + } + + // + // FIXME: Port O_TEMPORARY flag to Linux, + // + // Delete temporary .debugConfig. files on Linux. + // + + #ifndef WIN32 + + #define O_TEMPORARY 0 + + void DbgConfigCleanUp() + { + char path[260] = {0}; + + snprintf(path, sizeof(path), DEBUG_CONFIG_PATTERN, DbgGetTempDir(), DebugConfig.pid_); + + DBG_MSG("Deleting file [%s]...\n", path); + + unlink(path); + } + + void DbgConfigCleanUpHandler(int unused) + { + DbgConfigCleanUp(); + } + + #endif /* !WIN32 */ + + // + // Load debug configuratin for current running process, saved + // before by DbgSaveConfig. See DbgSaveConfig() for more . + // + // Used to share the same debug config within process even inside + // laoded DLLs linked static with -ldebug-static. + // + // debugCofig - struct, where is stored current config to save (IN). + // + // RETURNS: 0 if OK. + // + + int DbgLoadConfig(DebugConfig_t *debugConfig) + { + DBG_ENTER("DbgLoadConfig"); + + int exitCode = -1; + + int fd = -1; + + // + // Avoid loading config twice. + // + + if (debugConfig -> init_ == 0) + { + int readed = 0; + + char path[260] = {0}; + + // + // Try open .debugConfig. file. + // If exist it means there was already one DBG_INIT() sucessfull + // call inside current running process. + // + + snprintf(path, sizeof(path), DEBUG_CONFIG_PATTERN, DbgGetTempDir(), DebugConfig.pid_); + + fd = open(path, O_RDONLY | O_TEMPORARY, S_IREAD); + + FAIL(fd < 0); + + // + // Set hidden attribute on Windows. + // + + #ifdef WIN32 + SetFileAttributes(path, FILE_ATTRIBUTE_HIDDEN); + #endif + + // + // Load configuration from file. + // + + readed = read(fd, debugConfig, sizeof(DebugConfig_t)); + + FAIL(readed != sizeof(DebugConfig_t)); + + DBG_MSG("DbgLoadConfig : Loaded config:\n"); + DBG_MSG(" level : [%d]\n", debugConfig -> logLevel_); + DBG_MSG(" logFd : [%d]\n", debugConfig -> logFd_); + DBG_MSG(" pid : [%d]\n", debugConfig -> pid_); + DBG_MSG(" DBG_STATE : [%d]\n", debugConfig -> flags_ & DBG_STATE); + DBG_MSG(" DBG_TRACE : [%d]\n", debugConfig -> flags_ & DBG_TRACE); + DBG_MSG(" DBG_SEPARATE_PROCESSES : [%d]\n", debugConfig -> flags_ & DBG_SEPARATE_PROCESSES); + DBG_MSG(" DBG_SEPARATE_THREADS : [%d]\n", debugConfig -> flags_ & DBG_SEPARATE_THREADS); + } + + exitCode = 0; + + // + // Clean up. + // + + fail: + + if (exitCode) + { + DBG_MSG("DbgLoadConfig : Failed with code [%d].\n", GetLastError()); + } + + if (fd > 0) + { + close(fd); + } + + DBG_LEAVE("DbgLoadConfig"); + + return exitCode; + } + + // Save debug configuratin for current running process into + // temporary ".debugConfig." file. + // + // File is created as temporary and will be deleted just after + // process dead. + // + // Used to share the same debug config within whole process, + // even inside laoded DLLs linked static with -ldebug-static. + // + // It avoids scenario, when Foo.dll (linked with -ldebug-static) loaded: + // + // - Process main() begin. + // - Process init log DBG_INIT("file.log", flags); + // - Process calls Foo() from Foo.dll, + // - Foo() try use one of DBG_XXX() macro. + // + // PROBLEM: Foo.dll has own DebugConfig from static linked. + // DBG_INIT() called in main() has no efect on DLL. + // + // SOLUTION: First call to DBG_INIT() saves config to shared, temporary file. + // Another DBG_INIT() calls tries load config from file first. + // + // ARGS: + // + // debugConfig - pointer to global DebugConfig struct, where to store + // loaded options (OUT). + // + // RETURNS: 0 if OK. + // + + int DbgSaveConfig(DebugConfig_t *debugConfig) + { + int exitCode = -1; + + char path[260] = {0}; + + int written = 0; + + #ifdef WIN32 + snprintf(path, sizeof(path), DEBUG_CONFIG_PATTERN, DbgGetTempDir(), int(GetCurrentProcessId())); + #else + snprintf(path, sizeof(path), DEBUG_CONFIG_PATTERN, DbgGetTempDir(), int(getpid())); + #endif + + int fd = open(path, O_CREAT | O_TEMPORARY | O_RDWR, S_IREAD | S_IWRITE); + + if (fd > 0) + { + written = write(fd, debugConfig, sizeof(DebugConfig_t)); + + exitCode = 0; + + DBG_MSG("DbgSaveConfig : Saved config:\n"); + DBG_MSG(" level : [%d]\n", debugConfig -> logLevel_); + DBG_MSG(" logFd : [%d]\n", debugConfig -> logFd_); + DBG_MSG(" pid : [%d]\n", debugConfig -> pid_); + DBG_MSG(" DBG_STATE : [%d]\n", debugConfig -> flags_ & DBG_STATE_ENABLE); + DBG_MSG(" DBG_TRACE : [%d]\n", debugConfig -> flags_ & DBG_TRACE); + DBG_MSG(" DBG_SEPARATE_PROCESSES : [%d]\n", debugConfig -> flags_ & DBG_SEPARATE_PROCESSES); + DBG_MSG(" DBG_SEPARATE_THREADS : [%d]\n", debugConfig -> flags_ & DBG_SEPARATE_THREADS); + + // + // Set SIGTERM handler to remove .debugConfig. file + // manualy on linux due to missing O_TEMPORARY flag. + // + + #ifndef WIN32 + { + struct sigaction action = {0}; + + action.sa_handler = DbgConfigCleanUpHandler; + + sigaction(SIGTERM, &action, NULL); + + atexit(DbgConfigCleanUp); + } + #endif + } + + return exitCode; + } + +} /* namespace Tegenaria */ diff --git a/Source/Core/LibDebug/Config.h b/Source/Core/LibDebug/Config.h new file mode 100644 index 0000000..4c7bf88 --- /dev/null +++ b/Source/Core/LibDebug/Config.h @@ -0,0 +1,89 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Debug_Config_H +#define Tegenaria_Core_Debug_Config_H + +#include +#include +#include + +#ifdef WIN32 +# include +# include +# include +#else +# include +# include +# include +# include +# include +#endif + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +namespace Tegenaria +{ + // + // Defines. + // + + #define DEBUG_CONFIG_PATTERN "%s/.debugConfig.%d" + + // + // Structs. + // + + struct DebugConfig_t + { + int init_; // Already inited? + int logLevel_; // Log level, see DBG_LEVEL_XXX in Debug.h. + int logFd_; // FD to opened main log (defaulted to 2 = stderr). + int flags_; // Combination of DBG_XXX flags from Debug.h. + int stateFd_; // FD to opened state.. + int stateHisFd_; // FD to opened state-history.. + int ioFd_; // FD to write IO related messages. + int pid_; // pid of current process. + }; + + // + // Exported functions. + // + + int DbgLoadConfig(DebugConfig_t *debugConfig); + int DbgSaveConfig(DebugConfig_t *debugConfig); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Debug_Config_H */ diff --git a/Source/Core/LibDebug/Debug.cpp b/Source/Core/LibDebug/Debug.cpp new file mode 100644 index 0000000..1db1118 --- /dev/null +++ b/Source/Core/LibDebug/Debug.cpp @@ -0,0 +1,1134 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#undef DEBUG + +#include "Debug.h" +#include "Config.h" + +namespace Tegenaria +{ + #ifdef WIN32 + # define vsnprintf _vsnprintf + #else + # undef stricmp + # define stricmp strcasecmp + #endif + + extern DebugConfig_t DebugConfig; + + using std::min; + using std::string; + + // + // Used to debug itself. + // Needed for LibDebug developing only. + // + + #undef SELF_DEBUG + + #ifdef SELF_DEBUG + # undef DBG_ENTER + # undef DBG_LEAVE + # undef DBG_MSG + + # define DBG_ENTER(X) fprintf(stderr, "-> " X "()...\n") + # define DBG_LEAVE(X) fprintf(stderr, "<- " X "()...\n") + # define DBG_MSG(...) fprintf(stderr, __VA_ARGS__) + #endif + + // + // Defines. + // + + #define DBG_MSG_BUF_SIZE (1024 * 64) + + // + // Initialize: + // + // - main log file + // - state. file. + // - state-history. file. + // - save pid of current process. + // + // fname - file path, where to store main log file. + // Defaulted to stderr if NULL or file cannot be created (IN/OPT). + // + // + // level - one of DBG_LEVEL_XXX (see Debug.h) level to set. + // Defaulted to DBG_LEVEL_DEFAULT if -1. (IN/OPT). + // + // flags - combination of DBG_XXX flags degined in Debug.h. + // Defaulted to DBG_FLAGS_DEFAULT if -1. (IN/OPT). + // + + void DbgInit(const char *fname, int logLevel, int flags) + { + DBG_ENTER("DbgInit"); + + // + // Flags changed. + // + + int reinit = 0; + + if (flags != -1) + { + DBG_MSG("DbgInit : Flags changed from [0x%x] to [0x%x].\n", DebugConfig.flags_, flags); + + reinit = 1; + } + + // + // Do reinit if log file changed. + // + + else if (fname) + { + DBG_MSG("DbgInit : Log file changed to [%s], going to reinit...\n", fname); + + reinit = 1; + } + + // + // No reinit needed, but log level changed. + // Change log level only + // + + else if (logLevel != -1) + { + DBG_MSG("DbgInit : Log level changed to [%d].\n", logLevel); + + DbgSetLevel(logLevel); + } + + // + // Avoid calling DbgInit twice. + // Do real work only if first time or reinit needed. + // + + if (DebugConfig.init_ == 0 || reinit) + { + DBG_MSG("DbgInit : Not inited yet.\n"); + + // + // Retrieve current running pid. + // + + #ifdef WIN32 + DebugConfig.pid_ = GetCurrentProcessId(); + #else + DebugConfig.pid_ = getpid(); + #endif + + // + // Try load config from .debugConfig.. + // If .debugConfig. not found init and save own one. + // + + if (reinit || DbgLoadConfig(&DebugConfig) != 0) + { + char path[260] = {0}; + + DBG_MSG("DbgInit : Config not found.\n"); + + // + // Default flags and logLevel if not specified. + // + + if (logLevel == -1) + { + DBG_MSG("DbgInit : Defaulted log level to [%d].\n", DBG_LEVEL_DEFAULT); + + logLevel = DBG_LEVEL_DEFAULT; + } + + if (flags == -1) + { + DBG_MSG("DbgInit : Defaulted flags to [%d].\n", DBG_FLAGS_DEFAULT); + + flags = DBG_FLAGS_DEFAULT; + } + + // + // Clear DBG_REINIT flag. + // + + flags = flags & (~DBG_REINIT); + + DebugConfig.init_ = 1; + DebugConfig.flags_ = flags; + DebugConfig.logLevel_ = logLevel; + + DBG_MSG("DbgInit : Set flags to [0x%x].\n", DebugConfig.flags_); + DBG_MSG("DbgInit : Set loglevel to [%d].\n", DebugConfig.logLevel_); + + // + // Init main log over selected file if specified. + // + + DBG_MSG("DbgInit : Log file is set to [%s].\n", fname); + + if (fname) + { + strncpy(path, fname, sizeof(path)); + + // + // DBG_SEPARATE_PROCESSES flag. + // Convert 'fname' to 'fname.'. + // + + if (flags & DBG_SEPARATE_PROCESSES) + { + snprintf(path, sizeof(path), "%s.%d", fname, DebugConfig.pid_); + } + + // + // DBG_SEPARATE_THREADS flag. + // Convert 'path' to 'path.'. + // + + if (flags & DBG_SEPARATE_THREADS) + { + fprintf(stderr, "WARNING: DBG_SEPARATE_THREADS not implemented."); + } + + // + // Open main log file. + // + + DBG_MSG("DbgInit : Opening file [%s]...\n", path); + + DebugConfig.logFd_ = open(path, O_APPEND | O_CREAT | O_WRONLY, + S_IREAD | S_IWRITE); + + DBG_MSG("DbgInit : Retrieved FD : [%d].\n", DebugConfig.logFd_); + } + + // + // Cannot create main log file of filename not specified. + // Use stderr. + // + + if (DebugConfig.logFd_ < 0 || fname == NULL) + { + DebugConfig.logFd_ = 2; + } + + // + // Init io. file if needed. + // + + if (flags & DBG_IO_ENABLE) + { + if (fname) + { + snprintf(path, sizeof(path), "%s.io.%d.log", fname, DebugConfig.pid_); + } + else + { + snprintf(path, sizeof(path), "io.%d.log", DebugConfig.pid_); + } + + DBG_MSG("DbgInit : Opening io file [%s]...\n", path); + + DebugConfig.ioFd_ = open(path, O_APPEND | O_CREAT | O_WRONLY, + S_IREAD | S_IWRITE); + + DBG_MSG("DbgInit : Retrieved FD : [%d].\n", DebugConfig.ioFd_); + } + else + { + DebugConfig.ioFd_ = -1; + } + + // + // Save current config for other modules. + // + + DbgSaveConfig(&DebugConfig); + + // + // Init state. and state-history. file if needed. + // See State.cpp for more. + + if (flags & DBG_STATE_ENABLE) + { + DBG_MSG("DbgInit : Going to init state log with fname = [%s]...\n", fname); + + DbgSetInit(fname); + } + } + } + + DBG_LEAVE("DbgInit"); + } + + // + // Wrapper for DbgInit() working with human readable string + // as log level name. + // See DbgInit() and TranslateLogName() for more. + // + + void DbgInit(const char *fname, const char *levelName, int flags) + { + int level = DbgTranslateLevelName(levelName); + + DbgInit(fname, level, flags); + } + + // + // Generate '[pid][threadID] time' prefix. + // + // prefix - buffer, where to store created prefix (OUT). + // prefixSize - size of buffer[] in bytes (IN). + // level - log level to generate prefix if DBG_LOGLEVEL_PREFIX + // flag set (IN). + // + + void DbgGetPrefix(char *prefix, int prefixSize, int level) + { + // + // Windows. + // + + #ifdef WIN32 + { + SYSTEMTIME st; + + GetSystemTime(&st); + + snprintf(prefix, prefixSize, "[%05d][%05d] %02d:%02d:%02d %03d", + GetCurrentProcessId(), GetCurrentThreadId(), + (int) st.wHour, (int) st.wMinute, + (int) st.wSecond, (int) st.wMilliseconds); + } + + // + // Linux, Mac. + // + + #else + { + struct timeval nowMs; + + gettimeofday(&nowMs, NULL); + + int ms = nowMs.tv_usec / 1000; + + int threadId = (int) syscall (SYS_gettid); + + char buf[80]; + + struct tm localTimeBuffer; + + time_t now = time(0); + + struct tm tstruct = *localtime_r(&now, &localTimeBuffer); + + strftime(buf, sizeof(buf), "%X", &tstruct); + + snprintf(prefix, prefixSize, "[%05d][%05d] %s %03d ", + getpid(), threadId, buf, ms); + } + #endif + + // + // Add log level name if needed. + // + + if ((DebugConfig.flags_ & DBG_LOGLEVEL_PREFIX) && + level >= 0 && level <= DBG_LEVEL_MAX) + { + const char *knownNames[] = + { + "", " ERROR:", " Info:", " Debug1:", " Debug2:", " Debug3:" + }; + + strncat(prefix, knownNames[level], prefixSize); + } + } + + // + // Put formatted message into main log. + // + // TIP#1: Default log file is stderr. To redirect it to file, + // use DBG_INIT(logfile). + // + // TIP#2: To change log level in current process use + // DBG_INIT_EX(logfile, level, flags) instead of DBG_INIT. + // + // level - requested log level, if less than log level for current + // process nothing happen. See DBG_LEVEL_XXX in Debug.h (IN). + // + // fmt, ... - printf like arguments to format message (IN). + // + + void DbgMsg(int level, const char *fmt, ...) + { + char timestamp[128]; + + char *msg = NULL; + + char *timestampMsg = NULL; + + char *src = NULL; + char *dst = NULL; + + int len = 0; + int spaceLeft = 0; + + int timeStampLen = 0; + + size_t msgSize = DBG_MSG_BUF_SIZE - 1 - sizeof("\n"); + + va_list ap; + + // + // Check log level. + // + + DbgInit(NULL, -1, -1); + + if (level > DebugConfig.logLevel_) + { + DBG_MSG("DbgMsg : Rejected message level %d (current %d).\n", + level, DebugConfig.logLevel_); + + return; + } + + if (level < 0 || level > DBG_LEVEL_MAX) + { + DBG_MSG("DbgMsg : Rejected message with invalid level %d.\n", level); + + return; + } + + // + // Allocate buffers. + // + + msg = (char *) calloc(1, DBG_MSG_BUF_SIZE + 1); + timestampMsg = (char *) calloc(1, DBG_MSG_BUF_SIZE + 1); + + // + // Get time prefix. + // + + DbgGetPrefix(timestamp, sizeof(timestamp), level); + + // + // Create message. + // + + va_start(ap, fmt); + len = vsnprintf(msg, msgSize, fmt, ap); + va_end(ap); + + len = strlen(msg); + + // + // Remove end of line. + // + + while (len > 0 && (msg[len - 1] == 13 || msg[len - 1] == 10)) + { + msg[len - 1] = 0; + + len --; + } + + // + // Write error on stderr too, but only + // if logfile is not stder itself. + // + + if (DebugConfig.logFd_ != 2 && level == DBG_LEVEL_ERROR) + { + int written = -1; + + strcpy(msg + len, "\n"); + + written = write(2, msg, len + sizeof("\n") - 1); + + msg[len] = 0; + } + + // + // Don't write timestamp if logs passed to stderr and + // ERROR or INFO level set. + // + + if (DebugConfig.logFd_ == 2 && DebugConfig.logLevel_ <= DBG_LEVEL_INFO) + { + if (msg[len - 1] != 10 && msg[len - 1] != 13) + { + msg[len] = 10; + msg[len + 1] = 0; + } + + len = write(DebugConfig.logFd_, msg, strlen(msg)); + } + else + { + snprintf(timestampMsg, DBG_MSG_BUF_SIZE - 1, "%s %s", timestamp, msg); + + // + // Change "\n" to SPC(). + // + + src = timestampMsg; + dst = msg; + + timeStampLen = strlen(timestamp) + 2; + + spaceLeft = DBG_MSG_BUF_SIZE - 1; + + for (; *src; src ++) + { + switch(*src) + { + case 13: + { + break; + } + + case 10: + { + if (spaceLeft >= timeStampLen + 1) + { + dst[0] = 10; + + memset(dst + 1, ' ', timeStampLen); + + dst += timeStampLen; + + spaceLeft -= timeStampLen; + } + + break; + } + + default: + { + if (spaceLeft >= 1) + { + *dst = *src; + + dst ++; + + spaceLeft --; + } + } + } + } + + if (dst > msg && dst[-1] != 10 && dst[-1] != 13) + { + dst[0] = 10; + dst[1] = 0; + } + + len = write(DebugConfig.logFd_, msg, strlen(msg)); + } + + // + // Free buffers. + // + + if (msg) + { + free(msg); + } + + if (timestampMsg) + { + free(timestampMsg); + } + } + + // + // Put formatted message into I/O log. + // + // TIP#1: Disabled as default, use DBG_IO_ENABLE flag in DBG_INIT_EX. + // + // TIP#2: IO log is written to io. file. + // + // TIP#3: Use DBG_IO_XXX() macros. + // + // level - requested log level, if less than log level for current + // process nothing happen. See DBG_LEVEL_XXX in Debug.h (IN). + // + // fmt, ... - printf like arguments to format message (IN). + // + + void DbgIoMsg(int level, const char *fmt, ...) + { + char timestamp[128]; + + char *msg = NULL; + + char *timestampMsg = NULL; + + char *src = NULL; + char *dst = NULL; + + int len = 0; + + int timeStampLen = 0; + + size_t msgSize = DBG_MSG_BUF_SIZE - 1 - sizeof("\n"); + + va_list ap; + + // + // Check log level. + // + + DbgInit(NULL, -1, -1); + + if (level > DebugConfig.logLevel_) + { + DBG_MSG("DbgIoMsg : Rejected message level %d (current %d).\n", + level, DebugConfig.logLevel_); + + return; + } + + if (DebugConfig.ioFd_ == -1) + { + DBG_MSG("DbgIoMsg : Rejected message - IO log not opened."); + + return; + } + + if (level < 0 || level > DBG_LEVEL_MAX) + { + DBG_MSG("DbgIoMsg : Rejected message with invalid level %d.\n", level); + + return; + } + + // + // Allocate buffers. + // + + msg = (char *) calloc(1, DBG_MSG_BUF_SIZE + 1); + timestampMsg = (char *) calloc(1, DBG_MSG_BUF_SIZE + 1); + + // + // Get time prefix. + // + + DbgGetPrefix(timestamp, sizeof(timestamp), level); + + // + // Create message. + // + + va_start(ap, fmt); + len = vsnprintf(msg, msgSize, fmt, ap); + va_end(ap); + + len = strlen(msg); + + // + // Remove end of line. + // + + while (len > 0 && (msg[len - 1] == 13 || msg[len - 1] == 10)) + { + msg[len - 1] = 0; + + len --; + } + + // + // Change "\n" to SPC(). + // + + snprintf(timestampMsg, DBG_MSG_BUF_SIZE - 1, "%s %s", timestamp, msg); + + src = timestampMsg; + dst = msg; + + timeStampLen = strlen(timestamp) + 2; + + for (; *src; src ++) + { + switch(*src) + { + case 13: + { + break; + } + + case 10: + { + dst[0] = 10; + + memset(dst + 1, ' ', timeStampLen); + + dst += timeStampLen; + + break; + } + + default: + { + *dst = *src; + + dst ++; + } + } + } + + if (dst > msg && dst[-1] != 10 && dst[-1] != 13) + { + dst[0] = 10; + dst[1] = 0; + } + + len = write(DebugConfig.ioFd_, msg, strlen(msg)); + + // + // Free buffers. + // + + if (msg) + { + free(msg); + } + + if (timestampMsg) + { + free(timestampMsg); + } + } + + // + // Put formatted header into log file in form: + // + // ------------------------------------------------ + // - some printf like formatted message here - + // ------------------------------------------------ + // + // level - requested log level, if current level is less nothing happen (IN). + // fmt - printf like args to fomat message (IN). + // + + void DbgHead(int level, const char *fmt, ...) + { + int maxLen = 0; + + const int wide = 60; + + char *msg = NULL; + + char *line = NULL; + + int len = 0; + + char buf[wide + 1] = {0}; + + va_list ap; + + // + // Check log level. + // + + DbgInit(NULL, -1, -1); + + // + // Allocate buffer. + // + + msg = (char *) calloc(1, DBG_MSG_BUF_SIZE + 1); + + // + // Format message. + // + + va_start(ap, fmt); + + vsnprintf(msg, DBG_MSG_BUF_SIZE - 1, fmt, ap); + + va_end(ap); + + // + // Top. + // + + memset(buf, '-', wide); + + DbgMsg(level, "\n%s\n", buf); + + // + // Split message to lines. + // + + line = strtok((char *) msg, "\n"); + + while (line) + { + int len = strlen(line); + int skip = (wide - 2 - len) / 2; + + memset(buf + 1, ' ', skip); + memset(buf + 1 + skip + len, ' ', wide - skip - len - 2); + + memcpy(buf + 1 + skip, line, len); + + DbgMsg(level, "%s\n", buf); + + line = strtok(NULL, "\n"); + } + + // + // Bottom. + // + + memset(buf, '-', wide); + + DbgMsg(level, "%s\n \n", buf); + + // + // Free buffers. + // + + if (msg) + { + free(msg); + } + } + + // + // Dump raw buffer to log as hex values. + // + // buf - buffer to dump (IN). + // size - size of buffer in bytes (IN). + // + + void DbgDump(void *buf, int size) + { + if (DebugConfig.logLevel_ < DBG_LEVEL_DEBUG5) + { + return; + } + + string s; + + unsigned char *src = (unsigned char *) buf; + + // + // FIXME: Handle bigger buffers. + // + + size = min(size, 1024 * 32); + + for (int i = 0; i < size; i++) + { + char tmp[8]; + + if (i > 0) + { + if (i % 4 == 0) + { + s += " "; + } + + if (i % 16 == 0) + { + s += "\n"; + } + } + + snprintf(tmp, sizeof(tmp), "%02x ", (unsigned char) src[i]); + + s += tmp; + } + + DbgMsg(DBG_LEVEL_DEBUG5, s.c_str()); + } + + // + // + // + + void DbgEnterEx(int level, const char *fname, const char *fmt, ...) + { + char *msg = NULL; + + va_list ap; + + // + // Allocate buffer. + // + + msg = (char *) calloc(DBG_MSG_BUF_SIZE + 1, 1); + + // + // Format args. + // + + va_start(ap, fmt); + + vsnprintf(msg, DBG_MSG_BUF_SIZE - 1, fmt, ap); + + va_end(ap); + + // + // Print '-> fname(MSG)...' log. + // + + DbgMsg(level, "-> %s(%s)...\n", fname, msg); + + // + // Free buffer. + // + + if (msg) + { + free(msg); + } + } + + // + // Change log level for current running process. + // + // level - one of DBG_LEVEL_XXX values from Debug.h. (IN). + // + // RETURNS: 0 if OK. + // + + int DbgSetLevel(int level) + { + DbgInit(NULL, -1, -1); + + if (level < 0 || level > DBG_LEVEL_MAX) + { + DbgMsg(DBG_LEVEL_ERROR, "ERROR: Wrong log level '%d'.\n", level); + + return -1; + } + else + { + DBG_MSG("DbgSetLevel : Changed level to [%d].\n", level); + + DebugConfig.logLevel_ = level; + + // + // Save current config for other modules. + // + + DbgSaveConfig(&DebugConfig); + + return 0; + } + } + + // + // Translate human readable log level value. + // + // levelName - Name of log level to set. Supported values are: + // none, error, info, debug1, debug2 or debug3 or + // number. Names are case insensitve - INFO and info are + // the same (IN). + // + // Examples: + // DbgTranslateLevelName("info") gives 2 + // DbgTranslateLevelName("2") gives 2 + // DbgTranslateLevelName("bla") gives -1 + // + // RETURNS: One of DBG_LEVEL_XXX values from Debug.h, + // or -1 if unknown level name. + // + + int DbgTranslateLevelName(const char *levelName) + { + // + // Log level in decimal form. + // + + if (levelName && levelName[0] >= '0' && levelName[0] <= '9') + { + int level = atoi(levelName); + + if (level >= 0 && level <= DBG_LEVEL_MAX) + { + return level; + } + } + + // + // Log level in name form. + // + + else if (levelName) + { + const char *knownNames[] = {"none", "error", "info", "debug1", "debug2", "debug3", "debug4", "debug5", NULL}; + + for (int i = 0; knownNames[i]; i++) + { + if (stricmp(levelName, knownNames[i]) == 0) + { + return i; + } + } + } + + DbgMsg(DBG_LEVEL_ERROR, "ERROR: Unknown log level '%s'.\n", levelName); + + return -1; + } + + // + // Wrapper for DbgSetLevel(int) working with human readable names. + // It can be used with name readed from text config file directly. + // + // levelName - Name of log level to set. Supported values are: + // none, error, info, debug1, debug2 or debug3. + // Names are case insensitve - INFO and info are the same (IN). + // + // RETURNS: 0 if OK. + // + + int DbgSetLevel(const char *levelName) + { + int level = DbgTranslateLevelName(levelName); + + return DbgSetLevel(level); + } + + // + // Dump read/write operation into IO log. + // + // level - requested log level, if less than log level for current + // process nothing happen. See DBG_LEVEL_XXX in Debug.h (IN). + // + // operation - one of DBG_IO_OPERATION_XXX code defined in Debug.h (IN) + // + // fdType - type of underlying IO object eg. "FD", "Socket" (IN). + // + // fdId64 - 64-bit ID of related IO object eg. socket number or pointer + // to NetConnection object (IN). + // + // buf - buffer related with operation (IN). + // + // count - size of operation in bytes (IN). + // + // sourceFile - source file name, where operation is called (IN). + // + // sourceLine - number of code line in source file (IN). + // + + void DbgIoDumpOperation(int level, int operationCode, + const char *fdType, uint64_t fdId64, + const void *buf, int count, + const char *sourceFile, int sourceLine) + { + char textBuf[16 + 1]; + + int bufSize = std::max(0, std::min(16, count)); + + char *inputBuf = (char *) buf; + + const char *textBufPostfix = ""; + const char *operationText = "Unknown"; + + // + // Convert binary buffer into ASCIZ text ready to write + // with printf like function. + // + + if (operationCode == DBG_IO_OPERATION_READING) + { + bufSize = 0; + + textBuf[0] = 0; + } + else + { + for (int i = 0; i < bufSize; i++) + { + switch(inputBuf[i]) + { + case 0: + case 10: + case 13: + { + textBuf[i] = '.'; + + break; + } + + default: + { + textBuf[i] = inputBuf[i]; + } + } + } + + textBuf[bufSize] = 0; + } + + // + // Adjust operation name human readable string. + // + + switch(operationCode) + { + case DBG_IO_OPERATION_READING: operationText = "Reading"; break; + case DBG_IO_OPERATION_READED: operationText = "Readed "; break; + case DBG_IO_OPERATION_WRITING: operationText = "Writing"; break; + case DBG_IO_OPERATION_WRITTEN: operationText = "Written"; break; + } + + // + // Append '...' postfix if we print only part of buffer. + // + + if (count > 16 && operationCode != DBG_IO_OPERATION_READING) + { + textBufPostfix = "..."; + } + + // + // Dump operation into IO log. + // + + if (fdId64 > 65535) + { + DbgIoMsg(level, "%s: (%s 0x%"PRIx64", %d bytes, buf=[%s%s]) (file '%s', line %d)...\n", + operationText, fdType, fdId64, count, textBuf, textBufPostfix, sourceFile, sourceLine); + } + else + { + DbgIoMsg(level, "%s: (%s #%"PRIu64", %d bytes, buf=[%s%s]) (file '%s', line %d)...\n", + operationText, fdType, fdId64, count, textBuf, textBufPostfix, sourceFile, sourceLine); + } + } + +} /* namespace Tegeneria */ diff --git a/Source/Core/LibDebug/Debug.h b/Source/Core/LibDebug/Debug.h new file mode 100644 index 0000000..e941369 --- /dev/null +++ b/Source/Core/LibDebug/Debug.h @@ -0,0 +1,362 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Debug_H +#define Tegenaria_Core_Debug_H + +// +// Includes. +// + +#include +#include +#include + +using std::min; + +#ifdef WIN32 +# include +#else +# include + +# define GetLastError() errno +# define SetLastError(X) ((errno) = (X)) +#endif + +namespace Tegenaria +{ + // + // Macros to get printf format to print int64_t type correctly. + // + + #ifndef PRId64 + # ifdef WIN32 + # define PRId64 "I64d" // Windows32 + # else + # ifdef __x86_64__ + # define PRId64 "ld" // Linux64 + # else + # define PRId64 "lld" // Linux32 + # endif + # endif + #endif + + #ifndef PRIu64 + # ifdef WIN32 + # define PRIu64 "I64u" // Windows32 + # else + # ifdef __x86_64__ + # define PRIu64 "lu" // Linux64 + # else + # define PRIu64 "llu" // Linux32 + # endif + # endif + #endif + + #ifndef PRIx64 + # ifdef WIN32 + # define PRIx64 "I64x" // Windows32 + # else + # ifdef __x86_64__ + # define PRIx64 "lx" // Linux64 + # else + # define PRIx64 "llx" // Linux32 + # endif + # endif + #endif + + // + // Defines. + // + + // + // Log levels passed to DBG_INIT_EX or to DBG_SET_LEVEL. + // + + #define DBG_LEVEL_NONE 0 // All messages disabled. + #define DBG_LEVEL_ERROR 1 // Fatal(), Error() + #define DBG_LEVEL_INFO 2 // DBG_INFO, DBG_HEAD + #define DBG_LEVEL_DEBUG1 3 // DEBUG1, DBG_MSG1, DBG_HEAD1, DBG_MSG + #define DBG_LEVEL_DEBUG2 4 // DEBUG2, DBG_MSG2, DBG_HEAD2 + #define DBG_LEVEL_DEBUG3 5 // DEBUG3, DBG_MSG3, DBG_HEAD3 + #define DBG_LEVEL_DEBUG4 6 // DEBUG4, DBG_MSG4, DBG_HEAD4 + #define DBG_LEVEL_DEBUG5 7 // DEBUG5, DBG_MSG5, DBG_HEAD5, DBG_DUMP + + #define DBG_LEVEL_MAX DBG_LEVEL_DEBUG5 + #define DBG_LEVEL_DEFAULT DBG_LEVEL_INFO + + // + // Flags passed to DBG_INIT_EX. + // + + #define DBG_SEPARATE_PROCESSES (1 << 0) // Split logs into . files. + #define DBG_SEPARATE_THREADS (1 << 1) // Split logs into . files. + #define DBG_TRACE (1 << 2) // Use DBG_ENTER() and DBG_LEAVE(). + #define DBG_STATE_ENABLE (1 << 3) // Use DBG_SET_XXX() macros. + #define DBG_REINIT (1 << 4) // Force init once again even if inited before. + #define DBG_LOGLEVEL_PREFIX (1 << 5) // Prepend messages by 'level name:' prefix. + #define DBG_IO_ENABLE (1 << 6) // Use DBG_IO_XXX macros. + + #define DBG_FLAGS_DEFAULT 0 + + // + // Known IO operations. + // + + #define DBG_IO_OPERATION_READING 0 + #define DBG_IO_OPERATION_READED 1 + #define DBG_IO_OPERATION_WRITING 2 + #define DBG_IO_OPERATION_WRITTEN 3 + + // + // Exported functions. + // + + void DbgInit(const char *fname, int level, int flags); + void DbgInit(const char *fname, const char *levelName, int flags); + void DbgUninit(); + + void DbgMsg(int level, const char *fmt, ...); + void DbgEnterEx(int level, const char *fname, const char *fmt, ...); + void DbgHead(int level, const char *fmt, ...); + void DbgDump(void *buf, int size); + void DbgGetPrefix(char *prefix, int prefixSize); + + int DbgSetLevel(int level); + int DbgSetLevel(const char *level); + int DbgTranslateLevelName(const char *levelName); + + void DbgIoMsg(int level, const char *fmt, ...); + + void DbgIoDumpOperation(int level, int operationCode, + const char *fdType, uint64_t fdId64, + const void *buf, int count, + const char *sourceFile, int sourceLine); + + // + // General logs. + // + + #ifdef DEBUG + + #define DBG_INIT_EX(FNAME, LEVEL, FLAGS) DbgInit(FNAME, LEVEL, FLAGS) + + #define DBG_INIT(FNAME) DbgInit(FNAME, DBG_LEVEL_DEFAULT, DBG_FLAGS_DEFAULT) + + #define DBG_DUMP(BUF, SIZE) DbgDump(BUF, SIZE) + + #define DBG_SET_LEVEL(LEVEL) DbgSetLevel(LEVEL) + + // + // Wrap DbgMsg(Level, ...) into macros for different levels. + // + + #define DBG_INFO(...) DbgMsg(DBG_LEVEL_INFO, __VA_ARGS__) + + #define DEBUG1(...) DbgMsg(DBG_LEVEL_DEBUG1, __VA_ARGS__) + #define DEBUG2(...) DbgMsg(DBG_LEVEL_DEBUG2, __VA_ARGS__) + #define DEBUG3(...) DbgMsg(DBG_LEVEL_DEBUG3, __VA_ARGS__) + #define DEBUG4(...) DbgMsg(DBG_LEVEL_DEBUG4, __VA_ARGS__) + #define DEBUG5(...) DbgMsg(DBG_LEVEL_DEBUG5, __VA_ARGS__) + + #define DBG_MSG(...) DbgMsg(DBG_LEVEL_DEBUG1, __VA_ARGS__) + #define DBG_MSG1(...) DbgMsg(DBG_LEVEL_DEBUG1, __VA_ARGS__) + #define DBG_MSG2(...) DbgMsg(DBG_LEVEL_DEBUG2, __VA_ARGS__) + #define DBG_MSG3(...) DbgMsg(DBG_LEVEL_DEBUG3, __VA_ARGS__) + #define DBG_MSG4(...) DbgMsg(DBG_LEVEL_DEBUG4, __VA_ARGS__) + #define DBG_MSG5(...) DbgMsg(DBG_LEVEL_DEBUG5, __VA_ARGS__) + + #define DBG_ENTER(X) DEBUG1("-> " X "()..."); + #define DBG_ENTER1(X) DEBUG1("-> " X "()..."); + #define DBG_ENTER2(X) DEBUG2("-> " X "()..."); + #define DBG_ENTER3(X) DEBUG3("-> " X "()..."); + #define DBG_ENTER4(X) DEBUG4("-> " X "()..."); + #define DBG_ENTER5(X) DEBUG5("-> " X "()..."); + + #define DBG_LEAVE(X) DEBUG1("<- " X "()..."); + #define DBG_LEAVE1(X) DEBUG1("<- " X "()..."); + #define DBG_LEAVE2(X) DEBUG2("<- " X "()..."); + #define DBG_LEAVE3(X) DEBUG3("<- " X "()..."); + #define DBG_LEAVE4(X) DEBUG4("<- " X "()..."); + #define DBG_LEAVE5(X) DEBUG5("<- " X "()..."); + + #define DBG_ENTER_EX(X, ...) Tegenaria::DbgEnterEx(DBG_LEVEL_DEBUG1, X, __VA_ARGS__); + #define DBG_ENTER_EX1(X, ...) Tegenaria::DbgEnterEx(DBG_LEVEL_DEBUG1, X, __VA_ARGS__); + #define DBG_ENTER_EX2(X, ...) Tegenaria::DbgEnterEx(DBG_LEVEL_DEBUG2, X, __VA_ARGS__); + #define DBG_ENTER_EX3(X, ...) Tegenaria::DbgEnterEx(DBG_LEVEL_DEBUG3, X, __VA_ARGS__); + #define DBG_ENTER_EX4(X, ...) Tegenaria::DbgEnterEx(DBG_LEVEL_DEBUG4, X, __VA_ARGS__); + #define DBG_ENTER_EX5(X, ...) Tegenaria::DbgEnterEx(DBG_LEVEL_DEBUG5, X, __VA_ARGS__); + + + #define DBG_HEAD(...) Tegenaria::DbgHead(DBG_LEVEL_INFO, __VA_ARGS__); + #define DBG_HEAD1(...) Tegenaria::DbgHead(DBG_LEVEL_DEBUG1, __VA_ARGS__); + #define DBG_HEAD2(...) Tegenaria::DbgHead(DBG_LEVEL_DEBUG2, __VA_ARGS__); + #define DBG_HEAD3(...) Tegenaria::DbgHead(DBG_LEVEL_DEBUG3, __VA_ARGS__); + #define DBG_HEAD4(...) Tegenaria::DbgHead(DBG_LEVEL_DEBUG4, __VA_ARGS__); + #define DBG_HEAD5(...) Tegenaria::DbgHead(DBG_LEVEL_DEBUG5, __VA_ARGS__); + + // + // IO related logs. + // + + #define DBG_IO_MSG(...) Tegenaria::DbgIoMsg(DBG_LEVEL_DEBUG1, __VA_ARGS__) + #define DBG_IO_MSG1(...) Tegenaria::DbgIoMsg(DBG_LEVEL_DEBUG1, __VA_ARGS__) + #define DBG_IO_MSG2(...) Tegenaria::DbgIoMsg(DBG_LEVEL_DEBUG2, __VA_ARGS__) + #define DBG_IO_MSG3(...) Tegenaria::DbgIoMsg(DBG_LEVEL_DEBUG3, __VA_ARGS__) + + // + // FIXME: Handle buffer dump at level3. + // + + #define DBG_IO_WRITE_BEGIN(TYPE, ID, BUF, COUNT) Tegenaria::DbgIoDumpOperation(2, DBG_IO_OPERATION_WRITING, TYPE, int64_t(ID), BUF, COUNT, __FILE__, __LINE__) + #define DBG_IO_WRITE_END(TYPE, ID, BUF, COUNT) Tegenaria::DbgIoDumpOperation(1, DBG_IO_OPERATION_WRITTEN, TYPE, int64_t(ID), BUF, COUNT, __FILE__, __LINE__) + + #define DBG_IO_READ_BEGIN(TYPE, ID, BUF, COUNT) Tegenaria::DbgIoDumpOperation(1, DBG_IO_OPERATION_READING, TYPE, int64_t(ID), BUF, COUNT, __FILE__, __LINE__) + #define DBG_IO_READ_END(TYPE, ID, BUF, COUNT) Tegenaria::DbgIoDumpOperation(1, DBG_IO_OPERATION_READED, TYPE, int64_t(ID), BUF, COUNT, __FILE__, __LINE__) + + #define DBG_IO_CLOSE_BEGIN(TYPE, ID) DBG_IO_MSG2("Closing : (%s #%d) (file '%s', line %d)...\n", TYPE, ID, __FILE__, __LINE__) + #define DBG_IO_CLOSE_END(TYPE, ID) DBG_IO_MSG1("Closed : (%s #%d) (file '%s', line %d)...\n", TYPE, ID, __FILE__, __LINE__) + + #define DBG_IO_CANCEL(TYPE, ID) DBG_IO_MSG1("Canceled: (%s #%d) (file '%s', line %d)...\n", TYPE, ID, __FILE__, __LINE__) + + // + // No DEBUG enabled. + // Declare only ghost macros to avoid compilation debug code + // in release version. + // + + #else /* DEBUG */ + + #define DBG_INIT(FNAME) + #define DBG_INIT_EX(FNAME, LEVEL, FLAGS) + #define DBG_MSG(...) + #define DBG_HEAD(...) + #define DBG_ENTER(X) + #define DBG_ENTER_EX(X, ...) + + #define DBG_ENTER1(X) + #define DBG_ENTER2(X) + #define DBG_ENTER3(X) + #define DBG_ENTER4(X) + #define DBG_ENTER5(X) + + #define DBG_LEAVE(X) + #define DBG_LEAVE1(X) + #define DBG_LEAVE2(X) + #define DBG_LEAVE3(X) + #define DBG_LEAVE4(X) + #define DBG_LEAVE5(X) + + #define DBG_DUMP(BUF, SIZE) + + #define DBG_SET_LEVEL(LEVEL) + + #define DEBUG1(...) + #define DEBUG2(...) + #define DEBUG3(...) + #define DEBUG4(...) + #define DEBUG5(...) + + #define DBG_MSG1(...) + #define DBG_MSG2(...) + #define DBG_MSG3(...) + #define DBG_MSG4(...) + #define DBG_MSG5(...) + + #define DBG_INFO(...) + + // + // IO related logs. + // + + #define DBG_IO_WRITE_BEGIN(TYPE, ID, BUF, COUNT) + #define DBG_IO_WRITE_END(TYPE, ID, BUF, COUNT) + + #define DBG_IO_READ_BEGIN(TYPE, ID, BUF, COUNT) + #define DBG_IO_READ_END(TYPE, ID, BUF, COUNT) + + #define DBG_IO_CLOSE_BEGIN(TYPE, ID) + #define DBG_IO_CLOSE_END(TYPE, ID) + + #define DBG_IO_CANCEL(TYPE, ID) + + #endif /* DEBUG */ + + // + // Macros to catch errors. + // + + #define Error(...) {DbgMsg(DBG_LEVEL_ERROR, __VA_ARGS__);} + #define Fatal(...) {DbgMsg(DBG_LEVEL_NONE, __VA_ARGS__); exit(-1);} + + #define FAIL(X) if (X) goto fail + + #define FAILEX(X, ...) if (X) \ + { \ + int _tmp_ = GetLastError(); \ + Error(__VA_ARGS__); \ + SetLastError(_tmp_); \ + goto fail; \ + } + + // + // Monitor objects created inside process. + // See State.cpp and example02. + // + + void DbgSetAdd(const char *setName, uint64_t id, const char *name = NULL, ...); + void DbgSetAdd(const char *setName, void *ptr, const char *name = NULL, ...); + void DbgSetDel(const char *setName, uint64_t id); + void DbgSetMove(const char *dstName, const char *srcName, uint64_t id); + + void DbgSetRename(const char *dsetName, uint64_t id, const char *name = NULL, ...); + void DbgSetRename(const char *dsetName, void *ptr, const char *name = NULL, ...); + + void DbgSetDump(); + void DbgSetInit(const char *fname = NULL); + + #ifdef DEBUG_STATE + + #define DBG_SET_ADD Tegenaria::DbgSetAdd + #define DBG_SET_RENAME Tegenaria::DbgSetRename + #define DBG_SET_DEL(SET_NAME, ID) Tegenaria::DbgSetDel(SET_NAME, uint64_t(ID)) + #define DBG_SET_MOVE(DST, SRC, ID) Tegenaria::DbgSetMove(DST, SRC, uint64_t(ID)); + #define DBG_SET_INIT() Tegenaria::DbgSetInit() + #define DBG_SET_DUMP() Tegenaria::DbgSetDump() + + #else /* DEBUG_STATE */ + + #define DBG_SET_ADD(SETNAME, ID, ...) + #define DBG_SET_MOVE(DST, SRC, ID) + #define DBG_SET_DEL(SETNAME, ID) + #define DBG_SET_RENAME(SETNAME, ID, ...) + #define DBG_SET_MOVE(DST, SRC, ID) + #define DBG_SET_INIT() + #define DBG_SET_DUMP() + + #endif /* DEBUG_STATE */ + +} /* Namespace Tegenaria */ + +#endif /* Tegenaria_Core_Debug_H */ diff --git a/Source/Core/LibDebug/Example01-simple/Example01.cpp b/Source/Core/LibDebug/Example01-simple/Example01.cpp new file mode 100644 index 0000000..c7bdb8f --- /dev/null +++ b/Source/Core/LibDebug/Example01-simple/Example01.cpp @@ -0,0 +1,63 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 + +using namespace Tegenaria; + +int Function(int arg1, const char *arg2) +{ + DBG_ENTER_EX("Function", "arg1=[%d], arg2=[%s]", arg1, arg2); + + DBG_MSG("Function : Working...\n"); + + DBG_LEAVE("Function"); +} + +int main() +{ + DBG_INIT("example.log"); + DBG_HEAD("LibDebug - Example"); + + DBG_SET_LEVEL("debug3"); + + DBG_ENTER("main"); + + double test = 1.1234; + + Function(12345678, "test"); + + DBG_MSG("Hello from main.\n" + "Bla bla bla bla bla.\n" + "Bla bla bla."); + + DBG_MSG("Double : [%lf].\n", test); + + Error("ERROR: Cannot bla bla bla bla.\n" + "Error code is : 1234."); + + DBG_LEAVE("main"); + + return 0; +} diff --git a/Source/Core/LibDebug/Example01-simple/qcbuild.src b/Source/Core/LibDebug/Example01-simple/qcbuild.src new file mode 100644 index 0000000..505bffc --- /dev/null +++ b/Source/Core/LibDebug/Example01-simple/qcbuild.src @@ -0,0 +1,31 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibDebug-example-simple +CXXSRC = Example01.cpp +ISRC = + +LIBS = -ldebug +DEPENDS = LibDebug diff --git a/Source/Core/LibDebug/Example02-monitor/Example02.cpp b/Source/Core/LibDebug/Example02-monitor/Example02.cpp new file mode 100644 index 0000000..e95e3a5 --- /dev/null +++ b/Source/Core/LibDebug/Example02-monitor/Example02.cpp @@ -0,0 +1,113 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Enable monitoring process resources in state. file +// if not in qcbuild.src. +// + +#ifndef DEBUG_STATE +#define DEBUG_STATE +#endif + +#include +#include +#include + +using namespace Tegenaria; + +int main() +{ + DBG_INIT_EX("example.log", DBG_LEVEL_DEBUG3, DBG_STATE_ENABLE); + + DBG_HEAD("LibDebug - Monitoring resources example"); + + DBG_ENTER("main"); + + // + // Example sets of objects and example human readable names + // to use instead of raw pointers/IDs. + // These names are arbitral. + // + // Object name is optional, can be NULL or skipped. + // If object name not specified raw ID is showed in state file. + // + + const char *setNames[] = {"socket", "thread", "session", "process"}; + const char *objectNames[] = {"IN", "OUT", "Listen", "Master", "Slave", NULL}; + + const int setNamesSize = 4; + const int objectNamesSize = 6; + + srand(time(0)); + + // + // Simulate creating/deleting random objects. + // + + for (int i = 0; i < 32; i++) + { + // + // Randomize object type socket, thread, etc. + // + + const char *setName = setNames[rand() % setNamesSize]; + + // + // Randomize optional object name. + // + + const char *objectName = objectNames[rand() % objectNamesSize]; + + // + // Randomize object ID. For object it can be this pointer. + // + + int id = rand() % 10; + + // + // Create fake object. + // + + if (rand() % 2) + { + DBG_SET_ADD(setName, id, objectName); + } + + // + // Delete fake object. + // + + else + { + DBG_SET_DEL(setName, id); + } + } + + DBG_SET_DUMP(); + + DBG_LEAVE("main"); + + return 0; +} diff --git a/Source/Core/LibDebug/Example02-monitor/qcbuild.src b/Source/Core/LibDebug/Example02-monitor/qcbuild.src new file mode 100644 index 0000000..bdc0d3c --- /dev/null +++ b/Source/Core/LibDebug/Example02-monitor/qcbuild.src @@ -0,0 +1,31 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibDebug-example02-monitor +CXXSRC = Example02.cpp +ISRC = + +LIBS = -ldebug +DEPENDS = LibDebug diff --git a/Source/Core/LibDebug/Example03-level/Example03.cpp b/Source/Core/LibDebug/Example03-level/Example03.cpp new file mode 100644 index 0000000..74ee22f --- /dev/null +++ b/Source/Core/LibDebug/Example03-level/Example03.cpp @@ -0,0 +1,176 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + const int level = -1; // log level to set. + const int flags = -1; // combination of DBG_XXX flags from Debug.h. + const char *logFile = NULL; // write log on stderr. + + char buffer[] = {1, 2, 3, 4, 5, 6, 7, 8, + 9, 10, 11, 12, 13, 14, 15, 16, + 17, 18, 19, 20, 21, 22, 23, 24}; + + // + // Get log level from argv[1]. + // + + if (argc < 2) + { + fprintf(stderr, "Usage2: %s\n", argv[0]); + fprintf(stderr, "Usage1: %s{none|error|info|debug1|debug2|debug3|debug4|debug5}\n", argv[0]); + + goto fail; + } + + // + // Init log with given level and default flags. + // + + DBG_INIT_EX(logFile, argv[1], -1); + + DBG_ENTER("main"); + + // + // DBG_LEVEL_NONE + // + // Enabled: Fatal. + // + // Comment out to test. + // Write error message and exit whole application. + // + + /* + Fatal("FATAL ERROR: You're too big sucker to use this program.\n"); + */ + + // + // DBG_LEVEL_ERROR + // + // Enabled: Error(). + // + // Error() macro writes message twice: + // - to log file if set in DBG_INIT(). + // - to stderr. + // + + Error("ERROR: Something wrong is here.\n"); + + // + // DBG_LEVEL_INFO. + // + // Enabled: DBG_HEAD, DBG_INFO + // + + DBG_HEAD("LibDebug - log level example"); + DBG_INFO("Info: New sucker arrived."); + + // + // DBG_LEVEL_DEBUG1. + // + // Enable: DEBUG1, DBG_MSG, DBG_MSG1, + // DBG_HEAD1, + // DBG_ENTER, DBG_ENTER1, + // DBG_LEAVE, DBG_LEAVE1 + // + + DEBUG1("Debug1: Some debug1 message."); + DBG_MSG("Debug1: Another debug1 message."); + DBG_MSG1("Debug1: Another debug1 message."); + + // + // DBG_LEVEL_DEBUG2 + // + // Enable: DEBUG2, DBG_MSG2, + // DBG_HEAD2, + // DBG_ENTER2, + // DBG_LEAVE2 + // + + DEBUG2("Debug2: Some level debug2 message."); + DBG_MSG2("Debug2: Some level debug2 message."); + + // + // DBG_LEVEL_DEBUG3 + // + // Enable: + // DEBUG3, DBG_MSG3, + // DBG_HEAD3 + // DBG_ENTER3, + // DBG_LEAVE3 + // + + DEBUG3("Debug3: Some level debug3 message."); + DBG_MSG3("Debug3: Some level debug3 message."); + DBG_DUMP(buffer, sizeof(buffer)); + + // + // DBG_LEVEL_DEBUG4 + // + // Enable: + // DEBUG4, DBG_MSG4, + // DBG_HEAD4 + // DBG_ENTER4, + // DBG_LEAVE4 + // + + DEBUG4("Debug4: Some level debug4 message."); + DBG_MSG4("Debug4: Some level debug4 message."); + + // + // DBG_LEVEL_DEBUG5 + // + // Enable: + // DEBUG5, DBG_MSG5, + // DBG_HEAD5 + // DBG_ENTER5, + // DBG_LEAVE5, + // DBG_DUMP + // + + DEBUG5("Debug5: Some level debug5 message."); + DBG_MSG5("Debug5: Some level debug5 message."); + + DBG_DUMP(buffer, sizeof(buffer)); + + // + // Error handler. + // We get here from FAIL and FAILEX macros. + // + + fail: + + DBG_LEAVE("main"); + + return 0; +} diff --git a/Source/Core/LibDebug/Example03-level/qcbuild.src b/Source/Core/LibDebug/Example03-level/qcbuild.src new file mode 100644 index 0000000..9b596f1 --- /dev/null +++ b/Source/Core/LibDebug/Example03-level/qcbuild.src @@ -0,0 +1,31 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibDebug-example-level +CXXSRC = Example03.cpp +ISRC = + +LIBS = -ldebug +DEPENDS = LibDebug diff --git a/Source/Core/LibDebug/Example04-io/Example04.cpp b/Source/Core/LibDebug/Example04-io/Example04.cpp new file mode 100644 index 0000000..7949f99 --- /dev/null +++ b/Source/Core/LibDebug/Example04-io/Example04.cpp @@ -0,0 +1,85 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +#ifdef WIN32 +# include +#else +# include +#endif + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + char buf1[] = "Hello world.\nWrite something on stdin.\n"; + char buf2[1024] = {0}; + + int written = -1; + int readed = -1; + + // + // Init log with IO debug enabled. + // + + DBG_INIT_EX(NULL, "debug3", DBG_IO_ENABLE); + + // + // Write something. + // + + DBG_IO_WRITE_BEGIN("fd", 1, buf1, sizeof(buf1)); + { + written = write(1, buf1, sizeof(buf1)); + } + DBG_IO_WRITE_END("fd", 1, buf1, sizeof(buf1)); + + // + // Write something. + // + + DBG_IO_READ_BEGIN("fd", 0, buf2, sizeof(buf2)); + { + readed = read(0, buf2, sizeof(buf2)); + } + DBG_IO_READ_END("fd", 0, buf2, readed); + + // + // Close stdout. + // + + DBG_IO_CLOSE_BEGIN("fd", 1); + { + close(1); + } + DBG_IO_CLOSE_END("fd", 1); + + return 0; +} diff --git a/Source/Core/LibDebug/Example04-io/qcbuild.src b/Source/Core/LibDebug/Example04-io/qcbuild.src new file mode 100644 index 0000000..3cd5aaa --- /dev/null +++ b/Source/Core/LibDebug/Example04-io/qcbuild.src @@ -0,0 +1,31 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibDebug-example-io +CXXSRC = Example04.cpp +ISRC = + +LIBS = -ldebug +DEPENDS = LibDebug diff --git a/Source/Core/LibDebug/README b/Source/Core/LibDebug/README new file mode 100644 index 0000000..38f0890 --- /dev/null +++ b/Source/Core/LibDebug/README @@ -0,0 +1,184 @@ +I. Init +======= + + Call DBG_INIT or DBG_INIT_EX at startup. + + If not called: + + - Log fd defaulted to stderr + - Log level defaulted to DBG_LEVEL_DEFAULT (see Debug.h) + + TIP#1: You can adjust extra features by setting flags parameter + to DBG_INIT_EX. See Debug.h for possible values. + + Examples: + + DBG_INIT("dirligo.log") + DBG_INIT_EX(NULL, "debug3", -1) + DBG_INIT_EX("dirligo.log", DBG_LEVEL_INFO, DBG_STATE_ENABLE) + +II. System error codes +====================== + + GetLastError() can be used: + + - Returns native GetLastError() on Windows. + - Returns errno value on Linux. + + No #ifdef needed. + +III. Tracing code +================= + + Use DBG_ENTER or DBG_ENTER_EX to mark begin of function calls. + Use DBG_LEAVE to mark end of function calls. + + TIP#1: DBG_ENTER2, DBG_ENTER3 etc. are enabled under DEBUG2, DEBUG3 levels + only. Use them to avoid flooding log with a lot of enter/leaves + messages if one of function is called very often. + +IV. Log levels +============== + + Defined in Debug.h. + + To set log level at init use DBG_INIT_EX at startup. + + To set log level after init use DBG_SET_LEVEL or DBG_INIT_EX with + DBG_REINIT flag. + + Level name | Enabled macros + =================+=================================================== + DBG_LEVEL_NONE | Fatal quits without message + -----------------+--------------------------------------------------- + DBG_LEVEL_ERROR | Error, Fatal + -----------------+--------------------------------------------------- + DBG_LEVEL_INFO | DBG_INFO, DBG_HEAD + -----------------+--------------------------------------------------- + DBG_LEVEL_DEBUG1 | DEBUG1, DBG_MSG, DBG_MSG1, DBG_HEAD1, DBG_ENTER, + | DBG_ENTER1, DBG_LEAVE, DBG_LEAVE1 + -----------------+--------------------------------------------------- + DBG_LEVEL_DEBUG2 | DEBUG2, DBG_MSG2, DBG_HEAD2, DBG_ENTER2, DBG_LEAVE2 + -----------------+--------------------------------------------------- + DBG_LEVEL_DEBUG3 | DEBUG3, DBG_MSG3, DBG_HEAD3 DBG_ENTER3, DBG_LEAVE3 + -----------------+--------------------------------------------------- + DBG_LEVEL_DEBUG4 | DEBUG4, DBG_MSG4, DBG_HEAD4 DBG_ENTER4, DBG_LEAVE4 + -----------------+--------------------------------------------------- + DBG_LEVEL_DEBUG5 | DEBUG5, DBG_MSG5, DBG_HEAD5 DBG_ENTER5, DBG_LEAVE5 + | DBG_DUMP + +V. Monitoring process resources +=============================== + + 1. To enable state monitor init log using DBG_INIT_EX with + DBG_STATE_ENABLE flag. + + 2. To add/delete resources to monitor use DBG_SET_XXX marcos. + + DBG_SET_ADD - add object to monitor + DBG_SET_DEL - remove object from monitor + DBG_SET_MOVE - move object from one set to another (e.g. move + mutex from locking to locked). + + Example: See example02-monitor. + + TIP#1: You can assign arbitar names to object ID to debug code easier. + To do it see at: + + DBG_SET_ADD_EX - Add named object to monitor + DBG_SET_RENAME - Rename anonymous object or change existing one + +VI. Monitoring I/O activity +=========================== + + 1. To enable I/O logs use DBG_IO_ENABLE flag in DBG_INIT_EX. + + 2. I/O log is written to *.io..log file. + + 3. To monitor I/O use DBG_IO_XXX macros: + + DBG_IO_WRITE_BEGIN(TYPE, ID, BUF, COUNT) + DBG_IO_WRITE_END(TYPE, ID, BUF, COUNT) + + DBG_IO_READ_BEGIN(TYPE, ID, BUF, COUNT) + DBG_IO_READ_END(TYPE, ID, BUF, COUNT) + + DBG_IO_CLOSE_BEGIN(TYPE, ID) + DBG_IO_CLOSE_END(TYPE, ID) + + where TYPE is arbirtar string e.g. "socket". + + 4. Examples: + + // + // Write some data to FD. + // + + DBG_IO_WRITE_BEGIN("fd", fd, buf, count); + written = write(fd, buf, count); + DBG_IO_WRITE_END("fd", fd, buf, written); + + // + // Read some data from socket. + // + + DBG_IO_READ_BEGIN("socket", sock, buf, count); + readed = recv(sock, buf, count, 0); + DBG_IO_READ_END("fd", fd, buf, readed); + + // + // Close stdio file. + // + + DBG_IO_CLOSE_BEGIN("FILE*", f); + fclose(f); + DBG_IO_CLOSE_END("FILE*", f); + + See example04-io for full working code. + +VII. Catching errors +==================== + + You can use *FAIL* family macros: + + FAIL(X) - if X true jump to fail + FAILEX(X, ...) - if X true write formatted messages at DBG_LEVEL_ERROR + and jump to fail + + + TIP#1: FAIL and FAILEX does NOT affect OS error code. + You can catch it just after fail label. + + Example: + + { + int exitCode = -1; + + ... + + FAIL(write(fd, buf, count) < 0); + + FAILEX(ptr == NULL, "ERROR: Ptr cannot be NULL."); + + ... + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + // + // We fall here if function fail in middle. + // + + Error("Fail with code : %d.\n", GetLastError()); + } + + ... + } + diff --git a/Source/Core/LibDebug/State.cpp b/Source/Core/LibDebug/State.cpp new file mode 100644 index 0000000..cf03c1b --- /dev/null +++ b/Source/Core/LibDebug/State.cpp @@ -0,0 +1,733 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose : Monitor objects created inside process. +// + +// +// Inlcudes. +// + +#undef DEBUG + +#include "Config.h" +#include "Debug.h" + +namespace Tegenaria +{ + using std::map; + using std::set; + using std::multiset; + using std::string; + + // + // Used to debug itself. + // Needed for LibDebug developing only. + // + + #undef SELF_DEBUG + + #ifdef SELF_DEBUG + # undef DBG_ENTER + # undef DBG_LEAVE + # undef DBG_MSG + + # define DBG_ENTER(X) fprintf(stderr, "-> " X "()...\n") + # define DBG_LEAVE(X) fprintf(stderr, "<- " X "()...\n") + # define DBG_MSG(...) fprintf(stderr, __VA_ARGS__) + #endif + + // + // Global variables. + // + + extern DebugConfig_t DebugConfig; + + struct DbgObject + { + int count_; + + char name_[64]; + }; + + static map > DbgSet; + + #ifdef WIN32 + static HANDLE DbgSetMutex = NULL; + #else + static sem_t DbgSetMutex; + #endif + + // + // Return current thread ID on linux. + // Shipped natively on Windows. + // + + #ifndef WIN32 + inline int GetCurrentThreadId() + { + return int(syscall (SYS_gettid)); + } + #endif + + // + // Called once to init state monitor. + // Used internally only. + // + // - Init mutex to protect DbgSet variable, where list + // of created objects is stored here. + // + // - Open 'state-history.' file to write create/destroy history. + // + + void DbgSetInit(const char *fname) + { + #pragma qcbuild_set_private(1) + + DBG_ENTER("DbgSetInit"); + + DbgInit(NULL, -1, -1); + + static int firstCall = 1; + + if (firstCall == 1 && DebugConfig.flags_ & DBG_STATE_ENABLE) + { + DBG_MSG("DbgSetInit : Going to init...\n"); + + firstCall = 0; + + char path[256] = {0}; + + int flags = 0; + int pmode = 0; + + // + // Init Mutex and get curent process PID. + // + + // + // Windows. + // + + #ifdef WIN32 + { + DbgSetMutex = CreateMutex(NULL, FALSE, NULL); + } + // + // Linux, MacOS. + // + + #else + { + sem_init(&DbgSetMutex, 0, 1); + } + #endif + + DBG_MSG("DbgSetInit : flags are [0x%x].\n", DebugConfig.flags_); + + if (DebugConfig.flags_ & DBG_STATE_ENABLE) + { + // + // Open state-history. file. + // We store history of create/delete operation. + // + + if (fname) + { + snprintf(path, sizeof(path), "%s.state-history.%d.log", fname, DebugConfig.pid_); + } + else + { + snprintf(path, sizeof(path), "state-history.%d.log", DebugConfig.pid_); + } + + DBG_MSG("DbgSetInit : Opening file [%s]...\n", DebugConfig.stateHisFd_); + + DebugConfig.stateHisFd_ = open(path, O_CREAT | O_TRUNC | O_WRONLY, + S_IREAD | S_IWRITE); + + // + // Open state. file. + // We store most actual snaphot of all monitored objects + // inside current running process. + // + + if (fname) + { + snprintf(path, sizeof(path), "%s.state.%d.log", fname, DebugConfig.pid_); + } + else + { + snprintf(path, sizeof(path), "state.%d.log", DebugConfig.pid_); + } + + DBG_MSG("DbgSetInit : Opening file [%s]...\n", DebugConfig.stateFd_); + + DebugConfig.stateFd_ = open(path, O_CREAT | O_TRUNC | O_WRONLY, + S_IREAD | S_IWRITE); + } + else + { + DebugConfig.stateHisFd_ = -1; + DebugConfig.stateFd_ = -1; + } + } + + DBG_LEAVE("DbgSetInit"); + } + + // + // Lock DbgSet variable. + // We can't use LibLock, because LibLock depends on LibDebug. + // + + static void DbgSetLock() + { + #pragma qcbuild_set_private(1) + + DBG_ENTER("DbgSetLock"); + + #ifdef WIN32 + WaitForSingleObject(DbgSetMutex, INFINITE); + #else + sem_wait(&DbgSetMutex); + #endif + + DBG_LEAVE("DbgSetLock"); + } + + // + // Unlock DbgSet variable. + // We can't use LibLock, because LibLock depends on LibDebug. + // + + static void DbgSetUnlock() + { + #pragma qcbuild_set_private(1) + + DBG_ENTER("DbgSetUnlock"); + + #ifdef WIN32 + ReleaseMutex(DbgSetMutex); + #else + sem_post(&DbgSetMutex); + #endif + + DBG_LEAVE("DbgSetUnlock"); + } + + // + // Dump state of all monitored objects to state. file. + // + + void DbgSetDump() + { + if ((DebugConfig.flags_ & DBG_STATE_ENABLE) == 0) + { + DBG_MSG("Rejected DbgSetDump.\n"); + + return; + } + + char fname[1024]; + + char head[64]; + + int written = 0; + + map >::iterator it; + + string buf; + + DbgSetInit(); + + // + // Dump all objects set to file. + // + + if (DebugConfig.stateFd_ != -1) + { + DbgSetLock(); + + // + // Rewind to file begin. + // We want only one most actual state in file. + // + + lseek(DebugConfig.stateFd_, 0, SEEK_SET); + + // + // Put header on top. + // + + buf = "------------- BEGIN OF SNAPSHOT ------------\n"; + + written = write(DebugConfig.stateFd_, buf.c_str(), buf.size()); + + // + // For all object sets... + // + + for (it = DbgSet.begin(); it != DbgSet.end(); it++) + { + map ¤tSet = it -> second; + + map::iterator object; + + // + // Form ' : {' head. + // + + snprintf(head, sizeof(head), "%20s : {", it -> first.c_str()); + + buf = head; + + // + // List all objects in set. + // + + for (object = currentSet.begin(); + object != currentSet.end(); object++) + { + for (int i = 0; i < object -> second.count_; i++) + { + buf += object -> second.name_; + buf += ", "; + } + } + + buf += "}\n"; + + // + // Flush buffer to file. + // + + written = write(DebugConfig.stateFd_, buf.c_str(), buf.size()); + + buf.clear(); + } + + // + // Overwrite possible old content. + // + + buf = "-------------- END OF SNAPSHOT -------------\n"; + + buf.resize(buf.size() + 1024); + + written = write(DebugConfig.stateFd_, buf.c_str(), buf.size()); + + DbgSetUnlock(); + } + } + + // + // Add object with given ID to objects set. + // + // setName - name of target set, eg. 'socket' (IN). + // id - object id (IN). + // fmtName - optional, human readable name e.g. NETAPI#2/Mutex, + // or printf like list to format name in runtime (IN/OPT). + // + // Examples: + // DbgSetAdd("socket", 1234); + // DbgSetAdd("mutex", 0x1000, "LogFile"); + // DbgSetAdd("session", this, "NETAPI #%d/%d, id, ownerId); + // + + void DbgSetAdd(const char *setName, uint64_t id, const char *fmtName, ...) + { + if ((DebugConfig.flags_ & DBG_STATE_ENABLE) == 0) + { + DBG_MSG("Rejected DbgSetAdd.\n"); + + return; + } + + DbgSetInit(); + + if (setName) + { + DbgSetLock(); + + DbgObject &object = DbgSet[setName][id]; + + object.count_ ++; + + // + // Name specified, + // use it as printf like list. + // + + if (fmtName) + { + char name[64]; + + int written = 0; + + va_list ap; + va_start(ap, fmtName); + vsnprintf(name, sizeof(name), fmtName, ap); + va_end(ap); + + if (id < uint64_t(64000)) + { + snprintf(object.name_, sizeof(object.name_), "[#%"PRId64"!%s]", id, name); + } + else + { + snprintf(object.name_, sizeof(object.name_), "[0x%"PRIx64"!%s]", id, name); + } + } + + // + // Name not specified. + // Use ID as name. + // + + else + { + if (id < 64000) + { + snprintf(object.name_, sizeof(object.name_), "#%"PRId64, id); + } + else + { + snprintf(object.name_, sizeof(object.name_), "0x%"PRIx64, id); + } + } + + // + // Log create event into history file. + // + + if (DebugConfig.stateHisFd_ != -1) + { + char buf[256]; + + int written = 0; + + snprintf(buf, sizeof(buf), "Created %s %s by thread ID#%d.\n", + setName, object.name_, GetCurrentThreadId()); + + written = write(DebugConfig.stateHisFd_, buf, strlen(buf)); + + DbgMsg(DBG_LEVEL_DEBUG4, "%s", buf); + } + + DbgSetUnlock(); + + DbgSetDump(); + } + } + + void DbgSetAdd(const char *setName, void *ptr, const char *fmt, ...) + { + if ((DebugConfig.flags_ & DBG_STATE_ENABLE) == 0) + { + DBG_MSG("Rejected DbgSetAdd.\n"); + + return; + } + + if (fmt) + { + char name[64] = {0}; + + va_list ap; + va_start(ap, fmt); + vsnprintf(name, sizeof(name), fmt, ap); + va_end(ap); + + DbgSetAdd(setName, uint64_t(ptr), name); + } + else + { + DbgSetAdd(setName, uint64_t(ptr)); + } + } + + // + // Remove object with given ID from objects set. + // + // setName - name of target set, eg. 'socket' (IN). + // id - object id (IN). + // + // Examples: + // DbgSetDel("socket", 1234); + // DbgSetDel("session", this); + // + + void DbgSetDel(const char *setName, uint64_t id) + { + if ((DebugConfig.flags_ & DBG_STATE_ENABLE) == 0) + { + DBG_MSG("Rejected DbgSetDel.\n"); + + return; + } + + DbgSetInit(); + + if (setName) + { + int written = 0; + + DbgSetLock(); + + // + // Find object set. + // + + map ¤tSet = DbgSet[setName]; + + // + // Find object in given set. + // + + map::iterator it = currentSet.find(id); + + // + // If object exist decrease its counter. + // + + if (it != currentSet.end()) + { + it -> second.count_ --; + + // + // Log delete event into history file and main log. + // + + if (DebugConfig.stateHisFd_ != -1) + { + char buf[256]; + + snprintf(buf, sizeof(buf), "Deleted %s %s by thread ID#%d.\n", + setName, it -> second.name_, GetCurrentThreadId()); + + written = write(DebugConfig.stateHisFd_, buf, strlen(buf)); + + DbgMsg(DBG_LEVEL_DEBUG4, "%s", buf); + } + + // + // If counter decreased to 0 remove object from set. + // + + if (it -> second.count_ <= 0) + { + currentSet.erase(it); + } + } + + DbgSetUnlock(); + + DbgSetDump(); + } + } + + // + // Move object with given ID from source set to destination set. + // + // dstSet - name of destination set (IN). + // srcSet - name of source set (IN). + // id - object id (IN). + // + + void DbgSetMove(const char *dstSet, const char *srcSet, uint64_t id) + { + if ((DebugConfig.flags_ & DBG_STATE_ENABLE) == 0) + { + DBG_MSG("Rejected DbgSetMove.\n"); + + return; + } + + DbgSetInit(); + + if (srcSet && dstSet) + { + DbgSetLock(); + + // + // Find source and destination sets. + // + + map &src = DbgSet[srcSet]; + map &dst = DbgSet[dstSet]; + + // + // Find object in source. + // + + map::iterator it = src.find(id); + + // + // If object exist decrease its counter in source + // and increase in destination set. + // + + if (it != src.end()) + { + it -> second.count_ --; + + dst[id].count_ ++; + + strncpy(dst[id].name_, it -> second.name_, sizeof(dst[id].name_)); + + // + // Log move event into history file and main log. + // + + if (DebugConfig.stateHisFd_ != -1) + { + char buf[256]; + + int written = 0; + + snprintf(buf, sizeof(buf), "Moved %s from %s to %s by thread ID#%d.\n", + it -> second.name_, srcSet, dstSet, GetCurrentThreadId()); + + written = write(DebugConfig.stateHisFd_, buf, strlen(buf)); + + DbgMsg(DBG_LEVEL_DEBUG4, "%s", buf); + } + + // + // If counter decreased to 0 remove object from source set. + // + + if (it -> second.count_ <= 0) + { + src.erase(it); + } + } + + DbgSetUnlock(); + + DbgSetDump(); + } + } + + // + // Assign human readable string to object. + // + // setName - name of object set used in DbgSetAdd() before (IN). + // id - object id (IN). + // + // fmtName - new object's name to assign e.g. 'Session ID#5' or + // printf like list to format new name. See DbgSetAdd() + // for examples (IN). + // + + void DbgSetRename(const char *setName, uint64_t id, const char *fmtName, ...) + { + if ((DebugConfig.flags_ & DBG_STATE_ENABLE) == 0) + { + DBG_MSG("Rejected DbgSetRename.\n"); + + return; + } + + DbgSetInit(); + + if (setName && fmtName && DebugConfig.flags_ & DBG_STATE_ENABLE) + { + DbgSetLock(); + + map::iterator it = DbgSet[setName].find(id); + + if (it != DbgSet[setName].end()) + { + DbgObject &object = it -> second; + + char name[64]; + char oldName[64]; + + va_list ap; + va_start(ap, fmtName); + vsnprintf(name, sizeof(name), fmtName, ap); + va_end(ap); + + strcpy(oldName, object.name_); + + if (id < 64000) + { + snprintf(object.name_, sizeof(object.name_), "[#%"PRId64"!%s]", id, name); + } + else + { + snprintf(object.name_, sizeof(object.name_), "[0x%"PRIx64"!%s]", id, name); + } + + // + // Log rename event into history file and main log. + // + + if (DebugConfig.stateHisFd_ != -1) + { + char buf[256]; + + int written = 0; + + snprintf(buf, sizeof(buf), "Renamed %s from %s to %s by thread ID#%d.\n", + setName, oldName, object.name_, GetCurrentThreadId()); + + written = write(DebugConfig.stateHisFd_, buf, strlen(buf)); + + DbgMsg(DBG_LEVEL_DEBUG3, "%s", buf); + } + } + + DbgSetUnlock(); + + DbgSetDump(); + } + } + + void DbgSetRename(const char *setName, void *ptr, const char *fmt, ...) + { + if ((DebugConfig.flags_ & DBG_STATE_ENABLE) == 0) + { + DBG_MSG("Rejected DbgSetRename.\n"); + + return; + } + + if (fmt && DebugConfig.flags_ & DBG_STATE_ENABLE) + { + char name[64] = {0}; + + va_list ap; + va_start(ap, fmt); + vsnprintf(name, sizeof(name), fmt, ap); + va_end(ap); + + DbgSetRename(setName, uint64_t(ptr), "%s", name); + } + } + +} /* namespace Tegenaria */ diff --git a/Source/Core/LibDebug/qcbuild.src b/Source/Core/LibDebug/qcbuild.src new file mode 100644 index 0000000..eee8418 --- /dev/null +++ b/Source/Core/LibDebug/qcbuild.src @@ -0,0 +1,34 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibDebug +CXXSRC = Debug.cpp State.cpp Config.cpp +INC_DIR = Tegenaria +ISRC = Debug.h + +AUTHOR = Sylwester Wysocki + +PURPOSE = Write logs to file/stderr and ships common +PURPOSE += macros to catch errors. diff --git a/Source/Core/LibError/Error.cpp b/Source/Core/LibError/Error.cpp new file mode 100644 index 0000000..495747a --- /dev/null +++ b/Source/Core/LibError/Error.cpp @@ -0,0 +1,322 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include +#include +#include "Error.h" + +#ifdef WIN32 +# include +#endif + +namespace Tegenaria +{ + // + // Translate ERR_XXX codes into human readable + // string. + // + // code - one of ERR_XXX codes defined in LibServer.h (IN). + // + // RETURNS: Human readable message or empty string if + // unknown code. + // + + const char *ErrGetString(int code) + { + static struct + { + int code_; + + const char *msg_; + } + + knownCodes[] = + { + // + // 0-99 + // Generic errors. + // + + {ERR_OK, "OK"}, + {ERR_GENERIC, "Generic error"}, + {-1, "Generic error"}, + + {ERR_NOT_IMPLEMENTED, "Not implemented"}, + {ERR_NOT_FOUND, "Element not found"}, + {ERR_ALREADY_EXISTS, "Element already exists"}, + {ERR_WRONG_PARAMETER, "Invalid parameter(s)"}, + {ERR_ACCESS_DENIED, "Access denied"}, + {ERR_TIMEOUT, "Timeout reached"}, + {ERR_SYNTAX_ERROR, "Syntaxt error"}, + {ERR_WRONG_PATH, "Invalid or missing path parameter" }, + {ERR_WRONG_ALIAS, "Invalid or missing alias parameter"}, + {ERR_WRONG_USER, "Invalid or missing user parameter"}, + {ERR_WRONG_MODE, "Invalid or missing mode parameter"}, + {ERR_WRONG_PIPENAME, "Invalid or missing pipename parameter"}, + {ERR_WRONG_TEXT, "Invalid or missing text parameter"}, + {ERR_TEXT_TOO_LONG, "Text is too long"}, + {ERR_WRONG_TYPE, "Invalid or missing type parameter"}, + {ERR_WRONG_ACL, "Invalid or missing accesslist parameter"}, + {ERR_WRONG_RESULT, "Invalid or missing result parameter"}, + {ERR_ACL_TOO_LONG, "Accesslist is too long"}, + {ERR_COULD_NOT_CONNECT, "Could not connect to server"}, + {ERR_USER_CONN_FAILED, "Could not connect with remote user"}, + {ERR_PATH_NOT_FOUND, "Path not found"}, + {ERR_INVALID_SESSION_ID, "Invalid session ID"}, + {ERR_AUTH_ERROR, "Authentification error"}, + {ERR_NOT_CONNECTED, "You are not connected"}, + {ERR_FILE_TOO_BIG, "File is too big"}, + + // + // 100-149 + // Dlserver errors. + // + + {ERR_DLSERVER_START_FAILED, "Failed to initialize the IPC connection"}, + {ERR_DLSERVER, "Internal error"}, + {ERR_SELF_ACCESS, "Access to own data" }, + {ERR_ALREADY_ONLINE, "User already online"}, + {ERR_ALIAS_IN_USE, "Selected alias already in use"}, + {ERR_PATH_ALREADY_SHARED, "Selected path is already shared under another alias"}, + {ERR_ALREADY_MOUNTED, "Selected resource is already mounted"}, + {ERR_FORBIDDEN_FOR_TEMP, "Operation forbidden for not registered user"}, + {ERR_ALIAS_NOT_FOUND, "Alias not found"}, + {ERR_NOT_MOUNTED, "Selected alias is not mounted"}, + {ERR_TOO_MANY_SHARES, "Too many shares"}, + {ERR_ALIAS_TOO_LONG, "Alias too long"}, + {ERR_COULD_NOT_MOUNT, "Could not mount remote resource"}, + {ERR_DLMOUNT_FAIL, "Dirligo Mounter process failed"}, + {ERR_DLMOUNT_TIMEOUT, "Timeout while mounting"}, + {ERR_P2P_INIT_FAILED, "Could not connect with remote user"}, + {ERR_NO_P2P_SESSION, "There is no peer to peer connection with selected user"}, + {ERR_COULT_NOT_SEND_REQUEST, "Could not send request"}, + + + {ERR_MOUNT_REQUEST_ERROR, "Error while processing mount request"}, + {ERR_MOUNT_REMOTE_ERROR, "Mount failed on remote side"}, + {ERR_DLMOUNT_CREATE_ERROR, "Could not start dlmount process"}, + + {ERR_DOKAN_NOT_FOUND, "Could not found dokan driver"}, + {ERR_DOKAN_DISABLED, "Dokan driver is disabled"}, + {ERR_DOKAN_DLL_ERROR, "Could not load dokan.dll library"}, + + {ERR_DLVDRIVE_NOT_FOUND, "Could not found Dirligo Virtual Drive driver"}, + {ERR_DLVDRIVE_DISABLED, "Dirligo Virtual Drive is disabled"}, + {ERR_DLVDRIVE_DLL_ERROR, "Could not load dlvdrive.dll library"}, + + // + // 200-249 + // Data base. + // + + {ERR_DB_ERROR, "Database error"}, + {ERR_DB_ALREADY_EXISTS, "Element already exists in database"}, + {ERR_DB_NOT_FOUND, "Element not found in database"}, + {ERR_DB_FRIEND_EXISTS, "Friend alredy exists"}, + {ERR_DB_FRIEND_NOT_FOUND, "Friend not found"}, + {ERR_DB_SQL_INJECTION, "Attemp to SQL injection detected"}, + {ERR_DB_WRONG_PARAMETER, "Wrong parrameter(s) passed to database function"}, + {ERR_DB_INVITATION_EXISTS, "Friend already invitated"}, + {ERR_DB_INVITATION_NOT_FOUND, "Friend does not exists on invitation list"}, + {ERR_DB_TOO_LESS_LICENSES, "Too less licenses"}, + {ERR_DB_LOGIN_ALREADY_EXISTS, "Login already exists in database"}, + {ERR_DB_LOGIN_NOT_FOUND, "Login not found in database"}, + + // + // 250-299 + // Data validation. + // + + {ERR_VERIFY_TOO_LONG, "Parameter is too long"}, + {ERR_VERIFY_TOO_SHORT, "Parameter is too short"}, + {ERR_VERIFY_WRONG_CHAR, "Parameter contains forbidden character(s)"}, + {ERR_VERIFY_WRONG_FORMAT, "Parameter has incorrect format"}, + {ERR_VERIFY_ALIAS_FORBIDDEN, "Aliases are not allowed"}, + {ERR_VERIFY_COMMENT_FORBIDDEN, "Comments are not allowed"}, + + // + // 300-349 + // Accserver. + + {ERR_ACCSERVER, "Internal error"}, + {ERR_ACCSERVER_CAPTCHA_ERROR, "Wrong captcha"}, + {ERR_ACCSERVER_PASS_ERROR, "Incorrect or empty password"}, + {ERR_ACCSERVER_AUTH_ERROR, "Authentification failed"}, + {ERR_ACCSERVER_EMAIL_ERROR, "Incorrect or missing email address"}, + {ERR_ACCSERVER_EMAIL_EXISTS, "Email already exists in database"}, + {ERR_ACCSERVER_EMAIL_SEND_ERROR, "Cannot to send email"}, + {ERR_ACCSERVER_LOGIN_ERROR, "Incorrect or empty login"}, + {ERR_ACCSERVER_LOGIN_EXISTS, "Login already exists in database"}, + {ERR_ACCSERVER_LOGIN_NOT_EXIST, "Login not found"}, + {ERR_ACCSERVER_ALREADY_ACTIVE, "Account already activated"}, + {ERR_ACCSERVER_ACCOUNT_INACTIVE, "Account inactive"}, + + // + // 500-549 + // P2PServer codes. + // + + {ERR_P2PSERVER, "Internal error"}, + {ERR_P2PSERVER_ALREADY_ONLINE, "User is already online"}, + {ERR_P2PSERVER_USER_OFFLINE, "User is offline"}, + {ERR_P2PSERVER_AUTH_ERROR, "Authentication failed"}, + {ERR_P2PSERVER_SHARES_NOT_SAVED, "Could not save the share list"}, + {ERR_P2PSERVER_SHARES_NOT_LOADED, "Could not load share list"}, + {ERR_P2PSERVER_PACKET_PARTIAL, "Partial packet received"}, + {ERR_P2PSERVER_PACKET_INVALID, "Invalid packet received"}, + {ERR_P2PSERVER_LICENSE_INACTIVE, "License is not activated"}, + {ERR_P2PSERVER_LICENSE_EXPIRED, "License has expired"}, + {ERR_P2PSERVER_LICENSE_TRIAL_EXPIRED, "Trial period has expired"}, + + // + // End of table terminator. + // + + {0, NULL} + }; + + for (int i = 0; knownCodes[i].msg_; i++) + { + if (knownCodes[i].code_ == code) + { + return knownCodes[i].msg_; + } + } + + return "Unknown error"; + } + + // + // Get last saved system error code. + // It calls internally: + // - GetLastError() on Windows + // - errno() on Linux + // + // RETURNS: System error code saved from last system function. + // + + int ErrGetSystemError() + { + #ifdef WIN32 + return int(GetLastError()); + #else + return errno; + #endif + } + + // + // Get last saved system error as human readable string. + // It calls internally: + // - GetLastError() on Windows + // - errno on Linux + // + // RETURNS: System error code saved from last system function converted + // to human readable string (eg. "access denied"). + // + + const string ErrGetSystemErrorString() + { + string ret = "Unknown"; + + // + // Windows. + // + + #ifdef WIN32 + { + DWORD lastError = GetLastError(); + + size_t size = 0; + + char *buf = NULL; + + DWORD flags = FORMAT_MESSAGE_ALLOCATE_BUFFER + | FORMAT_MESSAGE_FROM_SYSTEM + | FORMAT_MESSAGE_IGNORE_INSERTS; + + size = FormatMessage(flags, NULL, lastError, + MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), + (LPSTR) &buf, 0, NULL); + + if (size > 0) + { + // + // Remove end of line from retrieved message. + // + + while(size > 0 && (buf[size - 1] == 13 || buf[size - 1] == 10)) + { + buf[size - 1] = 0; + + size --; + } + + // + // Pass message to caller output. + // + + ret = buf; + } + + if (buf) + { + LocalFree(buf); + } + } + + // + // Linux, MacOS. + // + // FIXME: Not implemented. + // + + #else + { + char buf[128] = "Unknown"; + + int lastError = errno; + + const char *lastErrorString = NULL; + + #ifndef __APPLE__ + lastErrorString = strerror_r(lastError, buf, sizeof(buf) - 1); + + if (lastErrorString) + { + ret = lastErrorString; + } + #else //ifndef __APPLE__ + if (strerror_r(lastError, buf, sizeof(buf) - 1) == 0) + { + ret = buf; + } + #endif //ifndef __APPLE__ + } + #endif + + return ret; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibError/Error.h b/Source/Core/LibError/Error.h new file mode 100644 index 0000000..bc350d7 --- /dev/null +++ b/Source/Core/LibError/Error.h @@ -0,0 +1,91 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Error_H +#define Tegenaria_Core_Error_H + +#include + +namespace Tegenaria +{ + using std::string; + + // + // 0-99 + // Generic errors. + // + + #define ERR_OK 0 + #define ERR_GENERIC 999 + + #define ERR_NOT_IMPLEMENTED 1 + #define ERR_NOT_FOUND 2 + #define ERR_ALREADY_EXISTS 3 + #define ERR_WRONG_PARAMETER 4 + #define ERR_ACCESS_DENIED 5 + #define ERR_TIMEOUT 6 + #define ERR_SYNTAX_ERROR 7 + #define ERR_WRONG_PATH 8 + #define ERR_WRONG_ALIAS 9 + #define ERR_WRONG_USER 10 + #define ERR_WRONG_MODE 11 + #define ERR_WRONG_PIPENAME 12 + #define ERR_WRONG_TEXT 13 + #define ERR_TEXT_TOO_LONG 14 + #define ERR_WRONG_TYPE 15 + #define ERR_WRONG_ACL 16 + #define ERR_WRONG_RESULT 17 + #define ERR_ACL_TOO_LONG 18 + #define ERR_COULD_NOT_CONNECT 19 + #define ERR_PATH_NOT_FOUND 20 + #define ERR_INVALID_SESSION_ID 21 + #define ERR_AUTH_ERROR 22 + #define ERR_NOT_CONNECTED 23 + #define ERR_FILE_TOO_BIG 24 + + // + // 250-299 + // Data validation. + // + + #define ERR_VERIFY_TOO_LONG 250 + #define ERR_VERIFY_TOO_SHORT 251 + #define ERR_VERIFY_WRONG_CHAR 252 + #define ERR_VERIFY_WRONG_FORMAT 253 + #define ERR_VERIFY_ALIAS_FORBIDDEN 254 + #define ERR_VERIFY_COMMENT_FORBIDDEN 255 + + // + // Exported functions. + // + + const char *ErrGetString(int code); + + int ErrGetSystemError(); + + const string ErrGetSystemErrorString(); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Error_H */ diff --git a/Source/Core/LibError/Example01-system-codes/Main.cpp b/Source/Core/LibError/Example01-system-codes/Main.cpp new file mode 100644 index 0000000..05d3786 --- /dev/null +++ b/Source/Core/LibError/Example01-system-codes/Main.cpp @@ -0,0 +1,73 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +int main(int argc, char **argv) +{ + FILE *f = NULL; + + const char *fname = NULL; + + if (argc < 2) + { + fprintf(stderr, "Usage is: %s \n", argv[0]); + + return -1; + } + + fname = argv[1]; + + // + // Try open file. + // + + f = fopen(fname, "r"); + + // + // Error, put system code to user. + // + + if (f == NULL) + { + printf("Can't open '%s' file. System error is: '%s' (%d).\n", + fname, ErrGetSystemErrorString().c_str(), ErrGetSystemError()); + } + + // + // Success, file opened. + // + + else + { + printf("File '%s' opened.\n", fname); + + fclose(f); + } + + return 0; +} diff --git a/Source/Core/LibError/Example01-system-codes/qcbuild.src b/Source/Core/LibError/Example01-system-codes/qcbuild.src new file mode 100644 index 0000000..b1eddcd --- /dev/null +++ b/Source/Core/LibError/Example01-system-codes/qcbuild.src @@ -0,0 +1,33 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibError-example01-system-codes + +CXXSRC = Main.cpp + +LIBS = -lerror +DEPENDS = LibError + +AUTHOR = Sylwester Wysocki diff --git a/Source/Core/LibError/qcbuild.src b/Source/Core/LibError/qcbuild.src new file mode 100644 index 0000000..2b67565 --- /dev/null +++ b/Source/Core/LibError/qcbuild.src @@ -0,0 +1,34 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibError + +INC_DIR = Tegenaria +ISRC = Error.h +CXXSRC = Error.cpp + +AUTHOR = Sylwester Wysocki (sw143@wp.pl) + +PURPOSE = Unify error codes, translate error codes to human readable strings. diff --git a/Source/Core/LibFile/File.cpp b/Source/Core/LibFile/File.cpp new file mode 100644 index 0000000..51c8d7e --- /dev/null +++ b/Source/Core/LibFile/File.cpp @@ -0,0 +1,1499 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include +#include +#include +#include +#include + +#ifdef WIN32 +#include +#include +#endif + +#include +#include "File.h" +#include "Internal.h" + +namespace Tegenaria +{ + using namespace std; + + // + // Load file to new allocate buffer. + // + // fname - name of file to load (IN). + // readed - number of bytes allocated and readed (OUT/OPT). + // + // RETURNS: New allocated buffer or NULL if fail. + // + + char *FileLoad(const char *fname, int *readed) + { + char *buf = NULL; + + int fsize = 0; + + FILE *f = NULL; + + //DBG_MSG("LoadFile(\"%s\")...\n", fname); + + // + // Open file. + // + + f = fopen(fname, "rb"); + + FAIL(f == NULL); + + // + // Get file size. + // + + FAIL(fseek(f, 0, 2) < 0); + + fsize = ftell(f); + + // + // Allocate buffer. + // + + buf = (char *) malloc(sizeof(char) * (fsize + 2)); + + FAIL(buf == NULL); + + // + // Read file. + // + + fseek(f, 0, 0); + + if (fsize > 0) + { + FAIL(fread(buf, fsize, 1, f) != 1); + + buf[fsize] = 0; + buf[fsize + 1] = 0; + } + else + { + free(buf); + + buf = NULL; + } + + fclose(f); + + if (readed) + { + *readed = fsize; + } + + return buf; + + fail: + + return NULL; + } + + // + // Make file list in given directory. + // + // path - directory where to search (IN) + // mask - file mask (e.g. '*.dat') (IN) + // files - output file list (OUT) + // recursive - search also in subdirs, if set to true (IN) + // flags - combination of FILE_XXX flags defined in File.h (IN/OPT). + // + // RETURNS: 0 if OK + // + + int ListFiles(string path, string mask, vector& files, + bool recursive, unsigned int flags) + { + // + // Windows. + // + + #ifdef WIN32 + + HANDLE hFind = INVALID_HANDLE_VALUE; + + WIN32_FIND_DATA ffd; + + string spec; + + stack directories; + + directories.push(path); + + files.clear(); + + while (!directories.empty()) + { + path = directories.top(); + + spec = path + "\\" + mask; + + directories.pop(); + + hFind = FindFirstFile(spec.c_str(), &ffd); + + if (hFind == INVALID_HANDLE_VALUE) + { + return -1; + } + + do + { + if (strcmp(ffd.cFileName, ".") != 0 && strcmp(ffd.cFileName, "..") != 0) + { + if (recursive && ffd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) + { + directories.push(path + "\\" + ffd.cFileName); + } + else if ((ffd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) == 0) + { + files.push_back(ffd.cFileName); + } + } + } while (FindNextFile(hFind, &ffd) != 0); + + if (GetLastError() != ERROR_NO_MORE_FILES) + { + FindClose(hFind); + + return -1; + } + + FindClose(hFind); + + hFind = INVALID_HANDLE_VALUE; + } + + return 0; + + // + // Linux, Mac. + // + + #else + + fprintf(stderr, "ERROR: ListFiles() is not implemented yet.\n"); + + return -1; + + #endif + } + + // + // Make directories list in given directory. + // + // path - directory where to search (IN) + // mask - file mask (IN) + // files - output file list (OUT) + // recursive - list subdirs if true (IN) + // flags - combination of FILE_XXX flags defined in File.h (IN/OPT). + // + // RETURNS: 0 if OK + // + + int ListDirs(string path, string mask, vector& dirs, + bool recursive, unsigned int flags) + { + // + // Windows. + // + + #ifdef WIN32 + + HANDLE hFind = INVALID_HANDLE_VALUE; + + WIN32_FIND_DATA ffd; + + string spec; + + int skip = path.size(); + + stack directories; + + directories.push(path); + + dirs.clear(); + + while (!directories.empty()) + { + path = directories.top(); + + spec = path + "\\" + mask; + + directories.pop(); + + hFind = FindFirstFile(spec.c_str(), &ffd); + + if (hFind == INVALID_HANDLE_VALUE) + { + return -1; + } + + do + { + // + // Skip hidden if needed. + // + + if (flags & FILE_SKIP_HIDDEN) + { + if (ffd.dwFileAttributes == FILE_ATTRIBUTE_HIDDEN) + { + continue; + } + + if (ffd.cFileName[0] == '.') + { + continue; + } + } + + // + // Parse dir. + // + + if (strcmp(ffd.cFileName, ".") != 0 && strcmp(ffd.cFileName, "..") != 0) + { + if (ffd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) + { + if (path.size() == skip) + { + dirs.push_back(ffd.cFileName); + } + else + { + dirs.push_back(path.substr(skip + 1) + "\\" + ffd.cFileName); + } + + if (recursive) + { + directories.push(path + "\\" + ffd.cFileName); + } + } + } + } while (FindNextFile(hFind, &ffd) != 0); + + if (GetLastError() != ERROR_NO_MORE_FILES) + { + FindClose(hFind); + + return -1; + } + + FindClose(hFind); + + hFind = INVALID_HANDLE_VALUE; + } + + return 0; + + // + // Linux, MacOS. + // + + #else + + string spec; + + int skip = path.size(); + + stack directories; + + directories.push(path); + + dirs.clear(); + + while (!directories.empty()) + { + path = directories.top(); + + spec = path + "/"; + + directories.pop(); + + DIR *dir = opendir(spec.c_str()); + + if (dir == NULL) + { + fprintf(stderr, "ERROR: Cannot open directory '%s'.\n", spec.c_str()); + + return -1; + } + + // + // + // + + struct dirent *direntp = NULL; + + while ((direntp = readdir(dir)) != NULL) + { + // + // Skip hidden directories if needed. + // + + if (flags & FILE_SKIP_HIDDEN && direntp -> d_name[0] == '.') + { + continue; + } + + // + // Parse directory. + // + + if (strcmp(direntp -> d_name, ".") != 0 && strcmp(direntp -> d_name, "..") != 0) + { + struct stat stat_buf = {0}; + + int ret = stat((path + "/" + direntp -> d_name).c_str(), &stat_buf); + + if (S_ISDIR(stat_buf.st_mode)) + { + if (path.size() == skip) + { + dirs.push_back(direntp -> d_name); + } + else + { + dirs.push_back(path.substr(skip + 1) + "/" + direntp -> d_name); + } + + if (recursive) + { + directories.push(path + "/" + direntp -> d_name); + } + } + } + } + + closedir(dir); + } + + return 0; + + #endif + } + + // + // Compare two files. + // + // stat - result of comparison (1 if equal, 0 if not) (OUT). + // fname1 - first file to compare (IN). + // fname2 - second file to compare (IN). + // + // RETURNS: 0 if OK. + // + + int FileCompare(int &stat, const string &fname1, const string &fname2) + { + int exitCode = -1; + + ifstream f1(fname1.c_str()); + ifstream f2(fname2.c_str()); + + FAIL(f1.fail()); + FAIL(f2.fail()); + + stat = 1; + + while(f1.good() || f2.good()) + { + char c1; + + char c2; + + f1.get(c1); + f2.get(c2); + + if (c1 != c2) + { + stat = 0; + + break; + } + } + + exitCode = 0; + + fail: + + f1.close(); + f2.close(); + + return exitCode; + } + + // + // Check does file or directory exists on disk. + // + // path - path to check (IN). + // + // RETURNS: 1 if file exists. + // + + int FileExists(const string &path) + { + int exist = 0; + + struct stat buf; + + if (stat(path.c_str(), &buf) == 0) + { + exist = 1; + + DEBUG3("FileExists: Path [%s] exists.\n", path.c_str()); + } + else + { + DEBUG3("FileExists: Path [%s] does not exists.\n", path.c_str()); + } + + return exist; + } + + // + // Wait until given file exists on disk. + // + // fname - file name to wait (IN). + // + // timeout - maximum allowed wait time in ms. Defaulted to + // infinite if skipped (IN/OPT). + // + // RETURNS: 0 if file found within timeout, + // -1 if timeout reached. + // + + int FileWait(const char *fname, int timeout) + { + DBG_ENTER("FileWait"); + + int exitCode = -1; + + // + // Infinite loop. + // + + if (timeout < 0) + { + while(FileExists(fname) == 0) + { + #ifdef WIN32 + Sleep(10); + #else + usleep(10000); + #endif + } + } + + // + // Timeouted loop. + // + + else + { + while(timeout > 0 && FileExists(fname) == 0) + { + #ifdef WIN32 + Sleep(10); + #else + usleep(10000); + #endif + + timeout -= 10; + } + + FAILEX(timeout <= 0, "ERROR: Timeout while waiting for [%s] file.\n", fname); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE("FileWait"); + + return exitCode; + } + + // + // Remove file from disk. + // + // fname - path to file which we want to delete (IN). + // + // RETURNS: 0 if OK. + // + + int FileDelete(const char *fname) + { + int exitCode = -1; + + #ifdef WIN32 + { + FAIL(DeleteFile(fname) == FALSE); + } + #else + { + FAIL(unlink(fname) != 0); + } + #endif + + DEBUG2("FileDelete: File [%s] deleted.\n", fname); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot delete file [%s]. Error is %d.\n", fname, GetLastError()); + } + + return exitCode; + } + + // + // Create directory recursively at one call. + // + // target - path to create (e.g. 'A/B/C/D') (IN). + // + // RETURNS: 0 if OK. + // + + int FileCreateRecursiveDir(const string &target) + { + int exitCode = -1; + + string path = target + "/"; + + for (int i = 0; i < path.size(); i++) + { + if (path[i] == '\\' || path[i] == '/') + { + path[i] = 0; + + // + // Windows. + // + + #ifdef WIN32 + { + if (path[0] && FileExists(path.c_str()) == 0) + { + FAILEX(CreateDirectory(path.c_str(), NULL) == FALSE, + "ERROR: Cannot create [%s] dir.\n", path.c_str()); + } + + path[i] = '\\'; + } + + // + // Linux, MacOS. + // + + #else + { + if (path[0] && FileExists(path.c_str()) == 0) + { + FAILEX(mkdir(path.c_str(), 0755), + "ERROR: Cannot create [%s] dir.\n", path.c_str()); + } + + path[i] = '/'; + } + #endif + + + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create [%s] path. Error code is %d.\n", + target.c_str(), GetLastError()); + } + + return exitCode; + } + + // + // Create single directory. + // TIP#1: Use FileCreateRecursiveDir() to create whole path recursively. + // + // path - target path to create (IN). + // quiet - do not write error message if set to 1 (IN). + // + // RETURNS: 0 if OK. + // + + + int FileCreateDir(const string &path, int quiet) + { + int exitCode = -1; + + #ifdef WIN32 + { + FAIL(CreateDirectory(path.c_str(), NULL) == FALSE); + } + #else + { + FAIL(mkdir(path.c_str(), 0755)); + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode && quiet == 0) + { + Error("ERROR: Cannot create [%s] dir." + "Error code is : %d.\n", path.c_str(), GetLastError()); + } + + return exitCode; + } + + // + // Save buffer to file. If file already exists will be overwritten. + // + // fname - path to output file (IN). + // buf - buffer to dump (IN). + // size - size of buf[] buffer in bytes (IN). + // + // RETURNS: 0 if OK. + // + + int FileSave(const char *fname, const char *buf, int size) + { + int exitCode = -1; + + FILE *f = fopen(fname, "wb+"); + + FAIL(f == NULL); + + fwrite(buf, size, 1, f); + + exitCode = 0; + + fail: + + if (f) + { + fclose(f); + } + + return exitCode; + } + + // + // Get current working directory. + // + // path - buffer where to store retrieved directory (OUT). + // pathSize - size of path[] buffer in bytes (IN). + // + // RETURNS: 0 if OK. + // + + int FileGetDir(char *path, int pathSize) + { + int exitCode = -1; + + #ifdef WIN32 + FAIL(GetCurrentDirectory(pathSize - 1, path) == FALSE); + #else + FAIL(getcwd(path, pathSize - 1) == NULL); + #endif + + // + // Error handler. + // + + fail: + + return exitCode; + } + + // + // Change current working directory. + // + // path - new working directory to set (e.g. 'c:/tmp') (IN). + // + // RETURN: 0 if OK. + // + + int FileSetDir(const char *path) + { + int exitCode = -1; + + FAIL(path == NULL); + + if (path[0]) + { + #ifdef WIN32 + FAIL(SetCurrentDirectory(path) == FALSE); + #else + FAIL(chdir(path)); + #endif + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot set working directory to '%s'.\n", path); + } + + return exitCode; + } + + // + // Get root filename from path, eg. it retrieve + // 'file' from 'c:/tmp/file.dat'. + // + // path - path to split (IN). + // + // RETURNS: Root filename part or empty string if error. + // + + string FileGetRootName(const string &path) + { + #ifdef WIN32 + + char root[MAX_PATH + 1] = ""; + + _splitpath(path.c_str(), NULL, NULL, root, NULL); + + return string(root); + + #else + + fprintf(stderr, "ERROR: Not implemented.\n"); + + return ""; + + #endif + } + + // + // Genearete temporary filename (WITHOUT creating the file). + // Ouput path has format : '/XXX.YYY', + // where XXX.YYY are generated unique name and extension. + // + // baseDir - directory, where to store file. System temp will be + // used if skipped (IN/OPT). + // + // prefix - prefix to add before filename (IN/OPT). + // + // RETURNS: Abosolute path to temporary file or + // empty string if error. + // + // + + string FileCreateTempName(const char *baseDir, const char *prefix) + { + #ifdef WIN32 + + int exitCode = -1; + + char base[MAX_PATH + 1] = {0}; + char path[MAX_PATH + 1] = {0}; + char fname[MAX_PATH + 1] = {0}; + + if (baseDir == NULL) + { + GetTempPath(MAX_PATH, base); + } + else + { + strncpy(base, baseDir, MAX_PATH); + } + + FAIL(GetTempFileName(base, prefix, 0, fname) == 0); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + fprintf(stderr, "ERROR: Cannot crate temp name.\n" + "Error code is : %d.\n", GetLastError()); + } + + return string(fname); + + #else + + fprintf(stderr, "ERROR: Not implemented.\n"); + + return ""; + + #endif + } + + int CanonizePath(string &path) + { + #ifdef WIN32 + + char fullPath[MAX_PATH + 1]; + + if (GetFullPathName(path.c_str(), MAX_PATH, fullPath, NULL) == FALSE) + { + return -1; + } + + path = fullPath; + + return 0; + + #else + + return -1; + + #endif + }; + + // + // Retrieve size of given file. + // + // fname - path to check (e.g. 'c:/tmp/test.dat') (IN). + // + // RETURNS: Size of file in bytes or -1 if error. + // + + int FileSize(const char *fname) + { + int fsize = -1; + + FILE *f = NULL; + + // + // Open file. + // + + f = fopen(fname, "rb"); + + FAIL(f == NULL); + + // + // Get file size. + // + + FAIL(fseek(f, 0, 2) < 0); + + fsize = ftell(f); + + fail: + + if (fsize < 0) + { + fprintf(stderr, "ERROR: Cannot get size of [%s] file.\n", fname); + } + + if (f) + { + fclose(f); + } + + return fsize; + } + + // + // Normalize slashes in path to '/' or '\\'. + // + // path - path to normalize (IN/OUT). + // slash - new slash character to use ('/' or '\\') (IN). + // + + void FileNormalizeSlash(char *path, char slash) + { + // + // Remove extra slash at the end. + // + + int pathLen = strlen(path); + + while((pathLen > 0) && ((path[pathLen - 1] == '\\') || (path[pathLen - 1] == '/'))) + { + path[pathLen - 1] = 0; + + pathLen --; + } + + // + // Normalize slashes. + // + + for (int i = 0; path[i]; i++) + { + if (path[i] == '/' || path[i] == '\\') + { + path[i] = slash; + } + } + } + + // + // Normalize slashes in widechar path to L'/' or L'\\'. + // + // path - path to normalize (IN/OUT). + // slash - new slash character to use (L'/' or L'\\') (IN). + // + + void FileNormalizeSlash(wchar_t *path, wchar_t slash) + { + DBG_ENTER3("FileNormalizeSlash"); + + // + // Remove extra slash at the end. + // + + int pathLen = wcslen(path); + + while((pathLen > 1) && ((path[pathLen - 1] == L'\\') || (path[pathLen - 1] == L'/'))) + { + path[pathLen - 1] = 0; + + pathLen --; + } + + // + // Normalize slashes. + // + + for (int i = 0; path[i]; i++) + { + if (path[i] == L'/' || path[i] == L'\\') + { + path[i] = slash; + } + } + + DBG_LEAVE3("FileNormalizeSlash"); + } + + #ifdef WIN32 + + // + // Retrieve first free drive letter. + // + // RETURNS: First available letter (e.g. 'J'), + // or 0 if error. + // + + const char FileGetFirstFreeLetter() + { + DWORD drives = GetLogicalDrives(); + + for (int i = 3; i < 26; i++) + { + if ((drives & (1 << i)) == 0) + { + DEBUG1("First free drive letter is [%c].\n", 'A' + i); + + return 'A' + i; + } + } + + Error("ERROR: Can't find free drive letter.\n"); + + return 0; + } + + #endif /* WIN32 */ + + // + // Dump C++ string to binary file. + // It writes to file xx xx xx xx ss ss ss ss ss .... + // where: + // + // xx - little endian dword (4 bytes) length of string without 0 + // ss - variable string data + // + // f - C stream, where to write data (IN). + // str - C++ string to dump (IN). + // + // RETURNS: 0 if OK. + // + + int FileWriteString(FILE *f, const string &str) + { + int exitCode = -1; + + int len = str.size(); + + FAIL(fwrite(&len, sizeof(len), 1, f) != 1); + + if (len > 0) + { + FAIL(fwrite(&str[0], len, 1, f) != 1); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("Cannot write '%s' string to file.\n", str.c_str()); + } + + return exitCode; + } + + // + // Load C++ string from binary file, stored by FileWriteString() before. + // + // f - C stream, where to read data from (IN). + // str - C++ string where to load data (IN). + // + // RETURNS: 0 if OK. + // + + int FileReadString(FILE *f, string &str) + { + int exitCode = -1; + + int len = 0;; + + FAIL(fread(&len, sizeof(len), 1, f) != 1); + + if (len > 0) + { + str.resize(len); + + FAIL(fread(&str[0], len, 1, f) != 1); + } + else + { + str.clear(); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("Cannot read string from file.\n"); + } + + return exitCode; + } + + // + // Return system TEMP directory. + // + + const string FileGetTempDir() + { + string tmp; + + // + // Windows. + // + + #ifdef WIN32 + { + char path[MAX_PATH + 1] = {0}; + + GetTempPath(MAX_PATH, path); + + tmp = path; + } + + // + // Linux. + // + + #else + { + tmp = "/tmp"; + } + #endif + + return tmp.c_str(); + } + + // + // + // + + int FileReadInt16(FILE *f, int16_t *rv) + { + int exitCode = -1; + + FAILEX(f == NULL, "ERROR: Null file pointer at FileReadInt16().\n"); + FAILEX(rv == NULL, "ERROR: Null rv pointer at FileReadInt16().\n"); + + FAIL(fread(rv, 2, 1, f) != 1); + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Can't read 16-bit integer from file."); + } + + return exitCode; + } + + int FileReadInt32(FILE *f, int32_t *rv) + { + int exitCode = -1; + + FAILEX(f == NULL, "ERROR: Null file pointer at FileReadInt32().\n"); + FAILEX(rv == NULL, "ERROR: Null rv pointer at FileReadInt32().\n"); + + FAIL(fread(rv, 4, 1, f) != 1); + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Can't read 32-bit integer from file."); + } + + return exitCode; + } + + int FileReadInt64(FILE *f, int64_t *rv) + { + int exitCode = -1; + + FAILEX(f == NULL, "ERROR: Null file pointer at FileReadInt64().\n"); + FAILEX(rv == NULL, "ERROR: Null rv pointer at FileReadInt64().\n"); + + FAIL(fread(rv, 8, 1, f) != 1); + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Can't read 64-bit integer from file."); + } + + return exitCode; + } + + int FileReadFloat(FILE *f, float *rv) + { + int exitCode = -1; + + FAILEX(f == NULL, "ERROR: Null file pointer at FileReadInt32().\n"); + FAILEX(rv == NULL, "ERROR: Null rv pointer at FileReadInt32().\n"); + + FAIL(fread(rv, sizeof(float), 1, f) != 1); + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Can't read single-precision float from file."); + } + + return exitCode; + } + + int FileSkipBytes(FILE *f, int numberOfBytesToSkip) + { + int exitCode = -1; + + FAILEX(f == NULL, "ERROR: Null file pointer at FileSkipBytes().\n"); + + FAIL(fseek(f, numberOfBytesToSkip, SEEK_CUR)); + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Can't skip '%d' bytes from file.", numberOfBytesToSkip); + } + + return exitCode; + } + + int FileReadDouble(FILE *f, double *rv) + { + int exitCode = -1; + + FAILEX(f == NULL, "ERROR: Null file pointer at FileReadInt32().\n"); + FAILEX(rv == NULL, "ERROR: Null rv pointer at FileReadInt32().\n"); + + FAIL(fread(rv, sizeof(double), 1, f) != 1); + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Can't read double-precision float from file."); + } + + return exitCode; + } + + // + // Read line from C stream WITHOUT end of line character. + // + // buf - destination buffer, where to put readed data (OUT). + // bufSize - buf[] size in bytes (IN). + // f - C stream retrievead from fopen before (IN). + // readed - number of bytes readed (without end of line) (OUT/OPT). + // trim - remove white space from left and right side if set to 1 (IN/OPT). + // + // RETURNS: pointer to first byte of line + // or NULL if error. + // + + char *FileGetLine(char *buf, int bufSize, FILE *f, int *readed, int trim) + { + char *ret = NULL; + + int len = 0; + + // + // Read line. + // + + FAIL(fgets(buf, bufSize - 1, f) == NULL); + + // + // Remove end of line character. + // + + len = strlen(buf); + + while(len > 0 && ((buf[len - 1] == 10) || (buf[len - 1] == 13))) + { + buf[len - 1] = 0; + len --; + } + + // + // Trim buffer if needed. + // + + if (trim) + { + // + // Left side. + // + + while(isspace(*buf) && (*buf)) + { + buf ++; + len --; + } + + // + // Right side. + // + + while(len > 0 && isspace(buf[len - 1])) + { + buf[len - 1] = 0; + len --; + } + } + + // + // Put line length to caller if needed. + // + + if (readed) + { + *readed = len; + } + + ret = buf; + + // + // Error handler. + // + + fail: + + return ret; + } + + // + // Get root directory from path. + // + // Example input : "Lib/LibFile" + // Example output : "Lib" + // + + string FilePathGetTopDir(const string &path) + { + string rv; + + const int SPLIT_IDX_INVALID = 1000000; + + int firstSlashIdx = path.find('/'); + int firstBackSlashIdx = path.find('\\'); + int splitIdx = SPLIT_IDX_INVALID; + + if (firstSlashIdx != string::npos && firstSlashIdx < splitIdx) + { + splitIdx = firstSlashIdx; + } + + if (firstBackSlashIdx != string::npos && firstBackSlashIdx < splitIdx) + { + splitIdx = firstBackSlashIdx; + } + + if (splitIdx != SPLIT_IDX_INVALID) + { + rv = path.substr(0, splitIdx); + } + else + { + rv = path; + } + + return rv; + } + + // + // Get directory name at given deep level inside path. + // + // Example path : "Source/Lib/LibFile" + // Example deep : 1 + // Example returns : Lib + // + + string FilePathGetDirAtDeep(const string &path, int deep) + { + string rv; + + int beginIdx = -1; + int endIdx = -1; + int slashCnt = 0; + + for (int i = 0; i < path.size(); i++) + { + if (path[i] == '\\' || path[i] == '/') + { + slashCnt++; + + if (slashCnt == deep) + { + beginIdx = i + 1; + } + else if (slashCnt == deep + 1) + { + endIdx = i; + + break; + } + } + } + + if (beginIdx != -1 && endIdx != -1) + { + rv = path.substr(beginIdx, endIdx - beginIdx); + } + + return rv; + } + + // + // Returns UNIX timestamp of last file modification or -1 if error. + // + + int FileGetLastModificationTimestamp(const char *path) + { + int rv = -1; + + struct stat attr; + + if (path && (stat(path, &attr) == 0)) + { + rv = attr.st_mtime; + } + + return rv; + } + +} /* namespace Tegenaria */ diff --git a/Source/Core/LibFile/File.h b/Source/Core/LibFile/File.h new file mode 100644 index 0000000..e4d9918 --- /dev/null +++ b/Source/Core/LibFile/File.h @@ -0,0 +1,154 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_File_H +#define Tegenaria_Core_File_H + +#include +#include + +namespace Tegenaria +{ + using std::vector; + using std::string; + + // + // Defines. + // + + #define FILE_SKIP_HIDDEN (1 << 0) // Skip hidden files in ListFiles(). + + // + // General file manegement. + // + + char *FileLoad(const char *fname, int *readed = NULL); + + int FileSize(const char *fname); + + int FileSave(const char *fname, const char *buf, int size); + + int ListFiles(string path, string mask, vector& files, + bool recursive, unsigned int flags = 0); + + int ListDirs(string path, string mask, vector& dirs, + bool recursive, unsigned int flags = 0); + + int FileCompare(int &stat, const string &fname1, const string &fname2); + + int FileExists(const string &fname); + + int FileWait(const char *fname, int timeout = -1); + + int FileDelete(const char *fname); + + // + // Paths manegement. + // + + int FileGetDir(char *path, int pathSize); + + int FileSetDir(const char *path); + + int FileCreateRecursiveDir(const string &path); + + int FileCreateDir(const string &path, int quiet = 0); + + string FileCreateTempName(const char *baseDir = NULL, const char *prefix = NULL); + + string FileGetRootName(const string &path); + + const string FileGetTempDir(); + + int CanonizePath(string &path); + + string FilePathGetTopDir(const string &path); + string FilePathGetDirAtDeep(const string &path, int deep); + + void FileNormalizeSlash(char *path, char slash = '/'); + void FileNormalizeSlash(wchar_t *path, wchar_t slash = L'/'); + + // + // Time functions. + // + + int FileGetLastModificationTimestamp(const char *path); + + // + // Load/store binary data. + // + + int FileWriteString(FILE *f, const string &str); + int FileSkipBytes(FILE *f, int numberOfBytesToSkip); + int FileReadString(FILE *f, string &str); + int FileReadInt16(FILE *f, int16_t *rv); + int FileReadInt32(FILE *f, int32_t *rv); + int FileReadInt64(FILE *f, int64_t *rv); + int FileReadFloat(FILE *f, float *rv); + int FileReadDouble(FILE *f, double *rv); + + // + // High level IO for text files. + // + + char *FileGetLine(char *buf, int bufSize, FILE *f, int *readed, int trim); + + // + // Transacted I/O. + // + + struct TFILE; + + // + // Transacted versions of stdio functions. + // + // FILE* -> TFILE * + // fopen -> tfopen + // fclose -> tfclose + // fprintf -> tfprintf + // fscanf -> tfscanf + // fwrite -> tfwrite + // fread -> tfread + // + + TFILE *tfopen(const char *fname, const char *mode); + + void tfclose(TFILE *f); + + int FileRecoverFailedIO(const char *directory); + + #define tfprintf(F, ...) fprintf(F -> ftemp_, __VA_ARGS__) + #define tfscanf(F, ...) fscanf(F -> ftemp_, __VA_ARGS__) + #define tfwrite(BUF, SIZE, COUNT, F) fwrite(BUF, SIZE, COUNT, F -> ftemp_) + #define tfread(BUF, SIZE, COUNT, F) fread(BUF, SIZE, COUNT, F -> ftemp_) + + // + // Windows only. + // + + const char FileGetFirstFreeLetter(); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_File_H */ diff --git a/Source/Core/LibFile/Internal.h b/Source/Core/LibFile/Internal.h new file mode 100644 index 0000000..1997c8b --- /dev/null +++ b/Source/Core/LibFile/Internal.h @@ -0,0 +1,86 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_File_Internal_H +#define Tegenaria_Core_File_Internal_H + +#ifdef WIN32 +#include +#endif + +#include + +namespace Tegenaria +{ + // + // FIXME! Set real maximum path's length + // on OSes other than Windows. + // + + #ifndef MAX_PATH + #define MAX_PATH 260 + #endif + + #ifdef WIN32 + + // + // TxF prototypes for Vista/Win7. + // + + typedef HANDLE WINAPI (*CreateFileTransactedProto)(LPCTSTR, DWORD, DWORD, + LPSECURITY_ATTRIBUTES, + DWORD, DWORD, + HANDLE, HANDLE, + PUSHORT, PVOID); + + typedef HANDLE WINAPI (*CreateTransactionProto)(LPSECURITY_ATTRIBUTES, LPGUID, + DWORD, DWORD, DWORD, DWORD, LPWSTR); + + typedef BOOL WINAPI (*CommitTransactionProto)(HANDLE); + + // + // Structures. + // + + struct TFILE + { + HANDLE lockHandle_; + HANDLE transaction_; + HANDLE hFile_; + + int cookie_; + int timestamp_; + + FILE *ftemp_; + + int fd_; + + char fname_[MAX_PATH]; + }; + + #endif /* WIN32 */ + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_File_Internal_H */ diff --git a/Source/Core/LibFile/TFile.cpp b/Source/Core/LibFile/TFile.cpp new file mode 100644 index 0000000..f620202 --- /dev/null +++ b/Source/Core/LibFile/TFile.cpp @@ -0,0 +1,572 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Transacted I/O API. +// +// On Vista+ native TxF used. +// On WinXP and older - custom failback mechanism. +// + +#ifdef WIN32 + +#include +#include "File.h" +#include "Internal.h" +#include +#include + +namespace Tegenaria +{ + int TxF_Availible = -1; + + CreateFileTransactedProto CreateFileTransacted = NULL; + CreateTransactionProto CreateTransaction = NULL; + CommitTransactionProto CommitTransaction = NULL; + + // + // Check is TxF functions availible and initiate it if yes. + // + // RETURNS: 1 if TxF availible. + // + + int _FileCheckForTxF() + { + #pragma qcbuild_set_private(1) + + // + // If TFile isn't initiated yet. + // + + if (TxF_Availible == -1) + { + TxF_Availible = 0; + + #ifdef WIN32 + + // + // Get current OS version. + // + + DWORD ver = GetVersion(); + DWORD majorVer = (DWORD)(LOBYTE(LOWORD(ver))); + DWORD minorVer = (DWORD)(HIBYTE(LOWORD(ver))); + + // + // If at least Vista try import TxF functions. + // + + if (majorVer >= 6) + { + CreateFileTransacted = (CreateFileTransactedProto) GetProcAddress(LoadLibrary("Kernel32.dll"), "CreateFileTransactedA"); + CreateTransaction = (CreateTransactionProto) GetProcAddress(LoadLibrary("KtmW32.dll"), "CreateTransaction"); + CommitTransaction = (CommitTransactionProto) GetProcAddress(LoadLibrary("KtmW32.dll"), "CommitTransaction"); + + FAILEX(CreateFileTransacted == NULL, "Cannot import CreateFileTransacted().\n"); + FAILEX(CreateTransaction == NULL, "Cannot import CreateTransaction().\n"); + FAILEX(CommitTransaction == NULL, "Cannot import CommitTransaction().\n"); + + DBG_MSG("TxF availible.\n"); + + TxF_Availible = 1; + + #endif /* WIN32 */ + } + } + + fail: + + return TxF_Availible; + } + + // + // Open file in transacted mode. + // + // fname - file path to open (IN). + // mode - C style open mode (see fopen) (IN). + // + // RETURNS: File handle or NULL if error. + // + + TFILE *tfopen(const char *fname, const char *mode) + { + DBG_ENTER("tfopen"); + + int exitCode = -1; + + int tmpCreated = 0; + + char tmpName[MAX_PATH] = ""; + + TFILE *f = NULL; + + // + // TxF functions availible. + // + + if (_FileCheckForTxF()) + { + DWORD desiredAccess = 0; + DWORD createDisposition = OPEN_EXISTING; + + // + // Allocate TFILE buffer. + // + + f = (TFILE *) calloc(sizeof(TFILE), 1); + + FAIL(f == NULL); + + // + // Decode C style mode. + // + + for (int i = 0; mode[i]; i++) + { + switch(mode[i]) + { + case 'r': {desiredAccess |= GENERIC_READ; break;} + case 'w': {desiredAccess |= GENERIC_WRITE; break;} + case '+': {createDisposition = CREATE_ALWAYS; break;} + } + } + + // + // Create transaction. + // + + f -> transaction_ = CreateTransaction(NULL, NULL, 0, 0, 0, 0, NULL); + + FAILEX(f -> transaction_ == NULL, "Cannot create transaction"); + + // + // Open file. + // + + f -> hFile_ = CreateFileTransacted(fname, desiredAccess, 0, NULL, + createDisposition, FILE_ATTRIBUTE_NORMAL, + NULL, f -> transaction_, NULL, NULL); + + FAILEX(f -> hFile_ == INVALID_HANDLE_VALUE, "Cannot open file.\n"); + + // + // Convert HANDLE to C FILE*. + // + + #if defined(WIN64) + f -> fd_ = _open_osfhandle((intptr_t) f -> hFile_, 0); + #else + f -> fd_ = _open_osfhandle((long) f -> hFile_, 0); + #endif + + FAIL(f -> fd_ < 0); + + f -> ftemp_ = fdopen(f -> fd_, mode); + + FAIL(f -> ftemp_ == NULL); + } + + // + // TxF unavailible. Use own mechanism. + // + + else + { + HANDLE lockHandle = INVALID_HANDLE_VALUE; + + int cookie = 0; + int timestamp = 0; + + // + // Generate cookie. + // + + cookie = rand(); + timestamp = time(0); + + // + // Copy original file to temp. + // + + snprintf(tmpName, MAX_PATH, "%s.tmp-%d%d", fname, cookie, timestamp); + + //DBG_MSG("Copying [%s] to [%s]...\n", fname, tmpName); + + tmpCreated = CopyFile(fname, tmpName, FALSE); + + FAIL(tmpCreated == 0); + + // + // Allocate TFILE buffer. + // + + f = (TFILE *) calloc(sizeof(TFILE), 1); + + FAIL(f == NULL); + + // + // Lock file. + // + + f -> lockHandle_ = CreateFile(fname, GENERIC_READ | GENERIC_WRITE, 0, + NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, + NULL); + + // + // Open temp file for real work. + // + + //DBG_MSG("Opening [%s]...\n", tmpName); + + f -> ftemp_ = fopen(tmpName, mode); + + FAIL(f -> ftemp_ == NULL); + + // + // Save original name and cookie number for close. + // + + strncpy(f -> fname_, fname, MAX_PATH); + + f -> cookie_ = cookie; + f -> timestamp_ = timestamp; + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + DBG_MSG("ERROR: Cannot open [%s] file.\n", fname); + + if (f) + { + tfclose(f); + } + + if (tmpCreated) + { + DeleteFile(tmpName); + } + } + + DBG_LEAVE("tfopen"); + + return f; + } + + // + // Close transacted file. + // + // f - handle retrieved from tfopen function (IN). + // + + void tfclose(TFILE *f) + { + DBG_ENTER("tfclose"); + + if (f) + { + // + // TxF functions availible. + // + + if (_FileCheckForTxF()) + { + if (f -> ftemp_) + { + fclose(f -> ftemp_); + } + + CommitTransaction(f -> transaction_); + + CloseHandle(f -> hFile_); + CloseHandle(f -> transaction_); + } + + // + // TxF unavailible. Use own mechanism. + // + + else + { + char altName[MAX_PATH]; + char tmpName[MAX_PATH]; + + // + // Close temp file. + // + + if (f -> ftemp_) + { + fclose(f -> ftemp_); + } + + // + // Remove lock. + // + + CloseHandle(f -> lockHandle_); + + // + // Rename original -> alt. + // + + snprintf(altName, MAX_PATH, "%s.alt-%d%d", + f -> fname_, f -> cookie_, f -> timestamp_); + + //DBG_MSG("Renaming [%s] to [%s]...\n", f -> fname_, altName); + + FAIL(MoveFile(f -> fname_, altName) == FALSE); + + // + // Rename tmp -> original. + // + + snprintf(tmpName, MAX_PATH, "%s.tmp-%d%d", + f -> fname_, f -> cookie_, f -> timestamp_); + + + FAIL(MoveFile(tmpName, f -> fname_) == FALSE); + + // + // Delete alt. + // + + DeleteFile(altName); + } + } + + fail: + + if (f) + { + free(f); + } + + DBG_LEAVE("tfclose"); + } + + // + // Recover corrupted I/O operations in given directory. + // + // directory - path, where scan for corrupted operations (IN). + // + // RETURNS: 0 if OK. + // + + int FileRecoverFailedIO(const char *directory) + { + DBG_ENTER("FileRecoverFailedIO"); + + int exitCode = -1; + + // + // TxF functions availible. + // + + if (_FileCheckForTxF()) + { + // + // Recover handled by TxF. No code needed. + // + } + + // + // TxF unavailible. Use own mechanism. + // + + else + { + vector altFiles; + vector tmpFiles; + + string fname; + string altName; + string tmpName; + + vector::iterator it; + vector::iterator jt; + + // + // Iterate over tmp files. + // + + ListFiles(directory, "*.tmp-*", tmpFiles, false); + + for (it = tmpFiles.begin(); it != tmpFiles.end(); it ++) + { + // + // Restore original and alt name from tmp. + // + + tmpName = *it; + altName = tmpName; + + int lastDot = tmpName.find_last_of("."); + + memcpy(&altName[lastDot] + 1, "alt", 3); + + fname = tmpName.substr(0, lastDot); + + if (FileExists(fname.c_str())) + { + // + // Exists : original, tmp + // Remove all tmps related to file. + // + + string mask = fname + ".tmp-"; + + for (jt = tmpFiles.begin(); jt != tmpFiles.end(); jt ++) + { + if (jt -> find(mask) != -1) + { + DBG_MSG("Cleaning up [%s]...\n", jt -> c_str()); + + DeleteFile(jt -> c_str()); + } + } + } + else + { + // + // Missing : original. + // Exists : Tmp, Alt. + // Recover original. + // + + if (FileExists(altName.c_str())) + { + DBG_MSG("Recovering [%s] from [%s]...\n", + fname.c_str(), tmpName.c_str()); + + if (MoveFile(tmpName.c_str(), fname.c_str())) + { + DeleteFile(altName.c_str()); + } + } + + // + // Missing : original, alt. + // Exists : tmp + + else + { + DBG_MSG("Cleaning up [%s]...\n", tmpName.c_str()); + + DeleteFile(tmpName.c_str()); + } + } + } + + // + // Iterate over alt files. + // + + ListFiles(directory, "*.alt-*", altFiles, false); + + for (it = altFiles.begin(); it != altFiles.end(); it ++) + { + // + // Restore original and tmp name from alt. + // + + altName = *it; + tmpName = altName; + + int lastDot = altName.find_last_of("."); + + memcpy(&tmpName[lastDot] + 1, "tmp", 3); + + fname = altName.substr(0, lastDot); + + if (FileExists(fname.c_str())) + { + // + // Exists : original, alt + // Remove all alt related to file. + // + + string mask = fname + ".alt-"; + + for (jt = altFiles.begin(); jt != altFiles.end(); jt ++) + { + if (jt -> find(mask) != -1) + { + DBG_MSG("Cleaning up [%s]...\n", jt -> c_str()); + + DeleteFile(jt -> c_str()); + } + } + } + else + { + // + // Missing : original. + // Exists : Tmp, Alt. + // Recover original. + // + + if (FileExists(altName.c_str())) + { + DBG_MSG("Recovering [%s] from [%s]...\n", + fname.c_str(), tmpName.c_str()); + + if (MoveFile(tmpName.c_str(), fname.c_str())) + { + DeleteFile(altName.c_str()); + } + } + + // + // Missing : original, tmp. + // Exists : alt + + else + { + DBG_MSG("Cleaning up [%s]...\n", altName.c_str()); + + DeleteFile(altName.c_str()); + } + } + } + } + + exitCode = 0; + + fail: + + DBG_LEAVE("FileRecoverFailedIO"); + + return exitCode; + } +} /* namespace Tegenaria */ + +#endif /* WIN32 */ diff --git a/Source/Core/LibFile/TODO b/Source/Core/LibFile/TODO new file mode 100644 index 0000000..c3e365b --- /dev/null +++ b/Source/Core/LibFile/TODO @@ -0,0 +1 @@ += Change tfwrite() like macros into pure functions to hide implementation. \ No newline at end of file diff --git a/Source/Core/LibFile/qcbuild.src b/Source/Core/LibFile/qcbuild.src new file mode 100644 index 0000000..28804ed --- /dev/null +++ b/Source/Core/LibFile/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibFile + +INC_DIR = Tegenaria +CXXSRC = File.cpp TFile.cpp +ISRC = File.h +LIBS = -ldebug + +AUTHOR = Sylwester Wysocki + +PURPOSE = Process files and pathes. Ships transacted I/O. + +DEPENDS = LibDebug diff --git a/Source/Core/LibIO/Example01-files/Main.cpp b/Source/Core/LibIO/Example01-files/Main.cpp new file mode 100644 index 0000000..381de66 --- /dev/null +++ b/Source/Core/LibIO/Example01-files/Main.cpp @@ -0,0 +1,210 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include + +using namespace Tegenaria; + +// +// Usage: +// +// 'libio-example' : dump four inputs mixed into one 'master' file. +// 'libio-example -r' : reconstruct original four inputs from 'master'. + +int main(int argc, char **argv) +{ + char buf[32] = {0}; + + DBG_INIT("iomixer.log"); + + IOMixer *iomixer = NULL; + + // + // No args. + // Mix outputs from 4 slaves into one master: + // + // + // slave1 \ + // slave2 -> master -> + // slave3 / + // + // For more details see IOMixer.cpp. + // + + if (argc < 2) + { + DBG_HEAD + ( + "iomixer.log\n\n" + "Pack 'N to 1' example.\n" + ); + + + // + // Redirect 'master-output' to file. + // No master input. + // + + int masterOut = open("master.out", O_WRONLY | O_CREAT | O_TRUNC, 666); + int masterIn = -1; + + // + // Wrap IOMixer over master FDs. + // + + iomixer = new IOMixer(masterOut, masterIn); + + // + // Declare four slaves. + // + + int slave1[2] = {-1, -1}; + int slave2[2] = {-1, -1}; + int slave3[2] = {-1, -1}; + int slave4[2] = {-1, -1}; + + int id1 = iomixer -> addSlave(slave1); + int id2 = iomixer -> addSlave(slave2); + int id3 = iomixer -> addSlave(slave3); + int id4 = iomixer -> addSlave(slave4); + + // + // Start master thread. + // From this time IOMixer start splitting master data + // into four slaves. + // + + iomixer -> start(); + + // + // Write test data on every slaves input. + // All messages will be mixed in output 'master' file. + // + + printf("Mixing four 'slave' channels into 'master.out' file...\n"); + + write(slave1[1], "Hello from slave0", 17); + write(slave2[1], "Hello from slave1", 17); + write(slave3[1], "Hello from slave2", 17); + write(slave4[1], "Hello from slave3", 17); + + // + // Wait until all threads finished work. + // + + iomixer -> join(); + } + + // + // '-r' specified. + // Rconstructs original four inputs from 'master' file. + // + // + // / slave1 + // -> master - slave2 + // \ slave3 + // + + else + { + DBG_HEAD + ( + "iomixer.log\n\n" + "Split '1 to N' example.\n" + ); + + // + // Redirect 'master-input' to file. + // No master output. + // + + int masterOut = -1; + int masterIn = open("master.out", O_RDONLY); + + // + // Wrap IOMixer over master FDs. + // + + iomixer = new IOMixer(masterOut, masterIn); + + // + // Declare four slaevs. + // + + int slave1[2] = {-1, -1}; + int slave2[2] = {-1, -1}; + int slave3[2] = {-1, -1}; + int slave4[2] = {-1, -1}; + + int id1 = iomixer -> addSlave(slave1); + int id2 = iomixer -> addSlave(slave2); + int id3 = iomixer -> addSlave(slave3); + int id4 = iomixer -> addSlave(slave4); + + // + // Start master thread. + // From this time IOMixer start splitting master data + // into four slaves. + // + + iomixer -> start(); + + // + // Read data from four slaves. + // + + char buf1[32] = {0}; + char buf2[32] = {0}; + char buf3[32] = {0}; + char buf4[32] = {0}; + + printf("Splitting 'master.out' input into four channels...\n"); + + read(slave1[0], buf1, sizeof(buf1)); + read(slave2[0], buf2, sizeof(buf2)); + read(slave3[0], buf3, sizeof(buf3)); + read(slave4[0], buf4, sizeof(buf4)); + + printf("Readed [%s] from slave1.\n", buf1); + printf("Readed [%s] from slave2.\n", buf2); + printf("Readed [%s] from slave3.\n", buf3); + printf("Readed [%s] from slave4.\n", buf4); + + // + // Wait until all threads finished work. + // + + iomixer -> join(); + } + + // + // Release IOMixer object. + // + + iomixer -> release(); + + return 0; +} diff --git a/Source/Core/LibIO/Example01-files/qcbuild.src b/Source/Core/LibIO/Example01-files/qcbuild.src new file mode 100644 index 0000000..30f222b --- /dev/null +++ b/Source/Core/LibIO/Example01-files/qcbuild.src @@ -0,0 +1,38 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibIO-example01-file-mixer +CXXSRC = Main.cpp + +LIBS = -lio-static -lthread-static -llock-static -ldebug-static +DEPENDS = LibDebug LibIO LibThread LibLock + +.section MinGW + LIBS += -lws2_32 +.endsection + +.section Linux + LIBS += -lpthread +.endsection diff --git a/Source/Core/LibIO/Example02-network/Main.cpp b/Source/Core/LibIO/Example02-network/Main.cpp new file mode 100644 index 0000000..02cd93b --- /dev/null +++ b/Source/Core/LibIO/Example02-network/Main.cpp @@ -0,0 +1,350 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include + +#include +#include +#include +#include + +using namespace Tegenaria; + +// ########################################################################## +// ################### S E R V E R S I D E C O D E ################### +// ########################################################################## + +// +// +// Callback handler to process one incoming connection. +// +// This function is runned in another thred created +// by main server loop. +// + +int ServeClient(NetConnection *nc) +{ + IOMixer *iomixer = NULL; + + int slave1Fd[2]; + int slave2Fd[2]; + int slave3Fd[2]; + int slave4Fd[2]; + + char slave1Msg[64] = {0}; + char slave2Msg[64] = {0}; + char slave3Msg[64] = {0}; + char slave4Msg[64] = {0}; + + // + // Wrap connected socket into IOMixer object. + // + + iomixer = new IOMixer(nc -> readCallback, nc -> writeCallback, nc, nc); + + // + // Open four channels. + // + + iomixer -> addSlave(slave1Fd, 1); + iomixer -> addSlave(slave2Fd, 2); + iomixer -> addSlave(slave3Fd, 3); + iomixer -> addSlave(slave4Fd, 4); + + // + // Start listening on master IN. + // + + iomixer -> start(); + + // + // Read four messages from client - each on different channel. + // + + slave1Msg[0] = 0; + slave2Msg[0] = 0; + slave3Msg[0] = 0; + slave4Msg[0] = 0; + + read(slave1Fd[0], slave1Msg, sizeof(slave1Msg)); + read(slave2Fd[0], slave2Msg, sizeof(slave2Msg)); + read(slave3Fd[0], slave3Msg, sizeof(slave3Msg)); + read(slave4Fd[0], slave4Msg, sizeof(slave4Msg)); + + printf("--------------------\n"); + printf(" Connection socket : [%d]\n", nc -> getSocket()); + printf(" Client info : [%s]\n", nc -> getClientInfo()); + printf(" Message on slave #1 : [%s].\n", slave1Msg); + printf(" Message on slave #2 : [%s].\n", slave2Msg); + printf(" Message on slave #3 : [%s].\n", slave3Msg); + printf(" Message on slave #4 : [%s].\n", slave4Msg); + printf("--------------------\n"); + + // + // Send four answers to server - each on different channel. + // + + strcpy(slave1Msg, "Answer from server #1"); + strcpy(slave2Msg, "Answer from server #2"); + strcpy(slave3Msg, "Answer from server #3"); + strcpy(slave4Msg, "Answer from server #4"); + + write(slave1Fd[1], slave1Msg, strlen(slave1Msg)); + write(slave2Fd[1], slave2Msg, strlen(slave2Msg)); + write(slave3Fd[1], slave3Msg, strlen(slave3Msg)); + write(slave4Fd[1], slave4Msg, strlen(slave4Msg)); + + // + // Close all slaves. + // + + close(slave1Fd[0]); + close(slave2Fd[0]); + close(slave3Fd[0]); + close(slave4Fd[0]); + + close(slave1Fd[1]); + close(slave2Fd[1]); + close(slave3Fd[1]); + close(slave4Fd[1]); + + // + // Close our side of master socket. + // + // It means: + // + // - we don't want to read anymore + // + // but it does NOT mean: + // + // - we don't want to write anymore, because + // slaves can still contains some not flushed + // data to send to other side. + // + + iomixer -> shutdown(); + + // + // Wait until all IO pending flushed inside IOMixer. + // + + iomixer -> join(); + + // + // Release IOMixer object. + // + + iomixer -> release(); + + return 0; +}; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + NetConnection *nc = NULL; + + // + // No arguments. + // Create server in background thread, which: + // + // - uses our ServerClient() routine to process incoming connections. + // - listens on port 6666 + // + + if (argc < 3) + { + DBG_INIT("server.log"); + DBG_HEAD("DIRLIGO-SERVER-0.1\nBuild [%s, %s]\n", __DATE__, __TIME__); + + nc = NetServerCreate(6666, ServeClient); + + FAIL(nc == NULL); + + printf("Server created with handle [%p].\n", nc); + + // + // Wait until server finishes. + // + + nc -> join(); + } + +// ########################################################################## +// ################### C L I E N T S I D E C O D E ################### +// ########################################################################## + + // + // 'libnet-example '. + // Client mode. + // + + else + { + DBG_INIT("client.log"); + DBG_HEAD("DIRLIGO-CLIENT-0.1\nBuild [%s, %s]\n", __DATE__, __TIME__); + + const char *ip = argv[1]; + + int port = atoi(argv[2]); + + int written = 0; + + int slave1Fd[2]; + int slave2Fd[2]; + int slave3Fd[2]; + int slave4Fd[2]; + + char slave1Msg[64] = "Hello from client slave #1."; + char slave2Msg[64] = "Hello from client slave #2."; + char slave3Msg[64] = "Hello from client slave #3."; + char slave4Msg[64] = "Hello from client slave #4."; + + IOMixer *iomixer = NULL; + + // + // Connect to server listening on given :. + // + + nc = NetConnect(ip, port); + + FAIL(nc == NULL); + + // + // Wrap connected socket into IOMixer object. + // + + //IOMixer iomixer(sock, sock, IOMIXER_TYPE_SOCKET, IOMIXER_TYPE_SOCKET); + + iomixer = new IOMixer(nc -> readCallback, nc -> writeCallback, nc, nc); + + // + // Open four channels. + // + + iomixer -> addSlave(slave1Fd, 1); + iomixer -> addSlave(slave2Fd, 2); + iomixer -> addSlave(slave3Fd, 3); + iomixer -> addSlave(slave4Fd, 4); + + // + // Start listening on master IN. + // + + iomixer -> start(); + + // + // Send four messages to server - each on different channel. + // + + DBG_MSG("Writing...\n"); + + write(slave1Fd[1], slave1Msg, strlen(slave1Msg)); + write(slave2Fd[1], slave2Msg, strlen(slave2Msg)); + write(slave3Fd[1], slave3Msg, strlen(slave3Msg)); + write(slave4Fd[1], slave4Msg, strlen(slave4Msg)); + + // + // Read four answers - each on different channel. + // + + memset(slave1Msg, 0, sizeof(slave1Msg)); + memset(slave2Msg, 0, sizeof(slave2Msg)); + memset(slave3Msg, 0, sizeof(slave3Msg)); + memset(slave4Msg, 0, sizeof(slave4Msg)); + + read(slave1Fd[0], slave1Msg, sizeof(slave1Msg)); + read(slave2Fd[0], slave2Msg, sizeof(slave2Msg)); + read(slave3Fd[0], slave3Msg, sizeof(slave3Msg)); + read(slave4Fd[0], slave4Msg, sizeof(slave4Msg)); + + printf("Answer on slave #1 : [%s].\n", slave1Msg); + printf("Answer on slave #2 : [%s].\n", slave2Msg); + printf("Answer on slave #3 : [%s].\n", slave3Msg); + printf("Answer on slave #4 : [%s].\n", slave4Msg); + + // + // Close all slaves. + // + + DBG_MSG("Closing...\n"); + + close(slave1Fd[0]); + close(slave2Fd[0]); + close(slave3Fd[0]); + close(slave4Fd[0]); + + close(slave1Fd[1]); + close(slave2Fd[1]); + close(slave3Fd[1]); + close(slave4Fd[1]); + + // + // Close our side of master socket. + // + // It means: + // + // - we don't want to read anymore + // + // but it does NOT mean: + // + // - we don't want to write anymore, because + // slaves can still contains some not flushed + // data to send to other side. + // + + iomixer -> shutdown(); + + // + // Wait until all IO pending flushed inside IOMixer. + // + + iomixer -> join(); + + // + // Release IOMixer object. + // + + iomixer -> release(); + } + + // + // Clean Up. + // + + fail: + + if (nc) + { + nc -> release(); + } + + + return 0; +} diff --git a/Source/Core/LibIO/Example02-network/qcbuild.src b/Source/Core/LibIO/Example02-network/qcbuild.src new file mode 100644 index 0000000..7cfb68e --- /dev/null +++ b/Source/Core/LibIO/Example02-network/qcbuild.src @@ -0,0 +1,43 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibIO-example02-network-mixer +CXXSRC = Main.cpp + +LIBS = -ldebug-static -lprocess-static +LIBS += -lio -llock-static -lnet -lthread-static + +DEPENDS = LibDebug LibNet LibProcess LibThread LibIO LibLock + +PURPOSE = Example showing how to set up multiplexed client-server +PURPOSE = using IOMixer and LibNet library. + +# +# Windows specific. +# + +.section MinGW + LIBS += -lws2_32 +.endsection diff --git a/Source/Core/LibIO/Example03-timeout-read/Main.cpp b/Source/Core/LibIO/Example03-timeout-read/Main.cpp new file mode 100644 index 0000000..7d90852 --- /dev/null +++ b/Source/Core/LibIO/Example03-timeout-read/Main.cpp @@ -0,0 +1,53 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_INIT_EX(NULL, "debug3", -1); + + // + // Read from stdin with 10s timeout. + // + + char buf[1024] = {0}; + + printf("Reading from stdin with 10s timeout...\n"); + + if (IOTimeoutRead(0, buf, sizeof(buf), 10000) > 0) + { + printf("Readed [%s].\n", buf); + } + + return 0; +} diff --git a/Source/Core/LibIO/Example03-timeout-read/qcbuild.src b/Source/Core/LibIO/Example03-timeout-read/qcbuild.src new file mode 100644 index 0000000..f64c6ad --- /dev/null +++ b/Source/Core/LibIO/Example03-timeout-read/qcbuild.src @@ -0,0 +1,33 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibIO-example03-timeout-read +CXXSRC = Main.cpp + +LIBS = -ldebug -lio -llock -lthread + +DEPENDS = LibDebug LibThread LibIO LibLock + +PURPOSE = Example showing how to read from CRT FD with timeout. diff --git a/Source/Core/LibIO/IOFifo.cpp b/Source/Core/LibIO/IOFifo.cpp new file mode 100644 index 0000000..1856426 --- /dev/null +++ b/Source/Core/LibIO/IOFifo.cpp @@ -0,0 +1,466 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Cyclic buffer to store I/O buffer. +// +// Incoming data is appended to the end. +// Outcoming data is popped from the begin. +// +// xx xx xx xx xx xx xx ... yy yy yy yy yy +// +// ^^^ ^^^ +// Read position. Write position. +// Pop data from here. Push data here. +// + +#include +#include + +#include "IOFifo.h" +#include + +namespace Tegenaria +{ + // ---------------------------------------------------------------------------- + // + // Constructors and destructors + // + // ---------------------------------------------------------------------------- + + // + // Create new IOFifo with given capacity. + // + // capacity - size of fifo in bytes (IN). + // + + IOFifo::IOFifo(unsigned int capacity) + { + DBG_SET_ADD("IOFifo", this); + + buffer_ = (char *) malloc(capacity); + capacity_ = capacity; + bytesLeft_ = capacity; + writePos_ = 0; + readPos_ = 0; + + mutex_ = new Mutex("IOFifo"); + } + + // + // Free buffers allocated in constructor. + // + + IOFifo::~IOFifo() + { + DBG_SET_DEL("IOFifo", this); + + if (buffer_) + { + free(buffer_); + + buffer_ = NULL; + } + + if (mutex_) + { + delete mutex_; + + mutex_ = NULL; + } + } + + // ---------------------------------------------------------------------------- + // + // Destructive functions (push/pop) + // + // ---------------------------------------------------------------------------- + + // + // Add data to the end of FIFO. + // + // Buffer before: xx xx xx xx xx + // Buffer after : xx xx xx xx xx yy yy yy yy ... + // + // source - source buffer with data to append (IN). + // len - number of bytes to append (IN). + // + // RETURNS: 0 if all bytes appended, + // -1 otherwise. + // + + int IOFifo::push(void *source, int len) + { + DBG_ENTER3("IOFifo::push"); + + int exitCode = -1; + + char *src = (char *) source; + + // + // Check is it sufficient space left. + // + + FAILEX(len > bytesLeft_, + "ERROR: Going to append [%d] bytes to IOFifo PTR#%p," + " but only [%d] bytes left.\n", len, this, bytesLeft_); + + // + // Write data to buffer. + // + + if ((writePos_ + len) < capacity_) + { + memcpy(buffer_ + writePos_, src, len); + } + else + { + unsigned int bytesToEnd = capacity_ - writePos_; + + unsigned int overflow = (len - bytesToEnd) % capacity_; + + memcpy(buffer_ + writePos_, src, bytesToEnd); + + memcpy(buffer_, src + bytesToEnd, overflow); + } + + writePos_ = (writePos_ + len) % capacity_; + + bytesLeft_ -= len; + + DEBUG2("Appended [%d] bytes to IOFifo PTR#%p," + " [%d] bytes left.\n", len, this, bytesLeft_); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("IOFifo::push"); + + return exitCode; + } + + // + // Pop data from the begin of FIFO. + // + // Buffer before: xx xx xx xx yy yy yy yy ... + // Buffer after : yy yy yy yy ... + // + // + // TIP#1: If dest buffer is NULL, data are popped from FIFO, + // but don't written anywhere. + // + // TIP#2: Skip len parameter or set to -1 if you want to pop up + // all data stored in queue. + // + // TIP#3: Use peekOnly flag to get data WITHOUT removing it from FIFO. + // + // + // dest - buffer where to write popped data (OUT/OPT). + // + // len - number of bytes to pop, if set to -1 all available data + // will be popped (IN/OPT). + // + // peekOnly - set to 1 if you want copy data to dest buffer WITHOUT + // remove it from buffer (IN/OPT). + // + // RETURNS: 0 if all bytes popped, + // -1 otherwise.. + // + + int IOFifo::pop(void *dest, int len, int peekOnly) + { + DBG_ENTER3("IOFifo::pop"); + + int exitCode = -1; + + char *dst = (char *) dest; + + // + // Check is it sufficient space left. + // + + FAILEX(capacity_ - bytesLeft_ < len, + "ERROR: Going to pop [%d] bytes from IOFifo PTR#%p," + " but only [%d] bytes available.\n", + len, this, capacity_ - bytesLeft_); + + // + // Read data from buffer if needed. + // + + if (dst) + { + if ((readPos_ + len) < capacity_) + { + memcpy(dst, buffer_ + readPos_, len); + } + else + { + unsigned int bytesToEnd = capacity_ - readPos_; + + unsigned int overflow = (len - bytesToEnd) % capacity_; + + memcpy(dst, buffer_ + readPos_, bytesToEnd); + + memcpy(dst + bytesToEnd, buffer_, overflow); + } + } + + // + // Move read position. + // + + if (peekOnly == 0) + { + readPos_ = (readPos_ + len) % capacity_; + + bytesLeft_ += len; + + DEBUG2("Popped [%d] bytes from IOFifo PTR#%p," + " [%d] bytes left.\n", len, this, bytesLeft_); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("IOFifo::pop"); + + return exitCode; + } + + // + // Eat data from the begin of FIFO. + // + // Buffer before: xx xx xx xx yy yy yy yy ... + // Buffer after : yy yy yy yy ... + // + // + // Works as pop() method with destination set to NULL. + // + // len - number of bytes to eat (IN). + // + // RETURNS: 0 if all bytes eated, + // -1 otherwise.. + // + + int IOFifo::eat(int len) + { + return pop(NULL, len); + } + + // ---------------------------------------------------------------------------- + // + // Non destructive read (peek) + // + // ---------------------------------------------------------------------------- + + // + // Copy bytes from begin of FIFO to , but + // do NOT remove them from FIFO. + // + // Works as pop() with peekOnly flag set to 1. + // + // + // dest - buffer where to store readed data (OUT). + // + // len - number of bytes to read. If set to -1 all + // available data will be copied (IN/OPT). + // + // + // RETURNS: 0 if all bytes copied, + // -1 otherwise. + // + // + + int IOFifo::peek(void *dest, int len) + { + return pop(dest, len, 1); + } + + // + // Peek QWORD from fifo begin, but do NOT remove it from buffer. + // + // WARNING: If there is less than 8 bytes in buffer, return value + // is always zero. + // + // endian - set to IO_BIG_ENDIAN or IO_LITTLE_ENDIAN (IN). + // + // RETURNS: First QWORD in queue. + // + + uint64_t IOFifo::peekQword(int endian) + { + uint64_t ret = 0; + + peek(&ret, 8); + + // + // Inverse bytes if needed. + // + + if (endian == IO_BIG_ENDIAN) + { + uint64_t tmp = ret; + + uint8_t *src = (uint8_t *) &tmp; + uint8_t *dst = (uint8_t *) &ret; + + dst[0] = src[7]; + dst[1] = src[6]; + dst[2] = src[5]; + dst[3] = src[4]; + dst[4] = src[3]; + dst[5] = src[2]; + dst[6] = src[1]; + dst[7] = src[0]; + } + + return ret; + } + + // + // Peek DWORD from fifo begin, but do NOT remove it from buffer. + // + // WARNING: If there is less than 4 bytes in buffer, return value + // is always zero. + // + // endian - set to IO_BIG_ENDIAN or IO_LITTLE_ENDIAN (IN). + // + // RETURNS: First DWORD in queue. + // + + uint32_t IOFifo::peekDword(int endian) + { + uint32_t ret = 0; + + peek(&ret, 4); + + // + // Inverse bytes if needed. + // + + if (endian == IO_BIG_ENDIAN) + { + uint32_t tmp = ret; + + uint8_t *src = (uint8_t *) &tmp; + uint8_t *dst = (uint8_t *) &ret; + + dst[0] = src[7]; + dst[1] = src[6]; + dst[2] = src[5]; + dst[3] = src[4]; + } + + return ret; + } + + // + // Peek byte from fifo begin, but do NOT remove it from buffer. + // + // WARNING: If there is less than 1 bytes in buffer, return value + // is always zero. + // + // RETURNS: First byte in queue. + // + + uint8_t IOFifo::peekByte() + { + uint8_t ret = 0; + + if (capacity_ - bytesLeft_ >= 1) + { + ret = buffer_[writePos_]; + } + + return ret; + } + + // ---------------------------------------------------------------------------- + // + // Multithread synchronization + // + // ---------------------------------------------------------------------------- + + // + // Lock access to fifo. + // + + void IOFifo::lock() + { + mutex_ -> lock(); + } + + // + // Unlock access to fifo blocked by lock() before. + // + + void IOFifo::unlock() + { + mutex_ -> unlock(); + } + + // ---------------------------------------------------------------------------- + // + // Getters and setters + // + // ---------------------------------------------------------------------------- + + // + // Return number of free bytes, which can be append to fifo. + // + + unsigned int IOFifo::bytesLeft() + { + return bytesLeft_; + } + + // + // Return number of bytes already stored inside fifo. + // + + unsigned int IOFifo::size() + { + return capacity_ - bytesLeft_; + } + + // + // Return total fifo capacity in bytes. + // + + unsigned int IOFifo::capacity() + { + return capacity_; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibIO/IOFifo.h b/Source/Core/LibIO/IOFifo.h new file mode 100644 index 0000000..b6f35d4 --- /dev/null +++ b/Source/Core/LibIO/IOFifo.h @@ -0,0 +1,97 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_IOFifo_H +#define Tegenaria_Core_IOFifo_H + +#include +#include + +namespace Tegenaria +{ + #define IOFIFO_DEFAULT_BUFFER_SIZE (1024 * 32) + + #define IO_BIG_ENDIAN 1 + #define IO_LITTLE_ENDIAN 0 + + class IOFifo + { + private: + + char *buffer_; + + unsigned int bytesLeft_; + unsigned int capacity_; + unsigned int writePos_; + unsigned int readPos_; + + Mutex *mutex_; + + public: + + // + // Constructors and destructors. + // + + IOFifo(unsigned int capacity = IOFIFO_DEFAULT_BUFFER_SIZE); + + ~IOFifo(); + + // + // Destructive methods (changes fifo). + // + + int push(void *src, int len); + int pop(void *dst, int len = -1, int peekOnly = 0); + int eat(int len); + + // + // Non-destructive read (read without changing fifo). + // + + int peek(void *dst, int len = -1); + + uint64_t peekQword(int endian); + uint32_t peekDword(int endian); + uint8_t peekByte(); + + // + // Multithread synchronization. + // + + void lock(); + void unlock(); + + // + // Getters and setters. + // + + unsigned int bytesLeft(); + unsigned int size(); + unsigned int capacity(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_IOFifo_H */ diff --git a/Source/Core/LibIO/IOLoop.cpp b/Source/Core/LibIO/IOLoop.cpp new file mode 100644 index 0000000..ef50312 --- /dev/null +++ b/Source/Core/LibIO/IOLoop.cpp @@ -0,0 +1,290 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// WARNING: Not used anywhere. +// Review how to inform loop about output queue changes +// when loop is blocked in read wait. + +// +// Purpose: Give common scheme to handle main I/O loop with +// many input/outputs. +// + +#include "IOLoop.h" +#include + +#ifdef WIN32 +# include +# include +#endif + +namespace Tegenaria +{ + // + // Template routine for main I/O loop. + // + // count - number of FDs to read/write. MUST much with number of + // elements in fd[], direct[] and queue[] tables (IN). + // + // fd - table with FDs to read or write (IN). + // + // direct - 0 at index i menns fd[i] is input device, + // 1 at index i means fd[i] is output device (IN). + // + // queue - table with IOFifo objects related with related fd. + // Used to collect data incoming from fd (direct=0), + // or as data source written to fd (direct=1) (IN/OUT). + // + // callback - routine called when portion of data received or send. + // Can be NULL if not needed. (IN/OPT). + // + // RETURNS: 0 if loop finished in usual way, + // -1 if abnormal exit. + // + + int IOLoop(int count, int *fd, int *direct, + IOFifo *queue, IOCompletedProto callback) + { + DBG_ENTER3("IOLoop"); + + int goOn = 1; + + int exitCode = -1; + + /* + * FIXME: Cross initialiation. + */ + + //FAILEX(count <= 0, "ERROR: count <= 0 passed to IOLoop.\n"); + //FAILEX(fd == NULL, "ERROR: fd cannot be NULL in IOLoop.\n"); + //FAILEX(direct == NULL, "ERROR: direct cannot be NULL in IOLoop.\n"); + //FAILEX(queue == NULL, "ERROR: queue cannot be NULL in IOLoop.\n"); + + // + // Windows. + // Overlapped I/O based loop. + // + + #ifdef WIN32 + { + HANDLE *handle = (HANDLE *) calloc(count, sizeof(HANDLE)); + HANDLE *event = (HANDLE *) calloc(count, sizeof(HANDLE)); + + OVERLAPPED *ov = (OVERLAPPED *) calloc(count, sizeof(OVERLAPPED)); + + int *pending = (int *) calloc(count, sizeof(int)); + + void **buf = (void **) calloc(count, sizeof(void *)); + + DWORD *bufSize = (DWORD *) calloc(count, sizeof(DWORD)); + + DWORD waitResult = 0; + DWORD transferred = 0; + + int id = 0; + + // + // For every CRT FD: + // + // - Get underlying HANDLE. + // - Prepare overlapped I/O. + // - Allocate work buffers to read/write data. + // + + DEBUG2("IOLoop: Preparing OS Handles...\n"); + + for (int i = 0; i < count; i++) + { + handle[i] = (HANDLE) _get_osfhandle(fd[i]); + + event[i] = CreateEvent(NULL, FALSE, FALSE, NULL); + + ov[i].hEvent = event[i]; + + bufSize[i] = queue[i].capacity(); + + buf[i] = malloc(bufSize[i]); + } + + // + // Fall into main loop. + // + + DEBUG1("IOLoop: Falling into main I/O loop...\n"); + + while(goOn) + { + // + // Start asynchronous read/write. + // + + for (int i = 0; i < count; i++) + { + // + // Start asynchronous read for every input handles if: + // + // - we have space to store data in queue. + // - there is no pending operation from last call. + // + + if (direct[i] == 0) + { + if (queue[i].bytesLeft() > 0) + { + DEBUG3("Going to read up to [%d] bytes from FD #%d HANDLE #%d.", + queue[i].bytesLeft(), fd[i], handle[i]); + + ReadFile(handle[i], buf[i], queue[i].bytesLeft(), NULL, &ov[i]); + + pending[i] = 1; + } + } + + // + // Start asynchronous write for every output handle if: + // + // - we have something to write in queue. + // - there is no pending operation from last call. + // + + else + { + if (queue[i].size() > 0) + { + DEBUG3("Going to write [%d] bytes to FD #%d HANDLE #%d.", + queue[i].size(), fd[i], handle[i]); + + queue[i].pop(buf[i]); + + WriteFile(handle[i], buf[i], bufSize[i], NULL, &ov[i]); + + pending[i] = 1; + } + } + } + + // + // Wait until one of asyncrhonous operation finished. + // + + waitResult = WaitForMultipleObjects(count, event, FALSE, INFINITE); + + id = waitResult - WAIT_OBJECT_0; + + FAILEX(id > count, + "ERROR: WaitForMultipleObjects() failed with" + " code [%d].\n", waitResult); + + GetOverlappedResult(handle[id], &ov[id], &transferred, TRUE); + + // + // One of asynchronous read finished. + // + + if (direct[id] == 0) + { + FAILEX(transferred == 0, + "ERROR: Cannot read from FD #%d handle #%d.\n", + fd[id], handle[id]); + + DEBUG3("Readed [%d] bytes from FD #%d handle #%d.\n", + transferred, fd[id], handle[id]); + + queue[id].push(buf[id], transferred); + } + + // + // One of asynchronous write finished. + // + + else + { + FAILEX(transferred == 0, + "ERROR: Cannot write to FD #%d handle #%d.\n", + fd[id], handle[id]); + + DEBUG3("Written [%d] bytes to FD #%d handle #%d.\n", + transferred, fd[id], handle[id]); + } + + // + // Disable pending flag. + // Move device pointr for block devices (e.g. files). + // + + pending[0] = 0; + + ov[id].Offset += transferred; + + // + // Inform caller that next portion of data received + // or sent. + // + + if (callback) + { + callback(fd[id], transferred, direct[id], &queue[id]); + } + } + + exitCode = 0; + + // + // Clean up. + // + + fail: + + DEBUG1("IOLoop: Main I/O loop finished.\n"); + + for (int i = 0; i < count; i++) + { + CloseHandle(event[i]); + + free(buf[i]); + } + + free(handle); + free(event); + free(ov); + free(pending); + free(buf); + free(bufSize); + } + + // + // Linux, MacOS. + // Select based loop. + // + + #else + { + Error("ERROR: IOLoop is not implemented.\n"); + } + #endif + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibIO/IOLoop.h b/Source/Core/LibIO/IOLoop.h new file mode 100644 index 0000000..b205ed6 --- /dev/null +++ b/Source/Core/LibIO/IOLoop.h @@ -0,0 +1,47 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_IOLoop_H +#define Tegenaria_Core_IOLoop_H + +#include "IOFifo.h" + +namespace Tegenaria +{ + // + // Typedef. + // + + typedef void (IOCompletedProto)(int id, int count, int direct, IOFifo *queue); + + // + // Exported functions. + // + + int IOLoop(int count, int *fd, int *direct, + IOFifo *queue, IOCompletedProto callback); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_IOLoop_H */ diff --git a/Source/Core/LibIO/IOMixer.cpp b/Source/Core/LibIO/IOMixer.cpp new file mode 100644 index 0000000..bffe24d --- /dev/null +++ b/Source/Core/LibIO/IOMixer.cpp @@ -0,0 +1,2152 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Send many isolated channels over one CRT file descriptor. +// + +#include "IOMixer.h" +#include "Utils.h" + +namespace Tegenaria +{ + // + // Static variables. + // + + set IOMixer::instances_; + + Mutex IOMixer::instancesMutex_("IOMixer::instances_"); + + // + // Create new slave fd pair. + // + // All written to 'slaveOut' will be wrapped to + // inside slave thread. One slave = one 'slave thread'. + // + // + // -> -> [Slave1] \ + // -> <1> <2> -> [master] -> + // -> -> [Slave3] / + // + // + // All readed from 'masterIn' will be dispatched + // into 'slaveIn' with given ID inside 'master thread'. + // One master thread is common to all slaves. + // + // -> + // / + // <1><2> -> [Master] + // \ + // -> + // + // + // callerFds[] - input/output CRT fds valid in caller context (OUT). + // + // slaveId - ID for new slave. Optional, if skipped new unique ID + // will be generated (IN/OPT). + // + // RETURNS: ID assigned to slave or -1 if error. + // + + int IOMixer::addSlave(int callerFds[2], int slaveId) + { + DBG_ENTER("IOMixer::addSlave"); + + int exitCode = -1; + + int pin[2]; + int pout[2]; + + IOMixerSlave *slave = NULL; + + char mutexName[64]; + + // + // Check args. + // + + FAILEX(init_ == 0, "ERROR: IOMixer object was not initiated correctly.\n"); + FAILEX(slaveId == 0, "ERROR: Slave ID #0 is reseved for internal use."); + FAILEX(dead_, "ERROR: IOMixer already dead while trying to add slave ID#%d.", slaveId); + + // + // Crate pipe pairs for slave's in/out. + // + + #ifdef WIN32 + { + // + // Security attributes for pin[] pair. + // + + SECURITY_ATTRIBUTES sain[2] = + { + {sizeof(SECURITY_ATTRIBUTES), NULL, FALSE}, // pin[0] - don't inherit + {sizeof(SECURITY_ATTRIBUTES), NULL, TRUE }, // pin[1] - inherit + }; + + // + // Security attributes for pout[] pair. + // + + SECURITY_ATTRIBUTES saout[2] = + { + {sizeof(SECURITY_ATTRIBUTES), NULL, TRUE }, // pout[0] - inherit + {sizeof(SECURITY_ATTRIBUTES), NULL, FALSE} // pout[1] - don't inherit + }; + + FAIL(CreatePipeEx(pin, sain, IOMIXER_MAX_PACKET, + FILE_FLAG_OVERLAPPED, FILE_FLAG_OVERLAPPED, 0)); + + FAIL(CreatePipeEx(pout, saout, IOMIXER_MAX_PACKET, + FILE_FLAG_OVERLAPPED, FILE_FLAG_OVERLAPPED, 0)); + } + #else + { + FAILEX(pipe(pin), "ERROR: Cannot create pipe pair."); + FAILEX(pipe(pout), "ERROR: Cannot create pipe pair."); + } + #endif + + DBG_SET_ADD("CRT FD", pout[0], "IOMixer/caller/FD/0"); + DBG_SET_ADD("CRT FD", pout[1], "IOMixerSlave::fdout_"); + DBG_SET_ADD("CRT FD", pin[0], "IOMixerSlave::fdin_"); + DBG_SET_ADD("CRT FD", pin[1], "IOMixer/caller/FD/1"); + + callerFds[0] = pout[0]; + callerFds[1] = pin[1]; + + slavesMutex_.lock(); + + // + // Assign unique ID to slave if not specified by user. + // + + if (slaveId == -1) + { + while(getSlave(slavesCount_)) + { + slavesCount_ ++; + } + + slaveId = slavesCount_; + } + + // + // If user specified own ID, check is it unique. + // + + else + { + FAILEX(slaves_.find(slaveId) != slaves_.end(), + "IOMixer::addSlve : ERROR: ID [%d] is not unique.\n", + slaveId); + } + + DEBUG1("IOMixer::addSlave : Assigned ID [%d] to slave FDs [%d][%d] for master [%d][%d].", + slaveId, callerFds[1], callerFds[0], masterOut_, masterIn_); + + // + // Allocate struct to store slave's context. + // + + slave = new IOMixerSlave; + + slave -> id_ = slaveId; + slave -> eofSent_ = 0; + slave -> eofReceived_ = 0; + slave -> fdin_ = pin[0]; + slave -> fdout_ = pout[1]; + slave -> this_ = this; + slave -> flags_ = 0; + + // + // Prepare overlapped I/O and cancel event on Windows. + // + + #ifdef WIN32 + { + memset(&slave -> ov_, 0, sizeof(OVERLAPPED)); + + slave -> cancelEvent_ = CreateEvent(NULL, FALSE, FALSE, NULL); + + DBG_SET_ADD("event", slave -> cancelEvent_, "IOMixerSlave::cancelEvent_"); + } + + // + // Prepare cancel FDs on Linux. + // + + #else + if (pipe(slave -> cancelFd_) < 0) + { + Error("ERROR: Cannot create cancel pipe for slave ID#%d.\n", slaveId); + } + DBG_SET_ADD("fd", slave -> cancelFd_[0], "IOMixerSlave::cancelFd_[0]"); + #endif + + snprintf(mutexName, sizeof(mutexName), "IOMixer::Slave#%d", slaveId); + + slave -> writeMutex_.setName(mutexName); + + // + // Start up slave thread. + // In this moment we're starting sending data + // from slaves to master outputs. + // + + slave -> thread_ = ThreadCreate((ThreadEntryProto) slaveLoop, slave); + + DBG_SET_RENAME("thread", slave -> thread_, "IOMixer::slaveLoop"); + + // + // Store {ID |-> slave} pair for quick search for slave with given ID. + // + + slaves_[slave -> id_] = slave; + + // + // Clean up. + // + + exitCode = 0; + + fail: + + slavesMutex_.unlock(); + + DBG_LEAVE("IOMixer::addSlave"); + + if (exitCode == 0) + { + return slaveId; + } + else + { + return -1; + } + }; + + // + // Constructor using socket/FDs pair. + // + + IOMixer::IOMixer(int masterOut, int masterIn, int masterOutType, int masterInType) + { + DBG_ENTER("IOMixer::IOMixer"); + + unsigned long mode = 1; + + int tcpNoDelay = 1; + + char buf[128] = {0}; + + DBG_SET_ADD("IOMixer", this); + + // + // Track created instances. + // + + instancesMutex_.lock(); + instances_.insert(this); + instancesMutex_.unlock(); + + DEBUG4("IOMixer::IOMixer : Creating I/O mixer from master" + " FDs [%d][%d]...\n", masterOut, masterIn); + + init_ = 0; + dead_ = 0; + quietMode_ = 0; + zlibLoaded_ = 0; + refCount_ = 1; + + #ifdef WIN32 + memset(&masterInOV_, 0, sizeof(masterInOV_)); + memset(&masterOutOV_, 0, sizeof(masterOutOV_)); + #endif + + FAILEX(masterOut < 0, "ERROR: Wrong master OUT in IOMixer::IOMixer.\n"); + FAILEX(masterIn < 0, "ERROR: Wrong master IN in IOMixer::IOMixer.\n"); + + slavesCount_ = 1; + masterOut_ = masterOut; + masterIn_ = masterIn; + masterOutType_ = masterOutType; + masterInType_ = masterInType; + masterEofSent_ = 0; + masterEofReceived_ = 0; + + + slaveDeadCallback_ = NULL; + + #ifdef WIN32 + masterInOV_.hEvent = WSACreateEvent(); + masterOutOV_.hEvent = WSACreateEvent(); + + DBG_SET_ADD("event", masterInOV_.hEvent, "IOMixer::masterInOV_"); + DBG_SET_ADD("event", masterOutOV_.hEvent, "IOMixer::masterOutOV_"); + + ioctlsocket(masterIn_, FIONBIO, &mode); + ioctlsocket(masterOut_, FIONBIO, &mode); + + /* + setsockopt(masterIn_, IPPROTO_TCP, TCP_NODELAY, (char *) &tcpNoDelay, sizeof(tcpNoDelay)); + setsockopt(masterOut_, IPPROTO_TCP, TCP_NODELAY, (char *) &tcpNoDelay, sizeof(tcpNoDelay)); + */ + #endif + + masterMutex_.setName("IOMixer::Master"); + slavesMutex_.setName("IOMixer::Slaves"); + + // + // Load ZLib for compression. + // + + initZLib(); + + // + // Generate object name. + // + + snprintf(buf, sizeof(buf) - 1, "IOMixer/0x%p", this); + + objectName_ = buf; + + // + // Set init OK flag. + // + + init_ = 1; + + // + // Error handler. + // + + fail: + + DBG_LEAVE("IOMixer::IOMixer"); + } + + // + // Constructor using two caller specified read/write functions. + // + // readCallback - function used to read data from master (IN). + // writeCallback - function used to write data to master (IN). + // readCtx - caller defined data passed to readCallback() (IN/OPT). + // writeCtx - caller defined data passed to writeCallback() (IN/OPT). + // ioCancelCallback - function used to cancel pending IO on master (IN/OPT) + // + + IOMixer::IOMixer(IOReadProto readCallback, IOWriteProto writeCallback, + void *readCtx, void *writeCtx, IOCancelProto ioCancelCallback) + { + DBG_ENTER("IOMixer::IOMixer"); + + unsigned long mode = 1; + + int tcpNoDelay = 1; + + char buf[128] = {0}; + + DBG_SET_ADD("IOMixer", this); + + // + // Track created instances. + // + + instancesMutex_.lock(); + instances_.insert(this); + instancesMutex_.unlock(); + + DEBUG4("IOMixer::IOMixer : Creating I/O mixer from master" + " callbacks [%p/%p][%p/%p]...\n", readCallback, readCtx, + writeCallback, writeCtx); + + init_ = 0; + dead_ = 0; + quietMode_ = 0; + zlibLoaded_ = 0; + refCount_ = 1; + + #ifdef WIN32 + memset(&masterInOV_, 0, sizeof(masterInOV_)); + memset(&masterOutOV_, 0, sizeof(masterOutOV_)); + #endif + + FAILEX(readCallback == NULL, "ERROR: Wrong read callback in IOMixer::IOMixer.\n"); + FAILEX(writeCallback == NULL, "ERROR: Wrong write callback in IOMixer::IOMixer.\n"); + + slavesCount_ = 1; + masterOut_ = -1; + masterIn_ = -1; + masterOutType_ = IOMIXER_TYPE_CALLBACK ; + masterInType_ = IOMIXER_TYPE_CALLBACK ; + + masterReadCallback_ = readCallback; + masterWriteCallback_ = writeCallback; + ioCancelCallback_ = ioCancelCallback; + readCtx_ = readCtx; + writeCtx_ = writeCtx; + + masterEofSent_ = 0; + masterEofReceived_ = 0; + + slaveDeadCallback_ = NULL; + + masterMutex_.setName("IOMixer::Master"); + slavesMutex_.setName("IOMixer::Slaves"); + + // + // Generate object name. + // + + snprintf(buf, sizeof(buf) - 1, "IOMixer/0x%p", this); + + objectName_ = buf; + + // + // Load ZLib for compression. + // + + initZLib(); + + // + // Set init OK flag. + // + + init_ = 1; + + // + // Error handler. + // + + fail: + + DBG_LEAVE("IOMixer::IOMixer"); + } + + // + // Retrieve pointer to slave object with given ID, + // added by addSlave() before. + // + // RETURNS: Pointer to slave object or NULL if wrong ID. + // + + IOMixerSlave *IOMixer::getSlave(int id) + { + map::iterator it = slaves_.find(id); + + if (it != slaves_.end()) + { + return it -> second; + } + + DEBUG1("Slave ID [%d] for master FDs [%d][%d] does not exist.\n", + id, masterIn_, masterOut_); + + return NULL; + } + + // + // Remove slave with given ID. + // + // id - ID of slave to remove, retrieved from addSlave() before (IN). + // + // RETURNS: 0 if OK. + // + + int IOMixer::removeSlave(int id) + { + DBG_ENTER("IOMixer::removeSlave"); + + slavesMutex_.lock(); + + IOMixerSlave *slave = getSlave(id); + + if (slave) + { + #ifdef WIN32 + DWORD unused = 0; + #endif + + DEBUG4("IOMixer::removeSlave : Closing slave ID [%d] FDs [%d][%d]" + " for master FDs [%d][%d]...\n", slave -> id_, + slave -> fdout_, slave -> fdin_, masterOut_, masterIn_); + + if (slave -> fdout_ != -1) + { + close(slave -> fdout_); + + DBG_SET_DEL("CRT FD", slave -> fdout_); + + slave -> fdout_ = -1; + } + + if (slave -> fdin_ != -1) + { + close(slave -> fdin_); + + DBG_SET_DEL("CRT FD", slave -> fdin_); + + slave -> fdin_ = -1; + } + + // + // Cancel slave loop thread and wait until finished. + // + + if (slave -> thread_) + { + DEBUG4("IOMixer::removeSlave : joining thread slave ID#%d...\n", id); + + + + #ifdef WIN32 + { + SetEvent(slave -> cancelEvent_); + } + #else + if (write(slave -> cancelFd_[1], "x", 1) <= 0) + { + DEBUG1("WARNING: Cannot cancel IO for slave ID#%d.\n", id); + } + #endif + + ThreadWait(slave -> thread_); + ThreadClose(slave -> thread_); + + slave -> thread_ = NULL; + } + + #ifdef WIN32 + { + if (slave -> ov_.hEvent) + { + DEBUG4("IOMixer::removeSlave : clearing overlapped struct for slave ID#%d...\n", id); + + CloseHandle(slave -> ov_.hEvent); + + DBG_SET_DEL("event", slave -> ov_.hEvent); + + slave -> ov_.hEvent = NULL; + } + } + #endif + + // + // Close cancel event on windows. + // + + #ifdef WIN32 + { + if (slave -> cancelEvent_) + { + CloseHandle(slave -> cancelEvent_); + + DBG_SET_DEL("event", slave -> cancelEvent_); + } + } + + // + // Close cancel FDs on linux. + // + + #else + { + if (slave -> cancelFd_[0] != -1) + { + close(slave -> cancelFd_[0]); + + DBG_SET_DEL("fd", slave -> cancelFd_[0]); + + slave -> cancelFd_[0] = -1; + } + + if (slave -> cancelFd_[1] != -1) + { + close(slave -> cancelFd_[1]); + + DBG_SET_DEL("fd", slave -> cancelFd_[1]); + + slave -> cancelFd_[1] = -1; + } + } + #endif + + // + // Free slave struct. + // + + DEBUG4("IOMixer::removeSlave : destroying slave ID#%d.\n", id); + + delete slave; + + slaves_.erase(id); + + DEBUG2("IOMixer::removeSlave : slave ID#%d destroyed.\n", id); + } + + slavesMutex_.unlock(); + + DBG_LEAVE("IOMixer::removeSlave"); + + return 0; + } + + // + // Start up master thread, which reading from + // and dispatching readed data to slaves. + // + // WARNING: If master thread will be started BEFORE registering + // needed slaves via addSlave(), all incoming data + // will be ignored with "ERROR: Unknown slave ID.". + // + // RETURNS: 0 if OK. + // + + int IOMixer::start() + { + int exitCode = -1; + + DEBUG4("IOMixer::start : Starting master thread for" + " FDs [%d][%d]...\n", masterOut_, masterIn_); + + FAILEX(init_ == 0, "ERROR: IOMixer object was not initiated correctly.\n"); + + masterThread_ = ThreadCreate((ThreadEntryProto) IOMixer::masterLoop, this); + + DBG_SET_RENAME("thread", masterThread_, "IOMixer::masterLoop"); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return 0; + } + + // + // Stop master thread started before by start() method. + // + // RETURNS: 0 if OK. + // + + int IOMixer::stop() + { + DEBUG4("IOMixer::stop : Stopping master thread for" + " FDs [%d][%d]...\n", masterOut_, masterIn_); + + dead_ = 1; + + if (ioCancelCallback_) + { + ioCancelCallback_(readCtx_); + ioCancelCallback_(writeCtx_); + } + + if (masterThread_) + { + DEBUG3("IOMixer::stop : Waiting for master thread for IOMixer PTR#%p.\n", this); + + ThreadWait(masterThread_); + ThreadClose(masterThread_); + + masterThread_ = NULL; + } + } + + // + // Thread routine to mix many into one . + // Used internally only. + // One slave = one slave loop = one slave thread. + // + // -> slave1 \ + // -> slave2 -> master + // -> slave3 / + // + // slave - pointer to related I/O slave (IN/OUT). + // + // RETURNS: 0 if OK. + // + + int IOMixer::slaveLoop(IOMixerSlave *slave) + { + DBG_ENTER("IOMixer::slaveLoop"); + + char buf[IOMIXER_MAX_PACKET]; + + int readed = 1; + + int id = slave -> id_; + + int ret = -1; + + IOMixer *this_ = slave -> this_; + + this_ -> addRef(); + + #ifdef WIN32 + HANDLE handle = (HANDLE) _get_osfhandle(slave -> fdin_); + + slave -> ov_.hEvent = CreateEvent(NULL, TRUE, TRUE, NULL); + + DBG_SET_ADD("event", slave -> ov_.hEvent, "IOMixerSlave::ov_"); + #endif + + // + // Copy every + // + // - readed from slave + // + // into: + // + // written to master OUT. + // + + while(readed > 0 && this_ -> dead_ == 0) + { + // + // Read from slave. + // + + DEBUG4("IOMixer::slaveLoop : Waiting for data from slave" + " FD [%d] ID [%d]...\n", slave -> fdin_, slave -> id_); + + DBG_IO_READ_BEGIN(this_ -> objectName(), id, buf, sizeof(buf)); + + #ifdef WIN32 + { + HANDLE events[2] = + { + slave -> ov_.hEvent, + slave -> cancelEvent_ + }; + + ReadFile(handle, buf, sizeof(buf), NULL, &slave -> ov_); + + switch(WaitForMultipleObjects(2, events, FALSE, INFINITE)) + { + case WAIT_OBJECT_0 + 0: + { + GetOverlappedResult(handle, &slave -> ov_, (PDWORD) &readed, FALSE); + + break; + } + + case WAIT_OBJECT_0 + 1: + { + DEBUG1("IOMixer::slaveLoop: Read canceled on FD #%d.\n", slave -> fdin_); + + readed = 0; + + break; + } + } + + if (WaitForSingleObject(slave -> cancelEvent_, 0) == WAIT_OBJECT_0) + { + DEBUG1("IOMixer::slaveLoop: Read canceled on FD #%d.\n", slave -> fdin_); + + readed = 0; + } + } + #else + { + fd_set rfd; + + int fdmax = std::max(slave -> fdin_, slave -> cancelFd_[0]); + + FD_ZERO(&rfd); + + FD_SET(slave -> fdin_, &rfd); + FD_SET(slave -> cancelFd_[0], &rfd); + + select(fdmax + 1, &rfd, NULL, NULL, NULL); + + if (FD_ISSET(slave -> cancelFd_[0], &rfd)) + { + DBG_INFO("Read canceled on slave #%d.\n", slave -> id_); + + readed = 0; + } + else if (FD_ISSET(slave -> fdin_, &rfd)) + { + readed = read(slave -> fdin_, buf, sizeof(buf)); + } + } + #endif + + DEBUG4("IOMixer::slaveLoop : Readed [%d] bytes from slave" + " FD [%d] ID [%d].\n", readed, slave -> fdin_, slave -> id_); + + DBG_IO_READ_END(this_ -> objectName(), id, buf, readed); + + // + // Write into master. + // + + DBG_IO_WRITE_BEGIN(this_ -> objectName(), 0, buf, readed); + + ret = this_ -> masterEncode(id, buf, readed, slave -> flags_); + + DBG_IO_WRITE_END(this_ -> objectName(), 0, buf, readed); + + FAIL(ret != 0); + + FAIL(readed <= 0); + } + + // + // EOF or error. + // Worker finished. + // + + fail: + + slave -> eofSent_ == 1; + + DEBUG1("IOMixer::slaveLoop : Job for slave ID [%d] for FDs [%d][%d]" + " finished with code [%d].\n", slave -> id_, this_ -> masterOut_, + this_ -> masterIn_, GetLastError()); + + #ifdef WIN32 + { + CloseHandle(slave -> ov_.hEvent); + + DBG_SET_DEL("event", slave -> ov_.hEvent); + + slave -> ov_.hEvent = NULL; + } + #endif + + // + // Tell caller about slave dead if he set callback. + // + + if (this_ && this_ -> slaveDeadCallback_) + { + this_ -> slaveDeadCallback_(id, this_ -> slaveDeadCallbackCtx_); + } + + this_ -> release(); + + DBG_LEAVE("IOMixer::slaveLoop"); + + return 0; + }; + + // + // Thread routine to split one into many . + // Used internally only. + // + // / slave1 + // -> master - slave2 + // \ slave3 + // + // this_ - pointer to related IOMixer object (IN/OUT). + // + // RETURNS: 0 if OK. + // + + int IOMixer::masterLoop(IOMixer *this_) + { + DBG_ENTER("IOMixer::masterLoop"); + + int readed = 0; + int len = 0; + int slaveId = 0; + + IOMixerSlave *slave = NULL; + + map::iterator it; + + char data[IOMIXER_MAX_PACKET]; + + int id = -1; + int size = -1; + int ret = -1; + + this_ -> addRef(); + + // + // Unpack one into many : + // + // / slave1 + // -> master - slave2 + // \ slave3 + // + + while(this_ -> masterEofReceived_ == 0) + { + // + // Decode packet from master IN. + // + + DBG_IO_READ_BEGIN(this_ -> objectName(), 0, data, sizeof(data)); + + ret = this_ -> masterDecode(&id, &size, data, sizeof(data)); + + DBG_IO_READ_END(this_ -> objectName(), 0, data, size); + + FAIL(ret != 0); + + // + // <= 0 means EOF or ERROR. + // + + if (size <= 0) + { + // + // ID #0 is reserved for master. + // It means close master connection and leave master loop. + // EOF #0 is sent by remote via IOMixer::shutdown() function. + // + + if (id == 0) + { + DEBUG1("IOMixer::masterLoop : Received EOF on master #0\n"); + + this_ -> masterEofReceived_ = 1; + } + + // + // EOF on slave with id . + // Remove slave and go on. + // + + else + { + DEBUG1("IOMixer::masterLoop : Received EOF on slave ID #%d.\n", id); + + this_ -> slavesMutex_.lock(); + + slave = this_ -> getSlave(id); + + if (slave) + { + slave -> eofReceived_ = 1; + + if (slave -> fdout_ != -1) + { + close(slave -> fdout_); + + DBG_SET_DEL("CRT FD", slave -> fdout_); + + slave -> fdout_ = -1; + } + } + + this_ -> slavesMutex_.unlock(); + } + } + + // + // Otherwise, write bytes of to slave with ID . + // + + else + { + DBG_IO_WRITE_BEGIN(this_ -> objectName(), id, data, size); + + this_ -> slaveWrite(id, data, size); + + DBG_IO_WRITE_END(this_ -> objectName(), id, data, size); + } + } + + // + // Clean up. + // + + fail: + + DEBUG1("IOMixer::masterLoop : Finished with code [%d].\n", GetLastError()); + + // + // If we exited masterLoop before we received master EOF + // it means connection brooken. + // Then, set masterEofReceived_ manually to avoid infinite loop + // in shutdown(), where we're waiting for remote EOF after + // we sent own one. + // + + if (this_ -> masterEofReceived_ == 0) + { + if (this_ -> quietMode_ == 0) + { + Error("IOMixer::masterLoop : connection broken.\n"); + } + + this_ -> masterEofReceived_ = 1; + } + + // + // Tell caller about master #0 dead. + // + + if (this_ && this_ -> slaveDeadCallback_) + { + this_ -> slaveDeadCallback_(0, this_ -> slaveDeadCallbackCtx_); + } + + this_ -> release(); + + DBG_LEAVE("IOMixer::masterLoop"); + + return 0; + } + + // + // Wait until 'master thread' and every 'slave threads' finished works. + // + // RETURNS: 0 if OK. + // + + int IOMixer::join() + { + DBG_ENTER("IOMixer::join"); + + // + // Join to all slave threads. + // + + flush(); + + // + // Join master thread first. + // + + DEBUG4("IOMixer::join : Joining to master thread...\n"); + + if (masterThread_) + { + ThreadWait(masterThread_); + ThreadClose(masterThread_); + + masterThread_ = NULL; + } + + DBG_LEAVE("IOMixer::join"); + + return 0; + } + + // + // Desctructor. + // Kill master thread and all slaves. + // + + IOMixer::~IOMixer() + { + DBG_ENTER("IOMixer::~IOMixer"); + + // + // Check is this pointer correct. + // + + if (isPointerCorrect(this) == 0) + { + Error("ERROR: Attemp to destroy non existing IOMixer PTR#%p.\n", this); + + return; + } + + // + // Track created instances. + // + + instancesMutex_.lock(); + instances_.erase(this); + instancesMutex_.unlock(); + + shutdown(); + + #ifdef WIN32 + { + if (masterInOV_.hEvent) + { + CloseHandle(masterInOV_.hEvent); + + DBG_SET_DEL("event", masterInOV_.hEvent); + + masterInOV_.hEvent = NULL; + } + + if (masterOutOV_.hEvent) + { + CloseHandle(masterOutOV_.hEvent); + + DBG_SET_DEL("event", masterOutOV_.hEvent); + + masterOutOV_.hEvent = NULL; + } + } + #endif + + // + // Free ZLib library if needed. + // + + if (zlib_) + { + #ifdef WIN32 + FreeLibrary(zlib_); + #else + dlclose(zlib_); + #endif + } + + DBG_SET_DEL("IOMixer", this); + + DBG_LEAVE("IOMixer::~IOMixer"); + } + + // + // Encode into and write it into master OUT. + // + // TIP: If is <= 0, then part will be skipped. + // It's equal to sending EOF/error to other side, where remote + // read() will return -1/0. + // + // id - channel id where to send data (IN). + // buf - buffer to send (IN). + // size - size of buf[] buffer in bytes (IN). + // flags - combination of IOMIXER_FLAG_XXX flags (IN). + // + // RETURNS: 0 if OK. + // + + int IOMixer::masterEncode(int id, void *buf, int size, uint8_t flags) + { + DBG_ENTER5("IOMixer::masterEncode"); + + int exitCode = -1; + + int packetSize; + + struct Packet + { + int32_t channelId_; + uint8_t flags_; + int32_t dataSize_; + + char data_[1]; + } + __attribute__((__packed__)); + + if (zlibLoaded_) + { + packetSize = zlibCompressBound_(size) + sizeof(Packet); + } + else + { + packetSize = size + sizeof(Packet); + } + + Packet *packet = (Packet *) malloc(packetSize); + + DEBUG4("IOMixer::masterEncode : Going to write [%d] bytes from slave ID [%d]" + " to master [%d].\n", size, id, masterOut_); + + masterMutex_.lock(); + + // + // Generate packet. + // + + packet -> channelId_ = id; + packet -> flags_ = flags; + packet -> dataSize_ = size; + + // + // Compression enabled. + // + + if (size > 256 && flags & IOMIXER_FLAG_COMPRESSION_ON && zlibLoaded_) + { + int compSize = packetSize - sizeof(Packet); + + int ret = zlibCompress_(packet -> data_, &compSize, buf, size); + + FAILEX(ret != 0, "ERROR: Compression failed with code [%d].\n", ret); + + packet -> dataSize_ = compSize; + + DEBUG5("IOMixer::masterEncode : Compressed [%d] bytes into [%d] (ratio %lf%%).\n", + size, compSize, double(compSize) / double(size) * 100.0); + + size = compSize; + } + + // + // Raw data. + // + + else if (size > 0) + { + packet -> flags_ &= ~IOMIXER_FLAG_COMPRESSION_ON; + + memcpy(packet -> data_, buf, size); + } + + // + // Write prefix. + // + + FAIL(masterWrite(packet, size + 9)); + + // + // If greater than zero write bytes of . + // + + if (size > 0) + { + DEBUG3("IOMixer::masterEncode : Written [%d] bytes with ID [%d]" + " to master [%d].", size, id, masterOut_); + } + else + { + DEBUG1("IOMixer::masterEncode : Sent EOF to slave ID [%d].", id); + } + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode && quietMode_ == 0) + { + Error("ERROR: Cannot encode packet to master OUT [%d].\n" + "Error code is : %d.\n", masterOut_, GetLastError()); + } + + masterMutex_.unlock(); + + if (packet) + { + free(packet); + } + + DBG_LEAVE5("IOMixer::masterEncode"); + + return exitCode; + } + + // + // Pop packet from master IN. + // + // id - buffer where to store decoded (OUT). + // size - buffer where to store decoded (OUT). + // data - buffer where to store decoded (OUT). + // dataSize - size of data[] buffer in bytes (IN). + // + // RETURNS: Number of decoded bytes of -1 if error. + // + + int IOMixer::masterDecode(int *id, int *size, void *data, int dataSize) + { + DBG_ENTER5("IOMixer::masterDecode"); + + int exitCode = -1; + + uint8_t flags; + + // + // Read head. + // + + FAIL(masterRead(id, 4)); + FAIL(masterRead(&flags, 1)); + FAIL(masterRead(size, 4)); + + DEBUG3("IOMixer::masterDecode : Readed <%d><%d><%d> head" + " from master [%d].", *id, (int) flags, *size, masterIn_); + + // + // Fail if data[] too small to store whole . + // + + FAILEX(dataSize < *size, "ERROR: Packet too big.\n"); + + // + // If greater than 0 read bytes of . + // + + if (*size > 0) + { + // + // Incoming data compressed. + // + + if (flags & IOMIXER_FLAG_COMPRESSION_ON) + { + unsigned char *compData = (unsigned char *) malloc(*size); + + int compSize = *size; + + // + // Read compressed data. + // + + if (masterRead(compData, *size) != 0) + { + free(compData); + + goto fail; + } + + // + // Decompress into caller buffer. + // + + if (zlibLoaded_) + { + *size = dataSize; + + zlibUncompress_(data, size, compData, compSize); + } + else + { + Error("ERROR: ZLib not available, but compressed data received.\n"); + + goto fail; + } + } + + // + // Incoming data are uncompressed. + // + + else + { + FAIL(masterRead(data, *size)); + } + + DEBUG3("IOMixer::masterDecode : Readed [%d] bytes for ID [%d]" + " from from master [%d].", *size, *id, masterIn_); + } + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode && quietMode_ == 0) + { + Error("ERROR: Cannot decode packet from master IN [%d].\n" + "Error code is : %d.\n", masterIn_, GetLastError()); + } + + DBG_LEAVE5("IOMixer::masterDecode"); + + return exitCode; + } + + // + // Atomic write bytes from to master OUT. + // + // Wrapper to system write() to hide difference beetwen socket + // and CRT FD on windows. + // + // buf - buffer with data to write (IN). + // bytesToWrite - number of bytes to be written (IN). + // + // RETURNS: 0 if all data written + // -1 if otherwise. + // + + int IOMixer::masterWrite(void *buf, int bytesToWrite) + { + DBG_ENTER5("IOMixer::masterWrite"); + + int exitCode = -1; + + int written = -1; + + char *src = (char *) buf; + + // + // Reject if already sent master EOF to remote. + // It meaans that we decalared - "we will not sent nothing anymore". + // + + if (masterEofSent_) + { + DEBUG3("Master EOF already sent - write rejected.\n"); + } + else + { + DBG_DUMP(buf, bytesToWrite); + + switch(masterOutType_) + { + // + // Master OUT is a SOCKET. + // Use send(). + // + + case IOMIXER_TYPE_SOCKET: + { + while(bytesToWrite > 0) + { + DEBUG4("IOMixer::masterWrite : writing [%d] bytes to master FD [%d]...\n", + bytesToWrite, masterOut_); + + // + // Windows. + // + + #ifdef WIN32 + { + WSABUF wsabuf = {bytesToWrite, src}; + + WSASend(masterOut_, &wsabuf, 1, NULL, 0, &masterOutOV_, NULL); + + WaitForSingleObject(masterOutOV_.hEvent, INFINITE); + + GetOverlappedResult(HANDLE(masterOut_), &masterOutOV_, PDWORD(&written), FALSE); + } + + // + // Linux, MacOS. + // + + #else + { + written = send(masterOut_, src, bytesToWrite, 0); + } + #endif + + FAIL(written <= 0); + + bytesToWrite -= written; + + src += written; + } + + break; + } + + // + // Master OUT is a CRT FD. + // Use write(). + // + + case IOMIXER_TYPE_FD: + { + while(bytesToWrite > 0) + { + DEBUG4("IOMixer::masterWrite : writing [%d] bytes to master FD [%d]...\n", + bytesToWrite, masterOut_); + + written = write(masterOut_, src, bytesToWrite); + + FAIL(written <= 0); + + bytesToWrite -= written; + + src += written; + } + + break; + } + + // + // Master OUT is a callback function. + // + + case IOMIXER_TYPE_CALLBACK: + { + while(bytesToWrite > 0) + { + written = masterWriteCallback_(src, bytesToWrite, -1, writeCtx_); + + FAIL(written <= 0); + + bytesToWrite -= written; + + src += written; + } + + break; + } + } + } + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode && quietMode_ == 0) + { + Error("ERROR: Cannot write to master IN.\n" + "Error code is : %d.\n", GetLastError()); + } + + DBG_LEAVE5("IOMixer::masterWrite"); + + return exitCode; + } + + // + // Atomic read bytes from master IN to . + // + // Wrapper to system read() to hide difference beetwen socket + // and CRT FD on windows. + // + // buf - buffer with data to write (IN). + // bytesToRead - number of bytes to be readed (IN). + // + // RETURNS: 0 if all data readed + // -1 if otherwise. + // + + int IOMixer::masterRead(void *buf, int bytesToRead) + { + DBG_ENTER5("IOMixer::masterRead"); + + int exitCode = -1; + + int readed = -1; + + char *dst = (char *) buf; + + // + // Reject if we already received master EOF from remote. + // It means that remote machine declared, that it has no + // any more data to sent to us. + // + + FAILEX(masterEofReceived_, + "ERROR: Master EOF already received - read rejected.\n"); + + switch(masterInType_) + { + // + // Master IN is a SOCKET. + // Use recv(). + // + + case IOMIXER_TYPE_SOCKET: + { + while(bytesToRead > 0) + { + // + // Windows. + // + + #ifdef WIN32 + { + readed = 0; + + WSANETWORKEVENTS wsaEvents = {0}; + + WSAEventSelect(SOCKET(masterIn_), + masterInOV_.hEvent, + FD_READ | FD_CLOSE); + + if (WaitForSingleObject(masterInOV_.hEvent, INFINITE) == WAIT_OBJECT_0) + { + WSAEnumNetworkEvents(SOCKET(masterIn_), + masterInOV_.hEvent, &wsaEvents); + + if (wsaEvents.lNetworkEvents & FD_READ) + { + masterMutex_.lock(); + + readed = recv(masterIn_, dst, bytesToRead, 0); + + masterMutex_.unlock(); + + FAIL(readed <= 0); + } + } + } + + // + // Linux, MacOS. + // + + #else + { + readed = recv(masterIn_, dst, bytesToRead, 0); + + FAIL(readed <= 0); + } + #endif + + if (readed > 0) + { + bytesToRead -= readed; + + dst += readed; + } + } + + break; + } + + // + // Master IN is a CRT FD. + // Use read(). + // + + case IOMIXER_TYPE_FD: + { + while(bytesToRead > 0) + { + readed = read(masterIn_, dst, bytesToRead); + + FAIL(readed <= 0); + + bytesToRead -= readed; + + dst += readed; + } + + break; + } + + // + // Master IN is a callback function. + // + + case IOMIXER_TYPE_CALLBACK: + { + while(bytesToRead > 0) + { + readed = masterReadCallback_(dst, bytesToRead, -1, readCtx_); + + FAIL(readed <= 0); + + bytesToRead -= readed; + + dst += readed; + } + + break; + } + } + + if (readed > 0) + { + DBG_DUMP(buf, readed); + } + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode && quietMode_ == 0) + { + Error("ERROR: Cannot read from master IN.\n" + "Error code is : %d.\n", GetLastError()); + } + + DBG_LEAVE5("IOMixer::masterRead"); + + return exitCode; + } + + // + // Write bytes from to slave with id . + // + // id - id of target slave (IN). + // buf - source buffer to write (IN). + // size - number of bytes to be written (IN). + // + // RETURNS: 0 if all data written, + // -1 otherwise. + // + + int IOMixer::slaveWrite(int id, void *buf, int size) + { + int exitCode = -1; + int written = -1; + + // + // Search for slave with given ID. + // + + IOMixerSlave *slave = getSlave(id); + + // + // If exists write bytes of on its output. + // + + if (slave) + { + if (slave -> eofSent_) + { + DEBUG3("EOF already sent on slave ID#%d - write rejected.\n", id); + } + else + { + slave -> writeMutex_.lock(); + + DEBUG4("IOMixer::slaveWrite : Writing [%d] bytes to slave FD [%d]" + " ID [%d]...\n", size, slave -> fdout_, id); + + written = write(slave -> fdout_, buf, size); + + slave -> writeMutex_.unlock(); + + FAIL(written != size); + } + } + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode && quietMode_ == 0) + { + Error("ERROR: Cannot write to slave ID [%d].\n" + "Error code is : %d.\n", id, GetLastError()); + } + + return exitCode; + } + + // + // Shutdown master FD. It sends EOF for ID #0, + // where ID #0 is reserved for master. + // + + int IOMixer::shutdown() + { + DBG_ENTER("IOMixer::shutdown"); + + int exitCode = -1; + + int timeleft = 10; + + map::iterator it; + + FAIL(dead_); + + dead_ = 1; + + // + // Flush pending operations. + // + + // flush(); + + // + // For every slave do: + // + // - Send <0> to remote (it means slave #ID EOF). + // + + slavesMutex_.lock(); + + for (it = slaves_.begin(); it != slaves_.end(); it++) + { + int id = it -> second -> id_; + + DEBUG4("IOMixer::shutdown : Sending EOF on channel ID#%d...\n", id); + + masterEncode(id, NULL, 0, 0); + + it -> second -> eofSent_ = 1; + } + + slavesMutex_.unlock(); + + // + // Send <0><0> packet on Master OUT. + // + + DEBUG4("IOMixer::shutdown : Sending master EOF...\n"); + + masterEncode(0, NULL, 0, 0); + + masterEofSent_ = 1; + + // + // Wait until remote sent its master EOF. + // + + DEBUG4("IOMixer::shutdown : Waiting for remote master EOF...\n"); + + while(masterEofReceived_ == 0 && timeleft > 0) + { + #ifdef WIN32 + Sleep(100); + #else + usleep(100000); + #endif + + timeleft --; + } + + if (timeleft <= 0) + { + DEBUG1("IOMixer::shutdown : WARNING: Timeout while" + " waiting for remote master EOF.\n"); + + masterEofReceived_ = 1; + } + + // + // Stop master thread. + // We don't want to read anything from remote more. + // + + flush(); + stop(); + + // + // Remove all slaves. + // + + while(slaves_.size() > 0) + { + removeSlave(slaves_.begin() -> second -> id_); + } + + exitCode = 0; + + // + // Error handler. + // + + fail: + + DBG_LEAVE("IOMixer::shutdown"); + + return exitCode; + } + + // + // Wait until all slave threads finished work. + // + + int IOMixer::flush() + { + DBG_ENTER("IOMixer::flush"); + + map::iterator it; + + // + // Join slave threads. + // + + slavesMutex_.lock(); + + for (it = slaves_.begin(); it != slaves_.end(); it++) + { + IOMixerSlave *sl = slaves_.begin() -> second; + + DEBUG4("IOMixer::flush : flushing slave ID#%d...\n", sl -> id_); + + #ifdef WIN32 + { + SetEvent(sl -> cancelEvent_); + } + #else + if (write(sl -> cancelFd_[1], "x", 1) <= 0) + { + DEBUG1("WARNING: Cannot cancel IO for slave ID#%d.\n", sl -> id_); + } + #endif + + if (sl -> thread_) + { + ThreadWait(sl -> thread_); + ThreadClose(sl -> thread_); + + sl -> thread_ = NULL; + } + } + + slavesMutex_.unlock(); + + DBG_LEAVE("IOMixer::flush"); + + return 0; + } + + // + // Register callback to inform caller when slave with given ID dead. + // + // callback - pointer to function, which will be called if one + // of slave dead (IN). + // + // ctx - custom, caller specified data passed directly + // into callback (IN/OPT). + // + // RETURNS: none. + // + + void IOMixer::setSlaveDeadCallback(IOSlaveDeadProto callback, void *ctx) + { + DEBUG1("IOMixer : Registered slave dead callback [%p][%p].\n", callback, ctx); + + slaveDeadCallback_ = callback; + slaveDeadCallbackCtx_ = ctx; + } + + // + // Enable/disble quiet mode to avoid printint error messages longer. + // + + void IOMixer::setQuietMode(int value) + { + quietMode_ = value; + } + + // + // Check is given this pointer points to correct IOMixer *object. + // + // ptr - this pointer to check (IN). + // + // RETURNS: 1 if given pointer points to correct IOMixer object, + // 0 otherwise. + // + + int IOMixer::isPointerCorrect(IOMixer *ptr) + { + int found = 0; + + instancesMutex_.lock(); + found = instances_.count(ptr); + instancesMutex_.unlock(); + + return found; + } + + // + // Enable or disable IOMIXER_FLAG_COMPRESSION_ON flag on selected + // channel. After that outcoming data on this channel will be + // compressed/uncompressed. + // + // id - slave ID to change (IN). + // enabled - set to 1 to enable compression, 0 to disable (IN). + // + // RETURNS: 0 if OK. + // + + int IOMixer::setSlaveCompression(int id, int enabled) + { + int exitCode = -1; + + IOMixerSlave *slave = getSlave(id); + + FAILEX(slave == NULL, "ERROR: Incorrect slave ID#%d.\n", id); + + FAILEX(zlibCompress_ == NULL, "ERROR: ZLib library not available.\n"); + + if (enabled) + { + slave -> flags_ |= IOMIXER_FLAG_COMPRESSION_ON; + } + else + { + slave -> flags_ &= ~IOMIXER_FLAG_COMPRESSION_ON; + } + + DEBUG1("IOMixer : Enabled compression on channel #%d.\n.", id); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot enable commpression on channel #%d.\n", id); + } + + return exitCode; + } + + // + // Initialize ZLib library. + // Called internally only. + // + // RETURNS: 0 if OK. + // + + int IOMixer::initZLib() + { + int exitCode = -1; + + #ifdef WIN32 + { + zlib_ = LoadLibrary("z.dll"); + + zlibCompress_ = (ZLibCompressProto) GetProcAddress(zlib_, "compress"); + zlibUncompress_ = (ZLibUncompressProto) GetProcAddress(zlib_, "uncompress"); + zlibCompressBound_ = (ZLibCompressBoundProto) GetProcAddress(zlib_, "compressBound"); + + } + #else + { + zlib_ = dlopen("libz.so", RTLD_LAZY); + + zlibCompress_ = (ZLibCompressProto) dlsym(zlib_, "compress"); + zlibUncompress_ = (ZLibUncompressProto) dlsym(zlib_, "uncompress"); + zlibCompressBound_ = (ZLibCompressBoundProto) dlsym(zlib_, "compressBound"); + } + #endif + + if (zlib_ && zlibCompress_ && zlibUncompress_ && zlibCompressBound_) + { + zlibLoaded_ = 1; + + exitCode = 0; + + DEBUG1("IOMixer::IOMixer : ZLib loaded.\n"); + } + else + { + zlibLoaded_ = 0; + + DEBUG1("WARNING: Cannot to load ZLib library. Compression not available.\n"); + } + + return exitCode; + } + + // + // Get object name generated in constructor. + // + + const char *IOMixer::objectName() + { + // + // Check is this pointer correct. + // + + if (isPointerCorrect(this) == 0) + { + Error("ERROR: Called objectName() on non existing IOMixer PTR#%p.\n", this); + + return "Incorrect"; + } + else + { + return objectName_.c_str(); + } + } + + // + // Increase refference counter. + // + // WARNING! Every call to addRef() MUSTS be followed by one release() call. + // + // TIP #1: Object will not be destroyed until refference counter is greater + // than 0. + // + // TIP #2: Don't call destructor directly, use release() instead. If + // refference counter achieve 0, object will be destroyed + // automatically. + // + + void IOMixer::addRef() + { + refCountMutex_.lock(); + + refCount_ ++; + + DEBUG2("Increased refference counter to %d for IOMixer PTR#%p.\n", + refCount_, this); + + refCountMutex_.unlock(); + } + + // + // Decrease refference counter increased by addRef() before. + // + + void IOMixer::release() + { + int deleteNeeded = 0; + + // + // Check is this pointer correct. + // + + if (isPointerCorrect(this) == 0) + { + Error("ERROR: Attemp to release non existing IOMixer PTR#%p.\n", this); + + return; + } + + // + // Decrease refference counter by 1. + // + + refCountMutex_.lock(); + + refCount_ --; + + DEBUG2("Decreased refference counter to %d for IOMIxer PTR#%p.\n", + refCount_, this); + + if (refCount_ == 0) + { + deleteNeeded = 1; + } + + refCountMutex_.unlock(); + + // + // Delete object if refference counter goes down to 0. + // + + if (deleteNeeded) + { + delete this; + } + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibIO/IOMixer.h b/Source/Core/LibIO/IOMixer.h new file mode 100644 index 0000000..755cbde --- /dev/null +++ b/Source/Core/LibIO/IOMixer.h @@ -0,0 +1,415 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_LibIO_H +#define Tegenaria_Core_LibIO_H + +#define IOMIXER_MAX_PACKET (1024 * 64) + +#ifdef WIN32 +# include +# include +# include +#else +# include +# include +# include +#endif + +#include +#include +#include +#include +#include + +#include +#include +#include + +namespace Tegenaria +{ + using std::map; + using std::set; + using std::min; + using std::max; + + #define IOMIXER_TYPE_AUTO 0 + #define IOMIXER_TYPE_FD 1 + #define IOMIXER_TYPE_SOCKET 2 + #define IOMIXER_TYPE_CALLBACK 3 + + #define IOMIXER_FLAG_COMPRESSION_ON (1 << 0) + #define IOMIXER_FLAG_ENCRYPTION_ON (1 << 1) + + // + // Typedef. + // + + typedef int (*IOReadProto)(void *buf, int count, int timeout, void *ctx); + typedef int (*IOWriteProto)(void *buf, int count, int timeout, void *ctx); + typedef void (*IOCancelProto)(void *ctx); + typedef void (*IOSlaveDeadProto)(int id, void *ctx); + + // + // ZLib typedefs. + // + + typedef int (*ZLibCompressProto)(void *dest, int *destLen, + const void *source, int sourceLen); + + typedef int (*ZLibUncompressProto)(void *dest, int *destLen, + const void *source, int sourceLen); + + typedef int (*ZLibCompressBoundProto)(int sourceLen); + + // + // Forward declarations. + // + + class IOMixer; + + // + // -------------- ------------ | ... | + // | | | | | | + // | | | | | | + // | OUT| |IN | | | + // | -----------> -----------> ... ----> MasterOut + // | | | | | | + // | Caller | | Slave | | IOMixer | + // | | | | | | + // | IN| |OUT | | | + // | <----------- ... <---------- ... ----- MasterIn + // | | | | | | + // -------------- ------------ | | + // ... + // + + struct IOMixerSlave + { + // + // Slave ID unique locally - inside one IOMixer context. + // NOT unique globally. + // + + int id_; + + // + // Save that remote side already sent <0> packet + // that means input is closed. + // + + int eofSent_; + int eofReceived_; + + // + // Slave in/out sinks. + // + // Used by: + // + // - IOMixer to communicate with caller. + // - Caller gets another side of them from 'addSlave()' call. + // + + int fdin_; + int fdout_; + + // + // Event to cancel pending read on Windows. + // + + #ifdef WIN32 + + HANDLE cancelEvent_; + + #else + + // + // FD to cancel pending read on Linux. + // + + int cancelFd_[2]; + + #endif + + // + // Save caller side in/out sinks. + // + // Used by: + // + // - Caller to communicate with master FDs. + // - IOMixer to simulate writing EOF on flush/shutdown. + // + + int callerIn_; + int callerOut_; + + // + // Mutex to synchronize many slaves writing to one master. + // + + Mutex writeMutex_; + + #ifdef WIN32 + OVERLAPPED ov_; + #endif + + // + // Handle of worker thread, where 'slaveLoop' is running. + // + + ThreadHandle_t *thread_; + + // + // Pointer to related IOMixer object. + // + + IOMixer *this_; + + // + // Slave flags. + // See IOMIXER_FLAG_XXX defines. + // + + uint8_t flags_; + }; + + // + // + // + + class IOMixer + { + map slaves_; + + Mutex slavesMutex_; + + int masterIn_; + int masterOut_; + int slavesCount_; + + int masterInType_; + int masterOutType_; + + int dead_; + + int masterEofSent_; + int masterEofReceived_; + + // + // Refference counter. + // + + int refCount_; + + Mutex refCountMutex_; + + // + // Quiet mode to avoid reporting error longer. + // Used when connection is shutted down in usual way. + // + + int quietMode_; + + Mutex masterMutex_; + + ThreadHandle_t *masterThread_; + + #ifdef WIN32 + OVERLAPPED masterInOV_; + OVERLAPPED masterOutOV_; + #endif + + // + // Callback funcions used to read/write from/to master FD. + // + + void *readCtx_; + void *writeCtx_; + + IOReadProto masterReadCallback_; + IOWriteProto masterWriteCallback_; + IOCancelProto ioCancelCallback_; + + // + // Optional callbacks to inform caller about events. + // + + IOSlaveDeadProto slaveDeadCallback_; + + void *slaveDeadCallbackCtx_; + + // + // Main decode and encode loops. + // Internal use only. + // + + static int masterLoop(IOMixer *this_); + static int slaveLoop(IOMixerSlave *slave); + + // + // Low-level functions to read/write single + // packets from/to master FD. + // + // Internal use only. + // + + int masterEncode(int id, void *data, int size, uint8_t flags); + int masterDecode(int *id, int *size, void *data, int dataSize); + + // + // Wrappers for system read/write with master FD to hide + // differences beetwen SOCKET and CRT FD on Windows. + // + // Internal use only. + // + + int masterRead(void *buf, int size); + int masterWrite(void *buf, int size); + + // + // Helper function to write bytes of + // to slave with id . + // + // Internal use only. + // + + int slaveWrite(int id, void *buf, int size); + + // + // Save that object is already corectly inited or not. + // + + int init_; + + // + // Track created instances to check is given this pointer correct or not. + // + + static set instances_; + + static Mutex instancesMutex_; + + // + // ZLib library loaded runtime. + // + + #ifdef WIN32 + HMODULE zlib_; + #else + void *zlib_; + #endif + + int zlibLoaded_; + + ZLibCompressProto zlibCompress_; + + ZLibUncompressProto zlibUncompress_; + + ZLibCompressBoundProto zlibCompressBound_; + + // + // Object name for debug purpose. + // + + string objectName_; + + // + // Public exported functions. + // + + public: + + IOMixerSlave *getSlave(int id); + + int addSlave(int callerFds[2], int id = -1); + + int setSlaveCompression(int id, int enabled); + + int removeSlave(int id); + + int start(); + int stop(); + int shutdown(); + int flush(); + int join(); + + void setSlaveDeadCallback(IOSlaveDeadProto callback, void *ctx); + + // + // Quiet mode to disable error reporting on usual exit. + // + + void setQuietMode(int value); + + // + // Check is given Session *pointer correct. + // + + static int isPointerCorrect(IOMixer *); + + // + // Refference counter. + // + + void addRef(); + void release(); + + // + // Initialize ZLib library. + // + + int initZLib(); + + // + // Get object name generated in constructor. + // + + const char *objectName(); + + // + // Constructor using two Socket/FDs. + // + + IOMixer(int masterIn = 0, int masterOut = 1, + int masterInType = 0, int masterOutType = 0); + + // + // Contsructor using caller specified read/write callback functions. + // + + IOMixer(IOReadProto readCallback, IOWriteProto writeCallback, + void *readCtx, void *writeCtx, IOCancelProto ioCancelCallback = NULL); + + // + // Private constructor. Use release(). + // + + private: + + ~IOMixer(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_LibIO_H */ diff --git a/Source/Core/LibIO/IOTime.cpp b/Source/Core/LibIO/IOTime.cpp new file mode 100644 index 0000000..91f5495 --- /dev/null +++ b/Source/Core/LibIO/IOTime.cpp @@ -0,0 +1,367 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Expand standard read/write functions with timeout functionality. +// All below functions work with CRT FD, retrieved from standard +// open() call (or equivalent). +// + +#include +#include +#include "IOTime.h" + +#ifdef WIN32 +# include +# include +#else +# include +#endif + +namespace Tegenaria +{ + // + // Works like standard CRT read(), but with timeout functionality. + // + // fd - CRT file descriptor (received from open()) (IN) + // buf - buffer where to store readed data (OUT) + // size - number of bytes to read (IN) + // timeout - timeout in ms or -1 for infinite (IN) + // + // RETURNS: number of bytes readed or + // -1 if error. + // + + int IOTimeoutRead(int fd, void *buf, int size, int timeout) + { + DBG_ENTER3("IOTimeoutRead"); + + int exitCode = -1; + + DBG_IO_READ_BEGIN("FD", fd, buf, size); + + // + // Windows. + // FIXME: Use overlapped IO when possible. + // + + #ifdef WIN32 + { + // + // Inifinite timeout. Just call read(). + // + + if (timeout < 0) + { + exitCode = read(fd, buf, size); + } + + // + // Timeout specified. Dispatch code depending on HANDLE type. + // + + else + { + HANDLE handle = HANDLE(_get_osfhandle(fd)); + + DWORD handleType = GetFileType(handle); + + switch(handleType) + { + // + // Char device (console). + // + + case FILE_TYPE_CHAR: + { + DEBUG3("IOTimeoutRead : FD#%d is CHAR device.\n", fd); + + int goOn = 1; + + int sleepTime = 5; + + FlushConsoleInputBuffer(handle); + + DEBUG3("IOTimeoutRead : Falling into wait loop for FD#%d...\n", fd); + + while(goOn) + { + INPUT_RECORD irec = {0}; + + DWORD eventsReaded = 0; + + // + // Peek input console. + // + + FAILEX(PeekConsoleInput(handle, &irec, 1, &eventsReaded) == FALSE, + "ERROR: Cannot peek console input HANDLE #%p FD #%d\n", + handle, fd); + + // + // Check is any events queued in buffer. + // + + if (eventsReaded > 0) + { + // + // Key event. It's signal to read. + // + + if (irec.EventType == KEY_EVENT && irec.Event.KeyEvent.bKeyDown) + { + DEBUG3("IOTimeoutRead : Reading from FD#%d...\n", fd); + + exitCode = read(fd, buf, size); + + goOn = 0; + } + + // + // Non key related event. Pop from queue and skip. + // + + else + { + ReadConsoleInput(handle, &irec, 1, &eventsReaded); + } + } + + // + // Control timeout. + // + + else + { + Sleep(sleepTime); + + timeout -= sleepTime; + + if (timeout <= 0) + { + Error("ERROR: Timeout reached while reading from FD#%d.\n", fd); + + SetLastError(WAIT_TIMEOUT); + + goto fail; + } + + if (sleepTime < 100) + { + sleepTime *= 2; + } + } + } + + break; + } + + // + // Pipe or socket. + // + + case FILE_TYPE_PIPE: + { + int optVal = 0; + int optLen = sizeof(optVal); + + // + // Socket. + // + + if (getsockopt((SOCKET) handle, SOL_SOCKET, + SO_ACCEPTCONN, (char *) &optVal, &optLen) == 0) + { + DEBUG3("IOTimeoutRead : FD#%d is a SOCKET device.\n", fd); + + fd_set rfd; + + struct timeval tv; + + FD_ZERO(&rfd); + + FD_SET(fd, &rfd); + + tv.tv_sec = timeout / 1000; + tv.tv_usec = (timeout % 1000) * 1000; + + DEBUG3("IOTimeoutRead : Falling into select loop for FD#%d...\n", fd); + + if (select((SOCKET) fd + 1, &rfd, NULL, NULL, &tv) > 0 && FD_ISSET(fd, &rfd)) + { + DEBUG3("IOTimeoutRead : Reading from FD#%d...\n", fd); + + exitCode = read(fd, buf, size); + } + else + { + Error("ERROR: Timeout reached while reading from FD#%d.\n", fd); + + goto fail; + } + } + + // + // Pipe. + // + + else + { + DEBUG3("IOTimeoutRead : FD#%d is a PIPE device.\n", fd); + + DWORD readed = 0; + + DWORD pFlags = 0; + + DWORD sleepTime = 5; + + int goOn = 1; + + FAILEX(GetNamedPipeInfo(handle, &pFlags, NULL, NULL, NULL) == FALSE, + "ERROR: Cannot get pipe info for HANDLE #%p FD #%d.\n", + handle, fd); + + + DEBUG3("IOTimeoutRead : Falling into wait loop for FD#%d...\n", fd); + + while(goOn) + { + FAILEX(PeekNamedPipe(handle, NULL, 0, NULL, &readed, NULL) == FALSE, + "ERROR: Cannot peek pipe HANDLE #%p FD #%p.\n", + handle, fd); + + + // + // Any bytes in buffer. It's signal to read. + // + + if (readed > 0) + { + DEBUG3("IOTimeoutRead : Reading from FD#%d...\n", fd); + + exitCode = read(fd, buf, size); + + goOn = 0; + } + + // + // No data in buffer, wait a moment and try again. + // + + else + { + Sleep(sleepTime); + + timeout -= sleepTime; + + if (timeout <= 0) + { + Error("ERROR: Timeout reached while reading from FD#%d.\n", fd); + + SetLastError(WAIT_TIMEOUT); + + goto fail; + } + + if (sleepTime < 100) + { + sleepTime *= 2; + } + } + } + } + + break; + } + + // + // File on disk. + // + + case FILE_TYPE_DISK: + { + DEBUG3("IOTimeoutRead : FD#%d is DISK device.\n", fd); + + exitCode = read(fd, buf, size); + + break; + } + + // + // Unknown type. + // + + default: + { + Error("ERROR: Unknown device type for FD#%d.\n", fd); + + goto fail; + } + } + } + } + + // + // Linux, MacOS. + // Select based. + // + + #else + { + fd_set rfd; + + struct timeval tv; + + FD_ZERO(&rfd); + + FD_SET(fd, &rfd); + + tv.tv_sec = timeout / 1000; + tv.tv_usec = (timeout % 1000) * 1000; + + if (select(fd + 1, &rfd, NULL, NULL, &tv) > 0 && FD_ISSET(fd, &rfd)) + { + exitCode = read(fd, buf, size); + } + } + #endif + + // + // Error handler. + // + + fail: + + if (exitCode < 0) + { + Error("ERROR: Cannot read from FD #%d. Error is %d.\n", fd, GetLastError()); + } + + DBG_IO_READ_END("FD", fd, buf, size); + + DBG_LEAVE3("IOTimeoutRead"); + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibIO/IOTime.h b/Source/Core/LibIO/IOTime.h new file mode 100644 index 0000000..967bd4f --- /dev/null +++ b/Source/Core/LibIO/IOTime.h @@ -0,0 +1,44 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_IOTime_H +#define Tegenaria_Core_IOTime_H + +namespace Tegenaria +{ + struct IOJob + { + int fd_; + + void *buf_; + + int size_; + int ret_; + }; + + int IOTimeoutRead(int fd, void *buf, int size, int timeout); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_IOTime_H */ diff --git a/Source/Core/LibIO/README b/Source/Core/LibIO/README new file mode 100644 index 0000000..5346bcb --- /dev/null +++ b/Source/Core/LibIO/README @@ -0,0 +1,123 @@ +------------------------------------------------------------------------------- +- - +- IOFifo class - +- - +------------------------------------------------------------------------------- + +I. Cyclic buffer to storing I/O data. + Incoming data is appended to the end of buffer. + Outcoming data is popped from the begin of buffer. + (First in first out order). + + xx xx xx xx xx xx xx ... yy yy yy yy yy + + ^^^ ^^^ + Read position. Write position. + Pop data from here. Push data here. + (Begin of buffer) (End of buffer). + +II. Read/write +============== + + To add data to FIFO use push(). + To pop data from FIFO use pop(). + To eat data (pop, but don't write anywhere) use eat(). + +III. Multithread +================ + + IOFifo is NOT thread safe itself. + Use lock() and unlock() to synchronize access from many threads. + +------------------------------------------------------------------------------- +- - +- IOMixer class - +- - +------------------------------------------------------------------------------- + +IOMixer to multiplex one master connection into many slave channels. + +I. Master thread: +================= + + One IOMixer = one master thread = one IOMixer::masterLoop(). + + / [slave1/IN] - ... + [Master] - [slave2/IN] - ... + \ [slave3/IN] - ... + + + Master loop does: + ----------------- + + 1. Read packet from master. + 2. Send bytes of to slave with ID . + + + -> slave1/IN + / + master/OUT -> <1><2> ... -> -> slave2/IN + \ + ... + + Master loop is created in IOMixer::start(). + Master loop is deleted in IOMixer::stop(). + + +II. Slave threads: +================== + + One IOMixer = many slaves threads = many IOMixer::slaveLoop(). + + ... -> [slave1/OUT] \ + ... -> [slave2/OUT] -> [Master/IN] -> + ... -> [slave3/OUT] / + + Slave loop does: + ---------------- + + 1. Read from slave with given . + 2. Write to master. + + + Slave1/OUT -> + \ + Slave2/OUT -> -> <1> <2> ... -> master/IN + / + ... + + + Slave thread is created in IOMixer::addSlave(...) + Slave thread is deleted in IOMixer::removeSlave(..) + + +III. Slave IDs: +=============== + + Slave 0 : Reserved for internal IOMixer usage. + Slave 1, 2, ... : Created by caller in IOMixer::addSlave(). + + +IV. EOF packets: +================ + + Used internally by IOMixer only. + + Zero length data means EOF, i.e. packet <0>. + + If slave loop received EOF it means slave with given is dead + and should be shutted down. + + EOF on slave ID#0 is reserved for master EOF. + It signal to shutdown whole connection. + + +VI. Shutdown protocol: +====================== + + 1. Send EOF for every slaves, i.e. <0>. + 2. Send master EOF, i.e. <0><0>. + 3. Wait for master EOF from remote or connection broken. + + Implemented in IOMixer::shutdown(). + Called internally from destructor. diff --git a/Source/Core/LibIO/TODO b/Source/Core/LibIO/TODO new file mode 100644 index 0000000..b3ab681 --- /dev/null +++ b/Source/Core/LibIO/TODO @@ -0,0 +1 @@ +- Review performance when TCP_NO_DELAY enabled. \ No newline at end of file diff --git a/Source/Core/LibIO/Utils.cpp b/Source/Core/LibIO/Utils.cpp new file mode 100644 index 0000000..36a1229 --- /dev/null +++ b/Source/Core/LibIO/Utils.cpp @@ -0,0 +1,142 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "Utils.h" +#include + +namespace Tegenaria +{ + #ifdef WIN32 + + // + // Create fake anonymous pipe pair ready for asynchronous read. + // + // pipe - buffer to store read and write instances of pipe (OUT). + // sa - security attributes to set (IN). + // bufSize - buffer size in bytes (IN). + // readMode - flags for read pipe (IN). + // writeMode - flags for write pipe (IN). + // + // RETURNS: 0 if OK. + // + + int CreatePipeEx(int pipe[2], SECURITY_ATTRIBUTES sa[2], int bufSize, + DWORD readMode, DWORD writeMode, int timeout) + { + DBG_ENTER("CreatePipeEx"); + + int exitCode = -1; + + char pipeName[MAX_PATH]; + + static unsigned int pipeCount = 0; + + static Mutex pipeNoMutex("pipeNoMutex"); + + HANDLE pipeHandle[2] = {NULL, NULL}; + + unsigned int pipeNo = 0; + + // + // Generate unique, thread safe ID. + // + + pipeNoMutex.lock(); + pipeNo = pipeCount; + pipeCount ++; + pipeNoMutex.unlock(); + + readMode |= PIPE_ACCESS_INBOUND | GENERIC_READ; + writeMode |= FILE_ATTRIBUTE_NORMAL; + + if (bufSize == 0) + { + bufSize = 4096; + } + + sprintf(pipeName, "\\\\.\\Pipe\\pipe-anon.%08x.%08x", + (unsigned int) GetCurrentProcessId(), pipeNo); + + // + // Create read pipe. + // + + DBG_MSG("Creating read pipe...\n"); + + pipeHandle[1] = CreateNamedPipe(pipeName, readMode, + PIPE_TYPE_BYTE, 1, + bufSize, bufSize, timeout, &sa[0]); + + FAIL(pipeHandle[1] == INVALID_HANDLE_VALUE); + + // + // Create write pipe. + // + + DBG_MSG("Creating write pipe...\n"); + + pipeHandle[0] = CreateFile(pipeName, GENERIC_WRITE, 0, &sa[1], OPEN_EXISTING, + writeMode, NULL); + + FAIL(pipeHandle[0] == INVALID_HANDLE_VALUE); + + // + // Wrap HANDLES into CRT FDs. + // + + pipe[1] = _open_osfhandle(intptr_t(pipeHandle[0]), 0); + pipe[0] = _open_osfhandle(intptr_t(pipeHandle[1]), 0); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + int err = GetLastError(); + + DBG_MSG("ERROR: Cannot create pipe pair.\n" + "Error code is : %d.\n", err); + + if (err != 0) + { + exitCode = err; + } + + CloseHandle(pipeHandle[0]); + CloseHandle(pipeHandle[1]); + } + + DBG_LEAVE("CreatePipeEx"); + + return exitCode; + } + + #endif /* WIN32 */ + +} /* namespace Tegenaria */ diff --git a/Source/Core/LibIO/Utils.h b/Source/Core/LibIO/Utils.h new file mode 100644 index 0000000..311f39d --- /dev/null +++ b/Source/Core/LibIO/Utils.h @@ -0,0 +1,46 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_IO_Utils_H +#define Tegenaria_Core_IO_Utils_H + +#include + +#ifdef WIN32 +# include +# include +#endif /* WIN32 */ + +namespace Tegenaria +{ + #ifdef WIN32 + + int CreatePipeEx(int pipe[2], SECURITY_ATTRIBUTES sa[2], int bufSize, + DWORD readMode, DWORD writeMode, int timeout); + + #endif /* WIN32 */ + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_IO_Utils_H */ diff --git a/Source/Core/LibIO/qcbuild.src b/Source/Core/LibIO/qcbuild.src new file mode 100644 index 0000000..e5538ea --- /dev/null +++ b/Source/Core/LibIO/qcbuild.src @@ -0,0 +1,42 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibIO + +INC_DIR = Tegenaria +CXXSRC = IOMixer.cpp Utils.cpp IOFifo.cpp IOLoop.cpp IOTime.cpp +ISRC = IOMixer.h IOFifo.h IOTime.h IOLoop.h + +LIBS = -llock -lthread -ldebug + +AUTHOR = Sylwester Wysocki + +PURPOSE = Ships common patterns to perform I/O tasks. + +DEPENDS = LibDebug LibLock LibThread ZLib + +.section MinGW + LIBS += -lws2_32 +.endsection \ No newline at end of file diff --git a/Source/Core/LibIpc/Example/Main.cpp b/Source/Core/LibIpc/Example/Main.cpp new file mode 100644 index 0000000..6b73f83 --- /dev/null +++ b/Source/Core/LibIpc/Example/Main.cpp @@ -0,0 +1,154 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +#include +#include + +#ifndef WIN32 +# include +#endif + +using namespace Tegenaria; + +// +// Callback function to process incoming connetion. +// +// fd - CRT descriptor connected to remote server (IN). +// +// ctx - optional caller context passed to IpcServerLoop() or +// IpcServerCreate() (IN). +// +// RETURNS: 0 if OK. +// + +int ProcessConnection(int fd, void *ctx) +{ + DBG_ENTER("ProcessConnection"); + + char msg[64] = {0}; + + // + // Read message from client. + // + + FAILEX(read(fd, msg, sizeof(msg)) <= 0, + "ERROR: Cannot read data from client.\n"); + + DBG_MSG("Readed [%s] from client.\n", msg); + + // + // Write answer to client. + // + + strcpy(msg, "Response from server."); + + DBG_MSG("Writing answer [%s] to client...\n", msg); + + FAILEX(write(fd, msg, strlen(msg)) <= 0, + "ERROR: Cannot write answer to client.\n"); + + fail: + + DBG_LEAVE("ProcessConnection"); + + return 0; +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_INIT_EX(NULL, "debug3", -1); + + // + // No args. + // Run server listening on 'dupa-1234'. + // + + if (argc < 2) + { + DBG_HEAD("LibIpc Example - server mode"); + + DBG_MSG("Creating server on 'dupa-1234'...\n"); + + FAIL(IpcServerLoop("dupa-1234", ProcessConnection)); + } + + // + // Pipename specified in argv[1]. + // Client mode. + // + + else + { + DBG_HEAD("LibIpc Example - client mode"); + + char msg[64] = "Hello from client."; + + // + // Open connection to server. + // + + DBG_MSG("Connecting to '%s'...\n", argv[1]); + + int fd = IpcOpen(argv[1]); + + FAIL(fd < 0); + + // + // Write message to server. + // + + DBG_MSG("Writing [%s] to server...\n", msg); + + FAIL(write(fd, msg, strlen(msg)) < 0); + + // + // Read response from server. + // + + FAIL(read(fd, msg, sizeof(msg)) < 0); + + DBG_MSG("Readed [%s] from server.\n", msg); + + // + // Close connetion. + // + + close(fd); + } + + // + // Error handler. + // + + fail: + + return 0; +} diff --git a/Source/Core/LibIpc/Example/qcbuild.src b/Source/Core/LibIpc/Example/qcbuild.src new file mode 100644 index 0000000..feade61 --- /dev/null +++ b/Source/Core/LibIpc/Example/qcbuild.src @@ -0,0 +1,32 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibIpc-example + +CXXSRC = Main.cpp +LIBS = -ldebug -lipc -lthread -llock + +PURPOSE = Inter-process comunication. +DEPENDS = LibIpc LibLock diff --git a/Source/Core/LibIpc/Example2/Main.cpp b/Source/Core/LibIpc/Example2/Main.cpp new file mode 100644 index 0000000..1f4b912 --- /dev/null +++ b/Source/Core/LibIpc/Example2/Main.cpp @@ -0,0 +1,92 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +#include +#include + +#ifndef WIN32 +# include +#endif + +using namespace Tegenaria; + +// +// +// + +#define CONTROL_PIPE "dlserver-6311294E-FE1D-11E2-BE3E-2AD76188709B" + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_HEAD("LibIpc Example - client mode"); + + char msg[64] = "Hello from client."; + + // + // Open connection to server. + // + + DBG_MSG("Connecting to '%s'...\n", argv[1]); + + int fd = IpcOpen(argv[1]); + + FAIL(fd < 0); + + // + // Write message to server. + // + + DBG_MSG("Writing [%s] to server...\n", msg); + + FAIL(write(fd, msg, strlen(msg)) < 0); + + // + // Read response from server. + // + + FAIL(read(fd, msg, sizeof(msg)) < 0); + + DBG_MSG("Readed [%s] from server.\n", msg); + + // + // Close connetion. + // + + close(fd); + + // + // Error handler. + // + + fail: + + return 0; +} diff --git a/Source/Core/LibIpc/Example2/qcbuild.src b/Source/Core/LibIpc/Example2/qcbuild.src new file mode 100644 index 0000000..d24b7c3 --- /dev/null +++ b/Source/Core/LibIpc/Example2/qcbuild.src @@ -0,0 +1,32 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibIpc-example2 + +CXXSRC = Main.cpp +LIBS = -ldebug -lipc -lthread -llock + +PURPOSE = Inter-process comunication. +DEPENDS = LibIpc LibLock diff --git a/Source/Core/LibIpc/Ipc.cpp b/Source/Core/LibIpc/Ipc.cpp new file mode 100644 index 0000000..f5578a5 --- /dev/null +++ b/Source/Core/LibIpc/Ipc.cpp @@ -0,0 +1,1114 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include +#include +#include +#include + +#include "Ipc.h" +#include "Utils.h" + +using std::map; +using std::string; + +// +// Define this to avoid TIME_WAIT warning +// on Linux. +// + +#ifndef WIN32 +# undef AVOID_TIMEWAIT +#endif + +#ifdef WIN32 +# include +#endif + +namespace Tegenaria +{ + // + // Server state on given pipe. + // + + static map IpcServerState; + + static Mutex IpcServerStateMutex("IpcServerStateMutex"); + + // + // Main loop for named pipe server. + // Can be used to set up blocking server loop in user app. + // + // TIP #1: To create server loop in another thread ('non-blocking') use + // IpcServerCreate() instead. + // + // TIP #2: Use IpcServerKill to close server. + // + // name - pipe name to create (IN). + // callback - handler function to process incoming connections (IN). + // timeout - maximum allow time to process one connection in ms (IN). + // ctx - caller context passed to callback function (IN/OPT). + // ready - set to 1 when server loop initialized (OUT/OPT). + // + // RETURNS: 0 if OK. + // + + int IpcServerLoop(const char *nameIn, IpcWorkerProto callback, void *ctx, int *ready) + { + DBG_ENTER("IpcServerLoop"); + + int exitCode = -1; + + int goOn = 1; + + int alreadyExist = 0; + + #ifdef AVOID_TIMEWAIT + int iSetOption = 1; + struct linger so_linger; + so_linger.l_onoff = 1; + so_linger.l_linger = 0; + #endif + + string name; + + // + // Check args. + // + + FAILEX(nameIn == NULL, "ERROR: 'nameIn' cannot be NULL in IpcServerLoop().\n"); + FAILEX(callback == NULL, "ERROR: 'callback' cannot be NULL in IpcServerLoop().\n"); + + #ifndef WIN32 + FAILEX((strlen(nameIn) >= 107), "ERROR: 'nameIn' too long.\n"); + #endif + + name = nameIn; + + // + // Check is server already running on given pipe. + // + + IpcServerStateMutex.lock(); + alreadyExist = IpcServerState[name]; + IpcServerStateMutex.unlock(); + + FAILEX(alreadyExist == 1, + "ERROR: Server already running on pipe '%s'.\n", name.c_str()); + + IpcServerStateMutex.lock(); + IpcServerState[name] = 1; + IpcServerStateMutex.unlock(); + + // + // Windows. + // + + #ifdef WIN32 + { + char pipeName[MAX_PATH] = {0}; + + HANDLE pipe = NULL; + HANDLE pipeAlt = NULL; + + DWORD pipeFlags = PIPE_TYPE_MESSAGE | PIPE_READMODE_MESSAGE | PIPE_WAIT; + DWORD openMode = PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED; + + SECURITY_ATTRIBUTES sa = {0}; + + // + // Add '\\.\pipe\' frefix to name. + // + + strncpy(pipeName, "\\\\.\\pipe\\", sizeof(pipeName)); + strncat(pipeName, name.c_str(), sizeof(pipeName)); + + // + // Set up security attributes with read and write access for everybody. + // + + FAIL(SetUpSecurityAttributesEverybody(&sa)); + + // + // Create named pipe. + // + + DBG_MSG("IpcServerLoop : Creating named pipe '%s'...\n", pipeName); + + pipe = CreateNamedPipe(pipeName, openMode, pipeFlags, 1, 1024, 1024, 0, &sa); + + FAIL(pipe == INVALID_HANDLE_VALUE); + + // + // Avoid closing underlying handle, when callback closes + // CRT FD wrapper. + // + + // + // SetHandleInformation(pipe, HANDLE_FLAG_PROTECT_FROM_CLOSE, + // HANDLE_FLAG_PROTECT_FROM_CLOSE); + + // + // Enter main server loop. + // + + DBG_INFO("Started IPC server loop on '%s'.\n", name.c_str()); + + if (ready) + { + *ready = 1; + } + + while(goOn == 1) + { + // + // Wait for next connection. + // + + DBG_MSG("IpcServerLoop : Waiting for connection on '%s'...\n", name.c_str()); + + if (ConnectNamedPipe(pipe, NULL)) + { + char clientMsg[8] = {0}; + + char endTag[] = "<>"; + + HANDLE pipeDup = NULL; + + DBG_MSG("IpcServerLoop : Received connection on '%s'.", pipeName); + + // + // Duplicate pipe handle to avoid closing original pipe, + // when FD wrapper is closed. + // + + DuplicateHandle(GetCurrentProcess(), pipe, + GetCurrentProcess(), &pipeDup, + 0, FALSE, DUPLICATE_SAME_ACCESS); + + // + // Wrap native HANDLE into CRT FD to be consistent + // with Linux/MacOS. + // + + // + // FIXME: Move worker to another thread. + // FIXME: Handle worker timeout. + // + + int fd = _open_osfhandle(intptr_t(pipeDup), 0); + + callback(fd, ctx); + + FlushFileBuffers(pipe); + + // + // Close connection. + // + + DBG_IO_CLOSE_BEGIN("IPC/FD", fd); + close(fd); + DBG_IO_CLOSE_END("IPC/FD", fd); + + DisconnectNamedPipe(pipe); + } + + // + // If client failed to connect close current pipe instance + // before creating another one. + // + + else + { + DBG_MSG("IpcServerLoop : Failed to connect client on '%s'." + "Error code is : %d.\n", pipeName, GetLastError()); + } + + // + // Check do we need wait for another connection. + // + + IpcServerStateMutex.lock(); + goOn = IpcServerState[name]; + IpcServerStateMutex.unlock(); + } + + CloseHandle(pipe); + + FreeSecurityAttributes(&sa); + } + + // + // Linux, MacOS. + // + + #else + { + int fdListen = -1; + int fdAccept = -1; + + struct sockaddr_un local, remote; + + memset(local.sun_path, 0, sizeof(local.sun_path)); + + local.sun_family = AF_UNIX; + + // + // Set first byte of sun_path to \0 to create socket in abstract namespace. + // + + strcpy(local.sun_path + 1, name.c_str()); + + DBG_MSG("IpcServerLoop : Obtaining fdListen descriptor.\n"); + + if ((fdListen = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) + { + int err = errno; + + Error("Error while obtaining fdListen. Error is: %d - %s", err, strerror(err)); + + goto fail; + } + + #ifdef AVOID_TIMEWAIT + setsockopt(fdListen, SOL_SOCKET, SO_LINGER, &so_linger, sizeof(so_linger)); + setsockopt(fdListen, SOL_SOCKET, SO_REUSEADDR, (char*)&iSetOption, sizeof(iSetOption)); + #endif + + DBG_MSG("IpcServerLoop : Binding named socket '%s' in abstract namespace.\n", name.c_str()); + + if (bind(fdListen, (struct sockaddr *) &local, sizeof(struct sockaddr_un)) == -1) + { + int err = errno; + + Error("Could not bind socket. Error is: %d - %s", err, strerror(err)); + + goto fail; + } + + // + // Don't inherit listening socket. + // + + fcntl(fdListen, F_SETFD, FD_CLOEXEC); + + // + // Enter main server loop. + // + + DBG_INFO("Started IPC server loop on '%s'.\n", name.c_str()); + + if (ready) + { + *ready = 1; + } + + while (goOn == 1) + { + fdAccept = -1; + + // + // Waiting for connection for client. Second parameter means that ten conenctions + // can be queued before we accept it. + // + + DBG_MSG("IpcServerLoop : Listening for connections on %s...\n", name.c_str()); + + if (listen(fdListen, 10) == -1) + { + int err = errno; + + Error("Error while listening for connection. Error is: %d - %s", err, strerror(err)); + + goto fail; + } + + unsigned int remoteSize = sizeof(remote); + + if ((fdAccept = accept(fdListen, (struct sockaddr *)&remote, &remoteSize)) == -1) + { + int err = errno; + + Error("Error while accepting connection. Error is: %d - %s", err, strerror(err)); + + goto fail; + } + + // + // Passing fd to handler. + // + + // + // FIXME: Move worker to another thread. + // FIXME: Handle worker timeout. + // + + #ifdef AVOID_TIMEWAIT + setsockopt(fdListen, SOL_SOCKET, SO_LINGER, &so_linger, sizeof(so_linger)); + setsockopt(fdListen, SOL_SOCKET, SO_REUSEADDR, (char*)&iSetOption, sizeof(iSetOption)); + #endif + + callback(fdAccept, ctx); + + shutdown(fdAccept, SHUT_RDWR); + + DBG_IO_CLOSE_BEGIN("IPC/FD", fdAccept); + close(fdAccept); + DBG_IO_CLOSE_END("IPC/FD", fdAccept); + + // + // Check do we need wait for another connection. + // + + IpcServerStateMutex.lock(); + goOn = IpcServerState[name]; + IpcServerStateMutex.unlock(); + } + + close(fdListen); + } + #endif + + DBG_INFO("IPC Server loop on '%s' finished.\n", name.c_str()); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot perform pipe server loop.\n" + "Error code is : %d.\n", GetLastError()); + } + + IpcServerStateMutex.lock(); + IpcServerState[name] = 0; + IpcServerStateMutex.unlock(); + + DBG_LEAVE("IpcServerLoop"); + + return exitCode; + } + + // + // Wrapper to pass IpcServerLoop() to threadCreate. + // Used internally only by IpcServerCreate. + // + + int IpcServerThreadLoop(IpcJob *job) + { + IpcServerLoop(job -> pipeName_, job -> callback_, job -> ctx_, &job -> ready_); + } + + // + // Create IPC server in another thread. Works as non-blocking IpcServerLoop(). + // + // name - pipe name to create (IN). + // callback - handler function to process incoming connections (IN). + // ctx - caller context passed to callback function directly (IN/OPT). + // + // TIP #1: Use IpcServerKill to close server. + // + // RETURNS: 0 if OK. + // + + int IpcServerCreate(const char *name, IpcWorkerProto callback, void *ctx) + { + int exitCode = -1; + + ThreadHandle_t *thread = NULL; + + int timeLeft = 5000; + + IpcJob job = {name, callback, 0, ctx}; + + int alreadyExist = 0; + + // + // Check is server already running on given pipe? + // + + IpcServerStateMutex.lock(); + alreadyExist = IpcServerState[name]; + IpcServerStateMutex.unlock(); + + FAILEX(alreadyExist, + "ERROR: Server already listening on pipe '%s'.\n", name); + + // + // Create server listening on given pipe in another thread. + // + + thread = ThreadCreate(IpcServerThreadLoop, &job); + + // + // Wait until server loop initialized. + // + + while(job.ready_ == 0 && timeLeft > 0) + { + ThreadSleepMs(10); + + timeLeft -= 10; + } + + FAILEX(timeLeft <= 0, + "ERROR: Timeout while initializing IPC server loop on pipe '%s'.\n", name); + + // + // Error handler. + // + + exitCode = 0; + + if (exitCode) + { + Error("ERROR: Cannot create IPC server on pipe '%s'.\n", name); + } + + fail: + + return exitCode; + } + + // + // Close server loop started by IpcServerLoop() or IpcServerCreate() before. + // + // WARNING! Do not use this function inside IPC request handler (passed + // to IpcServerCreate as callback). It can causes deadlock. + // + // TIP#1: To finish server inside IPC request handler use IpcServerFinish() + // instead. + // + // name - name passed to IpcServerXXX function before (IN). + // + // RETURNS: 0 if OK. + // + + int IpcServerKill(const char *name) + { + // + // Set server state to disabled. + // + + IpcServerStateMutex.lock(); + IpcServerState[name] = -1; + IpcServerStateMutex.unlock(); + + int fd = IpcOpen(name); + + close(fd); + + DEBUG1("Pipe loop '%s' canceled.\n", name); + + return 0; + } + + // + // Mark pipe loop started by IpcServerLoop() or IpcServerCreate() as + // finished. After exit from last pending IPC request server should exit + // from server loop. + // + // WARNING! This function should be called from IPC Request handler (passed + // to IpcServerCreate as callback). It means that current IPC + // request is last request in loop. + // + // TIP#1: If you want to finish IPC loop outside IPC request handler use + // IpcServerKill() instead. + // + // name - name passed to IpcServerXXX function before (IN). + // + // RETURNS: 0 if OK. + // + + int IpcServerMarkLastRequest(const char *name) + { + // + // Set server state to disabled. + // + + IpcServerStateMutex.lock(); + IpcServerState[name] = -1; + IpcServerStateMutex.unlock(); + + DEBUG1("Pipe loop '%s' marked as finished.\n", name); + + return 0; + } + + #ifdef WIN32 + + // + // Open connection to existing named pipe server. + // + // name - pipe name passed to IpcServer() in server process (IN). + // timeout - maximum allow wait time in ms (IN/OPT). + // + // RETURNS: Pipe HANDLE use with WriteFile/ReadFile functions, + // or INVALID_HANDLE_VALUE if error. + // + + HANDLE IpcOpenHandle(const char *name, int timeout = IPC_DEFAULT_TIMEOUT) + { + HANDLE pipe = INVALID_HANDLE_VALUE; + + DBG_ENTER("IpcOpenHandle"); + + char pipeName[MAX_PATH]; + + int connected = 0; + + // + // Check args. + // + + FAILEX(name == NULL, "ERROR: 'name' cannot be NULL in IpcOpen().\n"); + + FAILEX((strlen(name) >= 107), "ERROR: 'name' too long.\n"); + + // + // Add '\\.\pipe\' frefix to name. + // + + strncpy(pipeName, "\\\\.\\pipe\\", sizeof(pipeName)); + strncat(pipeName, name, sizeof(pipeName)); + + // + // Connect to named pipe. + // + + while(connected == 0) + { + // + // Try connect. + // + + DBG_MSG("IpcOpenHandle : Connecting to pipe '%s'...\n", pipeName); + + pipe = CreateFile(pipeName, GENERIC_READ | GENERIC_WRITE, + 0, NULL, OPEN_EXISTING, FILE_FLAG_OVERLAPPED, NULL); + + // + // Success - go out. + // + + if (pipe != INVALID_HANDLE_VALUE) + { + DBG_MSG("IpcOpenHandle : Connected to '%s'.\n", pipeName); + + connected = 1; + } + else + { + FAIL(GetLastError() != ERROR_PIPE_BUSY); + + // + // Server is busy. Wait up to specified timeout. + // + + DBG_MSG("IpcOpenHandle : Server is busy. Waiting up to %d ms...\n", timeout); + + WaitNamedPipe(pipeName, timeout); + } + } + + fail: + + return pipe; + } + + #endif + + // + // Open connection to existing pipe server. + // + // name - pipe name passed to IpcServer() in server process (IN). + // timeout - maximum allow wait time in ms (IN/OPT). + // + // RETURNS: CRT descriptor (fd) ready to use with write/read funcions, + // or -1 if error. + // + + int IpcOpen(const char *name, int timeout) + { + DBG_ENTER("IpcOpen"); + + int fd = -1; + + #ifdef AVOID_TIMEWAIT + int iSetOption = 1; + struct linger so_linger; + so_linger.l_onoff = 1; + so_linger.l_linger = 0; + #endif + + // + // Check args. + // + + FAILEX(name == NULL, "ERROR: 'name' cannot be NULL in IpcOpen().\n"); + + // + // Windows. + // + + #ifdef WIN32 + { + HANDLE pipe = IpcOpenHandle(name, timeout); + + FAIL(pipe == INVALID_HANDLE_VALUE); + + // + // Connected. Wrap native HANDLE into CRT fd to be + // consistent with Linux/MacOS. + // + + fd = _open_osfhandle(intptr_t(pipe), 0); + + DBG_MSG("IpcOpen : Connection on '%s' wrapped to fd '%d'.\n", name, fd); + } + + // + // Linux, MacOS. + // + + #else + { + struct sockaddr_un sock; + + memset(sock.sun_path, 0, sizeof(sock.sun_path)); + + sock.sun_family = AF_UNIX; + + // + // Set first byte of sun_path to \0 to create socket in abstract namespace. + // + + strcpy(sock.sun_path + 1, name); + + DBG_MSG("IpcServerLoop : Obtaining fd for socket '%s' in abstract namespace.\n", name); + + if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) + { + int err = errno; + + Error("Error while obtaining fd. Error is: %d - %s", err, strerror(err)); + + goto fail; + } + + #ifdef AVOID_TIMEWAIT + setsockopt(fd, SOL_SOCKET, SO_LINGER, &so_linger, sizeof(so_linger)); + setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char*)&iSetOption, sizeof(iSetOption)); + #endif + + DBG_MSG("IpcServerLoop : Connecting to socket.\n", name); + + // + // FIXME: Handle timeout. + // + + if (connect(fd, (struct sockaddr *)&sock, sizeof(sockaddr_un)) == -1) + { + int err = errno; + + Error("Error while connecting to server. Error is: %d - %s", err, strerror(err)); + + goto fail; + } + } + #endif + + // + // Error handler. + // + + fail: + + if (fd == -1) + { + Error("ERROR: Cannot open connection to pipe server '%s'.\n" + "Error code is : %d.\n", name, GetLastError()); + } + + DBG_LEAVE("IpcOpen"); + + return fd; + } + + // + // - Send single request to pipe server + // - read answer in format 'XYZ > message' + // - split answer to code and parts. + // + // Example usage: + // + // IpcRequest(PIPENAME, &code, answer, sizeof(answer), + // "share --alias %s --path %s", alias, path); + // + // TIP: If only exit code is needed can be set to NULL. + // + // pipeName - pipe name, where to send command (IN). + // serverCode - exit code returned by server (OUT/OPT). + // serverMsg - ASCIZ message returned by server (OUT/OPT). + // serverMsgSize - size of answer buffer in bytes (IN/OPT). + // fmt - printf like parameters to format command to send (IN). + // + // RETURNS: 0 if request sucessfuly sent and asnwer from server received. + // -1 otherwise. + // + // WARNING!: Request could still failed on server side. + // To get server's side exit code use 'answerCode' parameter. + // + + int IpcRequest(const char *pipeName, int *serverCode, + char *serverMsg, int serverMsgSize, const char *fmt, ...) + { + DBG_ENTER("IpcRequest"); + + int exitCode = -1; + + char buf[IPC_LEN_MAX]; + + int cmdLen = 0; + + char *dst = NULL; + + int readed = 0; + int total = 0; + + int len = 0; + + va_list ap; + + int fd = -1; + + // + // Windows variables. + // + + #ifdef WIN32 + + HANDLE pipe = INVALID_HANDLE_VALUE; + + OVERLAPPED ov = {0}; + + DWORD written = 0; + + // + // Linux variables. + // + + #else + + char buffer[1024]; + + fd_set rfd; + + struct timeval tv; + + #endif + + + // + // Check args. + // + + FAILEX(pipeName == NULL, "ERROR: 'pipeName' cannot be NULL in IpcRequest."); + FAILEX(fmt == NULL, "ERROR: 'fmt' cannot be NULL in IpcRequest."); + + // + // Clear output buffers to avoid returning random data + // on error. + // + + if (serverCode) + { + *serverCode = -1; + } + + if (serverMsg && serverMsgSize) + { + serverMsg[0] = 0; + } + + // + // Windows. + // + + #ifdef WIN32 + { + // + // Open connection to pipe server living on the same machine. + // + + pipe = IpcOpenHandle(pipeName); + + FAILEX(pipe == INVALID_HANDLE_VALUE, "ERROR: Cannot connect to [%s].\n", pipeName); + + // + // Format printf like message. + // + + va_start(ap, fmt); + + len = vsnprintf(buf, IPC_LEN_MAX - 1, fmt, ap); + + va_end(ap); + + // + // Send command to server. + // + + FAILEX(WriteFile(pipe, buf, len, &written, NULL) == FALSE, + "ERROR: Cannot send command to [%s].\n", pipeName); + + // + // Read 'XYZ> ' prefix first. + // where XYZ is 3 decimal exit code returned by server. + // + + TimeoutReadFileOv(pipe, buf, 5, &readed, 60000); + + FAILEX(readed != 5, "ERROR: Cannot read 'XYZ> ' prefix from [%s].", pipeName); + + buf[4] = 0; + + if (serverCode) + { + *serverCode = atoi(buf); + } + + // + // Read message part if needed. + // + + if (serverMsg && serverMsgSize > 0) + { + int goOn = 1; + + dst = serverMsg; + + total = 0; + + // + // Read data until something to read. + // + + while(goOn) + { + goOn = TimeoutReadFileOv(pipe, dst, + serverMsgSize - 1 - total, + &readed, 30000); + + DBG_MSG("IpcRequest : Readed [%d] bytes from pipe [%s].\n", readed, pipeName); + + total += readed; + + dst += readed; + } + + serverMsg[total] = 0; + } + } + + // + // Linux. + // + + #else + { + // + // Open connection to pipe server living on the same machine. + // + + fd = IpcOpen(pipeName); + + FAILEX(fd < 0, "ERROR: Cannot connect to [%s].\n", pipeName); + + // + // Format printf like message. + // + + va_start(ap, fmt); + + len = vsnprintf(buf, IPC_LEN_MAX - 1, fmt, ap); + + va_end(ap); + + // + // Send command to server. + // + + FAILEX(write(fd, buf, len) < 0, + "ERROR: Cannot send command to [%s].\n", pipeName); + + // + // Read 'XYZ >' prefix first. + // where XYZ is 3 decimal exit code returned by server. + // + + FAILEX(TimeoutReadSelect(fd, buf, 5, 60) != 5, + "ERROR: Cannot read 'XYZ> prefix ' from [%s].\n", pipeName); + + buf[4] = 0; + + if (serverCode) + { + *serverCode = atoi(buf); + } + + // + // Read message part if needed. + // + + if (serverMsg && serverMsgSize > 0) + { + dst = serverMsg; + + total = 0; + + readed = 1; + + while(readed > 0) + { + readed = TimeoutReadSelect(fd, dst, serverMsgSize - 1 - total, 60); + + DBG_MSG("IpcRequest : Readed [%d] bytes from pipe [%s].\n", readed, pipeName); + + if (readed > 0) + { + total += readed; + + dst += readed; + } + } + + serverMsg[total] = 0; + } + } + #endif + + exitCode = 0; + + // + // Clean up. + // + + fail: + + if (exitCode) + { + Error("Cannot send IPC request to [%s].\n" + "Error code is : %d.\n", pipeName, GetLastError()); + + if (serverCode) + { + *serverCode = -1; + } + } + + #ifdef WIN32 + CloseHandle(pipe); + #else + close(fd); + #endif + + DBG_LEAVE("IpcRequest"); + + return exitCode; + } + + // + // Format 'XYZ> message' string and send it to given CRT FD. + // + // fd - CRT FD, where to send answer (IN). + // code - 3 digit answer code (e.g. 100) (IN). + // msg - Optional, ASCIZ message to send, can be NULL (IN/OPT). + // + // RETURNS: 0 if OK. + // + + int IpcSendAnswer(int fd, int code, const char *msg) + { + DBG_ENTER3("IpcSendRequestAnswer"); + + int exitCode = -1; + + char buf[8] = {0}; + + int written = -1; + + int msgSize = -1; + + // + // Send 5-bytes "XYZ> " prefix. + // + + snprintf(buf, sizeof(buf) - 1, "%03d> ", code); + + DBG_IO_WRITE_BEGIN("IPC/FD", fd, buf, 5); + { + written = write(fd, buf, 5); + } + DBG_IO_WRITE_END("IPC/FD", fd, buf, written); + + FAILEX(written != 5, "ERROR: Cannot write to IPC/FD #%d.\n", fd); + + // + // Send message including zero terminator. + // + + if (msg) + { + msgSize = strlen(msg) + 1; + + DBG_IO_WRITE_BEGIN("IPC/FD", fd, msg, msgSize); + { + written = write(fd, msg, msgSize); + } + DBG_IO_WRITE_END("IPC/FD", fd, msg, written); + } + + FAILEX(written != msgSize, "ERROR: Cannot write to IPC/FD #%d.\n", fd); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("IpcSendRequestAnswer"); + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibIpc/Ipc.h b/Source/Core/LibIpc/Ipc.h new file mode 100644 index 0000000..aa3519c --- /dev/null +++ b/Source/Core/LibIpc/Ipc.h @@ -0,0 +1,96 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Ipc_H +#define Tegenaria_Core_Ipc_H + +#ifdef WIN32 +# include +# include +#endif + +#ifdef __linux__ +#include +#include +#include +#include +#include +#include +#include +#include +#endif + +#include + +#include + +namespace Tegenaria +{ + // + // Defines. + // + + #define IPC_DEFAULT_TIMEOUT 1000 + #define IPC_LEN_MAX (1024 * 256) + + // + // Typedef. + // + + typedef int (*IpcWorkerProto)(int fd, void *ctx); + + struct IpcJob + { + const char *pipeName_; + + IpcWorkerProto callback_; + + int ready_; + + void *ctx_; + }; + + // + // Exported functions. + // + + int IpcServerLoop(const char *name, IpcWorkerProto callback, + void *ctx = NULL, int *ready = NULL); + + int IpcServerCreate(const char *name, IpcWorkerProto callback, void *ctx = NULL); + + int IpcServerKill(const char *name); + + int IpcServerMarkLastRequest(const char *name); + + int IpcOpen(const char *name, int timeout = IPC_DEFAULT_TIMEOUT); + + int IpcRequest(const char *pipeName, int *serverCode, + char *serverMsg, int serverMsgSize, const char *fmt, ...); + + int IpcSendAnswer(int fd, int code, const char *msg); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Ipc_H */ diff --git a/Source/Core/LibIpc/Todo b/Source/Core/LibIpc/Todo new file mode 100644 index 0000000..89a3bd6 --- /dev/null +++ b/Source/Core/LibIpc/Todo @@ -0,0 +1,3 @@ +- Handle timeout + +- Move processing connection into another thread \ No newline at end of file diff --git a/Source/Core/LibIpc/Utils.cpp b/Source/Core/LibIpc/Utils.cpp new file mode 100644 index 0000000..80454d7 --- /dev/null +++ b/Source/Core/LibIpc/Utils.cpp @@ -0,0 +1,312 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "Utils.h" + +namespace Tegenaria +{ + // + // Work like system read(), but with timeout functionality. + // + // fd - CRT file descriptor where to read from (IN). + // buf - destination buffer (OUT). + // len - number of bytes to read (IN). + // timeout - timeout in seconds (IN). + // + // RETURNS: Number of bytes readed or + // -1 if error. + // + + int TimeoutReadSelect(int fd, void *buf, int len, int timeout) + { + int readed = 0; + + fd_set rfd; + + struct timeval tv; + + FD_ZERO(&rfd); + FD_SET(fd, &rfd); + + tv.tv_sec = timeout; + tv.tv_usec = 0; + + if (select(fd + 1, &rfd, NULL, NULL, &tv) > 0 && FD_ISSET(fd, &rfd)) + { + readed = read(fd, buf, len); + } + else + { + Error("ERROR: Timeout while reading from FD #%d.\n", fd); + + readed = -1; + } + + return readed; + } + + #ifdef WIN32 + + // + // Work like system ReadFile(), but with timeout functionality. + // + // WARNING: Handle MUST be opened in overlapped mode. + // + // handle - native HANDLE to input device e.g. named pipe or socket (IN). + // buf - destination buffer (OUT). + // len - number of bytes to read (IN). + // readed - number of bytes readed (OUT). + // timeout - timeout in miliseconds (IN). + // + // RETURNS: 1 if success and still something to read, + // 0 otherwise. + // + + int TimeoutReadFileOv(HANDLE handle, void *buf, int len, int *readed, int timeout) + { + OVERLAPPED ov = {0}; + + *readed = 0; + + ov.hEvent = CreateEvent(NULL, FALSE, FALSE, NULL); + + int goOn = ReadFile(handle, buf, len, NULL, &ov); + + if (goOn || GetLastError() == ERROR_IO_PENDING) + { + switch(WaitForSingleObject(ov.hEvent, timeout)) + { + case WAIT_OBJECT_0: + { + GetOverlappedResult(handle, &ov, PDWORD(readed), FALSE); + + break; + } + + case WAIT_TIMEOUT: + { + Error("Timeout while reading from handle #%d.\n", handle); + + goOn = 0; + } + } + } + + CloseHandle(ov.hEvent); + + return goOn; + } + + // + // Allocating security attributes giving READ+WRITE rights to + // everybody, and maximum allowed rights to administartors. + // + // WARNING: Output struct need to be uninitialized by + // FreeSecurityAttributes() function! + // + // sa - security attributes struct to fill (OUT). + // + // RETURNS: 0 if OK. + // + + int SetUpSecurityAttributesEverybody(SECURITY_ATTRIBUTES *sa) + { + DBG_ENTER3("SetUpSecurityAttributesEverybody"); + + int exitCode = -1; + + // + // Needed for set up security on communication pipe. + // + + PSID everybodySid = NULL; + PSID adminSid = NULL; + + PACL acl = NULL; + + PSECURITY_DESCRIPTOR sd = NULL; + + EXPLICIT_ACCESS ea[2] = {{0}}; + + SID_IDENTIFIER_AUTHORITY authWorldId = {SECURITY_WORLD_SID_AUTHORITY}; + SID_IDENTIFIER_AUTHORITY authNtId = {SECURITY_NT_AUTHORITY}; + + // + // Create everybody sid. + // + + DEBUG3("SetUpSecurityAttributesEverybody : Creating everybody sid...\n"); + + FAIL(AllocateAndInitializeSid(&authWorldId, 1, SECURITY_WORLD_RID, + 0, 0, 0, 0, 0, 0, 0, &everybodySid) == FALSE); + + // + // Create sid for BUILTIN\Administrators group. + // + + DEBUG3("SetUpSecurityAttributesEverybody : Creating adminstrators sid...\n"); + + FAIL(AllocateAndInitializeSid(&authNtId, 2, SECURITY_BUILTIN_DOMAIN_RID, + DOMAIN_ALIAS_RID_ADMINS, 0, 0, 0, 0, 0, 0, + &adminSid) == FALSE); + + // + // Give READ+WRITE access to everybody. + // + + ZeroMemory(&ea, 2 * sizeof(EXPLICIT_ACCESS)); + + ea[0].grfAccessPermissions = GENERIC_WRITE | GENERIC_READ; + ea[0].grfAccessMode = SET_ACCESS; + ea[0].grfInheritance= NO_INHERITANCE; + ea[0].Trustee.TrusteeForm = TRUSTEE_IS_SID; + ea[0].Trustee.TrusteeType = TRUSTEE_IS_WELL_KNOWN_GROUP; + ea[0].Trustee.ptstrName = (LPTSTR) everybodySid; + + // + // Give maximum allowed access to admin. + // + + ea[1].grfAccessPermissions = MAXIMUM_ALLOWED; + ea[1].grfAccessMode = SET_ACCESS; + ea[1].grfInheritance= NO_INHERITANCE; + ea[1].Trustee.TrusteeForm = TRUSTEE_IS_SID; + ea[1].Trustee.TrusteeType = TRUSTEE_IS_GROUP; + ea[1].Trustee.ptstrName = (LPTSTR) adminSid; + + // + // Create a new ACL that contains the new ACEs. + // + + DEBUG3("SetUpSecurityAttributesEverybody : Creating new ACL...\n"); + + FAIL(SetEntriesInAcl(2, ea, NULL, &acl) != ERROR_SUCCESS); + + // + // Init new, empty security descriptor. + // + + DEBUG3("SetUpSecurityAttributesEverybody : Allocating new security descriptor...\n"); + + sd = (PSECURITY_DESCRIPTOR) LocalAlloc(LPTR, SECURITY_DESCRIPTOR_MIN_LENGTH); + + FAIL(sd == NULL); + + FAIL(InitializeSecurityDescriptor(sd, SECURITY_DESCRIPTOR_REVISION) == FALSE); + + // + // Add the ACL to the security descriptor. + // + + DEBUG3("SetUpSecurityAttributesEverybody : Setting up DACL...\n"); + + FAIL(SetSecurityDescriptorDacl(sd, TRUE, acl, FALSE) == FALSE); + + // + // Fill output security attributes struct. + // + + sa -> nLength = sizeof (SECURITY_ATTRIBUTES); + sa -> lpSecurityDescriptor = sd; + sa -> bInheritHandle = TRUE; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + int err = GetLastError(); + + Error("ERROR: Cannot set up security attributes.\n" + "Error code is : %d.\n", err); + + if (err != 0) + { + exitCode = err; + } + } + + DBG_LEAVE3("SetUpSecurityAttributesEverybody"); + + return exitCode; + } + + // + // Free Security Attributes struct allocated by + // SetUpSecurityAttributes() function. + // + + void FreeSecurityAttributes(SECURITY_ATTRIBUTES *sa) + { + DBG_ENTER3("FreeSecurityAttributes"); + + if (sa && sa -> lpSecurityDescriptor) + { + BOOL daclPresent = FALSE; + BOOL daclDefault = FALSE; + + ACL *pACL = NULL; + + SECURITY_DESCRIPTOR *pSD = (SECURITY_DESCRIPTOR *) sa -> lpSecurityDescriptor; + + // + // Get ACL if exists. + // + + DEBUG3("FreeSecurityAttributes : Retrieving ACL...\n"); + + GetSecurityDescriptorDacl(pSD, &daclPresent, &pACL, &daclDefault); + + // + // Free security descriptor field. + // + + DEBUG3("FreeSecurityAttributes : Freeing SD...\n"); + + LocalFree(pSD); + + // + // Free ACL if exist. + // + + DEBUG3("FreeSecurityAttributes : Freeing ACL...\n"); + + if (daclPresent) + { + LocalFree(pACL); + } + + } + + DBG_LEAVE3("FreeSecurityAttributes"); + } + + #endif /* WIN32 */ + +} /* namespace Tegenaria */ diff --git a/Source/Core/LibIpc/Utils.h b/Source/Core/LibIpc/Utils.h new file mode 100644 index 0000000..1d24005 --- /dev/null +++ b/Source/Core/LibIpc/Utils.h @@ -0,0 +1,56 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Ipc_Utils_H +#define Tegenaria_Core_Ipc_Utils_H + +#ifdef WIN32 +# include +# include +# include +# include +#else +# include +# include +#endif + +#include + +namespace Tegenaria +{ + int TimeoutReadSelect(int fd, void *buf, int len, int timeout); + + #ifdef WIN32 + + int TimeoutReadFileOv(HANDLE handle, void *buf, int len, int *readed, int timeout); + + int SetUpSecurityAttributesEverybody(SECURITY_ATTRIBUTES *sa); + + void FreeSecurityAttributes(SECURITY_ATTRIBUTES *sa); + + #endif + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Ipc_Utils_H */ diff --git a/Source/Core/LibIpc/qcbuild.src b/Source/Core/LibIpc/qcbuild.src new file mode 100644 index 0000000..487b4c9 --- /dev/null +++ b/Source/Core/LibIpc/qcbuild.src @@ -0,0 +1,38 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibIpc + +INC_DIR = Tegenaria +CXXSRC = Ipc.cpp Utils.cpp +ISRC = Ipc.h + +LIBS = -llock -ldebug -lthread + +AUTHOR = Sylwester Wysocki + +PURPOSE = Inter-process comunication. + +DEPENDS = LibDebug LibThread LibLock diff --git a/Source/Core/LibJob/Example01-simple/Main.cpp b/Source/Core/LibJob/Example01-simple/Main.cpp new file mode 100644 index 0000000..27ce0fa --- /dev/null +++ b/Source/Core/LibJob/Example01-simple/Main.cpp @@ -0,0 +1,134 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +// +// Callback function called when job changed state or progress meter. +// + +void JobNotify(int code, Job *job, void *ctx) +{ + switch(code) + { + // + // Job changed it's state. + // + + case JOB_NOTIFY_STATE_CHANGED: + { + printf("%s : changed state to %s...\n", job -> getTitle(), job -> getStateString()); + + break; + } + + // + // Job changed it's progress meter. + // + + case JOB_NOTIFY_PROGRESS: + { + printf("%s : %3.1lf completed...\n", job -> getTitle(), job -> getPercentCompleted()); + + break; + } + } +} + +// +// Function performing our time consuming job. +// + +void DoMyJob(Job *job, void *ctx) +{ + for (int i = 0; i <= 100; i++) + { + job -> setPercentCompleted(i); + + ThreadSleepMs(100); + + // + // Check for cancel signal. + // + + if (job -> getState() == JOB_STATE_STOPPED) + { + return; + } + } + + // + // Mark job as finished. + // + // TIP: Use JOB_STATE_ERROR to mark job finished with error. + // + + job -> setState(JOB_STATE_FINISHED); +} + +// +// Entry point. +// + +int main() +{ + // + // Create new job. + // + + Job *job = new Job("MyJob", JobNotify, NULL, DoMyJob, NULL); + + // + // Wait until job finished. + // + // TIP#1: Use timeout parameter if you have time limit. + // TIP#2: Use job -> cancel() to cancel pending job. + // + + job -> wait(); + + // + // Check is job finished with success or error. + // + + if (job -> getState() == JOB_STATE_FINISHED) + { + printf("OK.\n"); + } + else + { + printf("Job finished with error no. %d.\n", job -> getErrorCode()); + } + + // + // Release job object. + // + + job -> release(); + + return 0; +} diff --git a/Source/Core/LibJob/Example01-simple/qcbuild.src b/Source/Core/LibJob/Example01-simple/qcbuild.src new file mode 100644 index 0000000..4669133 --- /dev/null +++ b/Source/Core/LibJob/Example01-simple/qcbuild.src @@ -0,0 +1,33 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = libjob-example01-simple +AUTHOR = Sylwester Wysocki + +CXXSRC = Main.cpp + +DEPENDS = LibJob + +LIBS = -ldebug -lthread -llock -ljob diff --git a/Source/Core/LibJob/Job.cpp b/Source/Core/LibJob/Job.cpp new file mode 100644 index 0000000..cc0450c --- /dev/null +++ b/Source/Core/LibJob/Job.cpp @@ -0,0 +1,407 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include "Job.h" + +namespace Tegenaria +{ + // + // Create job object. + // + // title - job's title (IN/OPT). + // notifyCallback - callback called when job changed state or progress meter (IN/OPT). + // notifyCallbackCtx - caller context passed to notifyCallback() directly (IN/OPT). + // workerCallback - callback function performing real job work (IN). + // workerCallbackCtx - caller context passed to workerCallback() directly (IN/OPT). + // + + Job::Job(const char *title, + JobNotifyCallbackProto notifyCallback, + void *notifyCallbackCtx, + JobWorkerCallbackProto workerCallback, + void *workerCallbackCtx) + { + DBG_ENTER3("Job::Job"); + + // + // Set job title. + // + + if (title) + { + title_ = title; + } + else + { + char title[64]; + + snprintf(title, sizeof(title) - 1, "Anonymous job %p.\n", this); + + title_ = title; + } + + // + // Add object to debug set. + // + + DBG_SET_ADD("Job", this, "%s", getTitle()); + + // + // Set notify callback. + // + + notifyCallback_ = notifyCallback; + notifyCallbackCtx_ = notifyCallbackCtx; + + // + // Set worker function. + // + + workerCallback_ = workerCallback; + workerCallbackCtx_ = workerCallbackCtx; + + // + // Zero refference counter. + // + + refCount_ = 1; + + // + // Set state to initializing. + // + + setState(JOB_STATE_INITIALIZING); + + // + // Create worker thread performing real job. + // + + workerThread_ = ThreadCreate(workerLoop, this); + + // + // Zero statistics. + // + + percentCompleted_ = 0.0; + errorCode_ = 0; + + DBG_SET_RENAME("thread", workerThread_, getTitle()); + + DBG_LEAVE3("Job::Job"); + } + + // + // Call underlying notify callback set in constructor. + // + // code - one of JOB_NOTIFY_XXX codes (IN). + // + + void Job::triggerNotifyCallback(int code) + { + if (notifyCallback_) + { + notifyCallback_(code, this, notifyCallbackCtx_); + } + } + + // + // Increase refference counter. + // + // WARNING! Every call to addRef() MUSTS be followed by one release() call. + // + // TIP #1: Object will not be destroyed until refference counter is greater + // than 0. + // + // TIP #2: Don't call destructor directly, use release() instead. If + // refference counter achieve 0, object will be destroyed + // automatically. + // + + void Job::addRef() + { + refCountMutex_.lock(); + + refCount_ ++; + + DEBUG2("Increased refference counter to %d for job '%s'.\n", refCount_, getTitle()); + + refCountMutex_.unlock(); + } + + // + // Decrease refference counter increased by addRef() before. + // + + void Job::release() + { + int deleteNeeded = 0; + + // + // Decrease refference counter by 1. + // + + refCountMutex_.lock(); + + refCount_ --; + + DEBUG2("Decreased refference counter to %d for job '%s'.\n", refCount_, getTitle()); + + if (refCount_ == 0) + { + deleteNeeded = 1; + } + + refCountMutex_.unlock(); + + // + // Delete object if refference counter goes down to 0. + // + + if (deleteNeeded) + { + delete this; + } + } + + // + // Worker loop performing real job in background thread. + // This function calls underlying doTheJob() function implemented in child class. + // + // jobPtr - pointer to related Job object (this pointer) (IN/OUT). + // + + int Job::workerLoop(void *jobPtr) + { + Job *this_ = (Job *) jobPtr; + + this_ -> addRef(); + this_ -> setState(JOB_STATE_PENDING); + + if (this_ -> workerCallback_) + { + this_ -> workerCallback_(this_, this_ -> workerCallbackCtx_); + } + else + { + Error("ERROR: Worker callback is NULL for '%s'.\n", this_ -> getTitle()); + } + + this_ -> release(); + + return 0; + } + + // + // Change current state. See JOB_STATE_XXX defines in Job.h. + // + // state - new state to set (IN). + // + + void Job::setState(int state) + { + state_ = state; + + DEBUG2("%s: changed state to [%s].\n", getTitle(), getStateString()); + + switch(state) + { + case JOB_STATE_ERROR: DBG_INFO("%s : finished with error.\n", getTitle()); break; + case JOB_STATE_INITIALIZING: DEBUG2("%s : initializing.\n", getTitle()); break; + case JOB_STATE_PENDING: DEBUG2("%s : pending.\n", getTitle()); break; + case JOB_STATE_FINISHED: DBG_INFO("%s : finished with success.\n", getTitle()); break; + case JOB_STATE_STOPPED: DBG_INFO("%s : stopped.\n", getTitle()); break; + } + + // + // Call notify callback if set. + // + + triggerNotifyCallback(JOB_NOTIFY_STATE_CHANGED); + } + + // + // Get current state code. See JOB_STATE_XXX defines in Job.h. + // + // RETURNS: Current state code. + // + + int Job::getState() + { + return state_; + } + + // + // Get current state as human readable string. + // + // RETURNS: Name of current job's state. + // + + const char *Job::getStateString() + { + switch(state_) + { + case JOB_STATE_ERROR: return "Error"; + case JOB_STATE_INITIALIZING: return "Initializing"; + case JOB_STATE_PENDING: return "Pending"; + case JOB_STATE_FINISHED: return "Finished"; + case JOB_STATE_STOPPED: return "Stopped"; + }; + + return "Unknown"; + } + + // + // Wait until job finished or stopped with error. + // + // timeout - maximum time to wait in ms. Set to -1 for infinite (IN). + // + // RETURNS: 0 if OK (job finished/stopped on exit), + // -1 otherwise (job still active on exit). + + int Job::wait(int timeout) + { + DBG_ENTER2("Job::wait"); + + int exitCode = -1; + + int timeLeft = timeout; + + while(state_ == JOB_STATE_INITIALIZING || state_ == JOB_STATE_PENDING) + { + ThreadSleepMs(50); + + if (timeout > 0) + { + timeLeft -= 50; + + if (timeLeft <= 0) + { + Error("ERROR: Timeout while waiting for job '%s'.\n", this -> getTitle()); + + goto fail; + } + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE2("SftpJob::wait"); + + return exitCode; + } + + // + // Send stop signal for pending job object. + // After that related thread should stop working and state + // should change to JOB_STATE_STOPPED. + // + // WARNING#1: Job object MUSTS be still released with release() method. + // + // TIP#1: To stop and release resources related with job use below code: + // + // job -> cancel(); + // job -> release(); + // + + void Job::cancel() + { + this -> setState(JOB_STATE_STOPPED); + } + + // + // Retrieve job's title set in constructor before. + // + + const char *Job::getTitle() + { + return title_.c_str(); + } + + Job::~Job() + { + ThreadWait(workerThread_); + ThreadClose(workerThread_); + + DBG_SET_DEL("Job", this); + } + + // + // Get current job's progress in percentages (0-100%). + // + + double Job::getPercentCompleted() + { + return percentCompleted_; + } + + // + // Get error code related with object. + // This function should be used when job finished with error state. + // + + int Job::getErrorCode() + { + return errorCode_; + } + + // + // Set current error code related with job. + // This function should be used to inform caller why job object + // finished with error state. + // + + void Job::setErrorCode(int code) + { + errorCode_ = code; + } + + // + // Set current job's progress in percentages (0-100%). + // + + void Job::setPercentCompleted(double percentCompleted) + { + int notifyNeeded = 0; + + if (fabs(percentCompleted_ - percentCompleted) > 0.01) + { + notifyNeeded = 1; + } + + percentCompleted_ = percentCompleted; + + if (notifyNeeded) + { + triggerNotifyCallback(JOB_NOTIFY_PROGRESS); + } + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibJob/Job.h b/Source/Core/LibJob/Job.h new file mode 100644 index 0000000..ac6583b --- /dev/null +++ b/Source/Core/LibJob/Job.h @@ -0,0 +1,187 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Job_H +#define Tegenaria_Core_Job_H + +#include +#include + +#include +#include + +namespace Tegenaria +{ + using namespace std; + + // + // Defines. + // + + #define JOB_STATE_ERROR 1 + #define JOB_STATE_INITIALIZING 2 + #define JOB_STATE_PENDING 3 + #define JOB_STATE_FINISHED 4 + #define JOB_STATE_STOPPED 5 + + #define JOB_NOTIFY_STATE_CHANGED 1 + #define JOB_NOTIFY_PROGRESS 2 + + // + // Forward declaration. + // + + class Job; + + // + // Typedef. + // + + typedef void (*JobNotifyCallbackProto)(int code, Job *job, void *ctx); + typedef void (*JobWorkerCallbackProto)(Job *job, void *ctx); + + // + // Class. + // + + class Job + { + protected: + + // + // Current job state (see JOB_STATE_XXX defines). + // + + int state_; + + double percentCompleted_; + + int errorCode_; + + // + // Basic properties set in constructor. + // + + string title_; + + JobNotifyCallbackProto notifyCallback_; + + void *notifyCallbackCtx_; + + // + // Refference counter. + // + + Mutex refCountMutex_; + + int refCount_; + + // + // Worker thread. + // + + ThreadHandle_t *workerThread_; + + // + // Underlying worker function. + // + + JobWorkerCallbackProto workerCallback_; + + void *workerCallbackCtx_; + + // + // -------------------------------------------------------------------------- + // + // Public interface. + // + // -------------------------------------------------------------------------- + + public: + + Job(const char *title, + JobNotifyCallbackProto notifyCallback, + void *notifyCallbackCtx, + JobWorkerCallbackProto workerCallback, + void *workerCallbackCtx); + + void triggerNotifyCallback(int code); + + // + // Refference counter. + // + + void addRef(); + void release(); + + // + // Worker thread. + // + + static int workerLoop(void *jobPtr); + + // + // State. + // + + void setState(int state); + + int getState(); + + const char *getStateString(); + + // + // General. + // + + const char *getTitle(); + + double getPercentCompleted(); + + void setPercentCompleted(double percentCompleted); + + void setErrorCode(int code); + + int getErrorCode(); + + // + // Synchronize functinos. + // + + int wait(int timeout = -1); + + void cancel(); + + // + // Private functions. + // + + protected: + + virtual ~Job(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Job_H */ diff --git a/Source/Core/LibJob/qcbuild.src b/Source/Core/LibJob/qcbuild.src new file mode 100644 index 0000000..d727818 --- /dev/null +++ b/Source/Core/LibJob/qcbuild.src @@ -0,0 +1,38 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibJob +PURPOSE = Template to performing asynchronous jobs like downloading file +PURPOSE += from network or compressing data. + +AUTHOR = Sylwester Wysocki + +INC_DIR = Tegenaria +ISRC = Job.h +CXXSRC = Job.cpp + +DEPENDS = LibDebug LibThread LibLock + +LIBS = -ldebug -lthread -llock diff --git a/Source/Core/LibLock/Example01-Mutex/Example01.cpp b/Source/Core/LibLock/Example01-Mutex/Example01.cpp new file mode 100644 index 0000000..151d63c --- /dev/null +++ b/Source/Core/LibLock/Example01-Mutex/Example01.cpp @@ -0,0 +1,119 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk . */ +/* */ +/* 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 +#include +#include +#include + +#ifndef WIN32 +#include +#endif + +#include +#include +#include + +using namespace Tegenaria; + +int loop1(void *parameter) +{ + printf("lockExample: LOOP-1 started\n"); + + Mutex *mutex = (Mutex *) parameter; + + printf("lockExample: LOOP-1 lock state: %d\n", mutex -> getState()); + + mutex -> lock(); + + for (int x = 0; x < 5; x++) + { + printf("lockExample: LOOP-1 nr %d\n", int(x)); + + ProcessSleepSec(2); + } + + mutex -> unlock(); + + printf("lockExample: LOOP-1 finished\n"); +} + +int loop2(void *parameter) +{ + printf("lockExample: LOOP-2 started\n"); + + Mutex *mutex = (Mutex *) parameter; + + printf("lockExample: LOOP-2 lock state: %d\n", mutex -> getState()); + + mutex -> lock(); + + for (int x = 0; x < 5; x++) + { + printf("lockExample: LOOP-2 nr %d\n", int(x)); + + ProcessSleepSec(2); + } + + mutex -> unlock(); + + printf("lockExample: LOOP-2 finished\n"); +} + +int main(int argc, char **argv) +{ + // + // Example of lock + // + + printf("\nlockExample: Starting.\n"); + + Mutex mutex; + + ThreadHandle_t *thread1 = ThreadCreate(loop1, &mutex); + + ProcessSleepSec(1); + + ThreadHandle_t *thread2 = ThreadCreate(loop2, &mutex); + + for (;;) + { + ProcessSleepSec(1); + + if (ThreadIsRunning(thread1) == 0 && ThreadIsRunning(thread2) == 0) + { + printf("Mutex example: threads are not running\n"); + + break; + } + } + + printf("lockExample: FINISH LOCK EXAMPLE\n"); + + ThreadClose(thread1); + ThreadClose(thread2); + + return 0; +} diff --git a/Source/Core/LibLock/Example01-Mutex/qcbuild.src b/Source/Core/LibLock/Example01-Mutex/qcbuild.src new file mode 100644 index 0000000..6faae92 --- /dev/null +++ b/Source/Core/LibLock/Example01-Mutex/qcbuild.src @@ -0,0 +1,39 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk . # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibLock-example01-mutex +CXXSRC = Example01.cpp + +LIBS = -llock -lprocess -lthread -ldebug -lstr + +AUTHOR = Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), +AUTHOR += Lukasz Bienczyk (lukasz.bienczyk@gmail.com) + +.section Linux +LIBS += -lpthread +.endsection + +DEPENDS = LibLock LibProcess LibThread LibDebug LibStr diff --git a/Source/Core/LibLock/Example02-Semaphore/Example02.cpp b/Source/Core/LibLock/Example02-Semaphore/Example02.cpp new file mode 100644 index 0000000..0fdcd17 --- /dev/null +++ b/Source/Core/LibLock/Example02-Semaphore/Example02.cpp @@ -0,0 +1,116 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk . */ +/* */ +/* 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 +#include +#include +#include + +#ifndef WIN32 +#include +#endif + +#include +#include +#include + +using namespace Tegenaria; + +int loop1(void *parameter) +{ + printf("lockExample: LOOP-1 started\n"); + + Semaphore *semaphore = (Semaphore *)parameter; + + + for (int x = 0; x < 5; x++) + { + printf("lockExample: LOOP-1 lock state: %d\n", semaphore -> getState()); + + printf("lockExample: LOOP-1 nr %d\n",int(x)); + + semaphore -> signal(); + + ProcessSleepSec(2); + } + + printf("lockExample: LOOP-1 finished\n"); +} + +int loop2(void *parameter) +{ + printf("lockExample: LOOP-2 started\n"); + + Semaphore *semaphore = (Semaphore *)parameter; + + for (int x = 0; x < 5; x++) + { + printf("lockExample: LOOP-2 lock state: %d\n", semaphore -> getState()); + + printf("lockExample: LOOP-2 nr %d\n",int(x)); + + semaphore -> unwoundWait(5); + + ProcessSleepSec(2); + } + + printf("lockExample: LOOP-2 finished\n"); +} + +int main(int argc, char **argv) +{ + // + // Example of lock + // + + printf("\nlockExample: Starting.\n"); + + Semaphore *semaphore = new Semaphore(); + + ThreadHandle_t *thread1 = ThreadCreate(loop1, semaphore); + + ProcessSleepSec(1); + + ThreadHandle_t * thread2 = ThreadCreate(loop2, semaphore); + + for (;;) + { + ProcessSleepSec(1); + + if (ThreadIsRunning(thread1) == 0 && ThreadIsRunning(thread2) == 0) + { + printf("lockExample: threads are not running\n"); + + break; + } + } + + ThreadClose(thread1); + ThreadClose(thread2); + + printf("lockExample: FINISH LOCK EXAMPLE\n"); + + return 0; +} diff --git a/Source/Core/LibLock/Example02-Semaphore/qcbuild.src b/Source/Core/LibLock/Example02-Semaphore/qcbuild.src new file mode 100644 index 0000000..9865010 --- /dev/null +++ b/Source/Core/LibLock/Example02-Semaphore/qcbuild.src @@ -0,0 +1,39 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk . # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibLock-example02-semaphore +CXXSRC = Example02.cpp + +LIBS = -lprocess -lthread -llock -ldebug -lstr + +AUTHOR = Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), +AUTHOR += Lukasz Bienczyk (lukasz.bienczyk@gmail.com) + +.section Linux +LIBS += -lpthread +.endsection + +DEPENDS = LibLock LibProcess LibThread LibDebug LibStr diff --git a/Source/Core/LibLock/Example03-RequestPool/Main.cpp b/Source/Core/LibLock/Example03-RequestPool/Main.cpp new file mode 100644 index 0000000..20824da --- /dev/null +++ b/Source/Core/LibLock/Example03-RequestPool/Main.cpp @@ -0,0 +1,160 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include + +using namespace Tegenaria; + +// +// Thread serving requests. +// It can be thread reading data from network and serving network requestes +// when answer packet received. +// + +int ServeThread(void *data) +{ + RequestPool *rpool = (RequestPool *) data; + + Request *r = NULL; + + // + // Serve request ID#1. + // + + ThreadSleepSec(1); + + r = rpool -> find(1); // Find request ID#1 + + if (r) + { + r -> lockData(); // Lock data stored in request + + *((string *) r -> outputData_) = "data1"; // Set outputData (optional) + + r -> unlockData(); // Unlock data stored in request + + r -> serve(); // Mark request as served + // (after that wait(1) will be + // finished + } + + // + // Serve request ID#2. + // + + ThreadSleepSec(1); + + r = rpool -> find(2); + + if (r) + { + r -> lockData(); + + *((string *) r -> outputData_) = "data2"; + + r -> unlockData(); + + r -> serve(); + } + + // + // Serve request ID#3. + // + + ThreadSleepSec(1); + + r = rpool -> find(3); + + if (r) + { + r -> lockData(); + + *((string *) r -> outputData_) = "data3"; + + r -> unlockData(); + + r -> serve(); + } +} + +// +// Entry point. +// + +int main() +{ + RequestPool rpool(8, "example-pool"); + + string packet1; + string packet2; + string packet3; + + // + // Push three requests with ID = 1,2,3. + // They can be packets with given ID sent to network. + // + // We set input datas to NULL + // and output datas to packet1, packet2, packet3. + // + // + + rpool.push(1, NULL, &packet1); + rpool.push(2, NULL, &packet2); + rpool.push(3, NULL, &packet3); + + // + // Start thread serving requests. + // It can be function reading packets from network. + // + + ThreadCreate(ServeThread, &rpool); + + // + // Wait until request ID#1 served. + // + + rpool.wait(1); + + DBG_INFO("Request ID#1 result is '%s'.\n", packet1.c_str()); + + // + // Wait until request ID#2 served. + // + + rpool.wait(2); + + DBG_INFO("Request ID#2 result is '%s'.\n", packet2.c_str()); + + // + // Wait until request ID#3 served. + // + + rpool.wait(3); + + DBG_INFO("Request ID#3 result is '%s'.\n", packet3.c_str()); + + return 0; +} diff --git a/Source/Core/LibLock/Example03-RequestPool/qcbuild.src b/Source/Core/LibLock/Example03-RequestPool/qcbuild.src new file mode 100644 index 0000000..b8ffa2a --- /dev/null +++ b/Source/Core/LibLock/Example03-RequestPool/qcbuild.src @@ -0,0 +1,36 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = liblock-example03-requestpool + +AUTHOR = Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), +AUTHOR += Lukasz Bienczyk (lukasz.bienczyk@gmail.com), +AUTHOR += Sylwester Wysocki (sw143@wp.pl) + +CXXSRC = Main.cpp +DEPENDS = LibDebug LibThread LibLock +LIBS = -lthread -llock -ldebug diff --git a/Source/Core/LibLock/Mutex.cpp b/Source/Core/LibLock/Mutex.cpp new file mode 100644 index 0000000..5d09d86 --- /dev/null +++ b/Source/Core/LibLock/Mutex.cpp @@ -0,0 +1,218 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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 + +#include "Mutex.h" +#include + +namespace Tegenaria +{ + // + // Constructor. Create named or anonymous mutex object. + // + // name - optional, human readable name (IN/OPT). + // + + Mutex::Mutex(const char *name) + { + #ifdef WIN32 + mutex_ = CreateMutex(NULL, FALSE, NULL); + #else + pthread_mutex_init(&mutex_, NULL); + #endif + + if (name) + { + DEBUG3("Created named mutex '%s'.\n", name); + + name_ = name; + } + else + { + char buf[16]; + + snprintf(buf, sizeof(buf), "%p", this); + + name_ = buf; + + DEBUG3("Created anonymous mutex '%s'.\n", name_.c_str()); + } + } + + // + // Destructor. + // + + Mutex::~Mutex() + { + DEBUG3("Destroying mutex [%s].\n", name_.c_str()); + + #ifdef WIN32 + CloseHandle(mutex_); + #else + pthread_mutex_destroy(&mutex_); + #endif + } + + // + // Get ownership of the mutex. + // + // TIP#1: Every call to lock() MUSTS be followed by one call to unlock(). + // + + void Mutex::lock() + { + // + // Windows. + // + + #ifdef WIN32 + { + DEBUG5("Locking mutex [%s] by thread #[%d]...\n", name_.c_str(), GetCurrentThreadId()); + + DBG_SET_ADD("Locking", this, name_.c_str()); + + WaitForSingleObject(mutex_, INFINITE); + + DBG_SET_MOVE("Locked", "Locking", this); + + DEBUG4("Mutex [%s] locked by thread #[%d].\n", + name_.c_str(), GetCurrentThreadId()); + + } + + // + // Linux, MacOS. + // + + #else + { + DEBUG5("Locking mutex [%s]...\n", name_.c_str()); + + DBG_SET_ADD("Locking", this, name_.c_str()); + + pthread_mutex_lock(&mutex_); + + DBG_SET_MOVE("Locked", "Locking", this); + + DEBUG4("Mutex [%s] locked.\n", name_.c_str()); + } + #endif + } + + // + // Releae mutex locked by lock() method before. + // + // WARNING: Only thread, that called lock() can free mutex. + // + + void Mutex::unlock() + { + // + // Windows. + // + + #ifdef WIN32 + { + DEBUG5("Releasing mutex [%s] by thread #[%d]...\n", + name_.c_str(), GetCurrentThreadId()); + + ReleaseMutex(mutex_); + + DBG_SET_DEL("Locked", this); + + DEBUG4("Mutex [%s] released from thread #[%d].\n", + name_.c_str(), GetCurrentThreadId()); + } + + // + // Linux, MacOS. + // + + #else + { + DEBUG5("Releasing mutex [%s]...\n", name_.c_str()); + + pthread_mutex_unlock(&mutex_); + + DBG_SET_DEL("Locked", this); + + DEBUG4("Mutex [%s] released.\n", name_.c_str()); + } + #endif + } + + // + // Get current mutex state. + // + // Unimplemented. + // + + int Mutex::getState() + { + Error("ERROR: Mutex::getState() not implemented.\n"); + + return -1; + } + + // + // Change mutex name. + // + // fmt - C printf like format (IN). + // + + void Mutex::setName(const char *fmt, ...) + { + if (fmt) + { + char name[1024] = ""; + + va_list ap; + + // + // Format printf like message. + // + + va_start(ap, fmt); + + vsnprintf(name, sizeof(name) - 1, fmt, ap); + + va_end(ap); + + // + // Set name. + // + + DEBUG4("Renaming mutex [%s] to [%s]...\n", name_.c_str(), name); + + name_ = name; + + DBG_SET_RENAME("Locked", this, name_.c_str()); + DBG_SET_RENAME("Locking", this, name_.c_str()); + } + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibLock/Mutex.h b/Source/Core/LibLock/Mutex.h new file mode 100644 index 0000000..86d656b --- /dev/null +++ b/Source/Core/LibLock/Mutex.h @@ -0,0 +1,70 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Mutex_H +#define Tegenaria_Core_Mutex_H + +#include + +using std::string; + +#ifdef WIN32 +# include +#else +# include +# include +#endif + +namespace Tegenaria +{ + class Mutex + { + public: + + Mutex(const char *name = NULL); + + ~Mutex(); + + void lock(); + + void unlock(); + + int getState(); + + void setName(const char *fmt, ...); + + string name_; + + #ifdef WIN32 + HANDLE mutex_; + #else + pthread_mutex_t mutex_; + #endif + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Mutex_H */ diff --git a/Source/Core/LibLock/RequestPool.cpp b/Source/Core/LibLock/RequestPool.cpp new file mode 100644 index 0000000..0bac4cd --- /dev/null +++ b/Source/Core/LibLock/RequestPool.cpp @@ -0,0 +1,549 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "RequestPool.h" + +namespace Tegenaria +{ + // + // Constructor. + // Allocate and zero pending request table. + // + // size - maximum number of pending request in one time (IN/OPT). + // name - arbitrary request pool name to debug code easier (IN/OPT). + // + + RequestPool::RequestPool(int size, const char *name) + { + DBG_ENTER3("RequestPool::RequestPool"); + + // + // Use default pool size if given value incorrect. + // + + if (size < 1) + { + Error("WARNING: 'size' parameter is less than 1 in" + " RequestPool::RequestPool(). Defaulted to %d.\n", + REQUEST_POOL_DEFAULT_SIZE); + + size = REQUEST_POOL_DEFAULT_SIZE; + } + + // + // Save pool name if set. + // + + if (name) + { + name_ = name; + } + else + { + char buf[16]; + + snprintf(buf, sizeof(buf) - 1, "%p", this); + + name_ = name; + } + + // + // Create mutex to lock whole object. + // + + mutex_ = new Mutex(getName()); + + // + // Init requests table. + // + + size_ = size; + + table_ = new Request[size_]; + + for (int i = 0; i < size; i++) + { + char buf[128]; + + table_[i].id_ = -1; + + snprintf(buf, sizeof(buf) - 1, "%s#%d", getName(), i); + + table_[i].served_ = new Semaphore(0, buf); + table_[i].dataMutex_ = new Mutex(buf); + } + + DBG_SET_ADD("ThreadPool", this, name_.c_str()); + + DBG_LEAVE3("RequestPool::RequestPool"); + } + + // + // Destructor. + // Free request table created in constructor. + // + + RequestPool::~RequestPool() + { + DBG_ENTER3("RequestPool::~RequestPool"); + + if (table_) + { + for (int i = 0; i < size_; i++) + { + delete table_[i].served_; + delete table_[i].dataMutex_; + } + + delete []table_; + + table_ = NULL; + } + + delete mutex_; + + DBG_SET_DEL("ThreadPool", this); + + DBG_LEAVE3("RequestPool::~RequestPool"); + } + + // + // Get object name. + // + + const char *RequestPool::getName() + { + return name_.c_str(); + } + + // + // Find request with given ID. + // + // WARNING: Function is not thread safe itselt. Caller MUSTS use lock()/unlock() + // by own. + // + // id - request's ID set int RequestPush() time before (IN). + // + // RETURNS: Pointer to found Request object, + // NULL if request with given ID does not exists. + // + + Request *RequestPool::find(int id) + { + for (int i = 0; i < size_; i++) + { + if (table_[i].id_ == id) + { + return &table_[i]; + } + } + + return NULL; + } + + // + // Find first not used request in requests table. + // + // WARNING: Function is not thread safe itselt. Caller MUSTS use lock()/unlock() + // by own. + // + // RETURNS: Pointer to first not used request, + // NULL if too many requests. + // + + Request *RequestPool::findFree() + { + for (int i = 0; i < size_; i++) + { + if (table_[i].id_ == -1) + { + return &table_[i]; + } + } + + Error("ERROR: Too many requests in request pool '%s'.\n", getName()); + + return NULL; + } + + // + // Wait until given request served by serve() function. + // + // WARNING#1: This function pop request from table even if timeout reached. + // WARNING#2: Only one thread can wait for request at one time. + // + // TIP#1: Use serve() method from another thread to serve pending request. + // After that wait() will finished with code 0. + // + // Parameters: + // + // id - request ID passed to push() before (IN). + // timeout - timeout in ms, -1 for infinity (IN). + // + // RETURNS: 0 if OK, + // ERR_WRONG_PARAMETER if there is no request with given ID, + // ERR_TIMEOUT if timeout reached. + + int RequestPool::wait(int id, int timeout) + { + DBG_ENTER5("RequestPool::wait"); + + int exitCode = -1; + + Request *r = NULL; + + int waitRet = -1; + + // + // Find request with given ID. + // + + r = find(id); + + if (r == NULL) + { + Error("ERROR: Request ID#%d does not exist in request pool '%s'.\n", id, getName()); + + exitCode = ERR_WRONG_PARAMETER; + + goto fail; + } + + // + // Wait until request served. + // + + DEBUG5("RequestPool::wait : Waiting for request" + " ID#%d pool '%s'...\n", id, getName()); + + waitRet = r -> served_ -> wait(timeout); + + switch(waitRet) + { + // + // OK. + // + + case 0: + { + DEBUG5("RequestPool::wait : Waiting finished" + " request ID#%d pool '%s'...\n", id, getName()); + + break; + } + + // + // Timeout. + // + + case -1: + { + Error("ERROR: Timeout while waiting" + " for request ID#%d pool '%s'.\n", id, getName()); + + exitCode = ERR_TIMEOUT; + + goto fail; + } + + // + // Unexpected error while waiting. + // + + default: + { + Error("ERROR: Wait finished with system code '%d'" + " for request ID#%d pool '%s'.\n", waitRet, id, getName()); + + exitCode = ERR_GENERIC; + + goto fail; + } + } + + // + // Unmark request in table. + // It's not used longer. + // + + r -> lockData(); + + r -> id_ = -1; + r -> inputData_ = NULL; + r -> outputData_ = NULL; + + r -> unlockData(); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot wait for request ID#%d" + " in request pool '%s'.\n", id, getName()); + } + + DBG_LEAVE5("RequestPool::wait"); + + return exitCode; + } + + // + // Mark request with given ID as served. After that thread wait() from + // another thead will be finished. + // + // id - request ID to serve, set in push() time (IN). + // + // RETURNS: 0 if OK, + // ERR_WRONG_PARAMETER if request with given id does not exist. + // + + int RequestPool::serve(int id) + { + DBG_ENTER5("RequestPool::serve"); + + int exitCode = ERR_WRONG_PARAMETER; + + Request *r = NULL; + + // + // Find request. + // + + r = find(id); + + if (r == NULL) + { + Error("ERROR: Request ID#%d does not exist.\n", id); + + goto fail; + } + + // + // Serve request. + // + + r -> served_ -> signal(); + + DEBUG3("Request ID#%d served in request pool '%s'.\n", id, getName()); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE5("RequestPool::serve"); + + return exitCode; + } + + // + // Mark request as served. After that thread wait() from another + // thread will be finished. + // + // r - pointer to request retrieved from find() function (IN). + // + // RETURNS: 0 if OK, + // ERR_WRONG_PARAMETER if request with given id does not exist. + // + + int RequestPool::serve(Request *r) + { + DBG_ENTER5("RequestPool::serve"); + + int exitCode = ERR_WRONG_PARAMETER; + + // + // Check args. + // + + if (r == NULL) + { + Error("ERROR: NULL request passed to RequestPool::serve().\n"); + + goto fail; + } + + // + // Serve request. + // + + r -> served_ -> signal(); + + DEBUG3("Request ID#%d served in request pool '%s'.\n", r -> id_, getName()); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE5("RequestPool::serve"); + + return exitCode; + } + + // + // Push new request to pending table. + // + // TIP#1: Another thread should use serve() to finalize (serve) request. + // + // TIP#2: Use wait() to wait until request served. + // + // WARNING#1: Every call to push() MUSTS be followed by one call to serve() + // with the same ID. + // + // id - request ID to assign, MUSTS be unique (IN). + // inputData - pointer to arbitrary input data, can be NULL (IN/OUT). + // outputData - pointer to arbitrary output data, can be NULL (IN/OUT). + // + // RETURNS: 0 if OK, + // -1 otherwise. + // + + int RequestPool::push(int id, void *inputData, void *outputData) + { + DBG_ENTER5("RequestPool::push"); + + int exitCode = -1; + + Request *r = NULL; + + this -> lock(); + + // + // Check is given request ID unique. + // + + if (this -> find(id) != NULL) + { + Error("ERROR: Request ID#%d already in use in request pool '%s'.\n", id, getName()); + + goto fail; + } + + // + // Find unused request in table. + // + + r = this -> findFree(); + + FAIL(r == NULL); + + // + // Assign buffer and id to request. + // Mark request as pending. + // + + DEBUG5("RequestPool::push : Pushing request ID#%d to pool '%s'...\n", id, getName()); + + r -> lockData(); + + r -> inputData_ = inputData; + r -> outputData_ = outputData; + r -> id_ = id; + + r -> unlockData(); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot push request ID#%d to request pool '%s'.\n", id, getName()); + } + + this -> unlock(); + + DBG_LEAVE5("RequestPool::push"); + + return exitCode; + } + + // + // Lock request pool object. + // + // WARNING: Every call to lock() MUSTS be followed by one unlock() call. + // + + void RequestPool::lock() + { + mutex_ -> lock(); + } + + // + // Unlock request pool object locked by lock() function before. + // + + void RequestPool::unlock() + { + mutex_ -> unlock(); + } + + // + // Lock data pointers stored inside Request struct. + // + // WARNING: Every calls to lockData() MUSTS be followed by one unlockData() + // call. + // + + void Request::lockData() + { + dataMutex_ -> lock(); + } + + // + // Unlock data pointers stored inside Request struct locked by lockData() + // before. + // + + void Request::unlockData() + { + dataMutex_ -> unlock(); + } + + // + // Mark request as served. + // + + void Request::serve() + { + served_ -> signal(); + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibLock/RequestPool.h b/Source/Core/LibLock/RequestPool.h new file mode 100644 index 0000000..424e869 --- /dev/null +++ b/Source/Core/LibLock/RequestPool.h @@ -0,0 +1,137 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_RequestPool_H +#define Tegenaria_Core_RequestPool_H + +// +// Includes. +// + +#include +#include +#include + +#include "Mutex.h" +#include "Semaphore.h" + +namespace Tegenaria +{ + // + // Defines. + // + + #define REQUEST_POOL_DEFAULT_SIZE 16 + + // + // Structure to store one generic request. + // + + struct Request + { + int id_; + + void *inputData_; + void *outputData_; + + Semaphore *served_; + + Mutex *dataMutex_; + + void lockData(); + void unlockData(); + void serve(); + }; + + // + // Class to store request pool. + // + + class RequestPool + { + // + // Private fields. + // + + Request *table_; + + Mutex *mutex_; + + int size_; + + string name_; + + // + // Internal use functions. + // + + Request *findFree(); + + // + // Public interface. + // + + public: + + // + // Init. + // + + RequestPool(int size = REQUEST_POOL_DEFAULT_SIZE, const char *name = NULL); + + ~RequestPool(); + + // + // Request management. + // + + int push(int id, void *inputData, void *outputData); + + int wait(int id, int timeout = -1); + + int cancel(int id); + + int serve(int id); + + int serve(Request *r); + + Request *find(int id); + + // + // Thread synchronization. + // + + void lock(); + void unlock(); + + // + // General. + // + + const char *getName(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_RequestPool_H */ diff --git a/Source/Core/LibLock/Semaphore.cpp b/Source/Core/LibLock/Semaphore.cpp new file mode 100644 index 0000000..49ec792 --- /dev/null +++ b/Source/Core/LibLock/Semaphore.cpp @@ -0,0 +1,320 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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 + +#include "Semaphore.h" +#include + +namespace Tegenaria +{ + Semaphore::Semaphore(int initValue, const char *name) + { + // + // Windows. + // + + #ifdef WIN32 + { + semaphore_ = CreateSemaphore(NULL, initValue, 1, NULL); + } + + // + // Linux, MacOS. + // + + #else + { + sem_init(&semaphore_, 0, initValue); + } + #endif + + // + // Common. + // + + if (name) + { + DEBUG3("Created named Semaphore '%s'.\n", name); + + name_ = name; + } + else + { + char buf[16]; + + snprintf(buf, sizeof(buf), "%p", this); + + name_ = buf; + + DEBUG3("Created anonymous Semaphore '%s'.\n", name_.c_str()); + } + + DBG_SET_ADD("Semaphore", this, name_.c_str()); + } + + Semaphore::~Semaphore() + { + DEBUG3("Destroying Semaphore [%s]...\n", name_.c_str()); + + #ifdef WIN32 + CloseHandle(semaphore_); + #else + sem_destroy(&semaphore_); + #endif + + DBG_SET_DEL("Semaphore", this); + } + + // + // Wait until semafore reach signaled state. + // + // TIP#1: Use signal() function to change object into signaled state. + // + // TIP#2: Use isSignaled() to check is semaphore signaled without falling into + // waiting loop. + // + // timeout - timeout in ms, -1 for infinite (IN/OPT). + // + // RETURNS: 0 on success, + // 1 on timeout, + // -1 if error. + // + + int Semaphore::wait(int timeout) + { + int result = 0; + + DBG_SET_ADD("Semaphore wait", this, name_.c_str()); + + // + // Windows. + // + + #ifdef WIN32 + { + if (timeout == -1) + { + DEBUG5("Waiting on Sempahore [%s] by thread #[%d]...\n", name_.c_str(), GetCurrentThreadId()); + + result = (int) WaitForSingleObject(semaphore_, INFINITE); + } + else + { + DEBUG5("Waiting on Sempahore [%s] by thread #[%d] with timeout [%d]...\n", name_.c_str(), GetCurrentThreadId(), timeout); + + result = (int) WaitForSingleObject(semaphore_, timeout); + } + + if (result == WAIT_OBJECT_0) + { + result = 0; + } + else if (result == WAIT_TIMEOUT) + { + result = -1; + } + else + { + result = (int) GetLastError(); + } + + DEBUG4("Finished waiting on Sempahore [%s] by thread #[%d] with timeout [%d] and result [%d]...\n", name_.c_str(), GetCurrentThreadId(), timeout, result); + } + + // + // Linux, MacOS. + // + + #else + { + if (timeout == -1) + { + DEBUG5("Waiting on Semaphore [%s]...\n", name_.c_str()); + + while ((result = sem_wait(&semaphore_)) != 0 && GetLastError() == EINTR) + { + } + } + else + { + DEBUG5("Waiting on Semaphore [%s] with timeout [%d]...\n", name_.c_str(), timeout); + + struct timespec ts = {0}; + + clock_gettime(CLOCK_REALTIME, &ts); + + ts.tv_sec += timeout / 1000; + ts.tv_nsec += (timeout % 1000) * 1000000; + + while ((result = sem_timedwait(&semaphore_, &ts)) != 0 && GetLastError() == EINTR) + { + } + } + + if (result == EAGAIN) + { + result = -1; + } + else if (result != 0) + { + result = errno; + } + } + #endif + + DBG_SET_DEL("Semaphore wait", this); + + DEBUG4("Finished waiting on Sempahore [%s] with timeout [%d] and result [%d]...\n", name_.c_str(), timeout, result); + + return result; + } + + void Semaphore::signal() + { + DEBUG5("Signalling Semaphore [%s]...\n", name_.c_str()); + + #ifdef WIN32 + ReleaseSemaphore(semaphore_, 1, NULL); + #else + sem_post(&semaphore_); + #endif + + DEBUG4("Semaphore [%s] signalled...\n", name_.c_str()); + } + + // + // Decrement the counter of the semaphore. Do not block if traditional + // wait() would block. + // + + int Semaphore::tryWait() + { + int result = -1; + + DEBUG5("Trying a wait on Semaphore [%s].\n", name_.c_str()); + + // + // Windows. + // + + #ifdef WIN32 + { + result = WaitForSingleObject(semaphore_, 0); + + if (result != WAIT_OBJECT_0) + { + DEBUG4("Wait would block or an error occured. Error is [%d]\n", GetLastError()); + } + } + + // + // Linux, MacOS. + // + + #else + { + while ((result = sem_trywait(&semaphore_)) != 0 && GetLastError() == EINTR) + { + } + + if (result != 0) + { + DEBUG4("Wait would block or an error occured. Error is [%d]\n", GetLastError()); + } + } + #endif + + return result; + } + + // + // Retrieve currect semaphore counter. + // + + int Semaphore::getState() + { + int value = 0; + + // + // Windows. + // + + #ifdef WIN32 + { + Error("ERROR: Semaphore::getState() not implemented on Windows."); + + value = -1; + } + + // + // Linux, MacOS. + // + + #else + { + sem_getvalue(&semaphore_, &value); + } + #endif + + return value; + } + + // + // Decrement the counter untill the wait call would block. + // + + int Semaphore::unwind() + { + int result = 0; + + DEBUG5("Unwinding semaphore [%s]...\n", name_.c_str()); + + while(tryWait() == 0) + { + result++; + } + + return result; + } + + int Semaphore::unwoundWait(int timeout) + { + unwind(); + + return this -> wait(timeout); + } + + void Semaphore::setName(const char *name) + { + if (name) + { + DEBUG5("Renaming semaphore [%s] to [%s]...\n", name_.c_str(), name); + + name_ = name; + } + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibLock/Semaphore.h b/Source/Core/LibLock/Semaphore.h new file mode 100644 index 0000000..d14d51b --- /dev/null +++ b/Source/Core/LibLock/Semaphore.h @@ -0,0 +1,75 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Semaphore_h +#define Tegenaria_Core_Semaphore_h + +#include + +using std::string; + +#ifdef WIN32 +# include +#else +# include +#endif + +namespace Tegenaria +{ + class Semaphore + { + public: + + Semaphore(int initValue = 0, const char *name = NULL); + + ~Semaphore(); + + int wait(int timeout = -1); + + void signal(); + + int tryWait(); + + int unwind(); + + int unwoundWait(int timeout = -1); + + int getState(); + + void setName(const char *name); + + string name_; + + #ifdef WIN32 + HANDLE semaphore_; + #else + sem_t semaphore_; + #endif + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Semaphore_H */ diff --git a/Source/Core/LibLock/qcbuild.src b/Source/Core/LibLock/qcbuild.src new file mode 100644 index 0000000..d79fcb4 --- /dev/null +++ b/Source/Core/LibLock/qcbuild.src @@ -0,0 +1,46 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibLock + +INC_DIR = Tegenaria +CXXSRC = Mutex.cpp Semaphore.cpp RequestPool.cpp +ISRC = Mutex.h Semaphore.h RequestPool.h + +LIBS = -ldebug + +.section Linux +LIBS += -lpthread +.endsection + +AUTHOR = Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), +AUTHOR += Lukasz Bienczyk (lukasz.bienczyk@gmail.com), +AUTHOR += Sylwester Wysocki (sw143@wp.pl) + +PURPOSE = Locks + +DEPENDS = LibDebug LibError diff --git a/Source/Core/LibMath/Math.h b/Source/Core/LibMath/Math.h new file mode 100644 index 0000000..136b2c4 --- /dev/null +++ b/Source/Core/LibMath/Math.h @@ -0,0 +1,31 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Math_H +#define Tegenaria_Core_Math_H + +#include "MathAvg.h" +#include "MathWeightAvg.h" + +#endif /* Tegenaria_Core_Math_H */ diff --git a/Source/Core/LibMath/MathAvg.cpp b/Source/Core/LibMath/MathAvg.cpp new file mode 100644 index 0000000..41ad517 --- /dev/null +++ b/Source/Core/LibMath/MathAvg.cpp @@ -0,0 +1,74 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "Math.h" + +namespace Tegenaria +{ + // + // Create empty average object with current value set to 0.0. + // + + MathAvg::MathAvg() + { + clear(); + } + + // + // Insert value to average. + // + + void MathAvg::insert(double x) + { + sum_ += x; + + count_ ++; + } + + // + // Get current average value. + // + + double MathAvg::getValue() + { + if (count_ > 0) + { + return sum_ / count_; + } + else + { + return 0.0; + } + } + + // + // Zero stored average. + // + + void MathAvg::clear() + { + sum_ = 0; + count_ = 0; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibMath/MathAvg.h b/Source/Core/LibMath/MathAvg.h new file mode 100644 index 0000000..1bd60dd --- /dev/null +++ b/Source/Core/LibMath/MathAvg.h @@ -0,0 +1,57 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_MathAvg_H +#define Tegenaria_Core_MathAvg_H + +namespace Tegenaria +{ + // + // Class to implement ordinal, arithmetic average: + // + // x1 + x2 + x3 + ... xn + // avg = ----------------------- + // n + // + + class MathAvg + { + double sum_; + + int count_; + + public: + + MathAvg(); + + void insert(double x); + + double getValue(); + + void clear(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_MathAvg_H */ diff --git a/Source/Core/LibMath/MathWeightAvg.cpp b/Source/Core/LibMath/MathWeightAvg.cpp new file mode 100644 index 0000000..17e3df8 --- /dev/null +++ b/Source/Core/LibMath/MathWeightAvg.cpp @@ -0,0 +1,76 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "Math.h" +#include +#include + +namespace Tegenaria +{ + // + // Create empty weighted average object with current value set to 0.0. + // + // 1 2 3 + // x1*alfa + x2*alfa + x3*alfa + ... + // w_avg = ------------------------------------ + // 1 2 3 + // alfa + alfa + alfa + ... + // + + MathWeightAvg::MathWeightAvg(double alfa) + { + alfa_ = alfa; + + clear(); + } + + // + // Insert value to average. + // + + void MathWeightAvg::insert(double x) + { + accTop_ = accTop_ * alfa_ + x * alfa_; + accBottom_ = accBottom_ * alfa_ + alfa_; + } + + // + // Get current average value. + // + + double MathWeightAvg::getValue() + { + return accTop_ / accBottom_; + } + + // + // Zero stored average. + // + + void MathWeightAvg::clear() + { + accTop_ = 0.0; + accBottom_ = 1.0; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibMath/MathWeightAvg.h b/Source/Core/LibMath/MathWeightAvg.h new file mode 100644 index 0000000..a475f40 --- /dev/null +++ b/Source/Core/LibMath/MathWeightAvg.h @@ -0,0 +1,61 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_MathWeightAvg_H +#define Tegenaria_Core_MathWeightAvg_H + +namespace Tegenaria +{ + #define MATH_WEIGHT_AVG_DEFAULT_ALFA 0.9 + + // + // Class to implement weighted average: + // + // 1 2 3 + // x1*alfa + x2*alfa + x3*alfa + ... + // w_avg = ------------------------------------ + // 1 2 3 + // alfa + alfa + alfa + ... + // + + class MathWeightAvg + { + double accTop_; + double accBottom_; + double alfa_; + + public: + + MathWeightAvg(double alfa = MATH_WEIGHT_AVG_DEFAULT_ALFA); + + void insert(double x); + + double getValue(); + + void clear(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_MathWeightAvg_H */ diff --git a/Source/Core/LibMath/qcbuild.src b/Source/Core/LibMath/qcbuild.src new file mode 100644 index 0000000..0c90d0e --- /dev/null +++ b/Source/Core/LibMath/qcbuild.src @@ -0,0 +1,42 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibMath + +AUTHOR = Sylwester Wysocki +PURPOSE = Compute averages. + +INC_DIR = Tegenaria +CXXSRC = MathAvg.cpp MathWeightAvg.cpp +ISRC = Math.h MathAvg.h MathWeightAvg.h + +LIBS = -ldebug +DEPENDS = LibDebug + +# +# Auto documentation flags. +# + +AUTODOC_PRIVATE = 1 diff --git a/Source/Core/LibObject/Object.cpp b/Source/Core/LibObject/Object.cpp new file mode 100644 index 0000000..34343c7 --- /dev/null +++ b/Source/Core/LibObject/Object.cpp @@ -0,0 +1,274 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "Object.h" +#include +#include + +namespace Tegenaria +{ + // + // Static variables. + // + + #ifdef DEBUG + std::set Object::instances_; + + Mutex Object::instancesMutex_("Object::instances_"); + + int Object::instancesCreatedCount_ = 0; + int Object::instancesDestroyedCount_ = 0; + int Object::instancesDuplicatedCount_ = -1; // TODO + #endif + + // + // Private copy constructor. + // + + Object::Object(const Object &) + { + } + + // + // Constructor. + // + + Object::Object(const char *className, const char *objectName) + { + if (className == NULL) + { + Fatal("ERROR: Class name cannot be NULL.\n"); + } + + className_ = className; + objectName_ = objectName; + refCount_ = 1; + + // + // Track created instances. + // + + DBG_SET_ADD(className, this); + + #ifdef DEBUG + { + instancesMutex_.lock(); + instances_.insert(this); + instancesCreatedCount_++; + instancesMutex_.unlock(); + } + #endif + } + + // + // Virtual destructor. + // Should be overwriten in derived class. + // + + Object::~Object() + { + // + // Check is this pointer correct. + // + + if (IsPointerCorrect(this) == 0) + { + Fatal("ERROR: Attemp to destroy non existing object PTR#%p.\n", this); + } + // + // Track created instances. + // + + DBG_SET_DEL(this -> getClassName(), this); + + #ifdef DEBUG + { + instancesMutex_.lock(); + instances_.erase(this); + instancesDestroyedCount_++; + instancesMutex_.unlock(); + } + #endif + } + + // + // Check is given this pointer points to correct Tegenaria::Object. + // + // ptr - this pointer to check (IN). + // + // RETURNS: 1 if given pointer points to correct Tegenaria::Object, + // 0 otherwise. + // + + bool Object::IsPointerCorrect(Object *ptr) + { + int found = 0; + + #ifdef DEBUG + { + instancesMutex_.lock(); + found = instances_.count(ptr); + instancesMutex_.unlock(); + } + #else + { + found = 1; + } + #endif + + return found; + } + + int Object::GetNumberOfInstances() + { + int rv = -1; + + #ifdef DEBUG + rv = instances_.size(); + #endif + + return rv; + } + + int Object::GetCreatedCounter() + { + int rv = -1; + + #ifdef DEBUG + rv = instancesCreatedCount_; + #endif + + return rv; + } + + int Object::GetDestroyedCounter() + { + int rv = -1; + + #ifdef DEBUG + rv = instancesDestroyedCount_; + #endif + + return rv; + } + + int Object::GetDuplicatedCounter() + { + int rv = -1; + + #ifdef DEBUG + rv = instancesDuplicatedCount_; + #endif + + return rv; + } + + // + // Increase refference counter. + // + // WARNING! Every call to addRef() MUSTS be followed by one release() call. + // + // TIP #1: Object will not be destroyed until refference counter is greater + // than 0. + // + // TIP #2: Don't call destructor directly, use release() instead. If + // refference counter achieve 0, object will be destroyed + // automatically. + // + + void Object::addRef() + { + refCountMutex_.lock(); + + refCount_ ++; + + DEBUG3("Increased refference counter to %d for '%s' PTR#%p.\n", + refCount_, this -> getObjectName(), this); + + refCountMutex_.unlock(); + } + + // + // Decrease refference counter increased by addRef() before. + // + + void Object::release() + { + int deleteNeeded = 0; + + // + // Check is this pointer correct. + // + + if (IsPointerCorrect(this) == 0) + { + Error("ERROR: Attemp to release non existing object PTR#%p.\n", this); + + return; + } + + // + // Decrease refference counter by 1. + // + + refCountMutex_.lock(); + + refCount_ --; + + DEBUG3("Decreased refference counter to %d for '%s' PTR#%p.\n", + refCount_, this -> getObjectName(), this); + + if (refCount_ == 0) + { + deleteNeeded = 1; + } + + refCountMutex_.unlock(); + + // + // Delete object if refference counter goes down to 0. + // + + if (deleteNeeded) + { + delete this; + } + } + + int Object::getRefCounter() + { + return refCount_; + } + + const char *Object::getObjectName() + { + return objectName_.c_str(); + } + + const char *Object::getClassName() + { + return className_.c_str(); + } + +} /* namespace Tegenaria */ diff --git a/Source/Core/LibObject/Object.h b/Source/Core/LibObject/Object.h new file mode 100644 index 0000000..5256b72 --- /dev/null +++ b/Source/Core/LibObject/Object.h @@ -0,0 +1,109 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Common_Object_H +#define Tegenaria_Core_Common_Object_H + +#include +#include + +namespace Tegenaria +{ + class Object + { + private: + + int refCount_; + + Mutex refCountMutex_; + + string className_; + string objectName_; + + // + // Track created instances to check is given this pointer correct or not. + // + + #ifdef DEBUG + static std::set instances_; + static Mutex instancesMutex_; + static int instancesCreatedCount_; + static int instancesDestroyedCount_; + static int instancesDuplicatedCount_; + #endif + + // + // Private copy constructor to avoid problems with tracking + // reference counter after copying. + // + + private: + + Object(const Object &); + + // + // Protected destructor. + // Use release() method instead. + // + + protected: + + virtual ~Object(); + + Object(const char *className, const char *objectName = "anonymous"); + + public: + + // + // Refference counter. + // Use addRef() to mark that object is needed. + // Use release() to mark that object is no longer needed. + // + // At startup object has refference counter set to 1. + // Object is destroyed when refference counter reaches 0. + // + + void addRef(); + void release(); + int getRefCounter(); + + // + // Check is given this pointer represents correct Object. + // Works in debug mode only. + // In realease mode returns true always. + // + + static bool IsPointerCorrect(Object *ptr); + static int GetNumberOfInstances(); + static int GetCreatedCounter(); + static int GetDestroyedCounter(); + static int GetDuplicatedCounter(); + + const char *getClassName(); + const char *getObjectName(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Common_Object_H */ diff --git a/Source/Core/LibObject/qcbuild.src b/Source/Core/LibObject/qcbuild.src new file mode 100644 index 0000000..975f519 --- /dev/null +++ b/Source/Core/LibObject/qcbuild.src @@ -0,0 +1,48 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibObject + +CXXSRC = Object.cpp +INC_DIR = Tegenaria +ISRC = Object.h +LIBS = -llock -ldebug +AUTHOR = Sylwester Wysocki +PURPOSE = Basic interfaces and types common for core libraries. +DEPENDS = LibLock LibDebug + +# +# Linux libs. +# + +.section Linux + LIBS += -lpthread +.endsection + +# +# Auto documentation flags. +# + +AUTODOC_PRIVATE = 1 diff --git a/Source/Core/LibProcess/ApiHandle.cpp b/Source/Core/LibProcess/ApiHandle.cpp new file mode 100644 index 0000000..d31005f --- /dev/null +++ b/Source/Core/LibProcess/ApiHandle.cpp @@ -0,0 +1,371 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifdef WIN32 +# include +#else +# include +# include +# include +# include +# include +# include +#endif + +#include +#include "Process.h" +#include "Monitor.h" +#include "Internal.h" + +namespace Tegenaria +{ + // -------------------------------------------------------------------------- + // + // ThreadHandle_t based API + // + // -------------------------------------------------------------------------- + + // + // Close handle retrieved from ProcessCreate() before. + // + // WARNING: Function does NOT terminate process if still running. + // + // proc - handle to process retrieved from ProcessCreate() before (IN). + // + // RETURNS: 0 if success, + // -1 otherwise. + // + + int ProcessClose(ProcessHandle_t *proc) + { + int exitCode = -1; + + if (proc) + { + CloseHandle(proc -> handle_); + + free(proc); + + exitCode = 0; + } + else + { + Error("ERROR: 'proc' can't be NULL in ProcessClose()"); + } + + return exitCode; + } + + // + // Check does given proces live. + // + // proc - process handle retrievied from ProcessCreate() function before (IN). + // + // RETURNS: 1 if process is running, + // 0 if dead, + // -1 if error. + // + + int ProcessIsRunning(ProcessHandle_t *proc) + { + int running = 0; + + // + // Windows. + // + + #ifdef WIN32 + { + if (proc) + { + if (WaitForSingleObject(proc -> handle_, 0) == WAIT_TIMEOUT) + { + running = 1; + } + } + } + + // + // Linux, MacOS. + // + + #else + { + if (proc) + { + if (proc -> pid_ > 0 && kill(proc -> pid_, 0) != -1) + { + running = 1 + } + } + } + #endif + + return running; + } + + // + // Unconditional terminate process. + // + // proc - process handle retrievied from ProcessCreate() function before (IN). + // + // RETURNS: 0 if success, + // -1 otherwise. + + int ProcessKill(ProcessHandle_t *proc) + { + int exitCode = -1; + + #ifdef WIN32 + { + int pid = -1; + + // + // Windows. + // + + FAILEX(proc == NULL, "ERROR: Proc can't be NULL in ProcessKill().\n"); + + pid = proc -> pid_; + + DBG_MSG("Terminating process '%d'...\n", pid); + + FAIL(TerminateProcess(proc -> handle_, 1) == FALSE); + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode) + { + Error("ERROR: Cannot terminate process '%d'.\n" + "Error code is : %d.\n", pid, GetLastError()); + } + } + #else + { + // + // Linux, MacOS. + // + + Fatal("ProcessKill() not implemented.\n"); + } + #endif + + return exitCode; + } + + // + // Wait until process finished or timeout reached. + // + // proc - process handle retrievied from ProcessCreate() function before (IN). + // + // timeout - maximum allowed wait time in miliseconds or -1 for inifinity (IN). + // + // resultCode - if process died before the timeout, this value returns + // its result code. Can be NULL if not needed. (OUT/OPT). + // + // RETURNS: 0 if process dead until timeout, + // 1 if timeout reached, + // -1 if error. + // + // TIP #1: On Linux you can get resultCode only for child process. + // + + int ProcessWait(ProcessHandle_t *proc, int timeout, int *resultCode) + { + // + // Windows. + // + + #ifdef WIN32 + { + int exitCode = -1; + int pid = -1; + + // + // Check args. + // + + FAILEX(proc == NULL, "ERROR: 'proc' can't be NULL in ProcessWait().\n"); + + if (timeout < 0) + { + timeout = INFINITE; + } + + // + // Wait for dead or timeout. + // + + DBG_MSG("Waiting for process PID '%d' with timeout '%d' ms...\n", pid, timeout); + + switch(WaitForSingleObject(proc -> handle_, timeout)) + { + // + // Process dead. + // + + case WAIT_OBJECT_0: + { + DBG_MSG("Process PID '%d' signaled.\n", pid); + + if (resultCode) + { + GetExitCodeProcess(proc -> handle_, PDWORD(resultCode)); + } + + exitCode = 0; + + break; + } + + // + // Timeout. + // + + case WAIT_TIMEOUT: + { + DBG_MSG("WARNING: Timeout reached while waiting for process PID '%d'.\n", pid); + + exitCode = 1; + + break; + } + + // + // Error. + // + + default: + { + goto fail; + } + } + + // + // Error handler. + // + + fail: + + if (exitCode == -1) + { + Error("ERROR: Cannot wait for process '%d'.\n" + "Error code is : %d.\n", pid, GetLastError()); + } + } + #else + + // + // Linux, MacOS. + // + + { + Fatal("ProcessWait() not implemented on Linux/MacOS.\n"); + } + #endif + } + + // + // Add process to monitored processes. + // After that process monitor will inform caller when process dead + // or specified timeout reached. + // + // TIP#1: Use ProcessCancelWatch() to remove process from monitor. + // + // + // proc - process handle retrieved from ProcessCreate() before (IN). + // + // callback - callback function to notify user when process dead or + // timeout reached (IN). + // + // timeout - maximum allowed life time for process in ms or -1 to infinite (IN). + // + // ctx - caller specified context passed directly to callback (IN). + // + // RETURNS: 0 if OK. + // + + int ProcessWatch(ProcessHandle_t *proc, + ProcessWatchCbProto callback, + int timeout, void *ctx) + { + if (proc) + { + return _ProcessMonitorAddPid(proc -> pid_, callback, timeout, ctx); + } + else + { + return -1; + } + } + + // + // Remove process from monitored processes (added by ProcessWatch() before). + // + // proc - process handle retrieved from ProcessCreate() before (IN). + // + // RETURNS: 0 if OK. + // + + int ProcessCancelWatch(ProcessHandle_t *proc) + { + if (proc) + { + return _ProcessMonitorRemovePid(proc -> pid_); + } + else + { + return -1; + } + } + + // + // Return pid of given process. + // + // proc - process handle retrieved from ProcessCreate() before (IN). + // + // RETURNS: PID of process given as proc parameter, + // or -1 if error. + // + + int ProcessGetPidByHandle(ProcessHandle_t *proc) + { + if (proc) + { + return proc -> pid_; + } + else + { + return -1; + } + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibProcess/ApiPid.cpp b/Source/Core/LibProcess/ApiPid.cpp new file mode 100644 index 0000000..ccb3e6a --- /dev/null +++ b/Source/Core/LibProcess/ApiPid.cpp @@ -0,0 +1,311 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifdef WIN32 +# include +#else +# include +# include +# include +# include +# include +# include +#endif + +#include +#include "Process.h" +#include "Monitor.h" +#include "Internal.h" + +namespace Tegenaria +{ + // -------------------------------------------------------------------------- + // + // PID based API + // + // -------------------------------------------------------------------------- + + // + // Check does given proces live. + // + // pid - pid of process to check (IN). + // + // RETURNS: 1 if process is running, + // 0 if dead, + // -1 if error. + // + + int ProcessIsRunningById(int pid) + { + int running = 0; + + // + // Windows. + // + + #ifdef WIN32 + { + HANDLE process = OpenProcess(SYNCHRONIZE, FALSE, pid); + + if (process != NULL) + { + if (WaitForSingleObject(process, 0) == WAIT_TIMEOUT) + { + running = 1; + } + + CloseHandle(process); + } + } + + // + // Linux, MacOS. + // + + #else + { + if (pid > 0 && kill(pid, 0) != -1) + { + running = 1 + } + } + #endif + + return running; + } + + // + // Unconditional terminate process. + // + // pid - pid of process, which we want to kill (IN) + // + // RETURNS: 0 if success, + // -1 otherwise. + // + + int ProcessKillByPid(int pid) + { + int exitCode = -1; + + #ifdef WIN32 + { + // + // Windows. + // + + DBG_MSG("Terminating process '%d'...\n", pid); + + HANDLE process = OpenProcess(PROCESS_TERMINATE, FALSE, pid); + + FAIL(process == NULL); + + FAIL(TerminateProcess(process, 1) == FALSE); + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode) + { + Error("ERROR: Cannot terminate process '%d'.\n" + "Error code is : %d.\n", pid, GetLastError()); + } + + CloseHandle(process); + } + #else + { + // + // Linux, MacOS. + // + + Fatal("ProcessKill() not implemented.\n"); + } + #endif + + return exitCode; + } + + // + // Wait until process finished or timeout reached. + // + // WARNING#1: Function does NOT detect zoombi processes on Linux as long + // as resultCode parameter is NULL. Process become zoombi when + // finished its work, but parent didn't call waitpid to pop + // result code from it. + // + // pid - pid of process to wait (IN). + // + // timeout - maximum allowed wait time in miliseconds or -1 for inifinity (IN). + // + // resultCode - if process died before the timeout, this value returns + // its result code. Can be NULL if not needed. (OUT/OPT). + // + // RETURNS: 0 if process dead until timeout, + // 1 if timeout reached, + // -1 if error. + // + // TIP #1: you can get resultCode only for child process. + // + + int ProcessWaitByPid(int pid, int timeout, int *resultCode) + { + // + // Windows. + // + + #ifdef WIN32 + { + int exitCode = -1; + + if (timeout < 0) + { + timeout = INFINITE; + } + + // + // Open process. + // + + HANDLE process = OpenProcess(SYNCHRONIZE, FALSE, pid); + + FAILEX(process == NULL, "ERROR: Cannot open process '%d'.\n", pid); + + // + // Wait for dead or timeout. + // + + DBG_MSG("Waiting for process '%d' with timeout '%d' ms...\n", pid, timeout); + + switch(WaitForSingleObject(process, timeout)) + { + // + // Process dead. + // + + case WAIT_OBJECT_0: + { + DBG_MSG("Process '%d' signaled.\n", pid); + + if (resultCode) + { + GetExitCodeProcess(process, PDWORD(resultCode)); + } + + exitCode = 0; + + break; + } + + // + // Timeout. + // + + case WAIT_TIMEOUT: + { + DBG_MSG("WARNING: Timeout reached while waiting for process '%d'.\n", pid); + + exitCode = 1; + + break; + } + + // + // Error. + // + + default: + { + goto fail; + } + } + + // + // Error handler. + // + + fail: + + if (exitCode == -1) + { + Error("ERROR: Cannot wait for process '%d'.\n" + "Error code is : %d.\n", pid, GetLastError()); + } + + CloseHandle(process); + } + #else + + // + // Linux, MacOS. + // + + { + Fatal("ProcessWait() not implemented on Linux/MacOS.\n"); + } + #endif + } + + // + // Add process to monitored processes. + // After that process monitor will inform caller when process dead + // or specified timeout reached. + // + // pid - process ID to monitor (IN). + // + // callback - callback function to notify user when process dead or + // timeout reached (IN). + // + // timeout - maximum allowed life time for process in ms or -1 to infinite (IN). + // + // ctx - caller specified context passed directly to callback (IN). + // + // RETURNS: 0 if OK. + // + + int ProcessWatchByPid(int pid, ProcessWatchCbProto callback, int timeout, void *ctx) + { + return _ProcessMonitorAddPid(pid, callback, timeout, ctx); + } + + // + // Remove process from monitored processes (added by ProcessWatchByPid() before). + // + // pid - process ID passed to ProcessWatchByPid() before (IN). + // + // RETURNS: 0 if OK. + // + + int ProcessCancelWatchByPid(int pid) + { + return _ProcessMonitorRemovePid(pid); + } + +} /* namespace Tegenaria */ diff --git a/Source/Core/LibProcess/Create.cpp b/Source/Core/LibProcess/Create.cpp new file mode 100644 index 0000000..9cc677c --- /dev/null +++ b/Source/Core/LibProcess/Create.cpp @@ -0,0 +1,258 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifdef WIN32 +# include +# include +# include +#else +# include +# include +# include +# include +# include +# include +#endif + +#include +#include +#include "Process.h" +#include "Internal.h" + +namespace Tegenaria +{ + // -------------------------------------------------------------------------- + // + // Helper functions, internall only. + // + // -------------------------------------------------------------------------- + + // + // Allocate new ProcessHandle_t struct basing on system handle/pid data. + // + // handle - underlying system handle (IN). + // pid - underlying process id (IN). + // + // RETURNS: Pointer to new allocated handle. + // + + static ProcessHandle_t *_ProcessHandleAlloc(void *handle, int pid) + { + #pragma qcbuild_set_private(1) + + ProcessHandle_t *rv = (ProcessHandle_t *) calloc(sizeof(ProcessHandle_t), 1); + + if (rv) + { + rv -> handle_ = handle; + rv -> pid_ = pid; + } + else + { + Error("ERROR: Can't allocate ProcessHandle_t. Out of memory?\n"); + } + + return rv; + } + + // -------------------------------------------------------------------------- + // + // Create process functions + // + // -------------------------------------------------------------------------- + + // + // USE: + // const char *argv[5] + // argv[0] = "path_to_process" + // argv[1] = "parameter#1" + // argv[2] = "parameter#2" + // argv[3] = "parameter#3" + // argv[4] = NULL + // + // argv[] - NULL terminated parameter list (IN). + // fdin - FD to set for std input (IN/OPT). + // fdout - FD to set for std output (IN/OPT). + // fderr - FD to set for std error (IN/OPT). + // + // fdType - type of specified fdin/fdout/fderr values. One of + // PROCESS_TYPE_XXX values defined in LibProcess.h. Defaulted + // to PROCESS_FDTYPE_CRT if skipped. (IN/OPT). + // + // options - combination of PROCESS_OPTIONS_XXX flags (IN/OPT). + // + // TIP #1: Set fdin/fdout/fderr to PROCESS_FD_PARENT to inherit handle from parent. + // TIP #2: Set fdin/fdout/fderr to PROCESS_FD_NULL to redirect handle to nul. + // TIP #3: Set fdType to PROCESS_FD_TYPE_WINAPI_HANDLE if you have raw windows handle. + // + // RETURNS: Pointer to ProcessHandle_t structure, + // or NULL if error. + // + + ProcessHandle_t *ProcessCreate(const char *const argv[], + int fdin, int fdout, int fderr, + int fdType, int options) + { + ProcessHandle_t *rv = NULL; + + int exitCode = -1; + + // + // Check args. + // + + FAILEX(argv == NULL, "ERROR: 'argv' cannot be NULL in ProcessCreate().\n"); + FAILEX(argv[0] == NULL, "ERROR: 'argv[0]' cannot be NULL in ProcessCreate().\n"); + + DBG_MSG("Creating process [%s]\n", argv[0]); + + for (int i = 1; argv[i]; i++) + { + DBG_MSG("With parameter [%d][%s]\n", i, argv[i]); + } + + // + // Allocate new process handle. + // + + rv = _ProcessHandleAlloc(NULL, -1); + + FAIL(rv == NULL); + + // + // Windows. + // + + #ifdef WIN32 + { + PROCESS_INFORMATION pi = {0}; + + STARTUPINFO si = {0}; + + DWORD creationFlags = 0; + + char cmd[1024 * 4] = {0}; + + // + // Set std handles for child process. + // + + si.hStdInput = ProcessParseFdParameter(fdin, fdType, STD_INPUT_HANDLE); + si.hStdOutput = ProcessParseFdParameter(fdout, fdType, STD_OUTPUT_HANDLE); + si.hStdError = ProcessParseFdParameter(fderr, fdType, STD_ERROR_HANDLE); + + // + // Set up STARTUPINFO. + // + + si.cb = sizeof(STARTUPINFO); + si.dwFlags = STARTF_USESTDHANDLES; + + // + // Set up command to execute in one continous string. + // + + for (int i = 1; argv[i]; i++) + { + strncat(cmd, argv[i], sizeof(cmd)); + strncat(cmd, " ", sizeof(cmd)); + } + + // + // Set up creation flags + // + + if (options & PROCESS_OPTIONS_NO_WINDOW) + { + creationFlags = CREATE_NO_WINDOW; + } + + // + // Create new process. + // + + DBG_MSG + ( + "Creating process...\n" + "command : [%s]\n" + "fdin : [%d/%d]\n" + "fdout : [%d/%d]\n" + "fderr : [%d/%d]\n", + cmd, + fdin, si.hStdInput, + fdout, si.hStdOutput, + fderr, si.hStdError + ); + + FAIL(CreateProcess(NULL, cmd, NULL, NULL, TRUE, + creationFlags, NULL, NULL, &si, &pi) == FALSE); + + DBG_MSG("Created process pid '%d'.\n", int(pi.dwProcessId)); + + // + // Wrap system handle/pid into ProcessHandle_t struct. + // + + rv -> handle_ = pi.hProcess; + rv -> pid_ = pi.dwProcessId; + } + + // + // Linux, MacOS. + // + + #else + { + Fatal("ProcessCreate() not implemented on this platform.\n"); + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + const char *binaryName = "(null)"; + + if (argv && argv[0]) + { + binaryName = argv[0]; + } + + Error("ERROR: Cannot create process '%s'.\n" + "Error code is : %d.\n", binaryName, GetLastError()); + + ProcessClose(rv); + } + + return rv; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibProcess/Internal.h b/Source/Core/LibProcess/Internal.h new file mode 100644 index 0000000..4cb68f8 --- /dev/null +++ b/Source/Core/LibProcess/Internal.h @@ -0,0 +1,58 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Group internal structure, which should NOT +// be visible in public. This structures can be +// modified from version to version wthout risk. +// + +#ifndef Tenegaria_Core_Process_Internal_H + +#ifdef WIN32 +# include +#endif + +namespace Tegenaria +{ + struct ProcessHandle_t + { + int pid_; + int result_; + int resultIsSet_; + + #ifdef WIN32 + HANDLE handle_; + #endif + }; + + #ifdef WIN32 + HANDLE ProcessParseFdParameter(int fd, int fdType, DWORD parentHandleId); + #endif /* WIN32 */ +} + + +#endif /* Tenegaria_Core_Process_Internal_H */ diff --git a/Source/Core/LibProcess/Monitor.cpp b/Source/Core/LibProcess/Monitor.cpp new file mode 100644 index 0000000..289cc25 --- /dev/null +++ b/Source/Core/LibProcess/Monitor.cpp @@ -0,0 +1,615 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Monitor selected process to inform caller when it dead +// or specified timeout reached. +// + +#pragma qcbuild_set_private(1) + +#include "Monitor.h" +#include "Internal.h" +#include + +#ifndef _WIN32 +# include +# include +#endif + +namespace Tegenaria +{ + // + // Globabal variables. + // + + static ThreadHandle_t *ProcessMonitorThread = NULL; + + static int ProcessMonitorEnabled = 0; + + // + // List of monitored processes. + // + + static list ProcessList; + + // + // Mutex to lock ProcessList. + // + + static Mutex ProcessMonitorMutex("ProcessMonitorMutex"); + + static Semaphore ProcessMonitorSem; + + // + // Reset event to let monitor thread know when + // list of monitored processes changed. + // + + #ifdef WIN32 + static HANDLE ProcessMonitorResetEvent = NULL; + #else + + void sigchldHandler(int signal) + { + if (signal == SIGCHLD) + { + ProcessMonitorSem.signal(); + } + } + + void setSignalHandler() + { + signal(SIGCHLD, &sigchldHandler); + } + + #endif + + // + // Main monitor loop working in background thread. + // Monitor processes specified in ProcessList and call user + // specified callback when one of below happen: + // + // - process dead + // - specified timeout reached + // + // TIP: Use processWatch() to add process to monitor. + // + + int _ProcessMonitorLoop(void *unused) + { + int exitCode = -1; + + DBG_ENTER("ProcessMonitorLoop"); + + ProcessMonitorEnabled = 1; + + // + // We don't need synchronise this thread with any else, + // do selt join. + // + + // threadClose(ProcessMonitorThread); + + // + // Windows. + // + + #ifdef WIN32 + { + DWORD ret = 0; + DWORD id = 0; + + DWORD timeout = INFINITE; + + ProcessMonitorEntry_t *proc = NULL; + + vector handles; + + vector handlesProcs; + + list::iterator it; + + while(ProcessMonitorEnabled) + { + // + // Collect handles needed to be watched. + // Set wait timeout to minimum from all processes. + // + + handles.clear(); + handlesProcs.clear(); + + timeout = INFINITE; + + DBG_MSG("ProcessMonitorLoop : Collecting handles...\n"); + + ProcessMonitorMutex.lock(); + + for (it = ProcessList.begin(); it != ProcessList.end(); it++) + { + proc = *it; + + handles.push_back(OpenProcess(SYNCHRONIZE, FALSE, proc -> pid_)); + + handlesProcs.push_back(proc); + + // + // Set wait timeout to minimum from every monitored processes. + // + + if (proc -> timeout_ > 0 && DWORD(proc -> timeout_) < timeout) + { + timeout = proc -> timeout_; + } + } + + ProcessMonitorMutex.unlock(); + + // + // Add reset event at the end to know when new process arrived. + // + + handles.push_back(ProcessMonitorResetEvent); + + // + // Check is loop finished before falling into wait. + // + + if (ProcessMonitorEnabled == 0) + { + break; + } + + // + // Wait until one of below happen: + // + // - one of process dead + // - timeout (set to minimum from collected processes) + // - reset event signaled + // + + DBG_MSG("ProcessMonitorLoop : Waiting for" + " something happen with timeout [%d]...\n", timeout); + + ret = WaitForMultipleObjects(handles.size(), &handles[0], FALSE, timeout); + + // + // Wait timeout. + // At least one of processes reaches its timeout. + // + + if (ret == WAIT_TIMEOUT) + { + ProcessMonitorMutex.lock(); + + for (it = ProcessList.begin(); it != ProcessList.end(); it++) + { + ProcessMonitorEntry_t *proc = *it; + + // + // If timeout set on given process decrease it with + // time of last WaitForMultpleObject() time. + // + + if (proc -> timeout_ > 0) + { + proc -> timeout_ -= timeout; + + if (proc -> timeout_ <= 0) + { + DBG_MSG("ProcessMonitorLoop : Process PID #%d timeout." + " Terminating...", proc -> pid_); + + ProcessKillByPid(proc -> pid_); + } + } + } + + ProcessMonitorMutex.unlock(); + } + + // + // One one of handle signaled or error. + // + + else + { + // + // Check which handle signaled. + // + + id = ret - WAIT_OBJECT_0; + + if (id >= handles.size()) + { + DEBUG1("ProcessMonitorLoop: WARNING: Wait failed with code [0x%x].\n", + (unsigned int) ret); + + continue; + } + + // + // Reset event. Only reset thread loop to collect + // actual process list once again. + // + + if (handles[id] == ProcessMonitorResetEvent) + { + DBG_MSG("ProcessMonitorLoop : Reset received.\n"); + } + + // + // One of processes dead. Inform caller via callback + // and remove process from list. + // + + else + { + int found = 0; + + proc = handlesProcs[id]; + + DBG_MSG("ProcessMonitorLoop : Process PID [%d] signaled.\n", proc -> pid_); + + // + // Call callback specified in processWatch() function. + // + + if (proc -> callback_) + { + proc -> callback_(proc -> pid_, proc -> ctx_); + } + + // + // Remove process from list. + // + + ProcessMonitorMutex.lock(); + + for (it = ProcessList.begin(); it != ProcessList.end(); it++) + { + if (proc == *it) + { + DBG_MSG("ProcessMonitorLoop : Removing process" + " PID [%d] from list...\n", proc -> pid_); + + ProcessList.erase(it); + + found = 1; + + break; + } + } + + // + // Free related Process struct. + // + + if (found) + { + DBG_MSG("ProcessMonitorThread : " + "Freeing process structure PID#%d PTR#%p...\n", + proc -> pid_, proc); + + free(proc); + } + + ProcessMonitorMutex.unlock(); + } + } + + // + // Clean handles table before next epoch. + // Skip last handle, becouse it's ready event. + // + + for (int i = 0; i < handles.size() - 1; i++) + { + CloseHandle(handles[i]); + } + } + } + #else + + // + // Linux, MacOS. + // + + { + Fatal("ProcessMonitorLoop() not implemented."); + } + + #endif + + DBG_MSG("Process monitor loop finished.\n"); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot monitor processes.\n" + "Error code is : %d.\n", GetLastError()); + } + + ProcessMonitorEnabled = 0; + + DBG_LEAVE("processMonitorLoop"); + + return exitCode; + }; + + // + // Stop ProcessMonitor thread inited by ProcessMonitorInit() function. + // Called internally as atexit() when needed. + // + + void _ProcessMonitorUninit() + { + if (ProcessMonitorThread) + { + ProcessMonitorEnabled = 0; + + #ifdef WIN32 + SetEvent(ProcessMonitorResetEvent); + #endif + + ThreadWait(ProcessMonitorThread); + ThreadClose(ProcessMonitorThread); + + ProcessMonitorThread = NULL; + } + } + + // + // Init process monitor. + // Called one time to init monitor thread. + // Used internally only. + // + + int _ProcessMonitorInit() + { + DBG_ENTER("ProcessMonitorInit"); + + int exitCode = -1; + + // + // Create monitor thread. + // + + if (ProcessMonitorThread == 0) + { + ProcessMonitorThread = ThreadCreate(_ProcessMonitorLoop, NULL); + + FAILEX(ProcessMonitorThread == 0, "ERROR: Cannot create Process Monitor thread.\n"); + } + + DBG_SET_RENAME("thread", ProcessMonitorThread, "ProcessMonitor"); + + // + // Windows only. + // Create reset event to let main thread + // know when new process arrived. + // + + #ifdef WIN32 + { + if (ProcessMonitorResetEvent == NULL) + { + ProcessMonitorResetEvent = CreateEvent(NULL, FALSE, FALSE, NULL); + } + } + #endif + + atexit(_ProcessMonitorUninit); + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode) + { + Error("ERROR: Cannot initialize process monitor.\n" + "Error code is : %d.\n", GetLastError()); + } + + DBG_LEAVE("ProcessMonitorInit"); + + return exitCode; + } + + // + // Add process to monitored processes. + // After that process monitor will inform caller when process dead + // or specified timeout reached. + // + // pid - process ID to monitor (IN). + // + // callback - callback function to notify user when process dead or + // timeout reached (IN). + // + // timeout - maximum allowed life time for process in ms or -1 to infinite (IN). + // + // ctx - caller specified context passed directly to callback (IN). + // + // RETURNS: 0 if OK. + // + + int _ProcessMonitorAddPid(int pid, ProcessWatchCbProto callback, int timeout, void *ctx) + { + DBG_ENTER("processWatch"); + + int exitCode = -1; + + ProcessMonitorEntry_t *proc = NULL; + + list::iterator it; + + int found = 0; + + // + // Check args. + // + + FAILEX(pid < 0, "ERROR: Wrong PID in processWatch.\n"); + + FAILEX(callback == NULL, "ERROR: Callback function cannot be NULL in processWatch.\n"); + + // + // Check is given PID not already watched. + // + + ProcessMonitorMutex.lock(); + + for (it = ProcessList.begin(); found == 0 && it != ProcessList.end(); it++) + { + if ((*it) -> pid_ == pid) + { + found = 1; + + DBG_MSG("ProcessWatch : PID #%d already monitored.\n", pid); + } + } + + ProcessMonitorMutex.unlock(); + + if (found == 0) + { + // + // Init process monitor thread if not inited yet. + // + + _ProcessMonitorInit(); + + // + // Allocate new Process struct. + // + + proc = (ProcessMonitorEntry_t *) malloc(sizeof(ProcessMonitorEntry_t)); + + FAILEX(proc == NULL, "ERROR: Out of memory.\n"); + + proc -> pid_ = pid; + proc -> timeout_ = timeout; + proc -> callback_ = callback; + proc -> ctx_ = ctx; + + // + // Add process to monitored list. + // + + DBG_MSG("processWatch : Adding process PID [%d] with timeout [%d] ms" + " to monitored list...\n", pid, timeout); + + ProcessMonitorMutex.lock(); + + ProcessList.push_back(proc); + + ProcessMonitorMutex.unlock(); + + // + // Reset process monitor thread on windows. + // + + #ifdef WIN32 + SetEvent(ProcessMonitorResetEvent); + #endif + } + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode) + { + Error("ERROR: Cannot add process PID [%d] to monitored list.\n" + "Error code is : %d.\n", GetLastError()); + } + + DBG_LEAVE("ProcessWatch"); + + return exitCode; + } + + // + // Remove process from process monitor, added before by processWatch(). + // + // pid - process ID to remove from monitor (IN). + // + // RETURNS: 0 if OK. + // + + int _ProcessMonitorRemovePid(int pid) + { + list::iterator it; + + ProcessMonitorMutex.lock(); + + for (it = ProcessList.begin(); it != ProcessList.end(); it++) + { + if ((*it) -> pid_ == pid) + { + DBG_MSG("ProcessCancelWatch : Removing PID #%d PTR #%p from process monitor...\n", pid, *it); + + free(*it); + + ProcessList.erase(it); + + break; + } + } + + ProcessMonitorMutex.unlock(); + + // + // Tell the process monitor that process list changed. + // + + #ifdef WIN32 + { + SetEvent(ProcessMonitorResetEvent); + } + #else + { + ProcessMonitorSem.signal(); + } + #endif + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibProcess/Monitor.h b/Source/Core/LibProcess/Monitor.h new file mode 100644 index 0000000..07c97fd --- /dev/null +++ b/Source/Core/LibProcess/Monitor.h @@ -0,0 +1,72 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_ProcessMonitor_H +#define Tegenaria_Core_ProcessMonitor_H + +#include +#include +#include + +#include "Process.h" + +#ifdef WIN32 +# include +#endif + +#include +#include + +namespace Tegenaria +{ + using std::list; + using std::vector; + + // + // Structures. + // + + struct ProcessMonitorEntry_t + { + int pid_; + int timeout_; + + ProcessWatchCbProto callback_; + + void *ctx_; + }; + + int _ProcessMonitorInit(); + + void _ProcessMonitorUninit(); + + int _ProcessMonitorAddPid(int pid, ProcessWatchCbProto callback, int timeout, void *ctx); + + int _ProcessMonitorRemovePid(int pid); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_ProcessMonitor_H */ diff --git a/Source/Core/LibProcess/Process.h b/Source/Core/LibProcess/Process.h new file mode 100644 index 0000000..3d3105b --- /dev/null +++ b/Source/Core/LibProcess/Process.h @@ -0,0 +1,151 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Process_H +#define Tegenaria_Core_Process_H + +#include + +#ifdef WIN32 +# include +#endif + +namespace Tegenaria +{ + // + // Defines. + // + + #define PROCESS_FD_TYPE_CRT 0 + #define PROCESS_FD_TYPE_WINAPI_HANDLE 1 + #define PROCESS_FD_TYPE_SOCKET 2 + + #define PROCESS_FD_INHERIT -1 + #define PROCESS_FD_NULL -2 + + #define PROCESS_OPTIONS_NO_WINDOW 1 + + // + // Structs. + // + + struct ProcessHandle_t; + + // + // Typedef. + // + + typedef int (*ProcessWatchCbProto)(int pid, void *ctx); + + // + // Fuctions. + // + + // -------------------------------------------------------------------------- + // + // Create process + // + // -------------------------------------------------------------------------- + + ProcessHandle_t *ProcessCreate(const char *const argv[], + int fdin = PROCESS_FD_INHERIT, + int fdout = PROCESS_FD_INHERIT, + int fderr = PROCESS_FD_INHERIT, + int fdType = PROCESS_FD_TYPE_CRT, + int options = 0); + + // -------------------------------------------------------------------------- + // + // ProcessHandle_t based API + // + // -------------------------------------------------------------------------- + + int ProcessIsRunning(ProcessHandle_t *proc); + + int ProcessWait(ProcessHandle_t *proc, int timeoutMs = -1, int *resultCode = NULL); + + int ProcessWatch(ProcessHandle_t *proc, + ProcessWatchCbProto callback, + int timeout = -1, + void *ctx = NULL); + + int ProcessCancelWatch(ProcessHandle_t *proc); + + int ProcessClose(ProcessHandle_t *proc); + + int ProcessKill(ProcessHandle_t *proc); + + // -------------------------------------------------------------------------- + // + // PID based API + // + // -------------------------------------------------------------------------- + + int ProcessIsRunningByPid(int pid); + + int ProcessWaitByPid(int pid, int timeoutMs = -1, int *resultCode = NULL); + + int ProcessWatchByPid(int pid, ProcessWatchCbProto callback, + int timeoutMs = -1, void *ctx = NULL); + + + int ProcessCancelWatchByPid(int pid); + + int ProcessKillByPid(int pid); + + int ProcessGetPidByHandle(ProcessHandle_t *proc); + + // -------------------------------------------------------------------------- + // + // Sleep functions + // + // -------------------------------------------------------------------------- + + void ProcessSleepUs(int us); + void ProcessSleepMs(int ms); + void ProcessSleepSec(double seconds); + + // -------------------------------------------------------------------------- + // + // General util functions + // + // -------------------------------------------------------------------------- + + int ProcessGetCurrentPid(); + + int ProcessGetParentPid(); + + int ProcessGetModulePath(char *path, int pathSize); + + int ProcessExpandRelativePath(char *normPath, int pathSize, const char *relative); + + int ProcessDaemonize(); + + int ProcessGetBinaryPath(char *binaryPath, int binaryPathSize, int pid); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Process_H */ diff --git a/Source/Core/LibProcess/Sleep.cpp b/Source/Core/LibProcess/Sleep.cpp new file mode 100644 index 0000000..db443cc --- /dev/null +++ b/Source/Core/LibProcess/Sleep.cpp @@ -0,0 +1,101 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifdef WIN32 +# include +#else +# include +# include +# include +# include +# include +# include +#endif + +#include +#include +#include "Process.h" + +namespace Tegenaria +{ + // -------------------------------------------------------------------------- + // + // Sleep functions + // + // -------------------------------------------------------------------------- + + // + // Sleep current thread for given number of microseconds. + // + + void ProcessSleepUs(int us) + { + #ifdef WIN32 + { + // + // TODO: Handle us on Windows. + // + + if (us < 1000) + { + Sleep(1); + } + else + { + Sleep(us / 1000); + } + } + #else + usleep(us); + #endif + } + + // + // Sleep current thread for given number of miliseconds. + // + + void ProcessSleepMs(int ms) + { + #ifdef WIN32 + Sleep(ms); + #else + usleep(ms * 1000); + #endif + } + + // + // Sleep current thread for given number of seconds. + // + + void ProcessSleepSec(double seconds) + { + #ifdef WIN32 + Sleep(seconds * 1000); + #else + usleep(seconds * 1000000); + #endif + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibProcess/Utils.cpp b/Source/Core/LibProcess/Utils.cpp new file mode 100644 index 0000000..266898d --- /dev/null +++ b/Source/Core/LibProcess/Utils.cpp @@ -0,0 +1,956 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Windows includes. +// + +#ifdef WIN32 + +# include +# include +# include +# include +# include +# include + +// +// Linux includes. +// + +#else + +# include +# include +# include +# include +# include +# include + +#endif + +#include +#include +#include "Process.h" + +namespace Tegenaria +{ + #ifdef WIN32 + + // + // Determine in/out/err handle basing on parameters given in ProcessCreate() + // function. + // + // fd - fd parameter passed to ProcessCreate() function (IN). + // fdType - fdType - parameter passed to ProcessCreate() function(IN). + // parentHandleId - handle to use if inherit mode detected eg. handle to stdin (IN). + // + // RETURNS: Winapi handle, which should be set for new process. + // + + HANDLE ProcessParseFdParameter(int fd, int fdType, DWORD parentHandleId) + { + #pragma qcbuild_set_private(1) + + HANDLE rv = NULL; + + if (fd == PROCESS_FD_INHERIT) + { + rv = GetStdHandle(parentHandleId); + } + else if (fd == PROCESS_FD_NULL) + { + rv = NULL; + } + else + { + switch(fdType) + { + // + // CRT FD. + // + + case PROCESS_FD_TYPE_CRT: + { + rv = HANDLE(_get_osfhandle(fd)); + + break; + } + + // + // Raw win32 handle. + // + + case PROCESS_FD_TYPE_WINAPI_HANDLE: + case PROCESS_FD_TYPE_SOCKET: + { + rv = (HANDLE) fd; + + break; + } + } + } + + return rv; + } + #endif /* WIN32 */ + + // + // USE: + // const char *argv[3 + argv_count]; + // argv[0] = "path_to_process"; + // argv[1] = "parameter#1"; + // argv[2] = "parameter#2"; + // argv[3] = "parameter#3"; + // argv[4] = NULL; + // + // argv[] - NULL terminated parameter list (IN). + // fdin - FD to set for std input (IN/OPT). + // fdout - FD to set for std output (IN/OPT). + // fderr - FD to set for std error (IN/OPT). + // + // fdType - type of specified fdin/fdout/fderr values. One of + // PROCESS_TYPE_XXX values defined in LibProcess.h. Defaulted + // to PROCESS_TYPE_CRT if skipped. (IN/OPT). + // + // options - combination of PROCESS_OPTIONS_XXX flags (IN/OPT). + // + // TIP #1: Set fdin/fdout/fderr to -1 to inherit handle from parent. + // TIP #2: Set fdin/fdout/fderr to -2 to redirect handle to nul. + // TIP #3: Set fdType to PROCESS_TYPE_HANDLE if you have raw win32 handle on windows. + // + // RETURNS: pid of new process + // or -1 if error. + // + + int ProcessCreate(const char *argv[], + int fdin, int fdout, int fderr, + int fdType, int options) + { + DBG_MSG("Creating process [%s]\n", argv[0]); + + for (int i = 1; argv[i]; i++) + { + DBG_MSG("With parameter [%d][%s]\n", i, argv[i]); + } + + // + // Windows. + // + + #ifdef WIN32 + { + PROCESS_INFORMATION pi = {0}; + + STARTUPINFO si = {0}; + + DWORD creationFlags = 0; + + char cmd[1024 * 4] = {0}; + + int pid = -1; + + // + // Check args. + // + + SetLastError(ERROR_INVALID_PARAMETER); + + FAILEX(argv == NULL, "ERROR: 'argv' cannot be NULL in ProcessCreate().\n"); + FAILEX(argv[0] == NULL, "ERROR: 'argv[0]' cannot be NULL in ProcessCreate().\n"); + + // + // Set std handles for child process. + // + // -1 = inherit from child + // -2 = NULL + // + // Otherwise set to given CRT FD. + // + + // + // Set handles. + // + + si.hStdInput = ProcessParseFdParameter(fdin, fdType, STD_INPUT_HANDLE); + si.hStdOutput = ProcessParseFdParameter(fdout, fdType, STD_OUTPUT_HANDLE); + si.hStdError = ProcessParseFdParameter(fderr, fdType, STD_ERROR_HANDLE); + + // + // Set up STARTUPINFO. + // + + si.cb = sizeof(STARTUPINFO); + si.dwFlags = STARTF_USESTDHANDLES; + + // + // Set up command to execute in one continous string. + // + + for (int i = 1; argv[i]; i++) + { + strncat(cmd, argv[i], sizeof(cmd)); + strncat(cmd, " ", sizeof(cmd)); + } + + // + // Set up creation flags + // + + if (options & PROCESS_OPTIONS_NO_WINDOW) + { + creationFlags = CREATE_NO_WINDOW; + } + + // + // Create new process. + // + + DBG_MSG + ( + "Creating process...\n" + "command : [%s]\n" + "fdin : [%d/%d]\n" + "fdout : [%d/%d]\n" + "fderr : [%d/%d]\n", + cmd, + fdin, si.hStdInput, + fdout, si.hStdOutput, + fderr, si.hStdError + ); + + FAIL(CreateProcess(NULL, cmd, NULL, NULL, TRUE, + creationFlags, NULL, NULL, &si, &pi) == FALSE); + + pid = pi.dwProcessId; + + DBG_MSG("Created process '%d'.\n", pid); + + // + // Error handler. + // + + fail: + + if (pid == -1) + { + Error("ERROR: Cannot create process '%s'.\n" + "Error code is : %d.\n", argv[0], + GetLastError()); + } + + return pid; + } + + // + // Linux, MacOS. + // + + #else + { + Fatal("ProcessCreate() not implemented on this platform.\n"); + } + #endif + } + + // + // Check does given proces live. + // + // pid - pid of process to check (IN). + // + // RETURNS: 1 if process is running, + // 0 if dead or error. + // + + int ProcessIsRunning(int pid) + { + int running = 0; + + // + // Windows. + // + + #ifdef WIN32 + { + HANDLE process = OpenProcess(SYNCHRONIZE, FALSE, pid); + + if (process != NULL) + { + if (WaitForSingleObject(process, 0) == WAIT_TIMEOUT) + { + running = 1; + } + + CloseHandle(process); + } + } + + // + // Linux, MacOS. + // + + #else + { + if (pid > 0 && kill(pid, 0) != -1) + { + running = 1 + } + } + #endif + + return running; + } + + void ProcessKill(int pid, int force) + { + #ifdef WIN32 + { + // + // Windows. + // + + int exitCode = -1; + + DBG_MSG("Terminating process '%d'...\n", pid); + + HANDLE process = OpenProcess(PROCESS_TERMINATE, FALSE, pid); + + FAIL(process == NULL); + + FAIL(TerminateProcess(process, 1) == FALSE); + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode) + { + Error("ERROR: Cannot terminate process '%d'.\n" + "Error code is : %d.\n", pid, GetLastError()); + } + + CloseHandle(process); + } + #else + { + // + // Linux, MacOS. + // + + Fatal("ProcessKill() not implemented.\n"); + } + #endif + } + + // + // Wait until process finished or timeout reached. + // + // WARNING#1: Function does NOT detect zoombi processes on Linux as long + // as resultCode parameter is NULL. Process become zoombi when + // finished its work, but parent didn't call waitpid to pop + // result code from it. + // + // pid - pid of process to wait (IN). + // + // timeout - maximum allowed wait time in miliseconds or -1 for inifinity (IN). + // + // resultCode - if process died before the timeout, this value returns + // its result code. Can be NULL if not needed. (OUT/OPT). + // + // RETURNS: 0 if process dead until timeout, + // 1 if timeout reached, + // -1 if error. + // + // TIP #1: you can get resultCode only for child process. + // + + int ProcessWait(int pid, int timeout, int *resultCode) + { + // + // Windows. + // + + #ifdef WIN32 + { + int exitCode = -1; + + if (timeout < 0) + { + timeout = INFINITE; + } + + // + // Open process. + // + + HANDLE process = OpenProcess(SYNCHRONIZE, FALSE, pid); + + FAILEX(process == NULL, "ERROR: Cannot open process '%d'.\n", pid); + + // + // Wait for dead or timeout. + // + + DBG_MSG("Waiting for process '%d' with timeout '%d' ms...\n", pid, timeout); + + switch(WaitForSingleObject(process, timeout)) + { + // + // Process dead. + // + + case WAIT_OBJECT_0: + { + DBG_MSG("Process '%d' signaled.\n", pid); + + if (resultCode) + { + GetExitCodeProcess(process, PDWORD(resultCode)); + } + + exitCode = 0; + + break; + } + + // + // Timeout. + // + + case WAIT_TIMEOUT: + { + DBG_MSG("WARNING: Timeout reached while waiting for process '%d'.\n", pid); + + exitCode = 1; + + break; + } + + // + // Error. + // + + default: + { + goto fail; + } + } + + // + // Error handler. + // + + fail: + + if (exitCode == -1) + { + Error("ERROR: Cannot wait for process '%d'.\n" + "Error code is : %d.\n", pid, GetLastError()); + } + + CloseHandle(process); + } + #else + + // + // Linux, MacOS. + // + + { + Fatal("ProcessWait() not implemented on Linux/MacOS.\n"); + } + #endif + } + + // + // Find PID of parent process. + // + // RETURNS: PID of parent of current running process, + // or -1 if error. + // + + int ProcessGetParentPid() + { + int parentPid = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + DWORD currentPid = GetCurrentProcessId(); + + HANDLE snap = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0); + + PROCESSENTRY32 procEntry = {0}; + + // + // Get snapshot of current running processes. + // + + FAILEX(snap == NULL, "ERROR: Cannot create processes snapshot.\n"); + + // + // Get first process in snapshot. + // + + procEntry.dwSize = sizeof(PROCESSENTRY32); + + FAIL(Process32First(snap, &procEntry) == FALSE); + + // + // Search for current running process in processes list. + // + + do + { + // + // Get parent pid for current process. + // + + if (currentPid == procEntry.th32ProcessID) + { + parentPid = (int) procEntry.th32ParentProcessID; + } + } + while (parentPid == -1 && Process32Next(snap, &procEntry)); + + FAILEX(parentPid < 0, "ERROR: Current running process" + " [%d] not found while searching for parent PID.\n", currentPid); + } + + // + // Linux. + // + + #else + { + parentPid = getppid(); + } + #endif + + // + // Error handler. + // + + fail: + + return parentPid; + } + + // + // Find PID of own process. + // + // RETURNS: PID of current running process, + // or -1 if error. + // + + int ProcessGetCurrentPid() + { + int currentPid = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + currentPid = (int) GetCurrentProcessId(); + } + + // + // Linux. + // + + #else + { + currentPid = getpid(); + } + #endif + + return currentPid; + } + + // + // Retrieve full, absolute path to current running binary + // (e.g. c:/dirligo/dirligo.exe) + // + // path - buffer, where to store retrieved path (OUT). + // pathSize - size of path[] buffer in bytes (IN). + // + // RETURNS: 0 if OK. + // + + int ProcessGetModulePath(char *path, int pathSize) + { + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + FAIL(GetModuleFileName(NULL, path, pathSize) == FALSE); + } + + // + // Linux, MacOS. + // + + #else + { + Error("ERROR: ProcessGetModulePath() is not implemented on this platform.\n"); + + goto fail; + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot retrieve path of current running module.\n" + "Error code is : %d.\n", GetLastError()); + } + + return exitCode; + } + + // + // Transform relative (to where current binary stored) path into full path. + // E.g. it transforms "/somedir" into "/somedir". + // We use it becouse daemon (service) doesn't start in path, where current binary + // stored until we don't set current directory manually. + // + // WARNING: If passed path is already absolute it returns the same string. + // + // normPath - full, generated path (OUT). + // pathSize - size of path buffer in bytes (IN). + // relative - relative path postfix to add to base path (IN). + // quiet - do not write logs if set to 1 (IN). + // + // RETURNS: 0 if OK. + // + + int ProcessExpandRelativePath(char *normPath, int pathSize, const char *relative) + { + DBG_ENTER3("processExpandRelativePath"); + + int exitCode = -1; + + int lastSlash = 0; + + char *path = (char *) malloc(pathSize); + + FAILEX(path == NULL, "ERROR: Out of memory.\n"); + + // + // Check is it already absolute? + // + + if (relative && relative[0] && relative[1] == ':') + { + DEBUG1("Path [%s] is already absolute.\n", relative); + + strncpy(path, relative, pathSize); + } + else + { + DEBUG3("Expanding path [%s]...\n", relative); + + // + // Get full path to nxdevice.exe binary. + // + + FAIL(ProcessGetModulePath(path, pathSize)); + + // + // Remove filename from path. + // + + for (int i = 0; path[i] && i < pathSize; i++) + { + if (path[i] == '\\' || path[i] == '/') + { + lastSlash = i; + } + } + + path[lastSlash] = 0; + + // + // Add relative postfix if any. + // + + if (relative) + { + strncat(path, "\\", pathSize); + strncat(path, relative, pathSize); + } + } + + // + // Normalize path for output (e.g. remove '..' entries). + // + + for (int i = 0; path[i]; i++) + { + if (path[i] == '/') + { + path[i] = '\\'; + } + } + + #ifdef WIN32 + PathCanonicalize(normPath, path); + #endif + + exitCode = 0; + + DEBUG1("Path [%s] expanded to [%s].\n", relative, normPath); + + // + // Error handler. + // + + fail: + + if (exitCode) + { + int err = GetLastError(); + + Error("ERROR: Cannot retrieve path of binary.\n" + "Error code is : %d.\n", err); + + if (err != 0) + { + exitCode = err; + } + } + + if (path != NULL) + { + free(path); + } + + DBG_LEAVE3("ProcessExpandRelativePath"); + + return exitCode; + } + + // + // Create duplicate of current running process and leave it alone in background, + // while parent procses (current running) is going to quit. + // + // WARNING#1: Linux only. + // + // Child process : function exits with code 0 + // Parent process : end of function never reached, process exits in the middle. + // + // RETURNS: 0 for child when success, + // -1 for parent if error. + // + + int ProcessDaemonize() + { + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + Error("ERROR: ProcessDaemonize() not implemented on Windows.\n"); + + SetLastError(ERROR_CALL_NOT_IMPLEMENTED); + + goto fail; + } + + // + // Linux, MacOS. + // + + #else + { + pid_t childPid = 0; + + // + // Create child process. + // + + childPid = fork(); + + FAIL(childPid == -1); + + // + // Parent process. + // Exit whole process with success. + // + + if (childPid > 0) + { + DEBUG1("Process daemonized with PID#%d. Parent is going to exit now.\n", childPid); + + exit(0); + } + + // + // Child process. + // Close std handles and go on. + // + + else + { + DEBUG1("Daemon process started.\n"); + + close(STDIN_FILENO); + close(STDOUT_FILENO); + close(STDERR_FILENO); + } + } + #endif + + // + // Exit code. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot to daemonize process.\n" + "Error code is : %d.\n", GetLastError()); + } + + return exitCode; + } + + // + // Retrieve full, absolute path to binary related with running process. + // + // WARNING#1: Caller MUSTS have PROCESS_VM_READ right to target process + // on Windows OS. In other case function will fail with system code + // ACCESS_DENIED (5). + // + // Parameters: + // + // binaryPath - buffer, where to store full path to binary file related with + // given running process (e.g. c:\windows\explorer.exe) (OUT) + // + // binaryPathSize - size of binaryPath[] buffer in bytes (IN). + // + // pid - pid of process to check (IN). + // + // RETURNS: 0 if OK. + // + + int ProcessGetBinaryPathByPid(char *binaryPath, int binaryPathSize, int pid) + { + int exitCode = -1; + + // + // Check parameters. + // + + FAILEX(binaryPath == NULL, "ERROR: 'binaryPath' cannot be NULL in processGetBinaryPath().\n"); + FAILEX(binaryPathSize <= 1, "ERROR: 'binaryPathSize' cannot be <= 1 in processGetBinaryPath().\n"); + FAILEX(pid <= 0, "ERROR: 'pid' cannot be <= 0 in processGetBinaryPath().\n"); + + // + // Windows. + // + + #ifdef WIN32 + { + HANDLE handle = NULL; + + // + // Open process with read rights. + // + + handle = OpenProcess(PROCESS_QUERY_INFORMATION | PROCESS_VM_READ, FALSE, pid); + + if (handle == NULL) + { + Error("ERROR: Can't open process with pid #%d.\n" + "Error code is %d.\n", pid, GetLastError()); + + goto fail; + } + + // + // Read binary name. + // + + GetModuleFileNameEx(handle, 0, binaryPath, binaryPathSize - 1); + + // + // Clean up. + // + + CloseHandle(handle); + } + + // + // Linux, MacOS. + // + + #else + { + Error("ERROR: processGetBinaryPath() not implemented on this OS.\n"); + + goto fail; + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return exitCode; + } + +} /* namespace Tegenaria */ diff --git a/Source/Core/LibProcess/example01-sshd/Example01.cpp b/Source/Core/LibProcess/example01-sshd/Example01.cpp new file mode 100644 index 0000000..3695054 --- /dev/null +++ b/Source/Core/LibProcess/example01-sshd/Example01.cpp @@ -0,0 +1,136 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef _WIN32 +# include +# include +# include +# include +#endif + +#include +#include +#include + +using namespace Tegenaria; + +/* +TODO: Obsolete due to removed ProcessCreateRead(). + +int runSshd(int port) +{ + // + // Start sshd and return it's pid + // and change port to pid. + // + + int killAfterWhile = 1; + + char buffer[33]; + + snprintf(buffer, sizeof(buffer), "%d", port); + + const char *parameters[6]; + + parameters[0] = "/usr/sbin/sshd"; + parameters[1] = "-De"; + parameters[2] = "-p"; + parameters[3] = buffer; + parameters[4] = NULL; + + ProcessHandle_t *sshd = ProcessCreate(parameters); + + printf("sshd pid: [%d]\n", ProcessGetPidByHandle(sshd)); + + int timer = 0; + + for (;;) + { + ProcessSleepSec(1); + + printf("sshd running: [%d].\n", ProcessIsRunning(sshd)); + + if (ProcessIsRunning(sshd) == 0) + { + break; + } + + timer++; + + if (timer == 5) + { + printf("Process wait started.\n"); + + int resultCode = 1; + + int result = ProcessWait(sshd, 10000, &resultCode); + + printf("Process wait finished with the result [%d] code [%d].\n", result, resultCode); + } + + if (timer == 10 && killAfterWhile == 1) + { + printf("going to kill sshd.\n"); + + ProcessKill(sshd); + } + } + + printf("sshd running: %d\n", ProcessIsRunning(sshd)); + + return 0; +} + + +int main(int argc, char **argv) +{ + Fatal("Not implemented.\n"); +/* + runSshd(1337); + + char *result = NULL; + + const char *parameters[6]; + + parameters[0] = "/usr/bin/ssh"; + parameters[1] = "/usr/bin/ssh"; + parameters[2] = "-v"; + parameters[3] = NULL; + + ProcessCreateRead(parameters, result); + + printf("ProcessExample: read: %s.\n", result); + + printf("ProcessExample: FINISHED\n"); + + return 0; +} +*/ + +int main() +{ + fprintf(stderr, "This example is obselete due to removed ProcessCreateRead() function.\n"); +} diff --git a/Source/Core/LibProcess/example01-sshd/qcbuild.src b/Source/Core/LibProcess/example01-sshd/qcbuild.src new file mode 100644 index 0000000..00a3c96 --- /dev/null +++ b/Source/Core/LibProcess/example01-sshd/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibProcess-example01-sshd +CXXSRC = Example01.cpp + +LIBS = -lprocess -ldebug -lstr -llock -lthread + +.section Linux +LIBS += -lpthread +.endsection + +DEPENDS = LibProcess diff --git a/Source/Core/LibProcess/example02-wrapper/Example02.cpp b/Source/Core/LibProcess/example02-wrapper/Example02.cpp new file mode 100644 index 0000000..0266346 --- /dev/null +++ b/Source/Core/LibProcess/example02-wrapper/Example02.cpp @@ -0,0 +1,52 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +int main(int argc, const char **argv) +{ + // + // Create child. + // + + printf("Creating child process...\n"); + + ProcessHandle_t *proc = ProcessCreate(argv); + + // + // Wait until child finished. + // + + printf("Waiting until child finished...\n"); + + ProcessWait(proc); + ProcessClose(proc); + + return 0; +} diff --git a/Source/Core/LibProcess/example02-wrapper/qcbuild.src b/Source/Core/LibProcess/example02-wrapper/qcbuild.src new file mode 100644 index 0000000..e4cf90e --- /dev/null +++ b/Source/Core/LibProcess/example02-wrapper/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibProcess-example02-wrapper +CXXSRC = Example02.cpp + +LIBS = -lprocess -ldebug -lstr -llock -lthread + +.section Linux +LIBS += -lpthread +.endsection + +DEPENDS = LibProcess LibStr diff --git a/Source/Core/LibProcess/example03-monitor/Example03.cpp b/Source/Core/LibProcess/example03-monitor/Example03.cpp new file mode 100644 index 0000000..2e7ac29 --- /dev/null +++ b/Source/Core/LibProcess/example03-monitor/Example03.cpp @@ -0,0 +1,136 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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 +#include +#include +#include + +#include + +#define N_SLAVES 16 + +using namespace Tegenaria; + +int Count = 0; + +Mutex CountMutex; + +// +// Callback handler to catch process dead or timeout. +// + +int CatchProcessCb(int pid, void *ctx) +{ + printf("Process PID #%d signaled.\n", pid); + + CountMutex.lock(); + Count --; + CountMutex.unlock(); + + printf("%d processes left.\n", Count); +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_INIT("libprocess-example03-monitor.log"); + + // + // No argument specified. + // Master process. + // Create N slave processes with random time life + // and monitor how they become dead or timeout. + // + + if (argc == 1) + { + const char *param[4] = + { + argv[0], + argv[0], + "--slave", + NULL + }; + + // + // Create N childs. + // + + for (int i = 0; i < N_SLAVES; i++) + { + // + // Create process. + // + + printf("Creating slave #%d...\n", i); + + ProcessHandle_t *proc = ProcessCreate(param); + + // + // Start monitoring it with random 0-10s timeout. + // + + ProcessWatch(proc, CatchProcessCb, rand() % 10000); + + // + // Count number of processes. + // + + Count ++; + } + + // + // Wait until at least one child left. + // + + printf("Waiting until processes dead...\n"); + + while(Count > 0) + { + ProcessSleepSec(1); + } + } + + // + // Argument specified. + // Create slave worker with random life time. + // + + else + { + printf("Hello from slave!\n"); + + ProcessSleepMs(rand() % 10000); + + printf("Slave going to dead...\n"); + } + + return 0; +} diff --git a/Source/Core/LibProcess/example03-monitor/qcbuild.src b/Source/Core/LibProcess/example03-monitor/qcbuild.src new file mode 100644 index 0000000..cb888b6 --- /dev/null +++ b/Source/Core/LibProcess/example03-monitor/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibProcess-example03-monitor +CXXSRC = Example03.cpp + +LIBS = -lprocess -lthread -llock -lstr -ldebug -llock -lthread + +.section Linux +LIBS += -lpthread +.endsection + +DEPENDS = LibProcess LibThread LibLock diff --git a/Source/Core/LibProcess/example04-wait-for-parent/Main.cpp b/Source/Core/LibProcess/example04-wait-for-parent/Main.cpp new file mode 100644 index 0000000..fcace40 --- /dev/null +++ b/Source/Core/LibProcess/example04-wait-for-parent/Main.cpp @@ -0,0 +1,43 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +int main() +{ + int parentPid = ProcessGetParentPid(); + + printf("Waiting for parent process PID #%d...\n", parentPid); + + ProcessWaitByPid(parentPid, -1); + + printf("Parent process finished.\n"); + + return 0; +} diff --git a/Source/Core/LibProcess/example04-wait-for-parent/qcbuild.src b/Source/Core/LibProcess/example04-wait-for-parent/qcbuild.src new file mode 100644 index 0000000..a3c038a --- /dev/null +++ b/Source/Core/LibProcess/example04-wait-for-parent/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibProcess-example04-wait-for-parent +CXXSRC = Main.cpp + +LIBS = -lprocess -lthread -llock -lstr -ldebug -llock -lthread + +.section Linux +LIBS += -lpthread +.endsection + +DEPENDS = LibProcess LibThread LibLock diff --git a/Source/Core/LibProcess/example05-daemon/Main.cpp b/Source/Core/LibProcess/example05-daemon/Main.cpp new file mode 100644 index 0000000..41f7ac8 --- /dev/null +++ b/Source/Core/LibProcess/example05-daemon/Main.cpp @@ -0,0 +1,71 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +int main() +{ + FILE *f = NULL; + + int count = 0; + + // + // Exit current process and leave forked copy in background. + // + + ProcessDaemonize(); + + // + // Here we're in child daemon with another PID. + // Stdin handles are no valid longer. + // + + f = fopen("daemon.out", "at+"); + + for (int i = 0; i < 30; i++) + { + if (f) + { + fprintf(f, "Daemon output no#%d.\n", count); + + count ++; + } + + ProcessSleepSec(1); + } + + if (f) + { + fprintf(f, "Daemon's work finished.\n"); + + fclose(f); + } + + return 0; +} diff --git a/Source/Core/LibProcess/example05-daemon/qcbuild.src b/Source/Core/LibProcess/example05-daemon/qcbuild.src new file mode 100644 index 0000000..afffa8a --- /dev/null +++ b/Source/Core/LibProcess/example05-daemon/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibProcess-example05-daemon +CXXSRC = Main.cpp + +LIBS = -lprocess -lthread -llock -lstr -ldebug -llock -lthread + +.section Linux +LIBS += -lpthread +.endsection + +DEPENDS = LibProcess diff --git a/Source/Core/LibProcess/qcbuild.src b/Source/Core/LibProcess/qcbuild.src new file mode 100644 index 0000000..2d75437 --- /dev/null +++ b/Source/Core/LibProcess/qcbuild.src @@ -0,0 +1,58 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibProcess + +CXXSRC = Create.cpp ApiPid.cpp ApiHandle.cpp Monitor.cpp Utils.cpp +CXXSRC += Sleep.cpp + +INC_DIR = Tegenaria +ISRC = Process.h +LIBS = -lthread -llock -lstr -ldebug + +AUTHOR = Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), +AUTHOR += Lukasz Bienczyk (lukasz.bienczyk@gmail.com), +AUTHOR += Sylwester Wysocki (sw143@wp.pl) + +PURPOSE = Creating and monitoring processes +DEPENDS = LibDebug LibLock LibThread LibStr + +# +# Linux libs. +# + +.section Linux + LIBS += -lpthread +.endsection + +# +# Windows libs. +# + +.section MinGW + LIBS += -lpsapi +.endsection diff --git a/Source/Core/LibReg/Example01-simple/Main.cpp b/Source/Core/LibReg/Example01-simple/Main.cpp new file mode 100644 index 0000000..0636fef --- /dev/null +++ b/Source/Core/LibReg/Example01-simple/Main.cpp @@ -0,0 +1,105 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +int main() +{ + DWORD fileSystem = 0; + + char biosDate[1024] = {0}; + + list securityPackages; + list exampleList; + + // + // Read some example keys from registry. + // + + printf("Read test\n"); + printf("---------\n\n"); + + RegGetDword(&fileSystem, HKEY_LOCAL_MACHINE, + "SYSTEM\\CurrentControlSet\\Control\\FileSystem", + "Win95TruncatedExtensions"); + + RegGetString(biosDate, sizeof(biosDate), HKEY_LOCAL_MACHINE, + "SYSTEM\\CurrentControlSet\\Control\\BiosInfo", + "SystemBiosDate"); + + RegGetStringList(securityPackages, HKEY_LOCAL_MACHINE, + "SYSTEM\\CurrentControlSet\\Control\\Lsa", + "Security Packages"); + + // + // Print readed keys. + // + + printf("FileSystem : [%d]\n", fileSystem); + printf("BiosDate : [%s]\n\n", biosDate); + + printf("Security packages:\n"); + + for (list::iterator it = securityPackages.begin(); + it != securityPackages.end(); it++) + { + printf(" '%s'\n", it -> c_str()); + } + + // + // Write example keys: + // + // HKEY_LOCAL_MACHINE\Software\Dirligo\dwordExample + // HKEY_LOCAL_MACHINE\Software\Dirligo\stringExample + // HKEY_LOCAL_MACHINE\Software\Dirligo\stringListExample + // + + printf("\nWrite test\n"); + printf("----------\n\n"); + + exampleList.push_back("Some example string"); + exampleList.push_back("Some another example string"); + exampleList.push_back("Bla bla bla"); + + RegSetDword(HKEY_LOCAL_MACHINE, "Software\\Dirligo", "dwordExample", 1234); + RegSetString(HKEY_LOCAL_MACHINE, "Software\\Dirligo", "stringExample", "example"); + RegSetStringList(HKEY_LOCAL_MACHINE, "Software\\Dirligo", "stringListExample", exampleList); + + printf("Open regedit and go to HKEY_LOCAL_MACHINE\\Software\\Dirligo.\n"); + + // + // Remove test. + // + + getchar(); + + printf("Press enter to remove HKEY_LOCAL_MACHINE\\Software\\Dirligo.\n"); + + RegRemove(HKEY_LOCAL_MACHINE, "Software\\Dirligo"); + + return 0; +} diff --git a/Source/Core/LibReg/Example01-simple/qcbuild.src b/Source/Core/LibReg/Example01-simple/qcbuild.src new file mode 100644 index 0000000..7d9f4e7 --- /dev/null +++ b/Source/Core/LibReg/Example01-simple/qcbuild.src @@ -0,0 +1,38 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibReg-example01-simple + +AUTHOR = Sylwester Wysocki + +# +# Windows only. +# + +.section MinGW + CXXSRC = Main.cpp + DEPENDS = LibReg LibDebug + LIBS = -lreg -ldebug +.endsection \ No newline at end of file diff --git a/Source/Core/LibReg/Example02-list-subkeys/Main.cpp b/Source/Core/LibReg/Example02-list-subkeys/Main.cpp new file mode 100644 index 0000000..01b07d0 --- /dev/null +++ b/Source/Core/LibReg/Example02-list-subkeys/Main.cpp @@ -0,0 +1,46 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include + +using namespace Tegenaria; + +int main() +{ + vector subkeys; + + RegListSubkeys(subkeys, HKEY_CURRENT_USER, + "Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\MountPoints2"); + + printf("Mount points:\n"); + + for (int i = 0; i < subkeys.size(); i++) + { + printf(" [%s]\n", subkeys[i].c_str()); + } + + return 0; +} diff --git a/Source/Core/LibReg/Example02-list-subkeys/qcbuild.src b/Source/Core/LibReg/Example02-list-subkeys/qcbuild.src new file mode 100644 index 0000000..4779731 --- /dev/null +++ b/Source/Core/LibReg/Example02-list-subkeys/qcbuild.src @@ -0,0 +1,38 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibReg-example02-list-subkeys + +AUTHOR = Sylwester Wysocki + +# +# Windows only. +# + +.section MinGW + CXXSRC = Main.cpp + DEPENDS = LibReg LibDebug + LIBS = -lreg -ldebug +.endsection \ No newline at end of file diff --git a/Source/Core/LibReg/Query.cpp b/Source/Core/LibReg/Query.cpp new file mode 100644 index 0000000..deaaa4c --- /dev/null +++ b/Source/Core/LibReg/Query.cpp @@ -0,0 +1,491 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: High-level functions to query windows registry. +// + +#ifdef WIN32 + +#include "Reg.h" + +namespace Tegenaria +{ + // + // Read DWORD value from registry. Quered key should be REG_DWORD type. + // + // value - output buffer, where to store readed value (OUT). + // rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN). + // path - key path (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN). + // element - element name (e.g. Win95TruncatedExtensions) (IN). + // + // RETURNS: 0 if OK, + // WINAPI error code otherwise. + // + + int RegGetDword(DWORD *value, HKEY rootKey, const char *path, const char *element) + { + DBG_ENTER2("RegGetDword"); + + int exitCode = -1; + int regCode = 0; + + HKEY key = NULL; + + DWORD keyType = 0; + DWORD keyValue = 0; + DWORD valueSize = sizeof(DWORD); + + // + // Check args. + // + + FAILEX(value == NULL, "ERROR: value parameter cannot be NULL in RegGetDword.\n"); + FAILEX(path == NULL, "ERROR: path parameter cannot be NULL in RegGetDword.\n"); + FAILEX(element == NULL, "ERROR: element parameter cannot be NULL in RegGetDword.\n"); + + // + // Open path. + // + + regCode = RegOpenKeyEx(rootKey, path, 0, KEY_READ, &key); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Read element value from opened path. + // + + regCode = RegQueryValueEx(key, element, NULL, + &keyType, (PBYTE) &keyValue, &valueSize); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Check readed key type. It should be DWORD. + // + + if (keyType != REG_DWORD) + { + Error("ERROR: Registry key '%s\\%s\\%s' has type '%s', but 'REG_DWORD' expected.\n", + RegGetRootKeyName(rootKey), path, element, RegGetTypeName(keyType)); + + exitCode = ERROR_INVALID_DATA; + + goto fail; + } + + // + // Pass readed value to caller parameter. + // + + *value = keyValue; + + // + // Show quered value in debug log. + // + + DEBUG1("RegGetDword : '%s\\%s\\%s' quered with value '%d'.\n", + RegGetRootKeyName(rootKey), path, element, exitCode, keyValue); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + if (regCode) + { + exitCode = regCode; + } + + DEBUG1("RegGetDword : Querying '%s\\%s\\%s' failed with code '%d'.\n", + RegGetRootKeyName(rootKey), path, element, exitCode); + } + + if (key) + { + RegCloseKey(key); + } + + DBG_LEAVE2("RegGetDword"); + + return exitCode; + } + + // + // Read ASCIZ string value from registry. Quered key should be REG_SZ type. + // + // value - output buffer, where to store readed string (OUT). + // valueSize - size of value[] buffer in bytes (IN). + // rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN). + // path - key path (e.g SYSTEM\CurrentControlSet\Control\BiosInfo) (IN). + // element - element name (e.g. SystemBiosDate) (IN). + // + // RETURNS: 0 if OK, + // WINAPI error code otherwise. + // + + int RegGetString(char *value, int valueSize, HKEY rootKey, + const char *path, const char *element) + { + DBG_ENTER2("RegGetString"); + + int exitCode = -1; + int regCode = 0; + + HKEY key = NULL; + + DWORD keyType = 0; + + // + // Check args. + // + + FAILEX(value == NULL, "ERROR: value parameter cannot be NULL in RegGetString.\n"); + FAILEX(valueSize <= 0, "ERROR: valueSize parameter cannot be <= 0 in RegGetString.\n"); + FAILEX(path == NULL, "ERROR: path parameter cannot be NULL in RegGetString.\n"); + FAILEX(element == NULL, "ERROR: element parameter cannot be NULL in RegGetString.\n"); + + // + // Default output string to empty. + // + + value[0] = 0; + + // + // Reserve one byte for string terminator. + // + + valueSize --; + + // + // Open path. + // + + regCode = RegOpenKeyEx(rootKey, path, 0, KEY_READ, &key); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Read element value from opened path. + // + + regCode = RegQueryValueEx(key, element, NULL, + &keyType, (PBYTE) value, (PDWORD) &valueSize); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Check readed key type. It should be DWORD. + // + + if (keyType != REG_SZ) + { + Error("ERROR: Registry key '%s\\%s\\%s' has type '%s', but 'REG_SZ' expected.\n", + RegGetRootKeyName(rootKey), path, element, RegGetTypeName(keyType)); + + exitCode = ERROR_INVALID_DATA; + + goto fail; + } + + // + // Show quered value in debug log. + // + + DEBUG1("RegGetString : '%s\\%s\\%s' quered with value '%s'.\n", + RegGetRootKeyName(rootKey), path, element, value); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + if (regCode) + { + exitCode = regCode; + } + + DEBUG1("RegGetString : Querying '%s\\%s\\%s' failed with code '%d'.\n", + RegGetRootKeyName(rootKey), path, element, exitCode); + } + + if (key) + { + RegCloseKey(key); + } + + DBG_LEAVE2("RegGetString"); + + return exitCode; + } + + // Read ASCIZ string list from registry. Quered key should be REG_MULTI_SZ type. + // + // values - string list where to store readed list (OUT). + // rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN). + // path - key path (e.g SYSTEM\CurrentControlSet\Control\ContentIndex) (IN). + // element - element name (e.g. DllsToRegister) (IN). + // + // RETURNS: 0 if OK, + // WINAPI error code otherwise. + // + + int RegGetStringList(list &values, HKEY rootKey, + const char *path, const char *element) + { + DBG_ENTER2("RegGetStringList"); + + int exitCode = -1; + int regCode = 0; + + HKEY key = NULL; + + DWORD keyType = 0; + + BYTE *buf = NULL; + + DWORD bufSize = 0; + + char *token = NULL; + + string debugList; + + // + // Check args. + // + + FAILEX(path == NULL, "ERROR: path parameter cannot be NULL in RegGetStringList.\n"); + FAILEX(element == NULL, "ERROR: element parameter cannot be NULL in RegGetStringList.\n"); + + // + // Default output list to empty. + // + + values.clear(); + + // + // Open path. + // + + regCode = RegOpenKeyEx(rootKey, path, 0, KEY_READ, &key); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Read element size. + // + + regCode = RegQueryValueEx(key, element, NULL, &keyType, buf, &bufSize); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Check readed key type. It should be DWORD. + // + + if (keyType != REG_MULTI_SZ) + { + Error("ERROR: Registry key '%s\\%s\\%s' has type '%s', but 'REG_MULTI_SZ' expected.\n", + RegGetRootKeyName(rootKey), path, element, RegGetTypeName(keyType)); + + exitCode = ERROR_INVALID_DATA; + + goto fail; + } + + // + // Allocate buffer to store readed list. + // Reserve 2 extra bytes for 0 bytes terminator as emergency for corrupted + // registry key. + // + + buf = (BYTE *) malloc(bufSize + 2); + + FAILEX(buf == NULL, "ERROR: Out of memory.\n"); + + // + // Read raw list to buffer. + // + + regCode = RegQueryValueEx(key, element, NULL, + &keyType, (PBYTE) buf, &bufSize); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Make sure there are last string and list terminators. + // It catches corrupted registry keys. + // + + buf[bufSize] = 0; + buf[bufSize + 1] = 0; + + // + // Put loaded list into output std list. + // + + token = (char *) buf; + + while((token - (char *) buf + 1) < bufSize) + { + values.push_back(token); + + debugList += token; + debugList += ", "; + + token = strchr(token, 0) + 1; + } + + // + // Show readed list in debug log. + // + + DEBUG1("RegGetStringList : '%s\\%s\\%s' quered with value '%s'.\n", + RegGetRootKeyName(rootKey), path, element, debugList.c_str()); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + if (regCode) + { + exitCode = regCode; + } + + DEBUG1("RegGetStringList : Querying '%s\\%s\\%s' failed with code '%d'.\n", + RegGetRootKeyName(rootKey), path, element, exitCode); + } + + if (key) + { + RegCloseKey(key); + } + + if (buf) + { + free(buf); + } + + DBG_LEAVE2("RegGetStringList"); + + return exitCode; + } + + // + // List subkeys inside given key. + // + // + // + + int RegListSubkeys(vector &subkeys, HKEY rootKey, const char *path) + { + DBG_ENTER2("RegListSubkeys"); + + int exitCode = -1; + int regCode = -1; + + HKEY key = NULL; + + char subkey[1024] = {0}; + + // + // Check args. + // + + FAILEX(path == NULL, "ERROR: path parameter cannot be NULL in RegListSubkeys.\n"); + + // + // Default output list to empty. + // + + subkeys.clear(); + + // + // Open path. + // + + regCode = RegOpenKeyEx(rootKey, path, 0, KEY_READ, &key); + + FAIL(regCode != ERROR_SUCCESS); + + // + // + // + + for (int i = 0; + RegEnumKey(key, i, subkey, sizeof(subkey) - 1) == ERROR_SUCCESS; + i++) + { + subkeys.push_back(subkey); + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + if (regCode) + { + exitCode = regCode; + } + + Error("ERROR: Cannot list keys under '%s\\%s'.\nError code is '%d'.\n", + RegGetRootKeyName(rootKey), path, exitCode); + } + + if (key) + { + RegCloseKey(key); + } + + DBG_LEAVE2("RegListSubkeys"); + + return exitCode; + } + +} /* namespace Tegenaria */ + +#endif /* WIN32 */ diff --git a/Source/Core/LibReg/Reg.h b/Source/Core/LibReg/Reg.h new file mode 100644 index 0000000..f2ca88f --- /dev/null +++ b/Source/Core/LibReg/Reg.h @@ -0,0 +1,86 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_LibReg_H +#define Tegenaria_Core_LibReg_H + +#ifdef WIN32 + +#include +#include +#include +#include + +#include + +namespace Tegenaria +{ + using std::list; + using std::vector; + using std::string; + + // + // Query functions. + // + + int RegGetDword(DWORD *value, HKEY rootKey, + const char *path, const char *element); + + int RegGetString(char *value, int valueSize, HKEY rootKey, + const char *path, const char *element); + + int RegGetStringList(list &values, HKEY rootKey, + const char *path, const char *element); + + int RegListSubkeys(vector &subkeys, HKEY rootKey, const char *path); + + // + // Write functions. + // + + int RegSetDword(HKEY rootKey, const char *path, + const char *element, DWORD value, DWORD flags = 0); + + int RegSetString(HKEY rootKey, const char *path, + const char *element, const char *value, DWORD flags = 0); + + int RegSetStringW(HKEY rootKey, const char *path, + const char *element, const wchar_t *value, DWORD flags = 0); + + int RegSetStringList(HKEY rootKey, const char *path, + const char *element, list values, DWORD flags = 0); + + int RegRemove(HKEY rootKey, const char *path); + + // + // Internal use only. + // + + const char *RegGetTypeName(DWORD type); + const char *RegGetRootKeyName(HKEY key); + +} /* namespace Tegenaria */ + +#endif /* WIN32 */ +#endif /* Tegenaria_Core_LibReg_H */ diff --git a/Source/Core/LibReg/Utils.cpp b/Source/Core/LibReg/Utils.cpp new file mode 100644 index 0000000..25feb8f --- /dev/null +++ b/Source/Core/LibReg/Utils.cpp @@ -0,0 +1,99 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifdef WIN32 + +#include "Reg.h" + +namespace Tegenaria +{ + // + // Translate REG_XXX registry type into human readable string. + // + // type - one of REG_XXX (e.g. REG_DWORD) value (IN). + // + // RETURNS: human readable type's name + // or "UNKNOWN" if type not recognized. + // + + const char *RegGetTypeName(DWORD type) + { + switch(type) + { + case REG_BINARY : return "REG_BINARY"; + case REG_DWORD : return "REG_DWORD"; + case REG_EXPAND_SZ : return "REG_EXPAND_SZ"; + case REG_LINK : return "REG_LINK"; + case REG_MULTI_SZ : return "REG_MULTI_SZ"; + case REG_NONE : return "REG_NONE"; + case REG_QWORD : return "REG_QWORD"; + case REG_SZ : return "REG_SZ"; + } + + return "UNKNOWN"; + } + + // + // Retrieve human readable name for one of HKEY_XXX predefined root keys + // (e.g. HKEY_LOCAL_MACHINE). + // + // key - one of HKEY_XXX predefined keys (IN). + // + // RETURNS: Human readable key name + // or "UNKNOWN" if key not recognized. + // + + const char *RegGetRootKeyName(HKEY key) + { + struct + { + HKEY key_; + + const char *name_; + } + knownKeys[] = + { + {HKEY_CLASSES_ROOT, "HKEY_CLASSES_ROOT"}, + {HKEY_CURRENT_CONFIG, "HKEY_CURRENT_CONFIG"}, + {HKEY_CURRENT_USER, "HKEY_CURRENT_USER"}, + {HKEY_LOCAL_MACHINE, "HKEY_LOCAL_MACHINE"}, + {HKEY_PERFORMANCE_DATA, "HKEY_PERFORMANCE_DATA"}, + {HKEY_USERS, "HKEY_USERS"}, + {NULL, NULL} + }; + + for (int i = 0; knownKeys[i].key_; i++) + { + if (knownKeys[i].key_ == key) + { + return knownKeys[i].name_; + } + } + + return "UNKNOWN"; + } + +} /* namespace Tegenaria */ + +#endif /* WIN32 */ diff --git a/Source/Core/LibReg/Write.cpp b/Source/Core/LibReg/Write.cpp new file mode 100644 index 0000000..1978d47 --- /dev/null +++ b/Source/Core/LibReg/Write.cpp @@ -0,0 +1,512 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: High-level functions to modify windows registry. +// + +#ifdef WIN32 + +#include "Reg.h" + +namespace Tegenaria +{ + // + // Write DWORD value to registry. If key not exist yet, function creates new one. + // + // rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN). + // path - key path (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN). + // element - element name (e.g. Win95TruncatedExtensions) (IN). + // value - DWORD value to set (IN). + // flags - combination of REG_OPTION_XXX flags (e.g. REG_OPTION_VOLATILE) (IN/OPT). + // + // RETURNS: 0 if OK, + // WINAPI error code otherwise. + // + + int RegSetDword(HKEY rootKey, const char *path, + const char *element, DWORD value, DWORD flags) + { + DBG_ENTER2("RegSetDword"); + + int exitCode = -1; + int regCode = 0; + + HKEY key = NULL; + + DWORD keyType = 0; + DWORD keyValue = 0; + DWORD valueSize = sizeof(DWORD); + + // + // Check args. + // + + FAILEX(path == NULL, "ERROR: path parameter cannot be NULL in RegSetDword.\n"); + FAILEX(element == NULL, "ERROR: element parameter cannot be NULL in RegSetDword.\n"); + + // + // Open path (or create new one if does not exist yet). + // + + regCode = RegCreateKeyEx(rootKey, path, 0, NULL, flags, + KEY_READ | KEY_WRITE, NULL, &key, NULL); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Write element value to opened path. + // + + regCode = RegSetValueEx(key, element, 0, REG_DWORD, + (PBYTE) &value, sizeof(value)); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Show set value in debug log. + // + + DEBUG1("RegSetDword : '%s\\%s\\%s' set to '%d'.\n", + RegGetRootKeyName(rootKey), path, element, value); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + if (regCode) + { + exitCode = regCode; + } + + Error("ERROR: Cannot set REG_DWORD key '%s\\%s\\%s' to '%d'.\n" + "Error code is %d.\n", + RegGetRootKeyName(rootKey), path, element, value, exitCode); + } + + if (key) + { + RegCloseKey(key); + } + + DBG_LEAVE2("RegSetDword"); + + return exitCode; + } + + // + // Write string value to registry. If key not exist yet, function creates new one. + // + // rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN). + // path - key path (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN). + // element - element name (e.g. Win95TruncatedExtensions) (IN). + // value - ASCIZ string to set (IN). + // flags - combination of REG_OPTION_XXX flags (e.g. REG_OPTION_VOLATILE) (IN/OPT). + // + // RETURNS: 0 if OK, + // WINAPI error code otherwise. + // + + int RegSetString(HKEY rootKey, const char *path, + const char *element, const char *value, DWORD flags) + { + DBG_ENTER2("RegSetString"); + + int exitCode = -1; + int regCode = 0; + + HKEY key = NULL; + + DWORD keyType = 0; + DWORD keyValue = 0; + DWORD valueSize = 0; + + // + // Check args. + // + + FAILEX(path == NULL, "ERROR: path parameter cannot be NULL in RegSetString.\n"); + FAILEX(element == NULL, "ERROR: element parameter cannot be NULL in RegSetString.\n"); + FAILEX(value == NULL, "ERROR: value parameter cannot be NULL in RegSetString.\n"); + + // + // Open path (or create new one if does not exist yet). + // + + regCode = RegCreateKeyEx(rootKey, path, 0, NULL, flags, + KEY_READ | KEY_WRITE, NULL, &key, NULL); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Compute string len including zero terminator. + // We want to write last zero byte to registry too. + // + + valueSize = strlen(value) + 1; + + // + // Write element value to opened path. + // + + regCode = RegSetValueEx(key, element, 0, REG_SZ, + (PBYTE) value, valueSize); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Show set value in debug log. + // + + DEBUG1("RegSetString : '%s\\%s\\%s' set to '%s'.\n", + RegGetRootKeyName(rootKey), path, element, value); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + if (regCode) + { + exitCode = regCode; + } + + Error("ERROR: Cannot set REG_SZ key '%s\\%s\\%s' to '%s'.\n" + "Error code is %d.\n", + RegGetRootKeyName(rootKey), path, element, value, exitCode); + } + + if (key) + { + RegCloseKey(key); + } + + DBG_LEAVE2("RegSetString"); + + return exitCode; + } + + // + // Write string value to registry. If key not exist yet, function creates new one. + // + // rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN). + // path - key path (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN). + // element - element name (e.g. Win95TruncatedExtensions) (IN). + // value - ASCIZ string to set (IN). + // flags - combination of REG_OPTION_XXX flags (e.g. REG_OPTION_VOLATILE) (IN/OPT). + // + // RETURNS: 0 if OK, + // WINAPI error code otherwise. + // + + int RegSetStringW(HKEY rootKey, const char *path, + const char *element, const wchar_t *value, DWORD flags) + { + DBG_ENTER2("RegSetStringW"); + + int exitCode = -1; + int regCode = 0; + + HKEY key = NULL; + + DWORD keyType = 0; + DWORD keyValue = 0; + DWORD valueSize = 0; + + wchar_t elementW[MAX_PATH] = {0}; + + // + // Check args. + // + + FAILEX(path == NULL, "ERROR: path parameter cannot be NULL in RegSetString.\n"); + FAILEX(element == NULL, "ERROR: element parameter cannot be NULL in RegSetString.\n"); + FAILEX(value == NULL, "ERROR: value parameter cannot be NULL in RegSetString.\n"); + + // + // Open path (or create new one if does not exist yet). + // + + regCode = RegCreateKeyEx(rootKey, path, 0, NULL, flags, + KEY_READ | KEY_WRITE, NULL, &key, NULL); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Compute string len including zero terminator. + // We want to write last zero byte to registry too. + // + + valueSize = wcslen(value) + 1; + + valueSize *= sizeof(wchar_t); + + // + // Write element value to opened path. + // + + swprintf(elementW, L"%hs", element); + + regCode = RegSetValueExW(key, elementW, 0, REG_SZ, + (PBYTE) value, valueSize); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Show set value in debug log. + // + + DEBUG1("RegSetStringW : '%s\\%s\\%s' set to '%ls'.\n", + RegGetRootKeyName(rootKey), path, element, value); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + if (regCode) + { + exitCode = regCode; + } + + Error("ERROR: Cannot set REG_SZ key '%s\\%s\\%s' to '%ls'.\n" + "Error code is %d.\n", + RegGetRootKeyName(rootKey), path, element, value, exitCode); + } + + if (key) + { + RegCloseKey(key); + } + + DBG_LEAVE2("RegSetStringW"); + + return exitCode; + } + + // + // Write string list to registry. If key not exist yet, function creates new one. + // + // rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN). + // path - key path (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN). + // element - element name (e.g. Win95TruncatedExtensions) (IN). + // values - list of strings to set (IN). + // flags - combination of REG_OPTION_XXX flags (e.g. REG_OPTION_VOLATILE) (IN/OPT). + // + // RETURNS: 0 if OK, + // WINAPI error code otherwise. + // + + int RegSetStringList(HKEY rootKey, const char *path, + const char *element, list values, DWORD flags) + { + DBG_ENTER2("RegSetStringList"); + + int exitCode = -1; + int regCode = 0; + + HKEY key = NULL; + + DWORD keyType = 0; + DWORD keyValue = 0; + + PBYTE buf = NULL; + PBYTE dst = NULL; + DWORD bufSize = 0; + + string debugList; + + // + // Check args. + // + + FAILEX(path == NULL, "ERROR: path parameter cannot be NULL in RegSetString.\n"); + FAILEX(element == NULL, "ERROR: element parameter cannot be NULL in RegSetString.\n"); + + // + // Open path (or create new one if does not exist yet). + // + + regCode = RegCreateKeyEx(rootKey, path, 0, NULL, flags, + KEY_READ | KEY_WRITE, NULL, &key, NULL); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Compute whole list length including zero terminator. + // + + + bufSize = 0; + + for (list::iterator it = values.begin(); it != values.end(); it++) + { + bufSize += it -> size() + 1; + } + + bufSize ++; + + // + // Allocate buffer to store raw list. + // + + buf = (PBYTE) calloc(bufSize, 1); + + FAILEX(buf == NULL, "ERROR: Out of memory.\n"); + + // + // Copy elements from std::list to raw. + // + + dst = buf; + + for (list::iterator it = values.begin(); it != values.end(); it++) + { + memcpy(dst, it -> c_str(), it -> size()); + + dst += it -> size() + 1; + + debugList += *it; + debugList += ", "; + } + + // + // Write raw list to opened path. + // + + regCode = RegSetValueEx(key, element, 0, REG_MULTI_SZ, buf, bufSize); + + FAIL(regCode != ERROR_SUCCESS); + + // + // Show set value in debug log. + // + + DEBUG1("RegSetStringList : '%s\\%s\\%s' set to '%s'.\n", + RegGetRootKeyName(rootKey), path, element, debugList.c_str()); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + if (regCode) + { + exitCode = regCode; + } + + Error("ERROR: Cannot set REG_MULTI_SZ key '%s\\%s\\%s'.\n" + "Error code is %d.\n", + RegGetRootKeyName(rootKey), path, element, exitCode); + } + + if (key) + { + RegCloseKey(key); + } + + if (buf) + { + free(buf); + } + + DBG_LEAVE2("RegSetStringList"); + + return exitCode; + } + + // + // Remove given key from registry. + // + // rootKey - one of HKEY_XXX defines (e.g. HKEY_LOCAL_MACHINE) (IN). + // path - key path to remove (e.g SYSTEM\CurrentControlSet\Control\FileSystem) (IN). + // + // RETURNS: 0 if OK, + // WINAPI error code otherwise. + // + + int RegRemove(HKEY rootKey, const char *path) + { + DBG_ENTER2("RegRemove"); + + vector subkeys; + + // + // Remove subkeys first. + // + + RegListSubkeys(subkeys, rootKey, path); + + for (int i = 0; i < subkeys.size(); i++) + { + string subpath = string(path) + "\\" + subkeys[i]; + + RegRemove(rootKey, subpath.c_str()); + } + + // + // Remove key itself. + // + + int exitCode = RegDeleteKey(rootKey, path); + + if (exitCode != ERROR_SUCCESS) + { + Error("ERROR: Cannot remove key '%s\\%s'.\n" + "Error code is : %d.\n", + RegGetRootKeyName(rootKey), path, exitCode); + } + else + { + DEBUG1("RegRemove : Key '%s\\%s' removed.\n", RegGetRootKeyName(rootKey), path); + } + + DBG_LEAVE2("RegRemove"); + + return exitCode; + } +} /* namespace Tegenaria */ + +#endif /* WIN32 */ diff --git a/Source/Core/LibReg/qcbuild.src b/Source/Core/LibReg/qcbuild.src new file mode 100644 index 0000000..9f8b7c2 --- /dev/null +++ b/Source/Core/LibReg/qcbuild.src @@ -0,0 +1,41 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibReg + +AUTHOR = Sylwester Wysocki +PURPOSE = High-level API to query and modify windows registry. + +# +# Windows only. +# + +.section MinGW + CXXSRC = Query.cpp Write.cpp Utils.cpp + INC_DIR = Tegenaria + ISRC = Reg.h + LIBS = -ldebug + DEPENDS = LibDebug +.endsection diff --git a/Source/Core/LibRuntime/Runtime.h b/Source/Core/LibRuntime/Runtime.h new file mode 100644 index 0000000..bf05493 --- /dev/null +++ b/Source/Core/LibRuntime/Runtime.h @@ -0,0 +1,54 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Runtime_H +#define Tegenaria_Core_Runtime_H + +// +// Windows. +// + +#ifdef WIN32 + +# include + +# define RuntimeLoadLibrary(X) (void *) LoadLibrary(X) +# define RuntimeImportSymbol(LIB, SYM) GetProcAddress((HMODULE) LIB, SYM) +# define RuntimeFreeLibrary(X) FreeLibrary((HMODULE) X) + +// +// Linux, MacOS. +// + +#else + +# include + +# define RuntimeLoadLibrary(X) dlopen(X, RTLD_LAZY) +# define RuntimeImportSymbol(LIB, SYM) dlsym(LIB, SYM) +# define RuntimeFreeLibrary(X) dlclose(X) + +#endif + +#endif /* Tegenaria_Core_Runtime_H */ diff --git a/Source/Core/LibRuntime/qcbuild.src b/Source/Core/LibRuntime/qcbuild.src new file mode 100644 index 0000000..8be4afd --- /dev/null +++ b/Source/Core/LibRuntime/qcbuild.src @@ -0,0 +1,33 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibRuntime + +INC_DIR = Tegenaria +ISRC = Runtime.h + +AUTHOR = Sylwester Wysocki + +PURPOSE = Manage runtime loaded code. diff --git a/Source/Core/LibSSMap/Example01-simple/Main.cpp b/Source/Core/LibSSMap/Example01-simple/Main.cpp new file mode 100644 index 0000000..005a4ff --- /dev/null +++ b/Source/Core/LibSSMap/Example01-simple/Main.cpp @@ -0,0 +1,100 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include +#include + +using std::vector; +using std::string; + +using namespace Tegenaria; + +int main(int argc, char **argv) +{ + SSMap ssmap; + + vector friends; + + // + // Put example data into ssmap object. + // + + ssmap["title"] = "Example01"; + ssmap["color"] = "red"; + ssmap["car"] = "Porshe"; + + ssmap.set("language", "assembler"); + + ssmap.setInt("count", 666); + + // + // Put example string list to ssmap object. + // + + friends.push_back("john"); + friends.push_back("janek"); + friends.push_back("jozek"); + + ssmap.setStringList("friends", friends); + + // + // Dump ssmap to file. + // + + ssmap.saveToFile("ssmap.dat"); + + // + // Clear objects. + // + + ssmap.clear(); + friends.clear(); + + // + // Try load data back from file. + // + + ssmap.loadFromFile("ssmap.dat"); + + printf("title : [%s].\n", ssmap.get("title")); + printf("color : [%s].\n", ssmap.get("color")); + printf("car : [%s].\n", ssmap.get("car")); + printf("language : [%s].\n", ssmap.get("language")); + + printf("count : [%d].\n", ssmap.getInt("count")); + printf("friends : [%s].\n", ssmap.get("friends")); + + ssmap.getStringList(friends, "friends"); + + printf("\nfriends:\n"); + + for (int i = 0; i < friends.size(); i++) + { + printf(" [%s]\n", friends[i].c_str()); + } + + return 0; +} diff --git a/Source/Core/LibSSMap/Example01-simple/qcbuild.src b/Source/Core/LibSSMap/Example01-simple/qcbuild.src new file mode 100644 index 0000000..fe2b079 --- /dev/null +++ b/Source/Core/LibSSMap/Example01-simple/qcbuild.src @@ -0,0 +1,31 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSSMap-example01-simple +CXXSRC = Main.cpp + +LIBS = -lssmap + +DEPENDS = LibSSMap diff --git a/Source/Core/LibSSMap/Example02-serialize/Main.cpp b/Source/Core/LibSSMap/Example02-serialize/Main.cpp new file mode 100644 index 0000000..9999c14 --- /dev/null +++ b/Source/Core/LibSSMap/Example02-serialize/Main.cpp @@ -0,0 +1,81 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include +#include + +using std::vector; +using std::string; + +using namespace Tegenaria; + +int main(int argc, char **argv) +{ + SSMap ssmap; + + string serial; + + // + // Put example data into ssmap object. + // + + ssmap["title"] = "Example01"; + ssmap["color"] = "red"; + ssmap["car"] = "Porshe"; + + ssmap.set("language", "assembler"); + + ssmap.setInt("count", 666); + + // + // Serialize object into one continous string. + // + + ssmap.saveToString(serial); + + printf("Serialized data is: [%s].\n\n", serial.c_str()); + + // + // Clear object. + // + + ssmap.clear(); + + // + // Load back object from serialized string. + // + + ssmap.loadFromString(&serial[0]); + + printf("title : [%s].\n", ssmap.get("title")); + printf("color : [%s].\n", ssmap.get("color")); + printf("car : [%s].\n", ssmap.get("car")); + printf("language : [%s].\n", ssmap.get("language")); + + printf("count : [%d].\n", ssmap.getInt("count")); + + return 0; +} diff --git a/Source/Core/LibSSMap/Example02-serialize/qcbuild.src b/Source/Core/LibSSMap/Example02-serialize/qcbuild.src new file mode 100644 index 0000000..5d21e91 --- /dev/null +++ b/Source/Core/LibSSMap/Example02-serialize/qcbuild.src @@ -0,0 +1,31 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSSMap-example02-serialize +CXXSRC = Main.cpp + +LIBS = -lssmap + +DEPENDS = LibSSMap diff --git a/Source/Core/LibSSMap/SSMap.cpp b/Source/Core/LibSSMap/SSMap.cpp new file mode 100644 index 0000000..96d9b58 --- /dev/null +++ b/Source/Core/LibSSMap/SSMap.cpp @@ -0,0 +1,630 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "SSMap.h" + +namespace Tegenaria +{ + using namespace std; + + // + // Save SSMap to file. + // + // fname - destination filename, where to dump map (IN). + // + // RETURNS: 0 if OK. + // + + int SSMap::saveToFile(const string &fname) + { + FILE *f = fopen(fname.c_str(), "wt+"); + + if (f) + { + for (SSMap::iterator it = begin(); it != end(); it++) + { + fprintf(f, "%s=%s\n", it -> first.c_str(), it -> second.c_str()); + } + + fclose(f); + + return 0; + } + + return -1; + } + + // + // Save SSMap to file. + // + // fname - destination filename, where to dump map (IN). + // flags - extra flags to format output file, see SSMap.h SSMAP_FLAGS_XXX defines (IN). + // + // RETURNS: 0 if OK. + // + + int SSMap::saveToFileEx(const string &fname, int flags) + { + FILE *f = fopen(fname.c_str(), "wt+"); + + if (flags & SSMAP_FLAGS_WIDE) + { + int len = 0; + + char fmt[32]; + + for (SSMap::iterator it = begin(); it != end(); it++) + { + len = max(len, (int) it -> first.size()); + } + + sprintf(fmt, "%%-%ds= %%s\n", len); + + if (f) + { + for (SSMap::iterator it = begin(); it != end(); it++) + { + fprintf(f, fmt, it -> first.c_str(), it -> second.c_str()); + } + + fclose(f); + + return 0; + } + + return saveToFile(fname); + } + + return -1; + } + + // + // Load SSMap from file. + // + // fname - source filename, where to load map from (IN). + // + // RETURNS: 0 if OK. + // + + int SSMap::loadFromFile(const string &fname) + { + FILE *f = fopen(fname.c_str(), "rt"); + + clear(); + + int valLen = 0; + int keyLen = 0; + + if (f) + { + char buf[1024 * 32] = {0}; + + while(fgets(buf, 1024 * 32, f)) + { + char *key = buf; + char *val = strstr(buf, "="); + + if (val && val[1]) + { + val[0] = 0; + + val ++; + + keyLen = strlen(key); + valLen = strlen(val); + + // + // Clean up white spaces from key and value if needed. + // + + while(*key && isspace(*key)) {key ++; keyLen --;} + while(*val && isspace(*val)) {val ++; valLen --;} + + while(keyLen > 0 && isspace(key[keyLen - 1])) + { + key[keyLen - 1] = 0; + + keyLen --; + } + + while(valLen > 0 && + (isspace(val[valLen - 1]) || + (val[valLen - 1] == 10) || + (val[valLen - 1] == 13))) + { + val[valLen - 1] = 0; + + valLen --; + } + + // + // Add new pair. + // + + (*this)[key] = val; + } + } + + fclose(f); + + return 0; + } + + return -1; + } + + // + // Serialize SSMap object into one continuos string. + // + // data - string, where to write serialized data (OUT). + // + + void SSMap::saveToString(string &data) + { + data.clear(); + + char buf[1024]; + + for (SSMap::iterator it = begin(); it != end(); it++) + { + snprintf(buf, sizeof(buf) - 1, "%s=%s\t", + it -> first.c_str(), it -> second.c_str()); + + data += buf; + } + } + + // + // Load SSMap object from one continous string created by saveToString() + // method before. + // + // WARNING: Function destroys input data[] string. + // + // data - source, single continous string created by saveToString() before (IN). + // + // RETURNS: 0 if OK. + // + + int SSMap::loadFromString(char *data) + { + int exitCode = -1; + + int valLen = 0; + int keyLen = 0; + + char *line = NULL; + + clear(); + + // + // Check args. + // + + if (data == NULL) + { + goto fail; + } + + // + // Handle quated "string" format. + // + + if (data[0] == '"' || data[0] == '\'') + { + data++; + } + + // + // Tokenize input string into lines. + // + + line = strtok(data, "\t"); + + while(line) + { + // + // Process line. + // + + char *key = line; + char *val = strstr(line, "="); + + if (val && val[1]) + { + val[0] = 0; + + val ++; + + keyLen = strlen(key); + valLen = strlen(val); + + // + // Clean up white spaces from key and value if needed. + // + + while(*key && isspace(*key)) {key ++; keyLen --;} + while(*val && isspace(*val)) {val ++; valLen --;} + + while(keyLen > 0 && isspace(key[keyLen - 1])) + { + key[keyLen - 1] = 0; + + keyLen --; + } + + while(valLen > 0 && + (isspace(val[valLen - 1]) || + (val[valLen - 1] == 10) || + (val[valLen - 1] == 13))) + { + val[valLen - 1] = 0; + + valLen --; + } + + // + // Add new pair. + // + + (*this)[key] = val; + } + + // + // Goto next line. + // + + line = strtok(NULL, "\t"); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return exitCode; + } + + // + // Setters and getters. + // + + // + // Set lvalue key to rvalue string. + // + // lvalue - key, where to assign data (IN). + // rvalue - string value to assign (IN). + // + // TIP#1: Use getXXX() methods to get back set value. + // + + void SSMap::set(const char *lvalue, const char *rvalue) + { + if (lvalue == NULL) return; + + if (rvalue == NULL) + { + erase(lvalue); + } + else + { + operator[](lvalue) = rvalue; + } + } + + // + // Set lvalue key to rvalue integer. + // + // lvalue - key, where to assign data (IN). + // rvalue - integer value to assign (IN). + + // WARNING: rvalue will be converted to string internally. + // + // TIP#1: Use getXXX() methods to get back set value. + // + + void SSMap::setInt(const char *lvalue, int rvalue) + { + char tmp[64] = {0}; + + if (lvalue == NULL) return; + + snprintf(tmp, sizeof(tmp) - 1, "%d", rvalue); + + operator[](lvalue) = tmp; + } + + // + // Set lvalue key to rvalue pointer. + // + // WARNING: rvalue will be converted to string internally. + // + // lvalue - key, where to assign data (IN). + // rvalue - pointer value to assign (IN). + // + // TIP#1: Use getXXX() methods to get back set value. + // + + void SSMap::setPtr(const char *lvalue, const void *rvalue) + { + if (lvalue) + { + char tmp[32]; + // + // FIXME: Check if %p adds '0x' and if not - check how to add it. + // + + snprintf(tmp, sizeof(tmp) - 1, "%p", rvalue); + + operator[](lvalue) = tmp; + } + } + + // + // Get value assigned to lvalue key as string. + // + // rvalue - key, where to search data (IN). + // + // RETURNS: String value assigned to key lvalue or + // NULL if key does not exist. + // + + const char *SSMap::get(const char *lvalue) + { + if (lvalue) + { + iterator it = find(lvalue); + + if (it != end()) + { + return it -> second.c_str(); + } + else + { + return NULL; + } + } + else + { + return NULL; + } + } + + // + // Get value assigned to lvalue key as string. + // + // rvalue - key, where to search data (IN). + // + // RETURNS: String value assigned to key lvalue or + // NULL if key does not exist. + // + + const char *SSMap::get(const string &lvalue) + { + return get(lvalue.c_str()); + } + + // + // Get value assigned to lvalue key as string with not-null warranty. + // + // rvalue - key, where to search data (IN). + // + // RETURNS: String value assigned to key lvalue or + // empty string if key does not exist. + // + + const char *SSMap::safeGet(const char *lvalue) + { + if (lvalue) + { + iterator it = find(lvalue); + + if (it != end()) + { + return it -> second.c_str(); + } + else + { + return ""; + } + } + else + { + return ""; + } + } + + // + // Get value assigned to lvalue key as string with not-null warranty. + // + // rvalue - key, where to search data (IN). + // + // RETURNS: String value assigned to key lvalue or + // empty string if key does not exist. + // + + const char *SSMap::safeGet(const string &lvalue) + { + return safeGet(lvalue.c_str()); + } + + // + // Get value assigned to lvalue key and convert it to integer. + // + // rvalue - key, where to search data (IN). + // + // RETURNS: Integer value assigned to key lvalue or + // 0 if key does not exist. + // + + int SSMap::getInt(const char *lvalue) + { + const char *raw = get(lvalue); + + if (raw) + { + return atoi(raw); + } + else + { + return 0; + } + } + + // + // Get value assigned to lvalue key and convert it to integer. + // + // rvalue - key, where to search data (IN). + // + // RETURNS: Integer value assigned to key lvalue or + // 0 if key does not exist. + // + + int SSMap::getInt(const string &lvalue) + { + const char *raw = get(lvalue); + + if (raw) + { + return atoi(raw); + } + else + { + return 0; + } + } + + // + // Get value assigned to lvalue key and convert it to hex pointer format. + // + // rvalue - key, where to search data (IN). + // + // RETURNS: Pointer value assigned to key lvalue or + // NULL if key does not exist. + // + + void *SSMap::getPtr(const char *lvalue) + { + const char *raw = get(lvalue); + + if (raw) + { + return (void *) strtol(raw, NULL, 16); + } + else + { + return NULL; + } + } + + // + // Check is lvalue key exist in map. + // + // rvalue - key, where to search data (IN). + // + // RETURNS: 1 if key exist, + // 0 otherwise. + // + + int SSMap::isset(const char *lvalue) + { + if (find(lvalue) == end()) + { + return 0; + } + else + { + return 1; + } + } + + // + // Check is lvalue key exist in map. + // + // rvalue - key, where to search data (IN). + // + // RETURNS: 1 if key exist, + // 0 otherwise. + // + + int SSMap::isset(const string &lvalue) + { + return isset(lvalue.c_str()); + } + + // + // Assign string list to given lvalue. + // + // lvalue - key, where to assign data (IN). + // stringList - string's list to assign (IN). + // + + void SSMap::setStringList(const char *lvalue, vector &stringList) + { + string rvalue; + + for (int i = 0; i < stringList.size(); i++) + { + rvalue += stringList[i]; + + rvalue += ";"; + } + + this -> set(lvalue, rvalue.c_str()); + } + + // + // Get value assigned to lvalue key and convert it to string's list. + // WARNING: Stored value must be in token1;token2;token3... format. + // + // stringList - stl vector, where to store readed list (OUT). + // lvalue - key, where to search data (IN). + // + // RETURNS: Pointer value assigned to key lvalue or + // NULL if key does not exist. + // + + void SSMap::getStringList(vector &stringList, const char *lvalue) + { + const char *raw = this -> get(lvalue); + + stringList.clear(); + + if (raw) + { + string rvalue = raw; + + char *token = strtok((char *) rvalue.c_str(), ";"); + + while(token) + { + stringList.push_back(token); + + token = strtok(NULL, ";"); + } + } + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibSSMap/SSMap.h b/Source/Core/LibSSMap/SSMap.h new file mode 100644 index 0000000..ed4c6af --- /dev/null +++ b/Source/Core/LibSSMap/SSMap.h @@ -0,0 +1,110 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_SSMap_H +#define Tegenaria_Core_SSMap_H + +#include +#include +#include +#include +#include +#include + +namespace Tegenaria +{ + #ifndef FAIL + #define FAIL(X) if (X) goto fail + #endif + + using namespace std; + + // + // Flags to format output file. + // + + #define SSMAP_FLAGS_WIDE 1 // align to '=' character + + // + // General class to store string |-> string map. + // + + class SSMap : public map + { + public: + + // + // Serialize object to disk. + // + + int saveToFile(const string &fname); + int saveToFileEx(const string &fname, int flags); + int loadFromFile(const string &fname); + + // + // Serialize object to single, continous string. + // + + void saveToString(string &data); + + int loadFromString(char *data); + + // + // Set value. + // + + void set(const char *lvalue, const char *rvalue); + void setInt(const char *lvalue, int rvalue); + void setPtr(const char *lvalue, const void *rvalue); + + void setStringList(const char *lvalue, vector &stringList); + + // + // Get value. + // + + const char *get(const char *lvalue); + const char *get(const string &lvalue); + + const char *safeGet(const char *lvalue); + const char *safeGet(const string &lvalue); + + int getInt(const char *lvalue); + int getInt(const string &lvalue); + + void getStringList(vector &stringList, const char *lvalue); + + void *getPtr(const char *ptr); + + // + // Check is any value assigned to given lvalue key. + // + + int isset(const char *lvalue); + int isset(const string &lvalue); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_SSMap_H */ diff --git a/Source/Core/LibSSMap/qcbuild.src b/Source/Core/LibSSMap/qcbuild.src new file mode 100644 index 0000000..17aaa78 --- /dev/null +++ b/Source/Core/LibSSMap/qcbuild.src @@ -0,0 +1,39 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibSSMap + +CXXSRC = SSMap.cpp +INC_DIR = Tegenaria +ISRC = SSMap.h + +LIBS = -ldebug-static + +AUTHOR = Sylwester Wysocki + +PURPOSE = Wrapper for map class to read/write content +PURPOSE += from/to external file easly. + +DEPENDS = LibDebug diff --git a/Source/Core/LibService/Service.cpp b/Source/Core/LibService/Service.cpp new file mode 100644 index 0000000..dfc1cb5 --- /dev/null +++ b/Source/Core/LibService/Service.cpp @@ -0,0 +1,1279 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Manage windows services. +// + +#ifdef WIN32 + +#include "Service.h" +#include "Utils.h" + +namespace Tegenaria +{ + // + // Convert service type string to int code. + // serviceType - string with start type (eg. "FILE_SYSTEM") (IN). + // + // RETURNS: Service type code or -1 if error. + // + + int ServiceGetTypeCode(const char *serviceType) + { + static const StringIntPair serviceTypes[] = + { + {"FILE_SYSTEM", SERVICE_FILE_SYSTEM_DRIVER}, + {"KERNEL_DRIVER", SERVICE_KERNEL_DRIVER}, + {"RECOGNIZER_DRIVER", SERVICE_RECOGNIZER_DRIVER}, + {"PROCESS", SERVICE_WIN32_OWN_PROCESS}, + {"SHARE_PROCESS", SERVICE_WIN32_SHARE_PROCESS}, + {"INTERACTIVE_PROCESS", SERVICE_INTERACTIVE_PROCESS}, + {NULL, 0} + }; + + for (int i = 0; serviceTypes[i].string_; i++) + { + if (strcmp(serviceTypes[i].string_, serviceType) == 0) + { + return serviceTypes[i].code_; + } + } + + return -1; + } + + // + // Convert service start type string to int code. + // + // serviceStartType - string with start type (IN). + // + // RETURNS: Start type code or -1 if error. + // + + int ServiceGetStartTypeCode(const char *startType) + { + static const StringIntPair startTypes[] = + { + {"AUTO", SERVICE_AUTO_START}, + {"BOOT", SERVICE_BOOT_START}, + {"DEMAND", SERVICE_DEMAND_START}, + {"DISABLED", SERVICE_DISABLED}, + {"SYSTEM", SERVICE_SYSTEM_START}, + {NULL, 0} + }; + + for (int i = 0; startTypes[i].string_; i++) + { + if (strcmp(startTypes[i].string_, startType) == 0) + { + return startTypes[i].code_; + } + } + + return -1; + } + + // + // Open service manager and given service. + // + // WARNING! serviceManager and service MUST be closed by + // CloseServiceHandle() function. + // + // serviceManager - handle to service manager (IN/OUT). + // If NULL, new handle opened, otherside + // given handle used as manager. + // + // service - handle to opened service with given name (OUT). + // name - name of service to open (IN). + // rights - requested access right for opened service (IN). + // quiet - don't write error messages if set to 1 (IN). + // + // RETURNS: 0 if OK. + // + + int ServiceOpen(SC_HANDLE *serviceManager, SC_HANDLE *service, + const char *name, DWORD rights, int quiet) + { + DBG_ENTER2("ServiceOpen"); + + int exitCode = -1; + + // + // Check args. + // + + DEBUG3("ServiceOpen : Checking args...\n"); + + SetLastError(ERROR_INVALID_PARAMETER); + + FAIL(name == NULL); + FAIL(service == NULL); + FAIL(serviceManager == NULL); + + // + // Open service manager if needed. + // + + if (*serviceManager == NULL) + { + DEBUG3("ServiceOpen : Opening service manager...\n"); + + *serviceManager = OpenSCManager(NULL, NULL, SC_MANAGER_CONNECT); + + FAIL(*serviceManager == NULL); + } + + // + // Open service. + // + + DEBUG3("ServiceOpen : Opening service '%s' with rights '0x%x'...\n", name, rights); + + *service = OpenService(*serviceManager, name, rights); + + FAIL(*service == NULL); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + int err = GetLastError(); + + if (quiet == 0) + { + Error("ERROR: Cannot open service '%s'.\nError code is %d.\n", name, err); + } + else + { + DEBUG1("Cannot open service '%s'. Error code is %d.\n", name, err); + } + + if (serviceManager) + { + CloseServiceHandle(*serviceManager); + } + + if (service) + { + CloseServiceHandle(*service); + } + + if (err != 0) + { + exitCode = err; + } + } + + DBG_LEAVE2("ServiceOpen"); + + SetLastError(exitCode); + + return exitCode; + } + + // + // Install and start new service. + // + // name - service name (IN) + // displayName - service "long" name. Can be NULL. (IN) + // type - service type (IN). + // startType - start type (IN). + // path - path to executable file with service's code (IN). + // failIfExists - function will fail if service already exists (IN). + // obj - target account name e.g. ".\\nx" (IN). + // pass - account's password if obj parameter specified (IN). + // startAfter - start service after add (default set to 1) (IN/OPT). + // quiet - do not write error messages if 1 (IN/OPT). + // + // RETURNS: 0 if OK. + // + + int ServiceAdd(const char *name, const char *displayName, int type, + int startType, const char *path, bool failIfExists, + const char *obj, const char *pass, int startAfter, + int quiet) + { + DBG_ENTER2("ServiceAdd"); + + int exitCode = -1; + + SC_HANDLE serviceManager = NULL; + + SC_HANDLE service = NULL; + + char fullPath[MAX_PATH] = {0}; + + SERVICE_STATUS status = {0}; + + // + // Check args. + // + + DEBUG3("ServiceAdd : Checking args...\n"); + + DEBUG1("ServiceAdd : Name : [%s]\n", name); + DEBUG1("ServiceAdd : Display name : [%s]\n", displayName); + DEBUG1("ServiceAdd : Type : [0x%x]\n", type); + DEBUG1("ServiceAdd : Start type : [0x%x]\n", startType); + DEBUG1("ServiceAdd : Path : [%s]\n", path); + DEBUG1("ServiceAdd : FailIfExists : [%d]\n", failIfExists); + DEBUG1("ServiceAdd : Account : [%s]\n", obj); + DEBUG1("ServiceAdd : Password : [%s]\n", pass ? "Specified" : "Not specified"); + + SetLastError(ERROR_INVALID_PARAMETER); + + FAILEX(name == NULL, "ERROR: Service's name is not valid.\n"); + FAILEX(path == NULL, "ERROR: Service's path is not valid.\n"); + + // + // Get absolute path to service binary. + // + + DEBUG3("ServiceAdd : Retrieving absolute path to service binary...\n"); + + FAIL(ExpandRelativePath(fullPath, MAX_PATH, path)); + + // + // Open service manager. + // + + DEBUG3("ServiceAdd : Opening service manager...\n"); + + serviceManager = OpenSCManager(NULL, NULL, SC_MANAGER_CONNECT | + SC_MANAGER_CREATE_SERVICE); + + FAIL(serviceManager == NULL); + + // + // Create new service. + // + + DEBUG3("ServiceAdd : Creating new service...\n"); + + service = CreateService(serviceManager, name, displayName, + SERVICE_START | DELETE | SERVICE_QUERY_STATUS | SERVICE_STOP, + type, startType, SERVICE_ERROR_IGNORE, + fullPath, NULL, NULL, NULL, obj, pass); + + // + // CreateService failed. + // + + if (service == NULL) + { + DEBUG1("ServiceAdd : CreateService() failed.\n"); + + // + // When service already exists try open existing one + // to make sure is it in running state. + // + + if (GetLastError() == ERROR_SERVICE_EXISTS) + { + FAIL(failIfExists); + + DEBUG1("ServiceAdd : Service already exists, going to open existing one.\n"); + + service = OpenService(serviceManager, name, + SERVICE_START | SERVICE_STOP | + SERVICE_QUERY_STATUS); + + FAIL(service == NULL); + } + + // + // Service doesn't exists. We can't do more, fail. + // + + else + { + FAIL(1); + } + } + + // + // Send SC_START signal to new service if needed. + // + + if (startAfter) + { + DEBUG3("ServiceAdd : Starting new service...\n"); + + FAIL(StartService(service, 0, NULL) == FALSE + && GetLastError() != ERROR_SERVICE_ALREADY_RUNNING); + + // + // Wait until service change state from SERVICE_START_PENDING + // to SERVICE_RUNNING. + // + + FAIL(ServiceWaitUntilRunning(service, SERVICE_START_PENDING, + SERVICE_RUNNING, SERVICE_RUN_TIMEOUT, 1)); + } + + DEBUG1("Service '%s' created.\n", name); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + int err = GetLastError(); + + if (quiet == 0) + { + Error("ERROR: Cannot create service '%s'.\n" + "Error code is %d.\n", name, err); + } + + // + // Sometimes service is created with errors (e.g. binary + // path doesn't exist). We don't want service in this case. + // + + if (err != ERROR_SERVICE_EXISTS) + { + DEBUG3("ServiceAdd : Cleaning up unusable service...\n"); + + // + // Send stop signal. + // + + if (ControlService(service, SERVICE_CONTROL_STOP, &status) == FALSE) + { + DEBUG1("WARNING: Cannot send stop to service.\n" + "Error code is : %d.\n", (int) GetLastError()); + } + + // + // Delete service from registry. + // + + if (DeleteService(service) == FALSE) + { + Error("WARNING: Cannot delete service '%s'.\n" + "Error code is : %d.\n", name, (int) GetLastError()); + } + } + + if (err != 0) + { + exitCode = err; + } + } + + CloseServiceHandle(serviceManager); + CloseServiceHandle(service); + + DBG_LEAVE2("ServiceAdd"); + + return exitCode; + } + + // + // Change parameters for existing service. + // + // name - service name (IN) + // displayName - service "long" name. Can be NULL. (IN) + // type - service type (IN). + // startType - start type (IN). + // path - path to executable file with service's code (IN). + // + // RETURNS: 0 if OK. + // + + int ServiceChange(const char *name, const char *displayName, int type, + int startType, const char *path) + { + DBG_ENTER2("ServiceChange"); + + int exitCode = -1; + + SC_HANDLE serviceManager = NULL; + + SC_HANDLE service = NULL; + + char fullPath[MAX_PATH] = {0}; + + char *pathArg = NULL; + + // + // Check args. + // + + DEBUG3("ServiceChange : Checking args...\n"); + + SetLastError(ERROR_INVALID_PARAMETER); + + FAIL(name == NULL); + + DEBUG1("ServiceChange : Name : [%s]\n", name); + DEBUG1("ServiceChange : Display name : [%s]\n", displayName); + DEBUG1("ServiceChange : Type : [0x%x]\n", type); + DEBUG1("ServiceChange : Start type : [0x%x]\n", startType); + DEBUG1("ServiceChange : Path : [%s]\n", path); + + // + // Get absolute path to service binary if needed. + // + + if (path) + { + DEBUG3("ServiceChange : Retrieving absolute path to service binary...\n"); + + FAIL(ExpandRelativePath(fullPath, MAX_PATH, path)); + + pathArg = fullPath; + } + + // + // Open service and service manager. + // + + DEBUG3("ServiceChange : Opening service...\n"); + + FAIL(ServiceOpen(&serviceManager, &service, name, SERVICE_CHANGE_CONFIG)); + + // + // Change service parameters. + // + + DEBUG3("ServiceChange : Changing service parameters...\n"); + + FAIL(ChangeServiceConfig(service, type, startType, SERVICE_ERROR_IGNORE, + pathArg, NULL, NULL, NULL, NULL, NULL, + NULL) == FALSE); + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + int err = GetLastError(); + + Error("ERROR: Cannot change service parameters.\n" + "Error code is %d.\n", err); + + if (err != 0) + { + exitCode = err; + } + } + + CloseServiceHandle(serviceManager); + CloseServiceHandle(service); + + DBG_LEAVE2("ServiceChange"); + + return exitCode; + } + + // + // Stop and delete existing service. + // + // name - service name to delete (IN). + // quiet - do not write error messages if 1 (IN/OPT). + // + // RETURNS: 0 if OK. + // + + int ServiceDelete(const char *name, int quiet) + { + DBG_ENTER2("ServiceDelete"); + + int exitCode = -1; + + SC_HANDLE serviceManager = NULL; + + SC_HANDLE service = NULL; + + SERVICE_STATUS status; + + // + // Check args. + // + + DEBUG3("ServiceDelete : Checking args...\n"); + + FAIL(name == NULL); + + // + // If service does not exists simply exit with success. + // + + if (ServiceExists(name) == 0) + { + DEBUG1("ServiceDelete : Service '%s' already deleted.\n", name); + + exitCode = 0; + + goto fail; + } + + // + // Open service. + // + + DEBUG3("Opening service '%s'...\n", name); + + FAIL(ServiceOpen(&serviceManager, &service, name, + DELETE | SERVICE_STOP | SERVICE_QUERY_STATUS, quiet)); + + // + // Delete service. + // + + DEBUG3("Deleting service '%s'...\n", name); + + FAIL(DeleteService(service) == FALSE); + + // + // We unregistered service, but service's instance can still exists. + // We stop current running instance if exist. + // + + DEBUG3("Sending STOP to '%s' service...\n", name); + + if (ControlService(service, SERVICE_CONTROL_STOP, &status) == TRUE) + { + // + // Wait until service change state from + // STOP_PENDING to STOPPED. + // + + if (ServiceWaitUntilRunning(service, SERVICE_STOP_PENDING, + SERVICE_STOPPED, + SERVICE_RUN_TIMEOUT, 1)) + { + // + // Kill service process if timeout reached. + // + + ServiceKill(service, 1); + } + } + + DEBUG1("Service '%s' deleted.\n", name); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + int err = GetLastError(); + + if (quiet == 0) + { + Error("ERROR: Cannot delete service '%s'.\n" + "Error code is %d.\n", name, err); + } + + if (err != 0) + { + exitCode = err; + } + } + + CloseServiceHandle(serviceManager); + CloseServiceHandle(service); + + DBG_LEAVE2("ServiceDelete"); + + return exitCode; + } + + // + // Retrieve status of given service. + // + // status - buffer, where to store retrieved status (OUT). + // name - service name to query (IN). + // quiet - don't write log on errors if 1 (IN). + // + // RETURNS: 0 if OK. + // + + int ServiceGetStatus(SERVICE_STATUS *status, const char *name, int quiet) + { + DBG_ENTER2("ServiceGetStatus"); + + int exitCode = -1; + + SC_HANDLE serviceManager = NULL; + + SC_HANDLE service = NULL; + + // + // Check args. + // + + DEBUG3("ServiceGetStatus : Checking args...\n"); + + FAIL(name == NULL); + + FAIL(status == NULL); + + // + // Open service. + // + + DEBUG3("ServiceGetStatus : Opening service...\n"); + + FAIL(ServiceOpen(&serviceManager, &service, name, + SERVICE_QUERY_STATUS, quiet)); + + // + // Retrieve status. + // + + DEBUG3("ServiceGetStatus : Retrieving status of service...\n"); + + FAIL(QueryServiceStatus(service, status) == FALSE); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + int err = GetLastError(); + + if (quiet == 0) + { + Error("ERROR: Cannot retrieve status for service '%s'.\n" + "Error code is %d.\n", name, err); + } + + if (err != 0) + { + exitCode = err; + } + } + + CloseServiceHandle(serviceManager); + CloseServiceHandle(service); + + DBG_LEAVE2("ServiceGetStatus"); + + return exitCode; + } + + // + // Start service. + // + // name - name of service to start (IN). + // argc - number of elements in argv table (IN). + // argv - table with input arguments for service binary (IN). + // + // RETURNS: 0 if OK. + // + + int ServiceStart(const char *name, int argc, const char **argv) + { + DBG_ENTER2("ServiceStart"); + + int exitCode = -1; + + SC_HANDLE serviceManager = NULL; + + SC_HANDLE service = NULL; + + // + // Check args. + // + + DEBUG3("ServiceStart : Checking args...\n"); + + FAIL(name == NULL); + + // + // Open service. + // + + DEBUG3("ServiceStart : Opening service...\n"); + + FAIL(ServiceOpen(&serviceManager, &service, name, + SERVICE_START | SERVICE_QUERY_STATUS)); + + // + // Start service. + // + + DEBUG3("ServiceStart : Retrieving status of service...\n"); + + FAIL(StartService(service, argc, argv) == FALSE); + + // + // Wait until service change state from SERVICE_START_PENDING + // to SERVICE_RUNNING. + // + + ServiceWaitUntilRunning(service, SERVICE_START_PENDING, + SERVICE_RUNNING, SERVICE_RUN_TIMEOUT, 1); + + DEBUG1("Service '%s' started.\n", name); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + int err = GetLastError(); + + Error("ERROR: Cannot start service '%s'.\n" + "Error code is %d.\n", name, err); + + if (err != 0) + { + exitCode = err; + } + } + + CloseServiceHandle(serviceManager); + CloseServiceHandle(service); + + DBG_LEAVE2("ServiceStart"); + + return exitCode; + } + + // + // Send stop signal to given service and optionally + // wait until service reach stopped. + // + // name - name of service to stop (IN). + // timeout - maximum time in ms to wait. If service not stopped before + // we kill it manually (IN/OPT). + // + // RETURNS: 0 if OK. + // + + int ServiceStop(const char *name, int timeout) + { + DBG_ENTER2("ServiceStop"); + + int exitCode = -1; + + SC_HANDLE serviceManager = NULL; + + SC_HANDLE service = NULL; + + SERVICE_STATUS status; + + // + // Check args. + // + + DEBUG3("ServiceStop : Checking args...\n"); + + FAIL(name == NULL); + + // + // Open service. + // + + DEBUG3("ServiceStop : Opening service...\n"); + + FAIL(ServiceOpen(&serviceManager, &service, name, + SERVICE_STOP | SERVICE_QUERY_STATUS)); + + // + // Send stop control code to service. + // + + DEBUG3("ServiceStop : Sending STOP to service...\n"); + + if (ControlService(service, SERVICE_CONTROL_STOP, &status) == FALSE) + { + Error("WARNING: Cannot send STOP signal to service.\n" + "Error code is : %d.\n", (int) GetLastError()); + } + + // + // Wait until service change state from SERVICE_STOP_PENDING + // to SERVICE_STOPPED. + // + + if (ServiceWaitUntilRunning(service, SERVICE_STOP_PENDING, + SERVICE_STOPPED, timeout, 1)) + { + // + // If service doen't response on STOP signal silently + // kill it's process. + // + + ServiceKill(service, 1); + } + + DEBUG1("Service '%s' stopped.\n", name); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + int err = GetLastError(); + + Error("ERROR: Cannot stop service '%s'.\n" + "Error code is %d.\n", name, err); + + if (err != 0) + { + exitCode = err; + } + } + + CloseServiceHandle(serviceManager); + CloseServiceHandle(service); + + DBG_LEAVE2("ServiceStop"); + + return exitCode; + } + + // + // Retrieve config of given service. + // + // WARNING: Output config buffer MUST be free by caller. + // + // config - pointer to new allocated config struct (OUT). + // name - service name to query (IN). + // quiet - don't write log on errors if 1 (IN). + // + // RETURNS: 0 if OK. + // + + int ServiceGetConfig(QUERY_SERVICE_CONFIG **config, const char *name, int quiet) + { + DBG_ENTER2("ServiceGetConfig"); + + int exitCode = -1; + + SC_HANDLE serviceManager = NULL; + + SC_HANDLE service = NULL; + + DWORD configSize = 0; + + // + // Check args. + // + + DEBUG3("ServiceGetConfig : Checking args...\n"); + + FAIL(name == NULL); + + FAIL(config == NULL); + + *config = NULL; + + // + // Open service. + // + + DEBUG3("ServiceGetConfig : Opening service...\n"); + + FAIL(ServiceOpen(&serviceManager, &service, name, + SERVICE_QUERY_CONFIG, quiet)); + + // + // Retrieve status. + // + + DEBUG3("ServiceGetConfig : Retrieving config of service...\n"); + + QueryServiceConfig(service, NULL, 0, &configSize); + + *config = (QUERY_SERVICE_CONFIG *) malloc(configSize); + + FAIL(QueryServiceConfig(service, *config, configSize, &configSize) == FALSE); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + int err = GetLastError(); + + if (quiet == 0) + { + Error("ERROR: Cannot retrieve config for service '%s'.\n" + "Error code is %d.\n", name, err); + } + + if (config && *config) + { + free(*config); + } + + if (err != 0) + { + exitCode = err; + } + } + + CloseServiceHandle(serviceManager); + CloseServiceHandle(service); + + DBG_LEAVE2("ServiceGetConfig"); + + return exitCode; + } + + // + // Check does service already exists. + // + // name - short name of service (IN) + // + // RETURNS: 1 if exists, + // 0 if not exists or error. + // + + int ServiceExists(const char *name) + { + SERVICE_STATUS status; + + if (ServiceGetStatus(&status, name, 1) == 0) + { + SetLastError(ERROR_ALREADY_EXISTS); + + DEBUG3("Service '%s' exists.\n", name); + + return 1; + } + else + { + SetLastError(ERROR_FILE_NOT_FOUND); + + DEBUG3("Service '%s' does not exist.\n", name); + + return 0; + } + } + + // + // Wait up to ms until given service change state from + // to state. + // We use it to wait until start/stop operations finished. + // + // WARNING: Input handle MUST have SERVICE_QUERY_STATUS right. + // + // service - handle to opened service (IN). + // targetState - expected state, when reached we quit with success (IN). + // timeout - maximum time limit in ms. If missed default one used. (IN/OPT). + // quiet - do not write errors on stderr if 1 (IN/OPT). + // + // RETURNS: 0 if service is running on function's exit. + // + + int ServiceWaitUntilRunning(SC_HANDLE service, DWORD initState, + DWORD targetState, int timeout, int quiet) + { + DBG_ENTER2("ServiceWaitUntilRunning"); + + SERVICE_STATUS status = {0}; + + int exitCode = -1; + + int stateReached = 0; + + // + // Wait until service change state. + // + + DEBUG3("ServiceWaitUntilRunning : Waiting until service state changed from [%d] to [%d]...\n", + initState, targetState); + + while(stateReached == 0 && timeout > 0) + { + // + // Get current service state. + // + + FAIL(QueryServiceStatus(service, &status) == FALSE); + + // + // If target state reached go out with success. + // + + if (status.dwCurrentState == targetState) + { + DEBUG2("ServiceWaitUntilRunning : Service reached state [%d]. Going to finish.\n", targetState); + + stateReached = 1; + } + + // + // If service is still in , keep waiting until timeout left. + // + + else if (status.dwCurrentState == initState) + { + DEBUG3("ServiceWaitUntilRunning : Service is still in [%d] state...\n", initState); + + Sleep(500); + + timeout -= 500; + } + + // + // Unexpected state. Probably error on service side. + // + + else + { + FAILEX(1, "ERROR: Unexpected service state [%d] reached.\n", + (int) status.dwCurrentState); + } + } + + // + // If still in , it means probably + // hung-up in service code. + // + + SetLastError(ERROR_SERVICE_REQUEST_TIMEOUT); + + FAIL(stateReached == 0); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + if (quiet) + { + DEBUG1("WARNING: Service doesn't response.\n" + "Error code is : %d.\n", GetLastError()); + } + else + { + Error("ERROR: Service doesn't response.\n" + "Error code is : %d.\n", (int) GetLastError()); + } + } + + DBG_LEAVE2("ServiceWaitUntilRunning"); + + return exitCode; + } + + // + // Retrieve PID for opened process and terminate it. + // + // WARNING: Handle MUSTS have SERVICE_QUERY_STATE right. + // WARNING: Caller user MUSTS have SE_DEBUG right to open not-own processes. + // + // service - handle to opened service (IN). + // quiet - do not write errors on stderr if 1 (IN/OPT). + // + // RETURNS: 0 if OK. + // + + int ServiceKill(SC_HANDLE service, int quiet) + { + DBG_ENTER2("ServiceKill"); + + int exitCode = -1; + + SERVICE_STATUS_PROCESS sp; + + DWORD spSize = 0; + + HANDLE process = NULL; + + // + // Get PID of given service. + // + + DEBUG3("ServiceKill : Retrieving service's PID...\n"); + + FAIL(QueryServiceStatusEx(service, SC_STATUS_PROCESS_INFO, + (PBYTE) &sp, sizeof(sp), &spSize) == FALSE); + + // + // Enable SE_DEBUG to open not-own process. + // This step needs caller user with SE_DEBUG privilege. + // + + DEBUG3("ServiceKill : Enabling SE_DEBUG privilege...\n"); + + FAIL(SetPrivilege("SeDebugPrivilege", 1)); + + // + // Open service process. + // + + DEBUG3("ServiceKill : Opening service process [%d]...\n", (int) sp.dwProcessId); + + process = OpenProcess(PROCESS_TERMINATE, FALSE, sp.dwProcessId); + + FAIL(process == NULL); + + // + // Terminate process. + // + + DEBUG3("ServiceKill : Terminating service process [%d]...\n", (int) sp.dwProcessId); + + FAIL(TerminateProcess(process, -1) == FALSE); + + DEBUG1("Service process PID #%d terminated.\n", (int) sp.dwProcessId); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + if (quiet) + { + DBG_MSG("WARNING: Cannot terminate service process.\n" + "Error code is : %d.\n", (int) GetLastError()); + } + else + { + Error("WARNING: Cannot terminate service process.\n" + "Error code is : %d.\n", (int) GetLastError()); + } + } + + SetPrivilege("SeDebugPrivilege", 0); + + DBG_LEAVE2("ServiceKill"); + + return exitCode; + } + + // + // Retrieve PID of service process. + // + // name - service name (IN). + // + // RETURNS: PID of service process, + // or -1 if error. + // + + int ServiceGetPid(const char *name) + { + DBG_ENTER3("ServiceGetPid"); + + int exitCode = -1; + + SC_HANDLE serviceManager = NULL; + SC_HANDLE service = NULL; + + SERVICE_STATUS_PROCESS sp = {0}; + + DWORD spSize = 0; + + // + // Open service. + // + + FAIL(ServiceOpen(&serviceManager, &service, name, + DELETE | SERVICE_STOP | SERVICE_QUERY_STATUS)); + + // + // Query for service process information. + // + + FAIL(QueryServiceStatusEx(service, SC_STATUS_PROCESS_INFO, + (PBYTE) &sp, sizeof(sp), &spSize) == FALSE); + + exitCode = sp.dwProcessId; + + DEBUG2("Service '%s' has PID #%d.\n", name, int(sp.dwProcessId)); + + // + // Clean up. + // + + fail: + + if (exitCode == -1) + { + Error("ERROR: Cannot retrieve PID for service '%s'.\n" + "Error code is : %d.\n", name, GetLastError()); + } + + CloseServiceHandle(serviceManager); + CloseServiceHandle(service); + + DBG_LEAVE3("ServiceGetPid"); + + return exitCode; + } + +} /* namespace Tegenaria */ + +#endif /* WIN32 */ diff --git a/Source/Core/LibService/Service.h b/Source/Core/LibService/Service.h new file mode 100644 index 0000000..3a4c766 --- /dev/null +++ b/Source/Core/LibService/Service.h @@ -0,0 +1,105 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Service_H +#define Tegenaria_Core_Service_H + +#ifdef WIN32 + +// +// Includes. +// + +#include +#include + +namespace Tegenaria +{ + // + // Defines. + // + + // + // Timeout for waiting until service init itself + // after ServiceAdd. + // + // + + #define SERVICE_RUN_TIMEOUT 10000 + + // + // Structures. + // + + struct StringIntPair + { + const char *string_; + + const int code_; + }; + + // + // Exported functions. + // + + int ServiceGetTypeCode(const char *serviceType); + int ServiceGetStartTypeCode(const char *startType); + + int ServiceOpen(SC_HANDLE *serviceManager, SC_HANDLE *service, + const char *name, DWORD rights, int quiet = 0); + + int ServiceAdd(const char *name, const char *displayName, int type, + int startType, const char *path, bool failIfExists = true, + const char *obj = NULL, const char *pass = NULL, + int startAfter = 1, int quiet = 0); + + int ServiceChange(const char *name, const char *displayName, int type, + int startType, const char *path); + + int ServiceDelete(const char *name, int quiet = 0); + int ServiceStart(const char *name, int argc = 0, const char **argv = NULL); + int ServiceStop(const char *name, int timeout = SERVICE_RUN_TIMEOUT); + + int ServiceGetStatus(SERVICE_STATUS *status, + const char *name, int quiet = 0); + + int ServiceGetConfig(QUERY_SERVICE_CONFIG **config, + const char *name, int quiet = 0); + + int ServiceGetPid(const char *name); + + int ServiceExists(const char *name); + + int ServiceWaitUntilRunning(SC_HANDLE service, DWORD initState, + DWORD targetState, + int timeout = SERVICE_RUN_TIMEOUT, + int quiet = 0); + + int ServiceKill(SC_HANDLE service, int quiet = 0); + +} /* namespace Tegenaria */ + +#endif /* WIN32 */ + +#endif /* Tegenaria_Core_Service_H */ diff --git a/Source/Core/LibService/Utils.cpp b/Source/Core/LibService/Utils.cpp new file mode 100644 index 0000000..2332887 --- /dev/null +++ b/Source/Core/LibService/Utils.cpp @@ -0,0 +1,214 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#define WINVER 0x501 + +#include "Utils.h" + +namespace Tegenaria +{ + // Transform relative (to where dlsetup stored) path into full path. + // E.g. it transforms "/somedir" into "/somedir". + // + // WARNING: If passed path is already absolute it returns the same string. + // + // normPath - full, generated path (OUT). + // pathSize - size of path buffer in bytes (IN). + // relative - relative path postfix to add to base path (IN). + // quiet - do not write logs if set to 1 (IN). + // + // RETURNS: 0 if OK. + // + + int ExpandRelativePath(char *normPath, int pathSize, const char *relative, int quiet) + { + DBG_ENTER2("ExpandRelativePath"); + + int exitCode = -1; + + int lastSlash = 0; + + char *path = (char *) malloc(pathSize); + + FAILEX(path == NULL, "ERROR: Out of memory.\n"); + + // + // Check is it already absolute? + // + + if (relative && relative[0] && relative[1] == ':') + { + DEBUG1("Path [%s] is already absolute.\n", relative); + + strncpy(path, relative, pathSize); + } + else + { + DEBUG3("Expanding path [%s]...\n", relative); + + // + // Get full path to nxdevice.exe binary. + // + + FAIL(GetModuleFileName(NULL, path, pathSize) == FALSE); + + // + // Remove filename from path. + // + + for (int i = 0; path[i] && i < pathSize; i++) + { + if (path[i] == '\\' || path[i] == '/') + { + lastSlash = i; + } + } + + path[lastSlash] = 0; + + // + // Add relative postfix if any. + // + + if (relative) + { + strncat(path, "\\", pathSize); + strncat(path, relative, pathSize); + } + } + + // + // Normalize path for output (e.g. remove '..' entries). + // + + for (int i = 0; path[i]; i++) + { + if (path[i] == '/') + { + path[i] = '\\'; + } + } + + PathCanonicalize(normPath, path); + + exitCode = 0; + + DEBUG1("Path [%s] expanded to [%s].\n", relative, normPath); + + // + // Error handler. + // + + fail: + + if (exitCode) + { + int err = GetLastError(); + + Error("ERROR: Cannot retrieve path of binary.\n" + "Error code is : %d.\n", err); + + if (err != 0) + { + exitCode = err; + } + } + + if (path != NULL) + { + free(path); + } + + DBG_LEAVE2("ExpandRelativePath"); + + return exitCode; + } + + // + // Enable or disable privilege for current running process + // + // privName - privilege name (IN) + // enabled - 1 for enabling, 0 for disabling (IN) + // + // RETURNS: 0 if OK. + // + + int SetPrivilege(const char *privName, int enabled) + { + TOKEN_PRIVILEGES tp; + + HANDLE hProcToken = NULL; + + LUID luid; + + int exitCode = 1; + + // + // Retrievie LUID from privilege name + // + + FAIL(LookupPrivilegeValue(NULL, privName, &luid) == FALSE); + + // + // Retrievie token for current running process + // + + FAIL(OpenProcessToken(GetCurrentProcess(), + TOKEN_ADJUST_PRIVILEGES, &hProcToken) == FALSE); + + // + // Adjust privilege to current running process + // + + tp.PrivilegeCount = 1; + tp.Privileges[0].Luid = luid; + tp.Privileges[0].Attributes = enabled ? SE_PRIVILEGE_ENABLED : 0; + + FAIL(AdjustTokenPrivileges(hProcToken, FALSE, &tp, + sizeof(TOKEN_PRIVILEGES), NULL, NULL) == FALSE); + + exitCode = 0; + + fail: + + // + // Free allocated memory if needed. + // + + if (hProcToken) + { + CloseHandle(hProcToken); + } + + if (exitCode) + { + DWORD err = GetLastError(); + + Error("ERROR. Cannot enable privilege" + " to current process (%d).", (int) err); + } + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibService/Utils.h b/Source/Core/LibService/Utils.h new file mode 100644 index 0000000..44b2e9c --- /dev/null +++ b/Source/Core/LibService/Utils.h @@ -0,0 +1,55 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Service_Utils_H +#define Tegenaria_Core_Service_Utils_H + +// +// Includes. +// + +#include + +#ifdef WIN32 +# include +# include +# include +# include +# include +#endif + +namespace Tegenaria +{ + // + // Exported functions. + // + + int ExpandRelativePath(char *normPath, int pathSize, + const char *relative, int quiet = 0); + + int SetPrivilege(const char *privName, int enabled); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Service_Utils_H */ diff --git a/Source/Core/LibService/qcbuild.src b/Source/Core/LibService/qcbuild.src new file mode 100644 index 0000000..07727c5 --- /dev/null +++ b/Source/Core/LibService/qcbuild.src @@ -0,0 +1,42 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibService + +AUTHOR = Sylwester Wysocki +PURPOSE = High level API to manage windows services. + +# +# Windows only. +# + +.section MinGW + INC_DIR = Tegenaria + ISRC = Service.h + CXXSRC = Service.cpp Utils.cpp + + DEPENDS = LibDebug + LIBS = -ldebug +.endsection diff --git a/Source/Core/LibStr/Binary.cpp b/Source/Core/LibStr/Binary.cpp new file mode 100644 index 0000000..1e7aa27 --- /dev/null +++ b/Source/Core/LibStr/Binary.cpp @@ -0,0 +1,396 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Edit raw byte buffers stored in pure C-style buffer i.e. +// {buf, len} pair. +// + +#include "Str.h" + +namespace Tegenaria +{ + // + // ---------------------------------------------------------------------------- + // + // Pop data from C-style {buf, len} buffer + // All below functions do NOT destroy input buffer. + // + // ---------------------------------------------------------------------------- + // + + // + // Pop bytes from begin of buffer. + // + // raw - buffer, where to write popped data (OUT). + // rawSize - how much bytes to pop (IN). + // it - pointer inside raw buffer, where to read data from (IN/OUT). + // bytesLeft - number of bytes left in buffer (IN/OUT). + // + // RETURNS: 0 if all bytes popped, + // -1 if error. + // + + int StrPopRaw(void *raw, int rawSize, char **it, int *bytesLeft) + { + DBG_ENTER3("StrPopRaw"); + + int exitCode = -1; + + // + // Check args. + // + + FAILEX(it == NULL, "ERROR: 'it' cannot be NULL in StrPopRaw."); + FAILEX(*it == NULL, "ERROR: '*it' cannot be NULL in StrPopRaw."); + FAILEX(raw == NULL, "ERROR: 'raw' cannot be NULL in StrPopRaw."); + FAILEX(bytesLeft == NULL, "ERROR: 'bytesLeft' cannot be NULL in StrPopRaw."); + FAILEX(rawSize > *bytesLeft, "ERROR: Buffer too small in StrPopRaw."); + + // + // Pop raw bytes from buffer. + // + + memcpy(raw, *it, rawSize); + + DEBUG3("StrPopRaw : Popped [%d] bytes from buffer.\n", rawSize); + + // + // Move pointer by rawSize bytes. + // + + (*it) += rawSize; + + (*bytesLeft) -= rawSize; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPopRaw"); + + return exitCode; + } + + // + // Pop QWORD from begin of string. + // + // value - buffer, where to write popped QWORD (OUT). + // it - pointer inside raw buffer, where to read data from (IN/OUT). + // bytesLeft - number of bytes left in buffer (IN/OUT). + // flags - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN). + // + // RETURNS: 0 if all 8 bytes popped, + // -1 if error. + // + + int StrPopQword(uint64_t *value, char **it, int *bytesLeft, int flags) + { + DBG_ENTER3("StrPopQword"); + + int exitCode = -1; + + // + // Check args. + // + + FAILEX(it == NULL, "ERROR: 'it' cannot be NULL in StrPopQword."); + FAILEX(*it == NULL, "ERROR: '*it' cannot be NULL in StrPopQword."); + FAILEX(value == NULL, "ERROR: Null pointer passed to StrPopQword."); + FAILEX(bytesLeft == NULL, "ERROR: 'bytesLeft' cannot be NULL in StrPopQword."); + FAILEX(*bytesLeft < 8, "ERROR: Buffer too small in StrPopQword."); + + // + // Pop big endian qword (motorola 68k like). + // + + if (flags & STR_BIG_ENDIAN) + { + uint8_t *dst = (uint8_t *) value; + uint8_t *src = (uint8_t *) *it; + + dst[0] = src[7]; + dst[1] = src[6]; + dst[2] = src[5]; + dst[3] = src[4]; + dst[4] = src[3]; + dst[5] = src[2]; + dst[6] = src[1]; + dst[7] = src[0]; + + DEBUG3("StrPopQword : Popped big endian [0x%"PRIx64"].\n", *value); + } + + // + // Pop little endian dword (intel 86 like). + // + + else + { + *value = *(uint64_t *)(*it); + + DEBUG3("StrPopQword : Popped little endian [0x%"PRIx64"].\n", *value); + } + + // + // Move pointer 8 bytes. + // + + (*it) += 8; + + (*bytesLeft) -= 8; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPopQword"); + + return exitCode; + } + + // + // Pop DWORD from begin of string. + // + // value - buffer, where to write popped DWORD (OUT). + // it - pointer inside raw buffer, where to read data from (IN/OUT). + // bytesLeft - number of bytes left in buffer (IN/OUT). + // flags - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN). + // + // RETURNS: 0 if all 4 bytes popped, + // -1 if error. + // + + int StrPopDword(uint32_t *value, char **it, int *bytesLeft, int flags) + { + DBG_ENTER3("StrPopDword"); + + int exitCode = -1; + + // + // Check args. + // + + FAILEX(it == NULL, "ERROR: 'it' cannot be NULL in StrPopDword."); + FAILEX(*it == NULL, "ERROR: '*it' cannot be NULL in StrPopDword."); + FAILEX(bytesLeft == NULL, "ERROR: 'bytesLeft' cannot be NULL in StrPopDword."); + FAILEX(value == NULL, "ERROR: Null pointer passed to StrPopDword."); + FAILEX(*bytesLeft < 4, "ERROR: Buffer too small in StrPopDword."); + + // + // Pop big endian dword (motorola 68k like). + // + + if (flags & STR_BIG_ENDIAN) + { + uint8_t *dst = (uint8_t *) value; + uint8_t *src = (uint8_t *) *it; + + dst[0] = src[3]; + dst[1] = src[2]; + dst[2] = src[1]; + dst[3] = src[0]; + + DEBUG3("StrPopDword : Popped big endian [0x%x].\n", *value); + } + + // + // Pop little endian dword (intel 86 like). + // + + else + { + *value = *(uint32_t *)(*it); + + DEBUG3("StrPopDword : Popped little endian [0x%x].\n", *value); + } + + // + // Move pointer 4 bytes. + // + + (*it) += 4; + + (*bytesLeft) -= 4; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPopDword"); + + return exitCode; + } + + // + // Pop one byte from begin of string. + // + // value - buffer, where to write popped byte (OUT). + // it - pointer inside raw buffer, where to read data from (IN/OUT). + // bytesLeft - number of bytes left in buffer (IN/OUT). + // + // RETURNS: 0 if byte popped, + // -1 if error. + // + + int StrPopByte(uint8_t *value, char **it, int *bytesLeft) + { + DBG_ENTER3("StrPopByte"); + + int exitCode = -1; + + // + // Check args. + // + + FAILEX(it == NULL, "ERROR: 'it' cannot be NULL in StrPopDword."); + FAILEX(*it == NULL, "ERROR: '*it' cannot be NULL in StrPopDword."); + FAILEX(bytesLeft == NULL, "ERROR: 'bytseLeft' cannot be NULL in StrPopDword."); + FAILEX(value == NULL, "ERROR: 'value' cannot be NULL in StrPopDword."); + FAILEX(*bytesLeft < 1, "ERROR: Buffer too small in StrPopDword."); + + // + // Pop byte from buffer. + // + + *value = **it; + + DEBUG3("StrPopByte : Popped byte [0x%x].\n", *value); + + // + // Move pointer one byte. + // + + (*it) ++; + + (*bytesLeft) --; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPopByte"); + + return exitCode; + } + + // + // Pop C string from buffer. + // + // str - pointer to begin of string (OUT). + // len - length of string in bytes, can be NULL if not needed (OUT/OPT). + // it - pointer inside raw buffer, where to read data from (IN/OUT). + // bytesLeft - number of bytes left in buffer (IN/OUT). + // + // RETURNS: 0 if byte popped, + // -1 if error. + // + + int StrPopString(const char **str, int *strLen, char **it, int *bytesLeft) + { + DBG_ENTER3("StrPopString"); + + int exitCode = -1; + + uint32_t len = 0; + + // + // Check args. + // + + FAILEX(str == NULL, "ERROR: 'str' cannot be NULL in StrPopString.\n"); + + // + // Pop size header. + // + + *str = ""; + + FAIL(StrPopDword(&len, it, bytesLeft)); + + DEBUG3("StrPopString : Popped length [%d].\n", len); + + FAILEX(*bytesLeft < len, "ERROR: Buffer too small in StrPopString.\n"); + + // + // Move pointer by bytes. + // + + *str = *it; + + (*it) += len; + + (*bytesLeft) -= len; + + // + // Make sure there is zero terminator at the end of string. + // + + if (len > 0) + { + (*it)[-1] = 0; + } + else + { + *str = ""; + } + + // + // Give length to user if needed. + // + + if (strLen) + { + *strLen = len; + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPopString"); + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/BinaryString.cpp b/Source/Core/LibStr/BinaryString.cpp new file mode 100644 index 0000000..ab62996 --- /dev/null +++ b/Source/Core/LibStr/BinaryString.cpp @@ -0,0 +1,565 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Edit raw byte buffers stored in string containter. +// + +#include "Str.h" + +namespace Tegenaria +{ + // + // ---------------------------------------------------------------------------- + // + // Pop data from std::string buffer + // + // ---------------------------------------------------------------------------- + // + + // + // Pop bytes from begin of string. + // + // Buffer before: xx xx xx xx xx xx ... yy yy yy yy + // Buffer after : ... yy yy yy yy + // + // raw - buffer, where to write popped data (OUT). + // rawSize - how much bytes to pop (IN). + // string - buffer from pop data (IN/OUT). + // + // RETURNS: 0 if all bytes popped, + // -1 if error. + // + + int StrPopRaw(void *raw, int rawSize, string &buf) + { + DBG_ENTER3("StrPopRaw"); + + int exitCode = -1; + + int bufSize = buf.size(); + + // + // Check args. + // + + FAILEX(raw == NULL, "ERROR: Null pointer passed to StrPopRaw."); + FAILEX(rawSize > bufSize, "ERROR: Buffer too small in StrPopRaw."); + + // + // Pop raw bytes from buffer. + // + + memcpy(raw, &buf[0], rawSize); + + DEBUG3("StrPopRaw : Popped [%d] bytes from buffer.\n", rawSize); + + // + // FIXME: Don't copy. + // + + memcpy(&buf[0], &buf[rawSize], bufSize - rawSize); + + buf.resize(bufSize - rawSize); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPopRaw"); + + return exitCode; + } + + // + // Pop QWORD from begin of string. + // + // Buffer before: 01 02 03 04 05 06 07 08 xx xx xx xx + // Buffer after : xx xx xx xx + // + // value - buffer, where to write popped QWORD (OUT). + // string - buffer from pop data (IN/OUT). + // flags - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN). + // + // RETURNS: 0 if all 8 bytes popped, + // -1 if error. + // + + int StrPopQword(uint64_t *value, string &buf, int flags) + { + DBG_ENTER3("StrPopQword"); + + int exitCode = -1; + + int bufSize = buf.size(); + + // + // Check args. + // + + FAILEX(value == NULL, "ERROR: Null pointer passed to StrPopQword."); + FAILEX(bufSize < 8, "ERROR: Buffer too small in StrPopQword."); + + // + // Pop big endian qword (motorola 68k like). + // + + if (flags & STR_BIG_ENDIAN) + { + uint8_t *dst = (uint8_t *) value; + uint8_t *src = (uint8_t *) &buf[0]; + + dst[0] = src[7]; + dst[1] = src[6]; + dst[2] = src[5]; + dst[3] = src[4]; + dst[4] = src[3]; + dst[5] = src[2]; + dst[6] = src[1]; + dst[7] = src[0]; + + DEBUG3("StrPopQword : Popped big endian [0x%"PRIx64"].\n", *value); + } + + // + // Pop little endian dword (intel 86 like). + // + + else + { + *value = *(uint64_t *)(&buf[0]); + + DEBUG3("StrPopQword : Popped little endian [0x%"PRIx64"].\n", *value); + } + + // + // FIXME: Don't copy. + // + + bufSize -= 8; + + if (bufSize > 0) + { + memcpy(&buf[0], &buf[8], bufSize); + } + + buf.resize(bufSize); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPopQword"); + + return exitCode; + } + + // + // Pop DWORD from begin of string. + // + // Buffer before: 01 02 03 04 xx xx xx xx + // Buffer after : xx xx xx xx + // + // value - buffer, where to write popped DWORD (OUT). + // string - buffer from pop data (IN/OUT). + // flags - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN). + // + // RETURNS: 0 if all 4 bytes popped, + // -1 if error. + // + + int StrPopDword(uint32_t *value, string &buf, int flags) + { + DBG_ENTER3("StrPopDword"); + + int exitCode = -1; + + int bufSize = buf.size(); + + // + // Check args. + // + + FAILEX(value == NULL, "ERROR: Null pointer passed to StrPopDword."); + FAILEX(bufSize < 4, "ERROR: Buffer too small in StrPopDword."); + + // + // Pop big endian dword (motorola 68k like). + // + + if (flags & STR_BIG_ENDIAN) + { + uint8_t *dst = (uint8_t *) value; + uint8_t *src = (uint8_t *) &buf[0]; + + dst[0] = src[3]; + dst[1] = src[2]; + dst[2] = src[1]; + dst[3] = src[0]; + + DEBUG3("StrPopDword : Popped big endian [0x%x].\n", *value); + } + + // + // Pop little endian dword (intel 86 like). + // + + else + { + *value = *(uint32_t *)(&buf[0]); + + DEBUG3("StrPopDword : Popped little endian [0x%x].\n", *value); + } + + // + // FIXME: Don't copy. + // + + bufSize -= 4; + + if (bufSize > 0) + { + memcpy(&buf[0], &buf[4], bufSize); + } + + buf.resize(bufSize); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPopDword"); + + return exitCode; + } + + // + // Pop one byte from begin of string. + // + // Buffer before: 01 xx xx xx xx + // Buffer after : xx xx xx xx + // + // value - buffer, where to write popped byte (OUT). + // string - buffer from pop data (IN/OUT). + // + // RETURNS: 0 if byte popped, + // -1 if error. + // + + int StrPopByte(uint8_t *value, string &buf) + { + DBG_ENTER3("StrPopByte"); + + int exitCode = -1; + + int bufSize = buf.size(); + + // + // Check args. + // + + FAILEX(value == NULL, "ERROR: Null pointer passed to StrPopDword."); + FAILEX(bufSize < 1, "ERROR: Buffer too small in StrPopDword."); + + // + // Pop byte from buffer. + // + + *value = buf[0]; + + DEBUG3("StrPopByte : Popped byte [0x%x].\n", *value); + + // + // FIXME: Don't copy. + // + + bufSize --; + + if (bufSize > 0) + { + memcpy(&buf[0], &buf[1], bufSize); + } + + buf.resize(bufSize); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPopByte"); + + return exitCode; + } + + // + // ---------------------------------------------------------------------------- + // + // Push data to std::string buffer + // + // ---------------------------------------------------------------------------- + // + + // + // Append buffer to the end of string. + // + // Buffer before: xx xx xx xx + // Buffer after : xx xx xx xx yy yy yy yy yy ... + // + // buf - buffer, where to append data (IN/OUT). + // rawSize - how much bytes to append (IN). + // raw - source buffer with data to append (IN). + // + // RETURNS: 0 if all data appended, + // -1 if error. + // + + int StrPushRaw(string &buf, const void *raw, int rawSize) + { + DBG_ENTER3("StrPushRaw"); + + int exitCode = -1; + + int bufSize = buf.size(); + + if (rawSize > 0) + { + // + // Check args. + // + + FAILEX(raw == NULL, "ERROR: Null pointer passed to StrPushRaw."); + + // + // Pop raw bytes from buffer. + // + + buf.resize(bufSize + rawSize); + + memcpy(&buf[bufSize], raw, rawSize); + + DEBUG3("StrPushRaw : Pushed [%d] bytes from buffer.\n", rawSize); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPushRaw"); + + return exitCode; + } + + // + // Append QWORD value to the end of string. + // + // Buffer before: xx xx xx xx + // Buffer after : xx xx xx xx 01 02 03 04 05 06 07 08 + // + // buf - buffer, where to append data (IN/OUT). + // value - QWORD value to append (IN). + // flags - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN). + // + // RETURNS: 0 if all data appended, + // -1 if error. + // + + int StrPushQword(string &buf, uint64_t value, int flags) + { + DBG_ENTER3("StrPushQword"); + + int bufSize = buf.size(); + + // + // Push big endian qword (motorola 68k like). + // + + buf.resize(bufSize + 8); + + if (flags & STR_BIG_ENDIAN) + { + uint8_t *dst = (uint8_t *) &buf[bufSize]; + uint8_t *src = (uint8_t *) &value; + + dst[0] = src[7]; + dst[1] = src[6]; + dst[2] = src[5]; + dst[3] = src[4]; + dst[4] = src[3]; + dst[5] = src[2]; + dst[6] = src[1]; + dst[7] = src[0]; + + DEBUG3("StrPushQword : Pushed big endian [0x%"PRIx64"].\n", value); + } + + // + // Pop little endian qword (intel 86 like). + // + + else + { + *(uint64_t *)(&buf[bufSize]) = value; + + DEBUG3("StrPushQword : Pushed little endian [0x%"PRIx64"].\n", value); + } + + DBG_LEAVE3("StrPushQword"); + + return 0; + } + + // + // Append DWORD value to the end of string. + // + // Buffer before: xx xx xx xx + // Buffer after : xx xx xx xx 01 02 03 04 + // + // buf - buffer, where to append data (IN/OUT). + // value - DWORD value to append (IN). + // flags - set to STR_BIG_ENDIAN or STR_LITTLE_ENDIAN (IN). + // + // RETURNS: 0 if all data appended, + // -1 if error. + // + + int StrPushDword(string &buf, uint32_t value, int flags) + { + DBG_ENTER3("StrPushDword"); + + int bufSize = buf.size(); + + // + // Push big endian dword (motorola 68k like). + // + + buf.resize(bufSize + 4); + + if (flags & STR_BIG_ENDIAN) + { + uint8_t *dst = (uint8_t *) &buf[bufSize]; + uint8_t *src = (uint8_t *) &value; + + dst[0] = src[3]; + dst[1] = src[2]; + dst[2] = src[1]; + dst[3] = src[0]; + + DEBUG3("StrPushDword : Pushed big endian [0x%x].\n", value); + } + + // + // Pop little endian dword (intel 86 like). + // + + else + { + *(uint32_t *)(&buf[bufSize]) = value; + + DEBUG3("StrPushDword : Pushed little endian [0x%x].\n", value); + } + + DBG_LEAVE3("StrPushDword"); + + return 0; + } + + // + // Append one byte to the end of string. + // + // Buffer before: xx xx xx xx + // Buffer after : xx xx xx xx 01 + // + // buf - buffer, where to append data (IN/OUT). + // value - byte to append (IN). + // + // RETURNS: 0 if byte appended, + // -1 if error. + // + + int StrPushByte(string &buf, uint8_t value) + { + DBG_ENTER3("StrPushByte"); + + buf.push_back(value); + + DEBUG3("StrPushByte : Pushed byte [0x%x].\n", value); + + DBG_LEAVE3("StrPushByte"); + + return 0; + } + + // + // Append string to the end of string buffer. + // + // Buffer before: xx xx xx xx + // Buffer after : xx xx xx xx ll ll ll ll ss ss ss ss ss ... 00 + // + // WHERE: + // + // ll - little endian size of string including zero terminator + // ss - string data + // 00 - zero terminator + // + // buf - buffer, where to append data (IN/OUT). + // str - C-style string to append (IN). + // + // RETURNS: 0 if byte appended, + // -1 if error. + // + + int StrPushString(string &buf, const char *str) + { + DBG_ENTER3("StrPushString"); + + int len = strlen(str) + 1; + + StrPushDword(buf, len); + StrPushRaw(buf, str, len); + + DBG_LEAVE3("StrPushString"); + + return 0; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Capitalize.cpp b/Source/Core/LibStr/Capitalize.cpp new file mode 100644 index 0000000..3c1e634 --- /dev/null +++ b/Source/Core/LibStr/Capitalize.cpp @@ -0,0 +1,96 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "Str.h" + +namespace Tegenaria +{ + // + // Capitalize string. + // + // str - string to captalize (IN/OUT). + // + + void StrCapitalize(string &str) + { + for (int i = 0; i < str.size(); i++) + { + if (str[i] >= 'a' && str[i] <= 'z') + { + str[i] -= 'a' - 'A'; + } + } + } + + // + // Capitalize string. + // + // str - string to captalize (IN/OUT). + // + + void StrCapitalize(char *str) + { + for (int i = 0; str[i]; i++) + { + if (str[i] >= 'a' && str[i] <= 'z') + { + str[i] -= 'a' - 'A'; + } + } + } + + // + // Lowerize string. + // + // s - string to captalize (IN/OUT). + // + + string &StrLowerize(string &s) + { + for (int i = 0; i < s.size(); i++) + { + if (s[i] >= 'A' && s[i] <= 'Z') + { + s[i] += 'a' - 'A'; + } + } + } + + // + // Lowerize string. + // + // s - string to captalize (IN/OUT). + // + + void StrLowerize(char *s) + { + for (int i = 0; s[i]; i++) + { + if (s[i] >= 'A' && s[i] <= 'Z') + { + s[i] += 'a' - 'A'; + } + } + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Convert.cpp b/Source/Core/LibStr/Convert.cpp new file mode 100644 index 0000000..5ae0720 --- /dev/null +++ b/Source/Core/LibStr/Convert.cpp @@ -0,0 +1,177 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Convert variety types into string and vice versa. +// + +#include "Str.h" + +namespace Tegenaria +{ + // + // Convert std::string to integer. + // + // str - input string e.g. "1234" (IN). + // algorithm - algorithm to use for conversion (IN). + // + // Possible are: + // + // - SimpleAtoi : Call C atoi() function on string. + // + // - EveryDigits : Skip all non-decimal number e.g. it converts "1-234xx-56" + // into 123456 number. + // + // - UntilAlpha : stop converting on first alpha charcter e.g. it + // converts "123-456xxx789" into 123456. + // + // RETURNS: Decoded integer. + // + + int StringToInt(const string &str, StringToIntAlgorithm algorithm) + { + return StringToInt(str.c_str(), algorithm); + } + + // + // Convert std::string to integer. + // + // str - input string e.g. "1234" (IN). + // algorithm - algorithm to use for conversion (IN). + // + // Possible are: + // + // - SimpleAtoi : Call C atoi() function on string. + // + // - EveryDigits : Skip all non-decimal number e.g. it converts "1-234xx-56" + // into 123456 number. + // + // - UntilAlpha : stop converting on first alpha charcter e.g. it + // converts "123-456xxx789" into 123456. + // + // RETURNS: Decoded integer. + // + + int StringToInt(const char *str, StringToIntAlgorithm algorithm) + { + if (str == NULL) + { + return 0; + } + + switch(algorithm) + { + case SimpleAtoi: + { + return atoi(str); + } + + case EveryDigits: + { + char tmp[64] = {0}; + + int p = 0; + + for (int i = 0; str[i] && p < 63; i++) + { + if (str[i] >= '0' && str[i] <= '9') + { + tmp[p] = str[i]; + + p ++; + } + } + + return atoi(tmp); + } + + case UntilAlpha: + { + char tmp[64] = {0}; + + int p = 0; + + for (int i = 0; str[i] && p < 63 && !isalpha(str[i]) && + str[i] != ',' && str[i] != '.'; i++) + { + if (str[i] >= '0' && str[i] <= '9') + { + tmp[p] = str[i]; + + p ++; + } + } + + return atoi(tmp); + } + } + + return 0; + } + + // + // Convert std::string into double value. + // + // RETURNS: Double value stored in input string. + // + + double StringToDouble(const string &str) + { + return atof(str.c_str()); + } + + // + // Create std::string from input integer value. + // + + string StringFromInt(int x) + { + string ret; + + ret.resize(64); + + snprintf(&ret[0], 64, "%d", x); + + ret.resize(strlen(&ret[0])); + + return ret; + } + + // + // Create std::string from input double value. + // + + string StringFromDouble(double x) + { + string ret; + + ret.resize(64); + + snprintf(&ret[0], 64, "%lf", x); + + ret.resize(strlen(&ret[0])); + + return ret; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Date.cpp b/Source/Core/LibStr/Date.cpp new file mode 100644 index 0000000..c7908b6 --- /dev/null +++ b/Source/Core/LibStr/Date.cpp @@ -0,0 +1,224 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Functions to manipulate date strings (e.g. "2014-10-14"). +// + +#include "Str.h" + +#ifdef WIN32 +#include +#endif + +namespace Tegenaria +{ + // + // Get local today date string in format: YYYY-MM-DD. + // + // RETURNS: String containing today date e.g. "2014-10-14". + // + + const string StrDateGetToday() + { + time_t now = time(0); + + struct tm tstruct; + + char buf[80]; + + tstruct = *localtime(&now); + + strftime(buf, sizeof(buf), "%Y-%m-%d", &tstruct); + + return buf; + } + + // + // Get UTC0 today date string in format: YYYY-MM-DD. + // + // RETURNS: String containing today date e.g. "2014-10-14". + // + + const string StrDateGetTodayUTC0() + { + time_t now = time(0); + + struct tm tstruct; + + char buf[80]; + + tstruct = *gmtime(&now); + + strftime(buf, sizeof(buf), "%Y-%m-%d", &tstruct); + + return buf; + } + + // + // Add N days to date string. + // + // Example: "2014-10-14" + 1 day = "2014-10-15" + // + // date - input date string to increase (IN). + // nDays - how many days to add (IN). + // + // RETURNS: Date string increased by given number of days. + // + + const string StrDateAddDays(string date, int nDays) + { + int exitCode = -1; + + string ret = date; + + int yyyy = 0; + int mm = 0; + int dd = 0; + + struct tm tstruct = {0}; + + time_t ts; + + char buf[80]; + + // + // Check args. + // + + FAILEX(date.size() != 10, "ERROR: Invalid date format in StrDateAddDays().\n"); + + // + // Convert date string into tm struct. + // + + FAILEX(strptime(date.c_str(), "%Y-%m-%d", &tstruct) == NULL, + "ERROR: Invalid date format in StrDateAddDays().\n"); + + // + // Convert tm struct into unix timestamp. + // + + ts = mktime(&tstruct); + + // + // Add days to timestamp. + // + + ts += nDays * 3600 * 24; + + // + // Convert increased timestamp back to string. + // + + tstruct = *localtime(&ts); + + strftime(buf, sizeof(buf), "%Y-%m-%d", &tstruct); + + ret = buf; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return ret; + } + + // + // Add N days to UTC0 date string. + // + // Example: "2014-10-14" + 1 day = "2014-10-15" + // + // date - input date string to increase (IN). + // nDays - how many days to add (IN). + // + // RETURNS: Date string increased by given number of days. + // + + const string StrDateAddDaysUTC0(string date, int nDays) + { + int exitCode = -1; + + string ret = date; + + int yyyy = 0; + int mm = 0; + int dd = 0; + + struct tm tstruct = {0}; + + time_t ts; + + char buf[80]; + + // + // Check args. + // + + FAILEX(date.size() != 10, "ERROR: Invalid date format in StrDateAddDays().\n"); + + // + // Convert date string into tm struct. + // + + FAILEX(strptime(date.c_str(), "%Y-%m-%d", &tstruct) == NULL, + "ERROR: Invalid date format in StrDateAddDays().\n"); + + // + // Convert tm struct into unix timestamp. + // + + ts = mktime(&tstruct); + + // + // Add days to timestamp. + // + + ts += nDays * 3600 * 24; + + // + // Convert increased timestamp back to string. + // + + tstruct = *gmtime(&ts); + + strftime(buf, sizeof(buf), "%Y-%m-%d", &tstruct); + + ret = buf; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return ret; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Example01-bianary-packet/Example01.cpp b/Source/Core/LibStr/Example01-bianary-packet/Example01.cpp new file mode 100644 index 0000000..ff5d555 --- /dev/null +++ b/Source/Core/LibStr/Example01-bianary-packet/Example01.cpp @@ -0,0 +1,133 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +// +// Encode example values into binary packet: +// +// offset length descritpion +// 0 1 some 8-bit value +// 1 4 some 32-bit value +// 5 8 some 64-bit value +// 13 4 size of string +// 17 ... string data with zero terminator +// + +void EncodePacket(string &packet, + uint8_t value8, + uint32_t value32, + uint64_t value64, + const char *valueString) +{ + StrPushByte(packet, value8); + StrPushDword(packet, value32); + StrPushQword(packet, value64); + StrPushString(packet, valueString); + + printf("Encoded packet is:\n"); + printf(" value8 : [%d].\n", value8); + printf(" value32 : [%d].\n", value32); + printf(" value64 : [%"PRId64"].\n", value64); + printf(" string : [%s].\n\n", valueString); +} + +// +// Decode packet back. This function emulate decoding packet +// e.g. just after receiving it from network, where we get raw {buf, len} +// buffer. +// + +int DecodePacket(const void *buf, int len) +{ + int exitCode = -1; + + uint8_t value8 = 0; + uint32_t value32 = 0; + uint64_t value64 = 0; + + const char *valueString = NULL; + + // + // Pointer to track current position in buffer. + // + + char *it = (char *) buf; + + int bytesLeft = len; + + // + // Decode. + // + + FAIL(StrPopByte(&value8, &it, &bytesLeft)); + FAIL(StrPopDword(&value32, &it, &bytesLeft)); + FAIL(StrPopQword(&value64, &it, &bytesLeft)); + FAIL(StrPopString(&valueString, NULL, &it, &bytesLeft)); + + // + // Print back decoded packet. + // + + printf("Decoded packet is:\n"); + printf(" value8 : [%d].\n", value8); + printf(" value32 : [%d].\n", value32); + printf(" value64 : [%"PRId64"].\n", value64); + printf(" string : [%s].\n\n", valueString); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot decode packet.\n"); + } +} + +int main(int argc, char **argv) +{ + string packet; + + // + // Encode some data into packet. + // + + EncodePacket(packet, 1, 2, 3, "hello"); + + // + // Decode it back. + // + + DecodePacket(packet.c_str(), packet.size()); + + return 0; +} diff --git a/Source/Core/LibStr/Example01-bianary-packet/LibStr-binary-packet.exe b/Source/Core/LibStr/Example01-bianary-packet/LibStr-binary-packet.exe new file mode 100644 index 0000000..0f7c74d Binary files /dev/null and b/Source/Core/LibStr/Example01-bianary-packet/LibStr-binary-packet.exe differ diff --git a/Source/Core/LibStr/Example01-bianary-packet/qcbuild.src b/Source/Core/LibStr/Example01-bianary-packet/qcbuild.src new file mode 100644 index 0000000..c8f1d47 --- /dev/null +++ b/Source/Core/LibStr/Example01-bianary-packet/qcbuild.src @@ -0,0 +1,31 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibStr-example01-binary-packet +CXXSRC = Example01.cpp + +LIBS = -lstr -ldebug + +DEPENDS = LibStr LibDebug diff --git a/Source/Core/LibStr/Example02-verify/Main.cpp b/Source/Core/LibStr/Example02-verify/Main.cpp new file mode 100644 index 0000000..d45f0e8 --- /dev/null +++ b/Source/Core/LibStr/Example02-verify/Main.cpp @@ -0,0 +1,105 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include + +using namespace Tegenaria; + +void ReadField(char *dst, int dstSize, const char *prompt) +{ + printf("%s", prompt); + + fgets(dst, dstSize, stdin); + + for (int i = 0; dst[i]; i++) + { + if (dst[i] == 10 || dst[i] == 13) + { + dst[i] = 0; + } + } +} + +int main(int argc, char **argv) +{ + char login[32]; + char email[32]; + char pass[32]; + + // + // Read fields from stdin. + // + + ReadField(login, sizeof(login), "Enter login: "); + ReadField(email, sizeof(email), "Enter email: "); + ReadField(pass, sizeof(pass), "Enter password: "); + + // + // Verify email. + // + + switch(StrEmailVerify(email)) + { + case ERR_OK: printf("Email OK.\n"); break; + case ERR_VERIFY_WRONG_FORMAT: printf("Email has wrong format.\n"); break; + case ERR_VERIFY_ALIAS_FORBIDDEN: printf("Email can't contain + aliases.\n"); break; + case ERR_VERIFY_COMMENT_FORBIDDEN: printf("Email can't contain () comment(s).\n"); break; + } + + // + // Verify login. + // + + switch(StrLoginVerify(login)) + { + case ERR_OK: printf("Login OK.\n"); break; + case ERR_VERIFY_WRONG_FORMAT: printf("Login has wrong format.\n"); break; + case ERR_VERIFY_WRONG_CHAR: printf("Login contains not allowed characters.\n"); break; + case ERR_VERIFY_TOO_SHORT: printf("Login too short.\n"); break; + case ERR_VERIFY_TOO_LONG: printf("Login too long.\n"); break; + } + + // + // Verify password. + // + + switch(StrPassVerify(pass)) + { + case ERR_OK: printf("Password OK.\n"); break; + case ERR_VERIFY_WRONG_FORMAT: printf("Password has wrong format.\n"); break; + case ERR_VERIFY_WRONG_CHAR: printf("Password contains not allowed characters.\n"); break; + case ERR_VERIFY_TOO_SHORT: printf("Password too short.\n"); break; + case ERR_VERIFY_TOO_LONG: printf("Password too long.\n"); break; + } + + // + // Compute password strength. + // + + printf("Password strength is %d.\n", StrPassStrength(pass)); + + return 0; +} diff --git a/Source/Core/LibStr/Example02-verify/qcbuild.src b/Source/Core/LibStr/Example02-verify/qcbuild.src new file mode 100644 index 0000000..36b81f8 --- /dev/null +++ b/Source/Core/LibStr/Example02-verify/qcbuild.src @@ -0,0 +1,31 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibStr-example02-verify +CXXSRC = Main.cpp + +LIBS = -lstr -ldebug + +DEPENDS = LibStr LibDebug diff --git a/Source/Core/LibStr/Example03-date/Main.cpp b/Source/Core/LibStr/Example03-date/Main.cpp new file mode 100644 index 0000000..aaf2614 --- /dev/null +++ b/Source/Core/LibStr/Example03-date/Main.cpp @@ -0,0 +1,45 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +int main(int argc, char **argv) +{ + string today = StrDateGetToday(); + string todayUTC0 = StrDateGetTodayUTC0(); + string nextDay = StrDateAddDays(today, 1); + string nextMonth = StrDateAddDays(today, 31); + string nextYear = StrDateAddDays(today, 365); + + printf("Today : [%s]\n", today.c_str()); + printf("Today UTC0 : [%s]\n", todayUTC0.c_str()); + printf("Today + 1 day : [%s]\n", nextDay.c_str()); + printf("Today + 31 days : [%s]\n", nextMonth.c_str()); + printf("Today + 365 days : [%s]\n", nextYear.c_str()); + + return 0; +} diff --git a/Source/Core/LibStr/Example03-date/qcbuild.src b/Source/Core/LibStr/Example03-date/qcbuild.src new file mode 100644 index 0000000..130864f --- /dev/null +++ b/Source/Core/LibStr/Example03-date/qcbuild.src @@ -0,0 +1,31 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibStr-example03-date +CXXSRC = Main.cpp + +LIBS = -lstr -ldebug + +DEPENDS = LibStr LibDebug diff --git a/Source/Core/LibStr/Example04-list/Main.cpp b/Source/Core/LibStr/Example04-list/Main.cpp new file mode 100644 index 0000000..919e764 --- /dev/null +++ b/Source/Core/LibStr/Example04-list/Main.cpp @@ -0,0 +1,75 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +int main(int argc, char **argv) +{ + string str; + + vector vec; + + // + // Add 3 elements. + // + + StrListAdd(str, "jozek"); + StrListAdd(str, "maciek"); + StrListAdd(str, "janek"); + + printf("List after add : [%s]\n", str.c_str()); + + // + // Remove element from the middle. + // + + StrListRemove(str, "maciek"); + + printf("List after remove : [%s]\n", str.c_str()); + + // + // Check is given lement exists. + // + + printf("Jozek exists : [%d].\n", StrListExists(str, "jozek")); + printf("Kuba exists : [%d].\n", StrListExists(str, "kuba")); + + // + // Convert string list into STL vector. + // + + StrListSplit(vec, str.c_str()); + + printf("Splitted list:\n"); + + for (int i = 0; i < vec.size(); i++) + { + printf(" Element no %d : [%s]\n", i, vec[i].c_str()); + } + + return 0; +} diff --git a/Source/Core/LibStr/Find.cpp b/Source/Core/LibStr/Find.cpp new file mode 100644 index 0000000..e2eb913 --- /dev/null +++ b/Source/Core/LibStr/Find.cpp @@ -0,0 +1,223 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Find substrings in string. +// + +#include "Str.h" + +namespace Tegenaria +{ + char *stristr(const char *arg1, const char *arg2) + { + const char *a, *b; + + for(; *arg1; *arg1++) + { + a = arg1; + b = arg2; + + while((*a++ | 32) == (*b++ | 32)) + { + if(!*b) + { + return (char *) arg1; + } + + } + } + + return NULL; + } + + char *StrFindIWord(const char *arg1, const char *arg2) + { + const char *a, *b; + + const char *arg1Oryg = arg1; + + for(; *arg1; *arg1++) + { + a = arg1; + b = arg2; + + while((*a++ | 32) == (*b++ | 32)) + { + if(!*b + && (arg1 == arg1Oryg || !isalpha(arg1[-1]) + && (*a == 0 || !isalpha(*a)))) + + { + return (char *) arg1; + } + + } + } + + return NULL; + } + + char *StrFindWord(const char *arg1, const char *arg2) + { + const char *a, *b; + + const char *arg1Oryg = arg1; + + for(; *arg1; *arg1++) + { + a = arg1; + b = arg2; + + while((*a++) == (*b++)) + { + if(!*b + && (arg1 == arg1Oryg || !isalpha(arg1[-1]) + && (*a == 0 || !isalpha(*a)))) + + { + return (char *) arg1; + } + + } + } + + return NULL; + } + + string StrGetTextBeetwen(const char *buf, const char *startStr, const char *endStr) + { + string ret; + + char *start = NULL; + char *end = NULL; + + char zero = 0; + + FAIL(buf == NULL); + FAIL(startStr == NULL); + FAIL(endStr == NULL); + FAIL(startStr[0] == 0); + FAIL(endStr[0] == 0); + + start = (char *) strstr(buf, startStr); + + FAIL(start == NULL); + + start += strlen(startStr); + + end = strstr(start, endStr); + + FAIL(end == NULL); + + swap(*end, zero); + ret = start; + swap(*end, zero); + + fail: + + return ret; + } + + char *strstrex(const char *s, const char *pattern) + { + if (s == NULL) + { + return NULL; + } + + char *ret = (char *) strstr(s, pattern); + + if (ret) + { + ret += strlen(pattern); + } + + return ret; + } + + char *strchrex(const char *s, char pattern) + { + if (s == NULL) + { + return NULL; + } + + char *ret = (char *) strchr(s, pattern); + + if (ret) + { + ret ++; + } + + return ret; + } + + // + // Multi character version of strchr. + // + // p - pointer to begin of buffer string (IN). + // chars - string containing list of characters to find (IN). + // zeroByteMatch - treat zero terminator as matching character if set to 1 (IN). + // + // RETURNS: Pointer to first character matching any of chars[] character + // or NULL if character not found. + // + + const char *StrFindCharMulti(const char *p, const char *chars, int zeroByteMatch) + { + const char *ret = NULL; + + // + // Check args. + // + + FAIL(p == NULL); + FAIL(chars == NULL); + + // + // Find first occurence of any from chars[]. + // + + while(p[0] && ret == NULL) + { + for (int i = 0; chars[i]; i++) + { + if (*p == chars[i]) + { + ret = p; + } + } + } + + if (p[0] == 0 && zeroByteMatch) + { + ret = p; + } + + fail: + + return ret; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Local.cpp b/Source/Core/LibStr/Local.cpp new file mode 100644 index 0000000..64459b4 --- /dev/null +++ b/Source/Core/LibStr/Local.cpp @@ -0,0 +1,406 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "Str.h" + +namespace Tegenaria +{ + /* + ** This lookup table is used to help decode the first byte of + ** a multi-byte UTF8 character. + */ + + static const unsigned char sqlite3Utf8Trans1[] = + { + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, + 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, + 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, + 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, + 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, + 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, + 0x00, 0x01, 0x02, 0x03, 0x00, 0x01, 0x00, 0x00, + }; + + // + // Pop next UTF8 character from string. + // + + inline unsigned int GetUtf8(unsigned const char *zIn, unsigned const char **pzNext) + { + unsigned int c; + + /* Same as READ_UTF8() above but without the zTerm parameter. + ** For this routine, we assume the UTF8 string is always zero-terminated. + */ + c = *(zIn++); + if( c>=0xc0 ){ + c = sqlite3Utf8Trans1[c-0xc0]; + while( (*zIn & 0xc0)==0x80 ){ + c = (c<<6) + (0x3f & *(zIn++)); + } + if( c<0x80 + || (c&0xFFFFF800)==0xD800 + || (c&0xFFFFFFFE)==0xFFFE ){ c = 0xFFFD; } + } + *pzNext = zIn; + + if (c == 0x105 || c == 0x104) c = 'a'; + else if (c == 0x119 || c == 0x118) c = 'e'; + else if (c == 0x107 || c == 0x106) c = 'c'; + else if (c == 0x142 || c == 0x141) c = 'l'; + else if (c == 0x144 || c == 0x143) c = 'n'; + else if (c == 0x0f3 || c == 0xd3) c = 'o'; + else if (c == 0x17a || c == 0x179) c = 'z'; + else if (c == 0x17c || c == 0x17b) c = 'z'; + else if (c == 0x15a || c == 0x15b) c = 's'; + else if (c == '-') c = ' '; + else if (c == '\t') c = ' '; + else if (c == ',') c = ' '; + else if (c == '.') c = ' '; + else if (c == '\'') c = ' '; + + return c; + } + + // + // Case insensitive UTF-8 version of C strstr(). + // + + char *stristr_utf8(const char *arg1, const char *arg2, int *byteLen) + { + unsigned const char *a, *b; + + for(; *arg1; *arg1++) + { + a = (unsigned const char *) arg1; + b = (unsigned const char *) arg2; + + while((GetUtf8(a, &a) | 32) == (GetUtf8(b, &b) | 32)) + { + if(!*b) + { + if (byteLen) + { + *byteLen = a - (unsigned const char *) arg1; + } + + return (char *) arg1; + } + + } + } + + return NULL; + } + + // + // + // + + char *StrFindIWord_utf8(const char *arg1, const char *arg2) + { + //printf("-> StrFindIWord_utf8()...\n"); + + const unsigned char *a, *b; + + const char *arg1Oryg = arg1; + + for(; *arg1; *arg1++) + { + a = (const unsigned char *) arg1; + b = (const unsigned char *) arg2; + + // while((*a++ | 32) == (*b++ | 32)) + + while((GetUtf8(a, &a) | 32) == (GetUtf8(b, &b) | 32)) + { + if(!*b + && (arg1 == arg1Oryg || !isalpha(arg1[-1]) + && (*a == 0 || !isalpha(*a)))) + + { + // printf("<- StrFindIWord_utf8()...\n"); + + return (char *) arg1; + } + + } + } + + //printf("<- StrFindIWord_utf8()...\n"); + + return NULL; + } + + // + // Change polish local characters into pure ASCII equivalent. + // + // dst - buffer where to store pure ASCIIZ string (OUT). + // src - source utf8 string potentially containing polish chars (IN). + // + // RETURNS: 0 if OK. + // + + int StrRemovePlChars_utf8(unsigned char *dst, unsigned char *src) + { + if (src == NULL || dst == NULL) + { + return -1; + } + + while(*src) + { + switch(*src) + { + case 0xc4: + { + src ++; + + switch(*src) + { + case 0x84: dst[0] = 'A'; break; + case 0x85: dst[0] = 'a'; break; + + case 0x86: dst[0] = 'C'; break; + case 0x87: dst[0] = 'c'; break; + + case 0x98: dst[0] = 'E'; break; + case 0x99: dst[0] = 'e'; break; + + default : dst[0] = ' '; + } + + break; + } + + case 0xc5: + { + src ++; + + switch(*src) + { + case 0x81: dst[0] = 'L'; break; + case 0x82: dst[0] = 'l'; break; + + case 0x83: dst[0] = 'N'; break; + case 0x84: dst[0] = 'n'; break; + + case 0x9a: dst[0] = 'S'; break; + case 0x9b: dst[0] = 's'; break; + + case 0xb9: dst[0] = 'Z'; break; + case 0xba: dst[0] = 'z'; break; + + case 0xbb: dst[0] = 'Z'; break; + case 0xbc: dst[0] = 'z'; break; + + default : dst[0] = ' '; + } + + break; + } + + case 0xc3: + { + src ++; + + switch(*src) + { + case 0x93: dst[0] = 'O'; break; + case 0xb3: dst[0] = 'o'; break; + + default : dst[0] = ' '; + } + + break; + } + + default: + { + dst[0] = src[0]; + } + } + + src ++; + dst ++; + } + + *dst = 0; + + return 0; + } + + static const char *STR_Cyr[] = + { + "а","б","в","г","д","е","Ñ‘","ж","з","и","й","к","л","м","н","о","п","Ñ€","Ñ","Ñ‚","у", + "Ñ„","Ñ…","ц","ч","ш","щ","ÑŠ", "Ñ‹","ÑŒ", "Ñ", "ÑŽ","Ñ", + "Ð","Б","Ð’","Г","Д","Е","Ð","Ж","З","И","Й","К","Л","Ðœ","Ð","О","П","Р","С","Т","У", + "Ф","Ð¥","Ц","Ч","Ш","Щ","Ъ", "Ы","Ь", "Э", "Ю","Я", + NULL + }; + + static const char *STR_Lat[] = + { + "a","b","v","g","d","e","e","zh","z","i","y","k","l","m","n","o","p","r","s","t","u", + "f" ,"h" ,"ts" ,"ch","sh" ,"sht" ,"i", "y", "y", "e" ,"yu" ,"ya","A","B","V","G","D","E","E","Zh", + "Z","I","Y","K","L","M","N","O","P","R","S","T","U", + "F" ,"H" ,"Ts" ,"Ch","Sh" ,"Sht" ,"I" ,"Y" ,"Y", "E", "Yu" ,"Ya", + NULL + }; + + string StrCyr2Lat(const string &cyrtext) + { + string rv; + + if (cyrtext.size() < 2) + { + rv = cyrtext; + } + else + { + const char *src = cyrtext.c_str(); + const char *lat = NULL; + + for (int i = 0; i < cyrtext.size() - 1; i ++) + { + lat = NULL; + + for (int j = 0; STR_Cyr[j]; j++) + { + if (memcmp(src, STR_Cyr[j], 2) == 0) + { + lat = STR_Lat[j]; + + break; + } + } + + if (lat) + { + rv += lat; + src += 2; + } + else + { + rv += src[0]; + src++; + } + } + } + + return rv; + } + + #ifdef WIN32 + + // + // Convert code page from to . + // + // str - string to convert (IN/OUT). + // sourceCP - original code page of input string (IN). + // targetCP - destination code page, we want convert to (IN). + // + // RETURNS: 0 if OK. + // + + int StrConvertCodePage(string &str, int sourceCP, int targetCP) + { + string tmpWide; + + tmpWide.resize(str.size() * 3); + + str.resize(str.size() * 2); + + if (MultiByteToWideChar(sourceCP, MB_PRECOMPOSED, str.c_str(), -1, + (wchar_t *) tmpWide.c_str(), tmpWide.size()) <= 0) + { + return -1; + } + + if (WideCharToMultiByte(targetCP, 0, (wchar_t *) tmpWide.c_str(), -1, + (char *) str.c_str(), str.size(), NULL, NULL) <= 0) + { + return -1; + } + + str.resize(strlen(str.c_str())); + + return 0; + } + + // + // Replace all polish non-lating characters by lating equvalent. + // + // str - string to convert (IN/OUT). + // sourceCP - code page of input string (IN). + // + // RETURNS: 0 if OK. + // + + int StrRemovePlChars(string &str, DWORD sourceCP) + { + string tmpWide; + + tmpWide.resize(str.size() * 3); + + str.resize(str.size() * 2); + + wchar_t *ws = (wchar_t *) &tmpWide[0]; + + if (MultiByteToWideChar(sourceCP, 0, str.c_str(), -1, + (wchar_t *) tmpWide.c_str(), tmpWide.size()) <= 0) + { + return -1; + } + + for (int i = 0; ws[i]; i++) + { + int c = ws[i]; + + if (c == 0x105 || c == 0x104) c = 'a'; + else if (c == 0x119 || c == 0x118) c = 'e'; + else if (c == 0x107 || c == 0x106) c = 'c'; + else if (c == 0x142 || c == 0x141) c = 'l'; + else if (c == 0x144 || c == 0x143) c = 'n'; + else if (c == 0x0f3 || c == 0xd3) c = 'o'; + else if (c == 0x17a || c == 0x179) c = 'z'; + else if (c == 0x17c || c == 0x17b) c = 'z'; + + ws[i] = c; + } + + if (WideCharToMultiByte(sourceCP, 0, (wchar_t *) tmpWide.c_str(), -1, + (char *) str.c_str(), str.size(), NULL, NULL) <= 0) + { + return -1; + } + + str.resize(strlen(&str[0])); + + return 0; + } + + #endif /* WIN32 */ +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Parser.cpp b/Source/Core/LibStr/Parser.cpp new file mode 100644 index 0000000..c04ec19 --- /dev/null +++ b/Source/Core/LibStr/Parser.cpp @@ -0,0 +1,518 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Parse string part by part. +// + +#include "Str.h" + +namespace Tegenaria +{ + // + // Count how many time given char exist in string. + // + // s - input string to scan (IN). + // c - character to be counted (IN). + // + // RETURNS: How many times char exist in string + // + + int StrCountChar(const char *s, char c) + { + int count = 0; + + for (int i = 0; s[i]; i++) + { + if (s[i] == c) + { + count ++; + } + } + + return count; + } + + // + // Count how many digit character (0-9) exists in string. + // + // s - input string to scan (IN). + // + // RETURNS: How many digits exist in string + // + + int StrCountDigits(const char *s) + { + int count = 0; + + for (int i = 0; s[i]; i++) + { + if (isdigit(s[i])) + { + count ++; + } + } + + return count; + } + + // + // Count how many alpha (a-z and A-Z) characters exist in string. + // + // s - input string to scan (IN). + // + // RETURNS: How many alpha characters exist in string + // + + int StrCountAlpha(const char *s) + { + int count = 0; + + for (int i = 0; s[i]; i++) + { + if (isalpha(s[i])) + { + count ++; + } + } + + return count; + } + + // + // Pop integer (%d) value from string. + // + // it - pointer source string (IN/OUT). + // + // RETURNS: Popped integer. + // + + int StrPopInt(const char **it) + { + int ret = 0; + + if (it && *it) + { + // + // Skip whites first. + // + + while(isspace(**it)) + { + (*it) ++; + } + + // + // Get number. + // + + ret = atoi(*it); + + while(isdigit(**it)) + { + (*it) ++; + } + } + + return ret; + } + + // + // Pop double (%lf) value from string. + // + // it - pointer source string (IN/OUT). + // + // RETURNS: Popped integer. + // + + double StrPopDouble(const char **it) + { + double ret = 0; + + if (it && *it) + { + // + // Skip whites first. + // + + while(isspace(**it)) + { + (*it) ++; + } + + // + // Get number. + // + + ret = atof(*it); + + while(isdigit(**it) || (**it == '.')) + { + (*it) ++; + } + } + + return ret; + } + + // + // Peek first character in string and pop it if it's match with + // expected character. + // + // NOTE #1: Character is popped only if matches with parameter. + // + // NOTE #2: Input string <*it> is NOT changed if first character NOT matches + // to parameter. + // + // EXAMPLE 1: + // ---------- + // + // Before call: + // *it = "jozek" + // expected = 'j' + // + // After call: + // *it = "ozek" + // expected = 'j' + // + // RETURNS: 0 + // + // EXAMPLE2: + // --------- + // + // Before call: + // *it = "jozek" + // expected = 'x' + // + // After call: + // *it = "jozek" + // expected = 'x' + // + // RETURNS: -1 + // + // it - pointer source string (IN/OUT). + // expected - character to match (IN). + // + // RETURNS: 0 if character matched and popped + // -1 otherwise. + // + + int StrMatchChar(const char **it, char expected) + { + if (it && *it && **it == expected) + { + (*it) ++; + + return 0; + } + + return -1; + } + + // + // Pop first character from string. + // + // it - pointer input string (IN/OUT). + // + // RETURNS: Popped character. + // + + char StrPopChar(const char **it) + { + char ret = 0; + + if (it && *it && **it) + { + ret = (**it); + + (*it) ++; + } + + return ret; + } + + // + // Pop alpha (a-z and A-Z) only word from string. + // Functin stops reading on first non alpha character. + // + // it - pointer to input string (IN/OUT). + // word - buffer where to store readed word (OUT). + // wordSize - size of word[] buffer in bytes (IN). + // + + void StrPopAlphaWord(const char **it, char *word, int wordSize) + { + if (it && *it && word) + { + // + // Skip whites first. + // + + while(**it && isspace(**it)) + { + (*it) ++; + } + + // + // Get alpha. + // + + while(isalpha(**it) && wordSize > 0) + { + *word = **it; + + (*it) ++; + + word ++; + + wordSize --; + } + + if (wordSize > 0) + { + word[0] = 0; + } + else + { + word[-1] = 0; + } + } + } + + // + // Pop bound/alpha (a-z and A-Z and [] and $) only word from string. + // Functin stops reading on first characer other than alpha, [] or $. + // + // it - pointer to input string (IN/OUT). + // word - buffer where to store readed word (OUT). + // wordSize - size of word[] buffer in bytes (IN). + // + + void StrPopAlphaWordBound(const char **it, char *word, int wordSize) + { + if (it && *it && word) + { + // + // Skip whites first. + // + + while(**it && isspace(**it)) + { + (*it) ++; + } + + // + // Get alpha. + // + + while((isalpha(**it) || (**it) == ']' || (**it) == '[' || + (**it) == '$') && wordSize > 0) + { + *word = **it; + + (*it) ++; + + word ++; + + wordSize --; + } + + if (wordSize > 0) + { + word[0] = 0; + } + else + { + word[-1] = 0; + } + } + } + + // + // Pop integer (%d) value from string. + // + // it - pointer source string (IN/OUT). + // + // RETURNS: Popped integer. + // + + int StrPopInt(char **it) + { + return StrPopInt((const char **) it); + } + + // + // Pop first character from string. + // + // it - pointer input string (IN/OUT). + // + // RETURNS: Popped character. + // + + char StrPopChar(char **it) + { + return StrPopChar((const char **) it); + } + + // + // Pop double (%lf) value from string. + // + // it - pointer source string (IN/OUT). + // + // RETURNS: Popped integer. + // + + double StrPopDouble(char **it) + { + return StrPopDouble((const char **) it); + } + + // + // Peek first character in string and pop it if it's match with + // expected character. + // + // NOTE #1: Character is popped only if matches with parameter. + // + // NOTE #2: Input string <*it> is NOT changed if first character NOT matches + // to parameter. + // + // EXAMPLE 1: + // ---------- + // + // Before call: After call: + // *it = "jozek" *it = "ozek" + // expected = 'j' expected = 'j' + // + // Return value : 0 + // + // EXAMPLE2: + // --------- + // + // Before call: After call: + // *it = "jozek" *it = "jozek" + // expected = 'x' expected = 'x' + // + // Return value: -1 + // + // it - pointer source string (IN/OUT). + // expected - character to match (IN). + // + // RETURNS: 0 if character matched and popped + // -1 otherwise. + // + + int StrMatchChar(char **it, char expected) + { + return StrMatchChar((const char **) it, expected); + } + + // + // Pop alpha (a-z and A-Z) only word from string. + // Functin stops reading on first non alpha character. + // + // it - pointer to input string (IN/OUT). + // word - buffer where to store readed word (OUT). + // wordSize - size of word[] buffer in bytes (IN). + // + + void StrPopAlphaWord(char **it, char *word, int wordSize) + { + StrPopAlphaWord((const char **) it, word, wordSize); + } + + // + // Pop bound/alpha (a-z and A-Z and [] and $) only word from string. + // Functin stops reading on first characer other than alpha, [] or $. + // + // it - pointer to input string (IN/OUT). + // word - buffer where to store readed word (OUT). + // wordSize - size of word[] buffer in bytes (IN). + // + + void StrPopAlphaWordBound(char **it, char *word, int wordSize) + { + StrPopAlphaWordBound((const char **) it, word, wordSize); + } + + // + // Skip whites characters. + // + // s - input string (IN). + // + // RETURNS: Pointer to first non-white character in string. + // + + const char *StrSkipWhites(const char *s) + { + while(isspace(s[0])) s++; + + return s; + } + + // + // Peek begin of string and pop it if matches with input . + // + // Example 1: + // ---------- + // + // Before call: After call: + // *it = "dirligo" *it = "ligo" + // pattern = "dir" pattern = "dir" + // + // + // Return value: "ligo" + // + // Example 2: + // ---------- + // + // Before call: After call: + // *it = "dirligo" *it = "dirligo" + // pattern = "xxx" pattern = "xxx" + // + // Return value: NULL + // + // it - pointer to input string (IN/OUT). + // pattern - pattern word to be matched (IN). + // + // RETURNS: Pointer to begin of patter found in string + // or NULL if pattern not found. + // + + const char *StrMatch(const char **it, const char *pattern) + { + if (it == NULL || *it == NULL) + { + return NULL; + } + + const char *next = strstr(*it, pattern); + + if (next) + { + *it = next + strlen(pattern); + } + + return *it; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Random.cpp b/Source/Core/LibStr/Random.cpp new file mode 100644 index 0000000..7a30eb2 --- /dev/null +++ b/Source/Core/LibStr/Random.cpp @@ -0,0 +1,74 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Generate pseudo-random strings. +// +// WARNING! These functions are NOT criptografically strong. +// + +#include "Str.h" + +namespace Tegenaria +{ + // + // Generate random 64-byte decimal only string. + // + // RETURNS: Random decimal-only string. + // + + string RandomIntString() + { + char tmp[64]; + + snprintf(tmp, 64, "%d%d", rand(), int(time(0))); + + return string(tmp); + } + + // + // Generate general random string. + // + // len - length of string to generate (IN). + // minChar - minimum character to use e.g. 'a' (IN). + // maxChar - maximum character to use e.g. 'z' (IN). + // + // RETURNS: Random string containing characters from + // range. + // + + string RandomString(int len, int minChar, int maxChar) + { + string ret; + + ret.resize(len); + + for (int i = 0; i < len; i++) + { + ret[i] = minChar + rand() % (maxChar - minChar); + } + + return ret; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/SourceCode.cpp b/Source/Core/LibStr/SourceCode.cpp new file mode 100644 index 0000000..d621cdc --- /dev/null +++ b/Source/Core/LibStr/SourceCode.cpp @@ -0,0 +1,331 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "Str.h" + +namespace Tegenaria +{ + // + // Minimalize source code (e.g. JS/CSS) by removing whitespaces and comments. + // + // code - source code to minify (IN). + // singleComment - string used as comment line e.g. '//' in C/C++ (IN/OPT). + // multiCommentBegin - string used to begin comment e.g. '/*' in C/C++ (IN/OPT). + // multiCommentEnd - string used to close comment e.g. '*/' in C/C++ (IN/OPT). + // removeWhites - remove redundant whites if set to 1 (IN/OPT). + // + // RETURNS: New string containing minimalized code. + // + + string StrMinifyCode(const string &code, const char *singleComment, + const char *multiCommentBegin, const char *multiCommentEnd, + int removeWhites) + { + enum MinifierState + { + CODE, + SINGLE_COMMENT, + MULTI_COMMENT, + SINGLE_STRING, + DOUBLE_STRING + }; + + MinifierState state = CODE; + + string rv; + + int currentChar = -1; + int lastChar = -1; + int nextChar = -1; + + int singleCommentSize = singleComment ? strlen(singleComment) : -1; + int multiCommentBeginSize = multiCommentBegin ? strlen(multiCommentBegin) : -1; + int multiCommentEndSize = multiCommentEnd ? strlen(multiCommentEnd) : -1; + + int appendToResult = 1; + + const char *src = code.c_str(); + + for (int i = 0; i < code.size(); i++) + { + appendToResult = 1; + + currentChar = code[i]; + src = code.c_str() + i; + + if (i < code.size() - 1) + { + nextChar = code[i + 1]; + } + else + { + nextChar = -1; + } + + switch(state) + { + // + // We're inside code. + // + + case CODE: + { + // + // Begin of single line comment. + // + + if (singleComment && (strncmp(src, singleComment, singleCommentSize) == 0)) + { + state = SINGLE_COMMENT; + + i += singleCommentSize - 1; + + appendToResult = 0; + } + + // + // Begin of multi line comment. + // + + else if (multiCommentBegin && strncmp(src, multiCommentBegin, multiCommentBeginSize) == 0) + { + state = MULTI_COMMENT; + + appendToResult = 0; + } + + // + // Begin of "" string (double). + // + + else if (currentChar == '"') + { + state = DOUBLE_STRING; + } + + // + // Begin of '' string (single). + // + + else if (currentChar == '\'') + { + state = SINGLE_STRING; + } + + // + // Ordinal code character. + // + + else + { + } + + break; + } + + // + // We're inside single line comment. + // Wait for end of line. + // + + case SINGLE_COMMENT: + { + if (currentChar == 10 || currentChar == 13) + { + state = CODE; + + i --; + } + + appendToResult = 0; + + break; + } + + // + // We're inside multi line comment. + // Wait for end comment tag. + // + + case MULTI_COMMENT: + { + if (multiCommentEnd && strncmp(src, multiCommentEnd, multiCommentEndSize) == 0) + { + i += multiCommentEndSize - 1; + + state = CODE; + } + + appendToResult = 0; + + break; + } + + // + // We're inside "" string (double). + // Wait for ending " char. + // + + case DOUBLE_STRING: + { + if (currentChar == '"' && lastChar != '\\') + { + state = CODE; + } + + break; + } + + // + // We're inside '' string (single). + // Wait for ending ' char. + // + + case SINGLE_STRING: + { + if (currentChar == '\'' && lastChar != '\\') + { + state = CODE; + } + + break; + } + } + + // + // Don't put redundant whites if needed. + // + + if (removeWhites && state == CODE) + { + if (currentChar == 10 || currentChar == 13) + { + currentChar = ' '; + } + + if (isspace(currentChar)) + { + switch(lastChar) + { + case ' ': + case '\t': + case ';': + case '=': + case ':': + case '}': + case '{': + case '(': + case ')': + case '+': + case '-': + case '*': + case '/': + case '&': + case '|': + case '?': + case ',': + case '<': + case '>': + { + appendToResult = 0; + + break; + } + } + + switch(nextChar) + { + case ' ': + case '\t': + case ';': + case '=': + case ':': + case '}': + case '{': + case '(': + case ')': + case '+': + case '-': + case '*': + case '/': + case '&': + case '|': + case '?': + case ',': + case '<': + case '>': + { + appendToResult = 0; + + break; + } + } + } + } + + // + // Append char tu result if needed. + // + + if (appendToResult) + { + rv += currentChar; + lastChar = currentChar; + } + } + + return rv; + }; + + // + // Remove single line comments from string. + // + // code - string containg source code (IN). + // commentString - string used as comment line e.g. '//' in C/C++ (IN). + // + // RETURNS: New string with removed comments. + // + + string StrRemoveSingleLineComments(string code, const char *commentString) + { + return StrMinifyCode(code, commentString, NULL, NULL, 0); + } + + // + // Remove multiline comments from string. + // + // code - string containg source code (IN). + // commentBegin - string used to begin comment e.g. '/*' in C/C++ (IN). + // commentEnd - string used to close comment e.g. '*/' in C/C++ (IN). + // + // RETURNS: New string with removed comments. + // + + string StrRemoveMultiLineComments(const string &code, + const char *commentBegin, + const char *commentEnd) + { + return StrMinifyCode(code, NULL, commentBegin, commentEnd, 0); + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Str.cpp b/Source/Core/LibStr/Str.cpp new file mode 100644 index 0000000..2d9dece --- /dev/null +++ b/Source/Core/LibStr/Str.cpp @@ -0,0 +1,754 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "Str.h" + +namespace Tegenaria +{ + using namespace std; + + void StringSet(char *&destination, const char *source) + { + if (destination != source) + { + if (destination != NULL) + { + delete [] destination; + } + + if (source == NULL) + { + destination = NULL; + } + else + { + int sourcelen = strlen(source) + 1; + + destination = new char[sourcelen]; + + memcpy(destination, source, sourcelen); + } + } + } + + void StringAdd(char *&destination, const char *source1, const char *source2, + const char *source3, const char *source4) + { + int length0 = (destination == NULL ? 0 : strlen(destination)); + + int length1 = (source1 == NULL ? 0 : strlen(source1)); + int length2 = (source2 == NULL ? 0 : strlen(source2)); + int length3 = (source3 == NULL ? 0 : strlen(source3)); + int length4 = (source4 == NULL ? 0 : strlen(source4)); + + int length = length0 + length1 + length2 + length3 + length4; + + if (length == 0) + { + return; + } + + char *data = new char[length + 1]; + + if (destination != NULL) + { + memcpy(data, destination, length0 + 1); + } + else + { + *data = '\0'; + } + + if (source1 != NULL) + { + memcpy(data + length0, source1, length1 + 1); + } + + if (source2 != NULL) + { + memcpy(data + length0 + length1, source2, length2 + 1); + } + + if (source3 != NULL) + { + memcpy(data + length0 + length1 + length2, source3, length3 + 1); + } + + if (source4 != NULL) + { + memcpy(data + length0 + length1 + length2 + length3, source4, length4 + 1); + } + + delete [] destination; + + destination = data; + } + + void StringReset(char *&destination) + { + if (destination != NULL) + { + delete [] destination; + + destination = NULL; + } + } + + // + // Replace all occurences of character by . + // + // str - string to modify (IN/OUT). + // oldChar - character to be replaced (IN). + // newChar - character to use for replacement (IN). + // + // RETURNS: Pointer to str[] parameter, + // or NULL if error. + // + + void StrReplace(char *str, char oldChar, char newChar) + { + if (str == NULL) + { + return; + } + + while (*str) + { + if ((*str) == oldChar) + { + *str = newChar; + } + + str ++; + } + } + + // + // Replace all occurences of character by . + // + // str - string to modify (IN/OUT). + // oldChar - character to be replaced (IN). + // newChar - character to use for replacement (IN). + // + // RETURNS: Pointer to str[] parameter, + // or NULL if error. + // + + void StrReplace(string &str, char oldChar, char newChar) + { + for (int i = 0; i < str.size(); i++) + { + if (str[i] == oldChar) + { + str[i] = newChar; + } + } + } + + // + // Remove all occurences of character from string . + // + // str - string to modify (IN/OUT). + // c - character to be removed (IN). + // + // RETURNS: Pointer to str[] parameter, + // or NULL if error. + // + + char *StrRemoveChar(char *str, char c) + { + if (str == NULL) + { + return NULL; + } + + char *src = str; + char *dst = str; + + while (*src) + { + if ((*src) != c) + { + *dst = *src; + + dst ++; + } + + src ++; + } + + *dst = 0; + + return str; + } + + // + // Remove all occurences of character from string . + // + // str - string to modify (IN). + // c - character to be removed (IN). + // + // RETURNS: new string with removed characters. + // + + string StrRemoveChar(const string &str, char c) + { + string rv; + + for (int i = 0; i < str.size(); i++) + { + if (str[i] != c) + { + rv += str[i]; + } + } + + return rv; + } + + // + // Remove all occurences of given from string e.g. + // + // Before call: + // buf[] = "hello world hello!" + // pattern[] = "hello" + // + // After call: + // buf[] = "world!" + // pattern[] = "hello" + // + // buf - buffer to change (IN/OUT). + // pattern - pattern to remove (IN). + // + // RETURNS: Pointer to buf[] parameter, + // or NULL if error. + // + + char *StrRemoveString(char *buf, const char *pattern) + { + if (buf == NULL || pattern == NULL) + { + return NULL; + } + + char *p = NULL; + + int patternLen = strlen(pattern); + + while(p = strstr(buf, pattern)) + { + strcpy(p, p + patternLen); + } + + return buf; + } + + // + // Remove all occurences of given without case sensity + // from string e.g. + // + // Before call: + // buf[] = "HeLLo world hello!" + // pattern[] = "hello" + // + // After call: + // buf[] = "world!" + // pattern[] = "hello" + // + // buf - buffer to change (IN/OUT). + // pattern - pattern to remove (IN). + // + // RETURNS: Pointer to buf[] parameter, + // or NULL if error. + // + + char *StrRemoveCaseString(char *buf, const char *pattern) + { + if (buf == NULL || pattern == NULL) + { + return NULL; + } + + char *p = NULL; + + int patternLen = strlen(pattern); + + while(p = stristr(buf, pattern)) + { + strcpy(p, p + patternLen); + } + + return buf; + } + + // + // Remove declination postfix if any. + // + // WARNING: Function need pure ASCII text on input (i.e. with already + // tarnslated polish chars to coresponding ASCII eg. ¥ to a). + // + // Example: + // Input : domy + // Output: dom + // + // Input : samochodow + // Output: samochod + // + + string StrRemoveDeclensionPostfixPL(string word) + { + string rv; + + int len = word.size(); + + // + // Word too short. Don't touch. + // + + if(len < 3) + { + rv = word; + } + + // + // Word has at least 3 chars. Go on. + // + + else + { + int found = 0; + + const char *postfix1[] = {"y" , "u" , "i" , "a" , NULL}; + const char *postfix2[] = {"ow" , "om" , "em" , "ni" , "ka" , "ie" , NULL}; + const char *postfix3[] = {"ami" , "owi" , "iem", "ach", "owy", "owe", "owo", "owa", "ace", NULL}; + const char *postfix4[] = {"iowe", "czek", NULL}; + + const char *p = word.c_str() + len; + + if (len >= 3 + 4) + { + for (int i = 0; found == 0 && postfix4[i]; i++) + { + if (stricmp(p - 4, postfix3[i]) == 0) + { + found = 4; + } + } + } + + if (len >= 3 + 3) + { + for (int i = 0; found == 0 && postfix3[i]; i++) + { + if (stricmp(p - 3, postfix3[i]) == 0) + { + found = 3; + } + } + } + + if (len >= 3 + 2) + { + for (int i = 0; found == 0 && postfix2[i]; i++) + { + if (stricmp(p - 2, postfix2[i]) == 0) + { + found = 2; + } + } + } + + if (len >= 3 + 1) + { + for (int i = 0; found == 0 && postfix1[i]; i++) + { + if (stricmp(p - 1, postfix1[i]) == 0) + { + found = 1; + } + } + } + + if (found != 0) + { + rv = word.substr(0, len - found); + } + else + { + rv = word; + } + } + + DEBUG3("StrRemoveDeclesionPostfixPL: Converted [%s] to [%s].\n", word.c_str(), rv.c_str()); + + return rv; + } + + // + // Replace all occurences by one. + // + // s - string to modify (IN/OUT). + // oldStr - pattern to be replaced (IN). + // newStr - new pattern for replacement (IN). + // + // RETURNS: Refference to input/output parmatere. + // + + string &StrReplaceString(string &s, const char *oldStr, const char *newStr) + { + string ret; + + if (oldStr == NULL || newStr == NULL) + { + return s; + } + + char *next = NULL; + char *p = (char *) s.c_str(); + + int oldStrLen = strlen(oldStr); + + while(next = strstr(p, oldStr)) + { + *next = 0; + + ret += p; + ret += newStr; + + p = next + oldStrLen; + } + + ret += p; + + s = ret; + + return s; + } + + // + // Mask last digits in phone number by 'x' characters e.g. + // + // Before call : 123-456-789 + // After call : 123-456-xxx + // + // p - buffer where telefone number to change (IN/OUT). + // + // RETURNS: 0 if OK, + // -1 otherwise. + // + + int StrMaskPhone(char *p) + { + if (p == NULL) + { + return -1; + } + + int count = 0; + + while(*p) + { + switch(*p) + { + case '0'...'9': + { + count ++; + + if (count > 6) + { + *p = 'x'; + } + + break; + } + + case 'a'...'z': + case 'A'...'Z': + case 13: + case 10: + case '.': + case ',': + { + count = 0; + + break; + } + + default: + { + //if (count > 0) + //{ + // count ++; + //} + } + } + + p ++; + } + + return 0; + } + + // + // Mask email address e.g. + // + // Before call : sucker@dirligo.com + // After call : xxxxxx@xxxxxxx.xxx + // + // p - buffer where mail to mask is stored (IN/OUT). + // + // RETURNS: 0 if OK, + // -1 otherwise. + // + + int StrMaskEmail(char *p) + { + if (p == NULL) + { + return -1; + } + + char *it = p; + char *next = p; + + while(next = strchr(next, '@')) + { + for (it = next - 1; it > p && isspace(*it) == 0; it --) + { + if (isalnum(*it)) + { + *it = 'x'; + } + } + + for (it = next + 1; *it && isspace(*it) == 0; it ++) + { + if (isalnum(*it)) + { + *it = 'x'; + } + } + + next ++; + } + + return 0; + } + + // + // Encode special chars e.g. '<' into HTML data. + // + // str - text to encode (IN). + // flags - combination of STR_HTML_XXX flags defines in Str.h (IN/OPT). + // + // RETURNS: Text encoded to html. + // + + string StrEncodeToHtml(const string &str, unsigned int flags) + { + DBG_ENTER("StrEncodeToHtml"); + + string ret; + + int last = 0; + + for (int i = 0; i < str.size(); i++) + { + int c = str[i]; + + switch(c) + { + // + // Encode end of line to "
. + // + + case 13: + case 10: + { + if (last != 13 && last != 10) + { + ret += "
"; + } + + break; + } + + // + // Encode '<' to '<' + // Encode '>' to '>' + // Encode space to " " to force column align. + // + + case '<': ret += "<"; break; + case '>': ret += ">"; break; + + case ' ': + { + if (flags & STR_HTML_NON_BREAK_SPACES) + { + ret += " "; + } + else + { + ret += ' '; + } + + break; + } + + // + // Default. Append to output directly. + // + + default: + { + ret += c; + } + } + + last = c; + } + + DBG_LEAVE("StrEncodeToHtml"); + + return ret; + } + + string StrNormalizeWhiteSpaces(string s) + { + DBG_ENTER("StrNormalizeWhiteSpaces"); + + int lastWhite = 1; + + string rv; + + for (int i = 0; i < s.size(); i++) + { + if (isspace(s[i])) + { + if (lastWhite == 0) + { + rv += s[i]; + } + + lastWhite = 1; + } + else + { + rv += s[i]; + + lastWhite = 0; + } + } + +/* + TODO: Review this code. + int len = rv.size(); + + while(len > 0 && isspace(rv[len - 1])) + { + len --; + } + + if (len > 0) + { + rv.resize(len); + } + else + { + rv.clear(); + } +*/ + + DBG_LEAVE("StrNormalizeWhiteSpaces"); + + return rv; + } + + // + // Remove all whitespaces from string. + // + + string StrRemoveWhiteSpaces(const string &str) + { + string rv; + + for (int i = 0; i < str.size(); i++) + { + if (!isspace(str[i])) + { + rv += str[i]; + } + } + + return rv; + } + + // + // Format money string by adding extra space per every 3 digits. + // For example it converts 5000000 into 5 000 000. + // + // money - output buffer, where to put formatted string (OUT). + // moneySize - size of money[] buffer in bytes (IN). + // value - input value string to format (IN). + // + // RETURNS: 0 if OK. + // + + int StrFormatMoney(char *money, int moneySize, const char *value) + { + int exitCode = -1; + + if (money && value) + { + int valueLen = strlen(value); + int spaceCnt = (valueLen - 1) / 3; + int moneyIdx = valueLen + spaceCnt - 1; + int count = 0; + + if (moneySize > moneyIdx + 1) + { + money[moneyIdx + 1] = 0; + + for (int valueIdx = valueLen - 1; valueIdx >= 0; valueIdx --) + { + money[moneyIdx--] = value[valueIdx]; + + count ++; + + if (count == 3) + { + money[moneyIdx--] = ' '; + + count = 0; + } + } + } + + exitCode = 0; + } + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Str.h b/Source/Core/LibStr/Str.h new file mode 100644 index 0000000..8e1c4b9 --- /dev/null +++ b/Source/Core/LibStr/Str.h @@ -0,0 +1,344 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Str_H +#define Tegenaria_Core_Str_H + +// +// Includes. +// + +#include +#include +#include +#include +#include +#include +#include +#include + +#ifdef WIN32 +#include +#endif + +namespace Tegenaria +{ + using namespace std; + + + // + // Defines. + // + + #define STR_HTML_NON_BREAK_SPACES (1 << 0) + + #ifndef WIN32 + # undef stricmp + # define stricmp strcasecmp + #endif + + #define STR_LITTLE_ENDIAN 0 + #define STR_BIG_ENDIAN 1 + + #define STR_MIN_LOGIN_LEN 1 + #define STR_MAX_LOGIN_LEN 60 + + #define STR_MIN_PASS_LEN 6 + #define STR_MAX_PASS_LEN 20 + + // + // Enums. + // + + enum StringToIntAlgorithm + { + SimpleAtoi, + EveryDigits, + UntilAlpha + }; + + // + // Exported functions. + // + + inline string StringFromChar(const char *p) + { + if (p) + { + return p; + } + else + { + return "N/A"; + } + } + + void StringSet(char *&destination, const char *source); + + void StringAdd(char *&destination, const char *source1 = NULL, + const char *source2 = NULL, const char *source3 = NULL, + const char *source4 = NULL); + + void StringReset(char *&destination); + + // + // Conversion. + // + + int StringToInt(const string &, StringToIntAlgorithm algorithm = SimpleAtoi); + int StringToInt(const char *, StringToIntAlgorithm algorithm = SimpleAtoi); + + double StringToDouble(const string &); + + string StringFromInt(int); + string StringFromDouble(double); + + // + // Tokenize. + // + + void StrTokenize(vector &tokens, const string &inputStr, + const char *delims = "\t\n "); + + void StrTokenize(vector &tokens, const string &inputStr, + const char *delims, const char *delimsExtra); + + void StrTokenize(vector &tokens, char *inputStr, + const char *delims, const char *delimsExtra); + + void StrTokenize(set &tokens, const string &inputStr, + const char *delims = "\t\n "); + + void StrTokenize(set &tokens, const string &inputStr, + const char *delims, const char *delimsExtra); + + void StrStrTokenize(vector &tokens, + const string &inputStr, const char *delim); + + void StrStrTokenize(vector &tokens, char *inputStr, const char *delim); + + int StrSplit(char *token, char **left, char **right, char splitChar); + + // + // Capitalize. + // + + void StrCapitalize(string &str); + + void StrCapitalize(char *str); + + string &StrLowerize(string &s); + + void StrLowerize(char *str); + + // + // Parser. + // + + const char *StrMatch(const char **it, const char *pattern); + + const char *StrSkipWhites(const char *); + + int StrCountChar(const char *s, char c); + int StrCountDigits(const char *s); + int StrCountAlpha(const char *s); + + int StrPopInt(const char **it); + int StrPopInt(char **it); + + double StrPopDouble(const char **it); + double StrPopDouble(char **it); + + char StrPopChar(const char **it); + char StrPopChar(char **it); + + int StrMatchChar(const char **it, char expected); + int StrMatchChar(char **it, char expected); + + void StrPopAlphaWord(const char **it, char *word, int wordSize); + void StrPopAlphaWord(char **it, char *word, int wordSize); + + void StrPopAlphaWordBound(const char **it, char *word, int wordSize); + void StrPopAlphaWordBound(char **it, char *word, int wordSize); + + string StrNormalizeWhiteSpaces(string s); + + // + // Find. + // + + char *stristr(const char *arg1, const char *arg2); + char *stristr_utf8(const char *arg1, const char *arg2, int *byteLen); + + char *StrFindIWord(const char *arg1, const char *arg2); + char *StrFindWord(const char *arg1, const char *arg2); + + char *StrFindIWord_utf8(const char *arg1, const char *arg2); + + string StrGetTextBeetwen(const char *buf, const char *startStr, const char *endStr); + + char *strstrex(const char *s, const char *pattern); + char *strchrex(const char *s, char pattern); + + const char *StrFindCharMulti(const char *p, const char *chars, int zeroByteMatch); + + // + // Remove. + // + + void StrReplace(char *str, char oldChar, char newChar); + void StrReplace(string &str, char oldChar, char newChar); + + char *StrRemoveChar(char *str, char c); + + string StrRemoveChar(const string &str, char c); + + string StrRemoveWhiteSpaces(const string &str); + + char *StrRemoveString(char *buf, const char *pattern); + + char *StrRemoveCaseString(char *buf, const char *pattern); + + string &StrReplaceString(string &buf, const char *oldStr, const char *newStr); + + int StrRemovePlChars_utf8(unsigned char *dst, unsigned char *src); + + string StrRemoveDeclensionPostfixPL(string word); + + // + // Random. + // + + string RandomIntString(); + + string RandomString(int len, int minChar, int maxChar); + + // + // Mask. + // + + int StrMaskPhone(char *p); + int StrMaskEmail(char *p); + + // + // Verify. + // + + int StrEmailVerify(const char *email); + int StrLoginVerify(const char *login); + int StrPassStrength(const char *pass); + int StrPassVerify(const char *pass); + + // + // String lists. + // + + void StrListSplit(vector &vec, const char *str); + + void StrListInit(string &str, vector &vec); + + int StrListAdd(string &str, const char *elem); + + int StrListRemove(string &str, const char *elem); + + int StrListExists(const string &str, const char *elem); + + // + // Html. + // + + string StrEncodeToHtml(const string &str, unsigned int flags = 0); + + // + // Local characters. + // + + string StrCyr2Lat(const string &cyrtext); + + #ifdef WIN32 + + int StrConvertCodePage(string &str, int sourceCP, int targetCP); + + int StrRemovePlChars(string &str, DWORD sourceCP = -1); + + #endif + + // + // Binary string. + // + + int StrPopByte(uint8_t *value, string &buf); + int StrPopDword(uint32_t *value, string &buf, int flags = 0); + int StrPopQword(uint64_t *value, string &buf, int flags = 0); + int StrPopRaw(void *raw, int rawSize, string &buf); + + int StrPushByte(string &buf, uint8_t value); + int StrPushDword(string &buf, uint32_t value, int flags = 0); + int StrPushQword(string &buf, uint64_t value, int flags = 0); + int StrPushRaw(string &buf, const void *raw, int rawSize); + int StrPushString(string &buf, const char *str); + + // + // C-style binary. + // + + int StrPopRaw(void *raw, int rawSize, char **it, int *bytesLeft); + int StrPopQword(uint64_t *value, char **it, int *bytesLeft, int flags = 0); + int StrPopDword(uint32_t *value, char **it, int *bytesLeft, int flags = 0); + int StrPopByte(uint8_t *value, char **it, int *bytesLeft); + int StrPopString(const char **str, int *strLen, char **it, int *bytesLeft); + + // + // Date strings. + // + + const string StrDateGetToday(); + const string StrDateGetTodayUTC0(); + + const string StrDateAddDays(string date, int nDays); + const string StrDateAddDaysUTC0(string date, int nDays); + + // + // Clean code. + // + + string StrRemoveSingleLineComments(string code, const char *commentString); + + string StrRemoveMultiLineComments(const string &code, + const char *commentBegin, + const char *commentEnd); + + string StrMinifyCode(const string &code, const char *singleComment, + const char *multiCommentBegin, const char *multiCommentEnd, + int removeWhites = 0); + + // + // Money. + // + + int StrFormatMoney(char *money, int moneySize, const char *value); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Str_H */ diff --git a/Source/Core/LibStr/StringList.cpp b/Source/Core/LibStr/StringList.cpp new file mode 100644 index 0000000..831609f --- /dev/null +++ b/Source/Core/LibStr/StringList.cpp @@ -0,0 +1,254 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Manage string lists in "elem1;elem2;...;elemn" format. +// + +#include "Str.h" +#include + +namespace Tegenaria +{ + // + // Split input string list in format "elem1;elem2;..." into STL vector + // containig [elem1,elem2,...] strings. + // + // vec - STL string vector, where to store retrieved elements list (OUT). + // str - string list in "elem1;elem2;..." format (IN). + // + + void StrListSplit(vector &vec, const char *str) + { + DBG_ENTER3("StrListSplit"); + + vec.clear(); + + if (str) + { + char *tmp = strdup(str); + + char *token = strtok(tmp, ";"); + + while(token) + { + vec.push_back(token); + + token = strtok(NULL, ";"); + } + + free(tmp); + } + + DBG_LEAVE3("StrListSplit"); + } + + // + // Create one conitous "elem1;elem2;..." string from stl vector + // containig [elem1,elem2,...]. + // + // str - STL string, where to store created list (OUT). + // vec - STL vector containing string elements (IN). + // + + void StrListInit(string &str, vector &vec) + { + DBG_ENTER3("StrListInit"); + + str.clear(); + + for (vector::iterator it = vec.begin(); it != vec.end(); it++) + { + str += (*it); + str += ';'; + } + + DBG_LEAVE3("StrListInit"); + } + + // + // Add element to list. + // + // Example: + // + // Input str : "jozek;janek;" + // Input elem : "maciek" + // Output str : "jozek;janek;maciek;" + // + // + // TIP#1: Element is added only if not exists on list yet. + // + // Parameters: + // + // str - string containing list in format "elem1;elem2;...", where to add + // new element (IN/OUT). + // + // elem - element to add (IN). + // + // RETURNS: 0 if element added, + // ERR_XXX code otherwise. + // + + int StrListAdd(string &str, const char *elem) + { + DBG_ENTER3("StrListAdd"); + + int exitCode = ERR_WRONG_PARAMETER; + + if (elem) + { + // + // If friend doesn't exist yet, add it to list. + // + + if (StrListExists(str, elem) == 0) + { + str += elem; + str += ";"; + + exitCode = 0; + } + else + { + exitCode = ERR_ALREADY_EXISTS; + } + } + + DBG_LEAVE3("StrListAdd"); + + return exitCode; + } + + // + // Remove element from list. + // + // Example: + // + // Input str : "jozek;janek;maciek;" + // Input elem : "janek" + // Output str : "jozek;maciek;" + // + // Parameters: + // + // str - string containing list in format "elem1;elem2;...", which we want + // to modify (IN/OUT). + // + // elem - element to remove (IN). + // + // RETURNS: 0 if element removed, + // ERR_XXX code otherwise. + // + + int StrListRemove(string &str, const char *elem) + { + DBG_ENTER3("StrListRemove"); + + int exitCode = ERR_WRONG_PARAMETER; + + int found = 0; + + if (elem) + { + char *tmp = strdup(str.c_str()); + + string newList; + + char *token = strtok(tmp, ";"); + + while(token) + { + if (stricmp(token, elem) != 0) + { + newList += token; + newList += ';'; + } + else + { + found = 1; + } + + token = strtok(NULL, ";"); + } + + str = newList; + + free(tmp); + + if (found == 1) + { + exitCode = ERR_OK; + } + else + { + exitCode = ERR_NOT_FOUND; + } + } + + DBG_LEAVE3("StrListRemove"); + + return exitCode; + } + + // + // Check is elem exists on list. + // + // str - string containing list in format "elem1;elem2;...", which we want + // search (IN). + // + // elem - element to found (IN). + // + // RETURNS: 1 if element exists in the list, + // 0 otherwise. + // + + int StrListExists(const string &str, const char *elem) + { + DBG_ENTER3("StrListExists"); + + int found = 0; + + if (elem) + { + char *tmp = strdup(str.c_str()); + + char *token = strtok(tmp, ";"); + + while(found == 0 && token) + { + if (stricmp(token, elem) == 0) + { + found = 1; + } + + token = strtok(NULL, ";"); + } + + free(tmp); + } + + DBG_LEAVE3("StrListExists"); + + return found; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Tokenize.cpp b/Source/Core/LibStr/Tokenize.cpp new file mode 100644 index 0000000..63a9330 --- /dev/null +++ b/Source/Core/LibStr/Tokenize.cpp @@ -0,0 +1,461 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Tokenize string into tokens. +// + + +#include "Str.h" + +namespace Tegenaria +{ + // + // Peek first character from input

string and check is it one of + // allowed delimer character from set. + // + // p - input string (IN). + // delims - list of allowed delims e.g. "\t\n " (IN) + // + // RETURNS: Delim character if detected or + // 0 if delim character NOT found. + // + + inline char StrIsDelim(char *p, const char *delims) + { + for (int i = 0; delims[i]; i++) + { + if (*p == delims[i]) return delims[i]; + } + + return 0; + } + + // + // Tokenize string. + // + // tokens - std::vector containing generated tokens (OUT). + // inputStr - string to tokenize (IN). + // delims - list of delim characters e.g. "\t " (IN). + // + + void StrTokenize(vector &tokens, const string &inputStr, const char *delims) + { + string str = string(inputStr.c_str()); + + char *pch = strtok((char *) str.c_str(), delims); + + tokens.clear(); + + while (pch) + { + tokens.push_back(pch); + + pch = strtok (NULL, delims); + } + } + + // + // Tokenize string. + // + // tokens - std::set containing generated tokens (OUT). + // inputStr - string to tokenize (IN). + // delims - list of delim characters e.g. "\t " (IN). + // + + void StrTokenize(set &tokens, const string &inputStr, const char *delims) + { + string str = string(inputStr.c_str()); + + char *pch = strtok((char *) str.c_str(), delims); + + tokens.clear(); + + while (pch) + { + tokens.insert(pch); + + pch = strtok (NULL, delims); + } + } + + // + // Tokenize string. + // + // TIP #1: Set to '"' if your string containing quoted "words", + // which should NOT be tokenized. + // + // tokens - vector containing generated tokens (OUT). + // inputStr - string to tokenize (IN). + // delims - list of delim characters e.g. "\t " (IN). + // delimsExtra - quatation characters to mark words should NOT be processed + // by tokenizer (IN). + // + + void StrTokenize(vector &tokens, char *inputStr, + const char *delims, const char *delimsExtra) + { + char *p = inputStr; + + char *begin = p; + char *end = p; + + char activeDelim = 1; + char activeDelimExtra = 0; + + char foundDelim = 0; + + tokens.clear(); + + while(end && *end) + { + if (foundDelim = StrIsDelim(end, delimsExtra)) + { + if (activeDelimExtra) + { + activeDelimExtra = 0; + + *end = 0; + } + else + { + while(StrIsDelim(begin, delimsExtra)) begin ++; + + activeDelimExtra = foundDelim; + } + } + + if (activeDelimExtra == 0) + { + if (end && (foundDelim = StrIsDelim(end, delims))) + { + *end = 0; + + tokens.push_back(begin); + + end ++; + + while(StrIsDelim(end, delims)) end ++; + + begin = end; + + continue; + } + } + + end ++; + } + + if (end > begin) + { + tokens.push_back(begin); + } + } + + // + // Tokenize string. + // + // TIP #1: Set to '"' if your string containing quoted "words", + // which should NOT be tokenized. + // + // tokens - vector containing generated tokens (OUT). + // inputStr - string to tokenize (IN). + // delims - list of delim characters e.g. "\t " (IN). + // delimsExtra - quatation characters to mark words should NOT be processed + // by tokenizer (IN). + // + + void StrTokenize(vector &tokens, const string &inputStr, + const char *delims, const char *delimsExtra) + { + string str = inputStr; + + char *p = (char *) str.c_str(); + + char *begin = p; + char *end = p; + + char activeDelim = 1; + char activeDelimExtra = 0; + + char foundDelim = 0; + + tokens.clear(); + + while(*end) + { + if (foundDelim = StrIsDelim(end, delimsExtra)) + { + if (activeDelimExtra) + { + activeDelimExtra = 0; + + *end = 0; + } + else + { + while(StrIsDelim(begin, delimsExtra)) begin ++; + + activeDelimExtra = foundDelim; + } + } + + if (activeDelimExtra == 0) + { + if (foundDelim = StrIsDelim(end, delims)) + { + *end = 0; + + tokens.push_back(begin); + + end ++; + + while(StrIsDelim(end, delims)) end ++; + + begin = end; + + continue; + } + } + + end ++; + } + + if (end > begin) + { + tokens.push_back(begin); + } + } + + // + // Tokenize string. + // + // TIP #1: Set to '"' if your string containing quoted "words", + // which should NOT be tokenized. + // + // tokens - std:set containing generated tokens (OUT). + // inputStr - string to tokenize (IN). + // delims - list of delim characters e.g. "\t " (IN). + // delimsExtra - quatation characters to mark words should NOT be processed + // by tokenizer (IN). + // + + void StrTokenize(set &tokens, const string &inputStr, + const char *delims, const char *delimsExtra) + { + string str = string(inputStr.c_str()); + + char *p = (char *) str.c_str(); + + char *begin = p; + char *end = p; + + char activeDelim = 1; + char activeDelimExtra = 0; + char foundDelim = 0; + + tokens.clear(); + + while(*end) + { + if (foundDelim = StrIsDelim(end, delimsExtra)) + { + if (activeDelimExtra) + { + activeDelimExtra = 0; + + *end = 0; + } + else + { + while(begin && StrIsDelim(begin, delimsExtra)) begin ++; + + activeDelimExtra = foundDelim; + } + } + + if (activeDelimExtra == 0) + { + if (foundDelim = StrIsDelim(end, delims)) + { + *end = 0; + + tokens.insert(string(begin)); + + end ++; + + while(end && StrIsDelim(end, delims)) end ++; + + begin = end; + + continue; + } + } + + end ++; + } + + // + // Last insert. + // + + if (end > begin) + { + tokens.insert(string(begin)); + } + } + + // + // Tokenize string with multiple characters delimiter. + // + // TIP #1: Set to '"' if your string containing quoted "words", + // which should NOT be tokenized. + // + // tokens - vector containing generated tokens (OUT). + // inputStr - string to tokenize (IN). + // delims - multiple character delimiter e.g. "" (IN). + // delimsExtra - quatation characters to mark words should NOT be processed + // by tokenizer (IN). + // + + void StrStrTokenize(vector &tokens, char *str, const char *delim) + { + char *p = str; + + char *next = NULL; + + int delimLen = strlen(delim); + + tokens.clear(); + + while (next = strstr(p, delim)) + { + *next = 0; + + tokens.push_back(p); + + p = next + delimLen; + } + + if (p && *p) + { + tokens.push_back(p); + } + } + + // + // Tokenize string with multiple characters delimiter. + // + // TIP #1: Set to '"' if your string containing quoted "words", + // which should NOT be tokenized. + // + // tokens - vector containing generated tokens (OUT). + // inputStr - string to tokenize (IN). + // delims - multiple character delimiter e.g. "" (IN). + // delimsExtra - quatation characters to mark words should NOT be processed + // by tokenizer (IN). + // + + void StrStrTokenize(vector &tokens, const string &inputStr, const char *delim) + { + string str = string(inputStr.c_str()); + + char *p = (char *) str.c_str(); + char *next = NULL; + + int delimLen = strlen(delim); + + tokens.clear(); + + while (next = strstr(p, delim)) + { + *next = 0; + + tokens.push_back(p); + + p = next + delimLen; + } + + if (p && *p) + { + tokens.push_back(p); + } + } + + // + // Split input string into and parts separated by . + // Eg. it can splits "variable=value" string into "variable" and "value" tokens. + // + // token - input string to split. Warning input token will be destroyed (IN/OUT). + // left - pointer to left token (OUT). + // right - pointer to right token (first character after splitChar) (OUT). + // + // RETURNS: 0 if found and string are splitteng sucessfuly, + // -1 otherwise. + // + + int StrSplit(char *token, char **left, char **right, char splitChar) + { + int exitCode = -1; + + char *split = NULL; + + // + // Check args. + // + + FAILEX(token == NULL, "ERROR: 'token' cannot be NULL in StrSplit().\n"); + FAILEX(left == NULL, "ERROR: 'left' cannot be NULL in StrSplit().\n"); + FAILEX(right == NULL, "ERROR: 'right' cannot be NULL in StrSplit().\n"); + + // + // Search for splitChar. + // + + split = strchr(token, splitChar); + + FAILEX(split == NULL, + "ERROR: Split char '%c' not found in token '%s'.\n", + splitChar, token); + + // + // Split token into lvalue and rvalue. + // + + *split = 0; + + *left = token; + *right = split + 1; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/Verify.cpp b/Source/Core/LibStr/Verify.cpp new file mode 100644 index 0000000..065596e --- /dev/null +++ b/Source/Core/LibStr/Verify.cpp @@ -0,0 +1,390 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Functions to verify strings (e.g. email, logins). +// + +#include +#include "Str.h" + +namespace Tegenaria +{ + // + // Check is given email is in correct X@Y format. + // + // email - email address to verify (IN). + // + // RETURNS: 0 if email seems correct, + // one of ERR_VERIFY_XXX code otherwise. + // + + int StrEmailVerify(const char *email) + { + DBG_ENTER3("StrEmailVerify"); + + int exitCode = ERR_VERIFY_WRONG_FORMAT; + + const char *atPtr = NULL; + const char *dotPtr = NULL; + + FAIL(email == NULL); + + // + // Check for X@Y format. + // + + exitCode = ERR_VERIFY_WRONG_FORMAT; + + atPtr = strchr(email, '@'); + + FAIL(atPtr == NULL); + FAIL(atPtr == email); + + FAIL(*(atPtr + 1) == 0); + + // + // Check for SQL injection. + // + + exitCode = ERR_VERIFY_WRONG_CHAR; + + FAIL(strchr(email, '\'') != NULL); + + // + // () comments are forbidden eg. john(comment)@gmail.com. + // + + if (strchr(email, '(') || strchr(email, ')')) + { + exitCode = ERR_VERIFY_COMMENT_FORBIDDEN; + + goto fail; + } + + // + // + aliases are forbidden e.g. john+alias@gmail.com + // + + if (strchr(email, '+')) + { + exitCode = ERR_VERIFY_ALIAS_FORBIDDEN; + + goto fail; + } + + /* + dotPtr = strchr(atPtr + 1, '.'); + + FAIL(dotPtr == NULL); + FAIL(dotPtr == atPtr + 1); + FAIL(*(dotPtr + 1) == 0); + */ + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrEmailVerify"); + + return exitCode; + } + + // + // Check is given login correct. + // + // Allowed chars are: A-Z a-z 0-9 -_@. + // (No space allowed, dot allowed). + // + // Minimum login length is STR_MIN_LOGIN_LEN. + // Maximum login length is STR_MAX_LOGIN_LEN. + // + // login - login to verify (IN). + // + // RETURNS: 0 if login seems correct, + // one of ERR_VERIFY_XXX code otherwise. + // + + int StrLoginVerify(const char *login) + { + DBG_ENTER3("StrLoginVerify"); + + int exitCode = ERR_VERIFY_WRONG_FORMAT; + + // + // Check args. + // + + FAIL(login == NULL); + + // + // Check length. + // + + if (strlen(login) < STR_MIN_LOGIN_LEN) + { + exitCode = ERR_VERIFY_TOO_SHORT; + + goto fail; + } + + if (strlen(login) > STR_MAX_LOGIN_LEN) + { + exitCode = ERR_VERIFY_TOO_LONG; + + goto fail; + } + + // + // Check allowed alphabet. + // + + for (int i = 0; login[i]; i++) + { + switch(login[i]) + { + // + // Allowed chars. + // + + case 'A'...'Z': + case 'a'...'z': + case '0'...'9': + case '-': + case '_': + case '@': + case '.': + { + break; + } + + // + // Not allowed chars. Fail with ERR_VERIFY_WRONG_CHAR code. + // + + default: + { + exitCode = ERR_VERIFY_WRONG_CHAR; + + goto fail; + } + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrLoginVerify"); + + return exitCode; + } + + // + // Check is given password correct. + // + // Allowed chars are <32;125> ascii. + + // Minimum login length is STR_MIN_PASS_LEN. + // Maximum login length is STR_MAX_PASS_LEN. + // + // pass - password to verify (IN). + // + // RETURNS: 0 if password seems correct, + // one of ERR_VERIFY_XXX code otherwise. + // + + int StrPassVerify(const char *pass) + { + DBG_ENTER3("StrPassVerify"); + + int exitCode = ERR_VERIFY_WRONG_FORMAT; + + // + // Check args. + // + + FAIL(pass == NULL); + + // + // Check length. + // + + if (strlen(pass) < STR_MIN_PASS_LEN) + { + exitCode = ERR_VERIFY_TOO_SHORT; + + goto fail; + } + + if (strlen(pass) > STR_MAX_PASS_LEN) + { + exitCode = ERR_VERIFY_TOO_LONG; + + goto fail; + } + + // + // Check allowed alphabet. + // + + for (int i = 0; pass[i]; i++) + { + if (pass[i] < 32 || pass[i] > 125) + { + exitCode = ERR_VERIFY_WRONG_CHAR; + + goto fail; + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("StrPassVerify"); + + return exitCode; + } + + // + // Compute password strength in <0;6> scale. + // + // pass - password to check (IN). + // + // RETURNS: Password strength in <0;6> scale. + // + + int StrPassStrength(const char *pass) + { + DBG_ENTER3("StrPassStrength"); + + int hasUpper = 0; + int hasLower = 0; + int hasSymbol = 0; + int hasSpecial = 0; + int hasNumber = 0; + int strength = 0; + + // + // Check args. + // + + FAIL(pass == NULL); + + // + // Hardcode strength = 0 if password too short. + // + + FAIL(strlen(pass) < 6); + + // + // Scan chars in password. + // + + for (int i = 0; pass[i]; i++) + { + switch(pass[i]) + { + case 'A'...'Z': + { + hasUpper = 1; + + break; + } + + case 'a'...'z': + { + hasLower = 1; + + break; + } + + case 33 ... 47: + case 58 ... 64: + case 91 ... 96: + { + hasSymbol = 1; + + break; + } + + case 123 ... 126: + { + hasSpecial = 1; + + break; + } + + case '0'...'9': + { + hasNumber = 1; + + break; + } + } + } + + // + // Compute strenghth. + // + + if (hasUpper) strength ++; + if (hasLower) strength ++; + if (hasNumber) strength ++; + if (hasSymbol) strength ++; + if (hasSpecial) strength ++; + + // + // Extra point for pass longer than 12 characters. + // + + if (strlen(pass) > 12) + { + strength ++; + } + + // + // Error handler. + // + + fail: + + DBG_LEAVE3("StrPassStrength"); + + return strength; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibStr/qcbuild.src b/Source/Core/LibStr/qcbuild.src new file mode 100644 index 0000000..72c8060 --- /dev/null +++ b/Source/Core/LibStr/qcbuild.src @@ -0,0 +1,49 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibStr + +CXXSRC = Binary.cpp BinaryString.cpp Capitalize.cpp Convert.cpp Find.cpp +CXXSRC += Local.cpp Parser.cpp Random.cpp Str.cpp Tokenize.cpp Verify.cpp +CXXSRC += Date.cpp StringList.cpp SourceCode.cpp + +INC_DIR = Tegenaria +ISRC = Str.h +LIBS = -ldebug + +AUTHOR = Sylwester Wysocki + +PURPOSE = Process strings and binary buffers. + +DEPENDS = LibDebug LibError + +# +# Link with external strptime() implementation on Windows. +# + +.section MinGW +DEPENDS += libstrptime +LIBS += -lstrptime-static +.endsection diff --git a/Source/Core/LibSystem/Cpu.cpp b/Source/Core/LibSystem/Cpu.cpp new file mode 100644 index 0000000..3d39f9f --- /dev/null +++ b/Source/Core/LibSystem/Cpu.cpp @@ -0,0 +1,247 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "System.h" + +namespace Tegenaria +{ + // + // Retrieve number of CPU cores installed on system. + // + + int SystemGetCpuCores() + { + DBG_ENTER3("SystemGetCpuNumber"); + + static int cpuCount = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + if (cpuCount == -1) + { + SYSTEM_INFO si = {0}; + + GetSystemInfo(&si); + + cpuCount = si.dwNumberOfProcessors; + } + } + + // + // Linux, MacOS. + // + + #else + { + cpuCount = sysconf(_SC_NPROCESSORS_ONLN); + } + #endif + + DBG_LEAVE3("SystemGetCpuNumber"); + + return cpuCount; + } + + // + // Run native cpuid instruction. + // + // func - CPU id function, see INTEL or AMD manual for more (IN). + // eax - copy of returned eax register (OUT). + // ebx - copy of returned ebx register (OUT). + // ecx - copy of returned ecx register (OUT). + // edx - copy of returned edx register (OUT). + // + + void SystemCpuId(unsigned int func, unsigned int *eax, + unsigned int *ebx, unsigned int *ecx, unsigned int *edx) + { + DBG_ENTER3("SystemCpuId"); + + static int firstCall = 1; + + static unsigned int cachedEax = 0; + static unsigned int cachedEbx = 0; + static unsigned int cachedEcx = 0; + static unsigned int cachedEdx = 0; + + // + // Check args. + // + + FAILEX(eax == NULL, "ERROR: eax paramater cannot be NULL in SystemCpuId().\n"); + FAILEX(ebx == NULL, "ERROR: ebx paramater cannot be NULL in SystemCpuId().\n"); + FAILEX(ecx == NULL, "ERROR: ecx paramater cannot be NULL in SystemCpuId().\n"); + FAILEX(edx == NULL, "ERROR: edx paramater cannot be NULL in SystemCpuId().\n"); + + // + // If already called use cached values. + // + + if (firstCall == 0) + { + *eax = cachedEax; + *ebx = cachedEbx; + *ecx = cachedEcx; + *edx = cachedEdx; + } + + // + // First call. Run cpuid instruction. + // + + else + { + // + // Sun or unknown CPU. + // + + #if defined(__sun) || (!defined(__i386) && !defined(__x86_64)) + { + *eax = 0; + *ebx = 0; + *ecx = 0; + *edx = 0; + + Error("ERROR: SystemCpuId() not implemented on this platform.\n"); + } + + // + // i386 and AMD64. + // + + #else + { + *eax = func; + + // + // AMD64. + // + + #if defined(__x86_64) + { + __asm volatile + ( + "cpuid;" + "mov %%ebx, %%esi;" + :"+a" (*eax), "=S" (*ebx), "=c" (*ecx), "=d" (*edx) + : + :"ebx" + ); + } + #endif + + // + // i386. + // + + #if defined(__i386) + { + __asm volatile + ( + "mov %%ebx, %%edi;" + "cpuid;" + "mov %%ebx, %%esi;" + "mov %%edi, %%ebx;" + :"+a" (*eax), "=S" (*ebx), "=c" (*ecx), "=d" (*edx) + : + :"edi" + ); + } + #endif + } + #endif + + // + // Cache result to avoid call cpuid at next calls. + // + + cachedEax = *eax; + cachedEbx = *ebx; + cachedEcx = *ecx; + cachedEdx = *edx; + + firstCall = 0; + } + + // + // Error handler. + // + + fail: + + return; + } + + // + // Check does current running CPU has SSE3 extension. + // + + int SystemCpuHasSSE3() + { + unsigned int eax; + unsigned int ebx; + unsigned int ecx; + unsigned int edx; + + SystemCpuId(1, &eax, &ebx, &ecx, &edx); + + return (ecx & SYSTEM_SSE3_AVAILABLE); + } + + // + // Check does current running CPU has SSE2 extension. + // + + int SystemCpuHasSSE2() + { + unsigned int eax; + unsigned int ebx; + unsigned int ecx; + unsigned int edx; + + SystemCpuId(1, &eax, &ebx, &ecx, &edx); + + return (edx & SYSTEM_SSE2_AVAILABLE); + } + + // + // Check does current running CPU has MMX extension. + // + + int SystemCpuHasMMX() + { + unsigned int eax; + unsigned int ebx; + unsigned int ecx; + unsigned int edx; + + SystemCpuId(1, &eax, &ebx, &ecx, &edx); + + return (edx & SYSTEM_MMX_AVAILABLE); + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibSystem/Environment.cpp b/Source/Core/LibSystem/Environment.cpp new file mode 100644 index 0000000..5be653c --- /dev/null +++ b/Source/Core/LibSystem/Environment.cpp @@ -0,0 +1,125 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "System.h" + +namespace Tegenaria +{ + // + // Retrieve all environment variables as string |-> string map. + // + // env - std string to string map, where to store retrieved + // environment block (OUT). + // + // RETURNS: 0 if OK. + // + + int SystemGetEnvironmentBlock(map &env) + { + DBG_ENTER("SystemGetEnvironment"); + + int exitCode = -1; + + env.clear(); + + char *delim = NULL; + char *tmp = NULL; + char *lvalue = NULL; + char *rvalue = NULL; + char *ptr = NULL; + + // + // Windows. + // + + #ifdef WIN32 + { + char *block = GetEnvironmentStrings(); + + ptr = block; + + while(*ptr) + { + tmp = strdup(ptr); + + delim = strchr(tmp + 1, '='); + + if (delim) + { + *delim = 0; + + lvalue = tmp; + rvalue = delim + 1; + + env[lvalue] = rvalue; + } + + free(tmp); + + ptr = strchr(ptr, 0) + 1; + } + + FreeEnvironmentStrings(block); + } + + // + // Linux. + // + + #else + { + extern char **environ; + + for (int i = 0; environ[i]; i++) + { + tmp = strdup(environ[i]); + + delim = strchr(tmp, '='); + + if (delim) + { + *delim = 0; + + lvalue = tmp; + rvalue = delim + 1; + + env[lvalue] = rvalue; + } + + free(tmp); + } + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + DBG_LEAVE("SystemGetEnvironment"); + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibSystem/Example01-simple/Main.cpp b/Source/Core/LibSystem/Example01-simple/Main.cpp new file mode 100644 index 0000000..2574c78 --- /dev/null +++ b/Source/Core/LibSystem/Example01-simple/Main.cpp @@ -0,0 +1,58 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include + +using namespace Tegenaria; + +int main() +{ + int64_t bytesFree = SystemGetFreeMemory(); + int64_t bytesUsed = SystemGetUsedMemory(); + + char machineName[128] = {0}; + char clientId[128] = {0}; + char user[128] = {0}; + + SystemGetMachineName(machineName, sizeof(machineName)); + + SystemGenerateClientId(clientId, sizeof(clientId)); + + SystemGetCurrentUser(user, sizeof(user)); + + printf("OS : %s.\n", SystemGetOsName()); + printf("OS version : %s.\n", SystemGetOsVersionString()); + printf("Machine name : %s.\n", machineName); + printf("Client ID : %s.\n", clientId); + printf("Memory free : %lf MB.\n", bytesFree / 1024.0 / 1024.0); + printf("Memory used : %lf MB.\n", bytesUsed / 1024.0 / 1024.0); + printf("CPU cores : %d.\n", SystemGetCpuCores()); + printf("MMX available : %s.\n", SystemCpuHasMMX() ? "yes" : "no"); + printf("SSE2 available : %s.\n", SystemCpuHasSSE2() ? "yes" : "no"); + printf("SSE3 available : %s.\n", SystemCpuHasSSE3() ? "yes" : "no"); + printf("Current user : %s.\n", user); + printf("Admin status : %d.\n", SystemCheckForAdmin()); +} diff --git a/Source/Core/LibSystem/Example01-simple/qcbuild.src b/Source/Core/LibSystem/Example01-simple/qcbuild.src new file mode 100644 index 0000000..dc9ccc2 --- /dev/null +++ b/Source/Core/LibSystem/Example01-simple/qcbuild.src @@ -0,0 +1,30 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSystem-example01-simple + +CXXSRC = Main.cpp +DEPENDS = LibSystem +LIBS = -lsystem -lstr -ldebug diff --git a/Source/Core/LibSystem/File.cpp b/Source/Core/LibSystem/File.cpp new file mode 100644 index 0000000..d01d48b --- /dev/null +++ b/Source/Core/LibSystem/File.cpp @@ -0,0 +1,153 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "System.h" + +namespace Tegenaria +{ + // + // Retrieve current limit of allowed opened FD for current user. + // + // RETURNS: Current set FD limit + // or -1 if error. + // + + int SystemGetFdLimit() + { + Error("SystemGetFdLimit() not implemented.\n"); + + return -1; + } + + // Set limit of maximum opened FD for current user. + // + // limit - new limit to set (IN). + // + // RETURNS: 0 if OK. + // + + int SystemSetFdLimit(int limit) + { + DBG_ENTER3("SystemSetFDLimit"); + + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + Error("SystemSetFDLimit not implemented on this platform.\n"); + } + + // + // Linux. + // + + #else + + // + // Check and change if needed the per-user limit of open files + // + + struct rlimit limitstruct; + + if(getrlimit(RLIMIT_NOFILE,&limitstruct) == -1) + { + Error("Could not establish user limits of open files."); + + goto fail; + } + + DEBUG1("Polled user limits for maximum number of open files:" + " soft: %d; hard: %d\n", (int) limitstruct.rlim_cur, (int) limitstruct.rlim_max); + + if(limitstruct.rlim_max < limit) + { + // The maximum value of the maximum number of open files is currently to low. + // We can try to increase this, but this probably will only work as root. + // A better durable solution is to use the /etc/security/limits.conf + // + // Attempt to increase the limits + + limitstruct.rlim_cur = limit; + limitstruct.rlim_max = limit; + + if(setrlimit(RLIMIT_NOFILE,&limitstruct) == -1) + { + Error("Could not increase hard user limit of open files to %d.\n" + "You can either try to run this program as root, or more recommended,\n" + "change the user limits on the system (e.g. /etc/security.limits.conf)\n", limit); + + goto fail; + } + + DEBUG1("Changed hard & soft limit to %d.\n", limit); + } + else if (limitstruct.rlim_cur < limit) + { + // + // The maximum limit is high enough, but the current limit might not be. + // We should be able to increase this. + // + + limitstruct.rlim_cur = limit; + + if(setrlimit(RLIMIT_NOFILE,&limitstruct) == -1) + { + Error("Could not increase soft user limit of open files to %d.\n" + "You can either try to run this program as root, or more recommended,\n" + "change the user limits on the system (e.g. /etc/security.limits.conf)\n", limit); + + goto fail; + } + + DEBUG1("Changed soft limit to %d\n", limit); + } + else + { + DEBUG1("Limit was high enough\n"); + } + + exitCode = 0; + + #endif + + // + // Error handler. + // + + fail: + + if (exitCode) + { + Error("ERROR: Cannot set up open FDs limit to %d.\n", limit); + } + + DBG_LEAVE3("SystemSetFdLimit"); + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibSystem/Memory.cpp b/Source/Core/LibSystem/Memory.cpp new file mode 100644 index 0000000..545a996 --- /dev/null +++ b/Source/Core/LibSystem/Memory.cpp @@ -0,0 +1,255 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "System.h" + +namespace Tegenaria +{ + // + // Retrieve number of free bytes available in system. + // + + int64_t SystemGetFreeMemory() + { + DBG_ENTER3("SystemGetFreeMemory"); + + int64_t bytesFree = 0.0; + + // + // Windows. + // + + #ifdef WIN32 + { + MEMORYSTATUSEX status = {0}; + + status.dwLength = sizeof(status); + + GlobalMemoryStatusEx(&status); + + bytesFree = status.ullAvailVirtual; + } + + // + // Linux, MacOS. + // + + #else + { + long pages = sysconf(_SC_PHYS_PAGES); + + long page_size = sysconf(_SC_PAGE_SIZE); + + bytesFree = int64_t(pages) * int64_t(page_size); + } + #endif + + DBG_LEAVE3("SystemGetFreeMemory"); + + return bytesFree; + } + + // + // Retrieve numer of bytes allocated by current running process. + // + + int64_t SystemGetUsedMemory() + { + DBG_ENTER3("SystemGetUsedMemory"); + + int64_t bytesUsed = 0; + + // + // Windows. + // + + #ifdef WIN32 + { + HANDLE process = NULL; + + PROCESS_MEMORY_COUNTERS pmc = {0}; + + // + // Open current running process. + // + + process = OpenProcess(PROCESS_QUERY_INFORMATION | PROCESS_VM_READ, + FALSE, GetCurrentProcessId()); + + if (process == NULL) + { + Error("ERROR: Cannot open current running process.\n" + "Error code is %d.\n", GetLastError()); + + goto fail; + } + + // + // Get memory info for opened process. + // + + if (GetProcessMemoryInfo(process, &pmc, sizeof(pmc)) == FALSE) + { + Error("ERROR: Cannot retrieve memory information for current process.\n" + "Error code is %d.\n", GetLastError()); + + goto fail; + } + + bytesUsed = pmc.WorkingSetSize + pmc.PagefileUsage; + + // + // Clean up. + // + + fail: + + CloseHandle(process); + } + + // + // Linux, MacOS. + // + + #else + { + FILE *f = NULL; + + char fname[1024] = {0}; + char line[1024] = {0}; + + int vmSizeFound = 0; + + char *delim1 = NULL; + char *delim2 = NULL; + char *vmSizeString = NULL; + char *unitString = NULL; + + // + // Open '/proc//status' file. + // + + snprintf(fname, sizeof(fname) - 1, "/proc/%d/status", getpid()); + + f = fopen(fname, "r"); + + FAILEX(f == NULL, "ERROR: Cannot open '%s' file.\n", fname); + + // + // Read file line by line until "VmSize" found or eof reached. + // + + while(vmSizeFound == 0 && fgets(line, sizeof(line) - 1, f)) + { + if (strstr(line, "VmSize") != NULL) + { + DEBUG3("SystemGetUsedMemory : VmSize found at line [%s]\n", line); + + vmSizeFound = 1; + } + } + + FAILEX(vmSizeFound == 0, "ERROR: VmSize row not found in '%s' file.\n", fname); + + // + // We expected 'VmSize: ' + // for example 'VmSize: 1024 kB' + // + + delim1 = strchr(line, ':'); + + FAILEX(delim1 == NULL, "ERROR: ':' delimer not found in line '%s'\n", line); + + delim2 = strchr(delim1, ' '); + + FAILEX(delim2 == NULL, "ERROR: ' ' delimer not found after ':' in line '%s'\n", line); + + // + // Split line into and . + // + + vmSizeString = delim1 + 1; + unitString = delim2 + 1; + + // + // Convert number of free memory from string into integer. + // + + bytesUsed = int64_t(atoi(vmSizeString)); + + // + // Lowerize unit string. + // + + StrLowerize(unitString); + + // + // Apply unit. + // + + if (strstr(unitString, "kb")) + { + DEBUG3("SystemGetUsedMemory : Detected kB unit.\n"); + + bytesUsed *= 1024; + } + else if (strstr(unitString, "mb")) + { + DEBUG3("SystemGetUsedMemory : Detected MB unit.\n"); + + bytesUsed *= 1024 * 1024; + } + else if (strstr(unitString, "gb")) + { + DEBUG3("SystemGetUsedMemory : Detected GB unit.\n"); + + bytesUsed *= 1024 * 1024 * 1024; + } + else if (strstr(unitString, "b")) + { + DEBUG3("SystemGetUsedMemory : Detected byte unit.\n"); + } + else + { + DEBUG1("WARNING: Unknown unit '%s' at line '%s'. Assumed bytes.\n", unitString, line); + } + + // + // Clean up. + // + + fail: + + if (f) + { + fclose(f); + } + } + #endif + + DBG_LEAVE3("SystemGetUsedMemory"); + + return bytesUsed; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibSystem/OS.cpp b/Source/Core/LibSystem/OS.cpp new file mode 100644 index 0000000..28dd80b --- /dev/null +++ b/Source/Core/LibSystem/OS.cpp @@ -0,0 +1,432 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "System.h" + +namespace Tegenaria +{ + // + // Retrieve name of current running OS (e.g. Windows). + // + + const char *SystemGetOsName() + { + // + // Windows. + // + + #ifdef WIN32 + { + return "Windows"; + } + #endif + + // + // Linux. + // + + #ifdef __linux__ + { + return "Linux"; + } + #endif + + // + // MacOS. + // + + #ifdef __APPLE__ + { + return "MacOS"; + } + #endif + + return "Unknown"; + } + + // + // Get version string of current running OS (e.g. XP 5.1.2600). + // + + const char *SystemGetOsVersionString() + { + static char version[1024] = {0}; + + if (version[0] == 0) + { + // + // Windows. + // + + #ifdef WIN32 + { + OSVERSIONINFOEX info = {0}; + + info.dwOSVersionInfoSize = sizeof(info); + + GetVersionEx(LPOSVERSIONINFO(&info)); + + sprintf(version, "[%d.%d.%d], Service Pack [%d.%d]", + info.dwMajorVersion, info.dwMinorVersion, + info.dwBuildNumber, (int) info.wServicePackMajor, + (int) info.wServicePackMinor); + } + #endif + + // + // Linux. + // + + #ifdef __linux__ + { + struct utsname utsnamebuf = {0}; + + if (uname(&utsnamebuf) == 0) + { + strncpy(version, utsnamebuf.version, sizeof(version) - 1); + } + else + { + Error("ERROR: Cannot retrieve OS version. Error code is %d.\n", errno); + } + } + #endif + + // + // MacOS. + // + + #ifdef __APPLE__ + { + strcpy(version, "Unknown"); + + Error("ERROR: SystemGetOsVersionString() not implemented on this platform.\n"); + } + #endif + } + + return version; + } + + // + // Get name of current running machine. + // + // machineName - buffer, where to store retrieved machine name (OUT). + // machineNameSize - size of machineName[] buffer in bytes (IN). + // + // RETURNS: 0 if OK. + // + + int SystemGetMachineName(char *machineName, int machineNameSize) + { + int exitCode = -1; + + // + // Check args. + // + + FAILEX(machineName == NULL, "ERROR: 'machineName' cannot be NULL in SystemGetMachineName().\n"); + FAILEX(machineNameSize < 1, "ERROR: 'machineNameSize' cannot be < 1 in SystemGetMachineName().\n"); + + // + // Windows. + // + + #ifdef WIN32 + { + FAIL(GetComputerName(machineName, (PDWORD) &machineNameSize) == FALSE); + } + + // + // Linux, MacOS. + // + + #else + { + FAIL(gethostname(machineName, machineNameSize)); + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot get machine name." + "Error code is : %d.\n", GetLastError()); + } + + return exitCode; + } + + // + // Generate unique string identyfing current running machine. + // Output string has format: + // + // X::, + // + // where: + // - X is 'W' for Windows, 'L' for Linux, 'M' for MacOS, + // 'A' for Android, 'i' for iOS, 'U' for unknown. + // + // - machineName is name of current machine retreved from + // SystemGetMachineName() + // + // - random-id is random 4 characters + // + // Example: W:Office-12345678:fsd2 + // + // clientId - buffer, where to store generated client ID (OUT). + // clientIdSize - size of clientId[] buffer in bytes (IN). + // + // RETURNS: 0 if OK. + // + + int SystemGenerateClientId(char *clientId, int clientIdSize) + { + int exitCode = -1; + + char machineName[65] = {0}; + + const char *os = NULL; + + char id[4 + 1] = {0}; + + static int randomInited = 0; + + // + // Check args. + // + + FAILEX(clientId == NULL, "ERROR: 'clientId' cannot be NULL in SystemGenerateClientId().\n"); + FAILEX(clientIdSize < 1, "ERROR: 'clientIdSize' cannot be < 1 in SystemGenerateClientId().\n"); + + // + // Initialize random generator on first call. + // + + if (randomInited == 0) + { + struct timeval tv; + + unsigned int seed; + + gettimeofday(&tv, NULL); + + seed = (tv.tv_sec * 1000) | (tv.tv_usec / 1000); + + srand(seed); + + randomInited = 1; + } + + // + // Get machine name. + // + + FAIL(SystemGetMachineName(machineName, sizeof(machineName))); + + for (int i = 0; machineName[i]; i++) + { + if (machineName[i] == ':') + { + machineName[i] = '-'; + } + } + + // + // Get current Running OS. + // + + os = SystemGetOsName(); + + // + // Generate random 4-characters random string. + // + + for (int i = 0; i < 4; i++) + { + int type = rand() % 3; + + switch(type) + { + // + // Big letter. + // + + case 0: + { + id[i] = 'A' + rand() % ('Z' - 'A'); + + break; + } + + // + // Low letter. + // + + case 1: + { + id[i] = 'a' + rand() % ('z' - 'a'); + + break; + } + + // + // Digits. + // + + case 2: + { + id[i] = '0' + rand() % ('9' - '0'); + + break; + } + } + } + + // + // Generate output 'X--id' string in caller buffer. + // + + snprintf(clientId, clientIdSize - 1, "%c:%s:%s", os[0], machineName, id); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot generate client ID.\n"); + } + + return exitCode; + } + + // + // Split client ID into OS (operating system), machine name and ID part. + // See SystemGenerateClientId() for more about client ID. + // + // os - OS part found in given client ID (OUT). + // machineName - machine name found in given client ID (OUT). + // id - random ID part found in given client ID (OUT). + // clientId - client ID to parse, generated by SystemGenerateClientId() before (IN). + // + // RETURNS: 0 if OK, + // -1 if error. + // + + int SystemParseClientId(string &os, string &machineName, + string &id, const char *clientId) + { + int exitCode = -1; + + char *input = NULL; + + char *delim1 = NULL; + char *delim2 = NULL; + + // + // Check args. + // + + FAILEX(clientId == NULL, "ERROR: 'clientId' cannot be NULL in SystemParseClientId().\n"); + + // + // Split client ID by ':' separator. + // We expected 'X:machinename:abcd' string here. + // + + input = strdup(clientId); + + delim1 = strchr(input, ':'); + + FAIL(delim1 == NULL); + + delim2 = strchr(delim1 + 1, ':'); + + FAIL(delim2 == NULL); + + *delim1 = 0; + *delim2 = 0; + + // + // Parse OS part. + // + + switch(input[0]) + { + case 'W': os = "Windows"; break; + case 'L': os = "Linux"; break; + case 'M': os = "MacOS"; break; + case 'A': os = "Android"; break; + case 'i': os = "iOS"; break; + + default: os = "Unknown"; + } + + // + // Parse machine name part. + // + + machineName = delim1 + 1; + + // + // Parse random id part. + // + + id = delim2 + 1; + + DEBUG3("Split client ID '%s' into [%s][%s][%s].\n", + os.c_str(), machineName.c_str(), id.c_str()); + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot parse client ID '%s'.\n", clientId); + } + + if (input) + { + free(input); + } + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibSystem/System.h b/Source/Core/LibSystem/System.h new file mode 100644 index 0000000..421b4d1 --- /dev/null +++ b/Source/Core/LibSystem/System.h @@ -0,0 +1,126 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_System_H +#define Tegenaria_Core_System_H + +// +// Includes. +// + +#ifdef WIN32 +# ifndef WINVER +# define WINVER 0x501 +# endif + +# include +# include +#else +# include +# include +# include +# include +#endif + +#include +#include +#include +#include +#include +#include +#include + +namespace Tegenaria +{ + using std::string; + using std::map; + + + // + // Defines. + // + + #define SYSTEM_MMX_AVAILABLE 0x0800000 // check edx + #define SYSTEM_SSE_AVAILABLE 0x1FFFFFF // check edx + #define SYSTEM_SSE2_AVAILABLE 0x4000000 // check edx + #define SYSTEM_SSE3_AVAILABLE 0x0000001 // check ecx + + #define SYSTEM_CLIENTID_MAX_SIZE 128 + + // + // Exported functions. + // + + // + // Memory info. + // + + int64_t SystemGetFreeMemory(); + int64_t SystemGetUsedMemory(); + + // + // CPU info. + // + + + int SystemGetCpuCores(); + + void SystemCpuId(unsigned int func, unsigned int *eax, + unsigned int *ebx, unsigned int *ecx, unsigned int *edx); + + int SystemCpuHasSSE3(); + int SystemCpuHasSSE2(); + int SystemCpuHasMMX(); + + // + // OS info. + // + + const char *SystemGetOsName(); + const char *SystemGetOsVersionString(); + + int SystemGetMachineName(char *machineName, int machineNameSize); + + int SystemGenerateClientId(char *clientId, int clientIdSize); + + int SystemParseClientId(string &os, string &machineName, + string &id, const char *clientId); + + // + // Info about current user. + // + + int SystemGetCurrentUser(char *user, int userSize); + + int SystemCheckForAdmin(); + + // + // Manage environment variables. + // + + int SystemGetEnvironmentBlock(map &env); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_System_H */ diff --git a/Source/Core/LibSystem/User.cpp b/Source/Core/LibSystem/User.cpp new file mode 100644 index 0000000..f9b36ff --- /dev/null +++ b/Source/Core/LibSystem/User.cpp @@ -0,0 +1,237 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "System.h" + +namespace Tegenaria +{ + // + // Check does current process has admin privilege. + // + // RETURNS: 0 if current process has admin privilege, + // 1 if current process has NO admin privilege, + // -1 if error. + // + + int SystemCheckForAdmin() + { + DBG_ENTER("SystemCheckForAdmin"); + + const int EXIT_ERROR = -1; + const int EXIT_NO_ADMIN = 1; + const int EXIT_OK = 0; + + int exitCode = EXIT_ERROR; + + // + // Windows. + // + + #ifdef WIN32 + { + + HANDLE token = NULL; + + PSID adminSid = NULL; + + TOKEN_GROUPS *tokenGroups = NULL;; + + DWORD cbSize = 0; + + SID_IDENTIFIER_AUTHORITY sidIdAuth = {SECURITY_NT_AUTHORITY}; + + int adminFound = 0; + + // + // Get current process token. + // + + DEBUG3("CheckForAdmin : retrieving current process token...\n"); + + FAIL(OpenProcessToken(GetCurrentProcess(), TOKEN_QUERY, &token) == FALSE); + + // + // Retrieve groups from token. + // + + DBG_MSG("CheckForAdmin : retrieving token's groups...\n"); + + GetTokenInformation(token, TokenGroups, NULL, 0, &cbSize); + + tokenGroups = (PTOKEN_GROUPS) LocalAlloc(LPTR, cbSize); + + FAIL(GetTokenInformation(token, TokenGroups, tokenGroups, + cbSize, &cbSize) == FALSE); + + // + // Create admin group SID for reference. + // + + DBG_MSG("CheckForAdmin : creating admin group SID...\n"); + + FAIL(AllocateAndInitializeSid(&sidIdAuth, 2, SECURITY_BUILTIN_DOMAIN_RID, + DOMAIN_ALIAS_RID_ADMINS, 0, 0, 0, 0, 0, + 0, &adminSid) == FALSE); + + // + // Search admin group SID in current process token. + // + + DBG_MSG("CheckForAdmin : searching for admin group...\n"); + + for (unsigned int i = 0; i < tokenGroups -> GroupCount && adminFound == 0; i++) + { + if (EqualSid(adminSid, tokenGroups -> Groups[i].Sid)) + { + adminFound = 1; + } + } + + // + // If admin account found, try some admin privilege function + // to exclude we are blocked by UAC. + // + + exitCode = EXIT_NO_ADMIN; + + if (adminFound) + { + DBG_MSG("CheckForAdmin : trying privilege function...\n"); + + SC_HANDLE scm = OpenSCManager(NULL, NULL, SC_MANAGER_ALL_ACCESS); + + if (scm) + { + CloseServiceHandle(scm); + + exitCode = EXIT_OK; + } + } + + // + // Clean up. + // + + fail: + + if (exitCode == EXIT_ERROR) + { + int err = GetLastError(); + + Error("ERROR: Cannot to check for admin privilege.\n" + "Error code is : %d.\n", err); + + if (err != 0) + { + exitCode = err; + } + } + + CloseHandle(token); + + if (adminSid) + { + FreeSid(adminSid); + } + + if (tokenGroups) + { + LocalFree(tokenGroups); + } + + DBG_MSG("CheckForAdmin : Admin check status : [%d]\n", exitCode); + } + + // + // Linux, MacOS. + // + + #else + { + DEBUG1("WARNING: CheckForAdmin() not implemented on Linux. Assumed success.\n"); + + exitCode = EXIT_OK; + } + #endif + + DBG_LEAVE("SystemCheckForAdmin"); + + return exitCode; + } + + // + // Retrieve name of current running user. + // + // user - buffer, where to store retrieved username (OUT). + // userSize - size of user[] buffer in bytes (IN). + // + // RETURNS: 0 if OK. + // + + int SystemGetCurrentUser(char *user, int userSize) + { + int exitCode = -1; + + // + // Check args. + // + + FAILEX(user == NULL, "ERROR: 'user' cannot be NULL in SystemGetCurrentUser().\n"); + FAILEX(userSize <= 0, "ERROR: 'userSize' cannot be <= 0 in SystemGetCurrentUser().\n"); + + // + // Windows. + // + + #ifdef WIN32 + { + FAIL(GetUserName(user, PDWORD(&userSize)) == FALSE); + } + + // + // Linux. + // + + #else + { + FAIL(getlogin_r(user, userSize)); + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot retrieve username. System error is %d.\n", GetLastError()); + } + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Core/LibSystem/qcbuild.src b/Source/Core/LibSystem/qcbuild.src new file mode 100644 index 0000000..b57bb16 --- /dev/null +++ b/Source/Core/LibSystem/qcbuild.src @@ -0,0 +1,40 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibSystem + +CXXSRC = Memory.cpp Cpu.cpp OS.cpp File.cpp User.cpp Environment.cpp +INC_DIR = Tegenaria +ISRC = System.h +LIBS = -lstr -ldebug + +PURPOSE = Platform independend API to retrieve info about system and OS. +AUTHOR = Sylwester Wysocki + +DEPENDS = LibStr LibDebug + +.section MinGW + LIBS += -lpsapi +.endsection diff --git a/Source/Core/LibThread/Example01-simple/Example01.cpp b/Source/Core/LibThread/Example01-simple/Example01.cpp new file mode 100644 index 0000000..a04686c --- /dev/null +++ b/Source/Core/LibThread/Example01-simple/Example01.cpp @@ -0,0 +1,89 @@ +/**************************************************************************/ +/* */ +/* This file is part of Tegenaria project. */ +/* Copyright (c) 2010, 2014 */ +/* Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), */ +/* Lukasz Bienczyk (lukasz.bienczyk@gmail.com). */ +/* */ +/* The Tegenaria library and any derived work however based on this */ +/* software are copyright of Sylwester Wysocki. Redistribution and use of */ +/* the present software is allowed according to terms specified in the */ +/* file LICENSE which comes in the source distribution. */ +/* */ +/* All rights reserved. */ +/* */ +/**************************************************************************/ + +#ifndef WIN32 +#include +#include +#include +#include +#endif + +#include +#include + +using namespace Tegenaria; + +int loop1(int *result) +{ + printf("ThreadExample: loop1 started with a parameter : %d\n", *result); + + for (int x = 0; x < 5; x++) + { + printf("ThreadExample: LOOP nr %d\n",int(x)); + + ThreadSleepSec(2); + } + + *result = 10; + + printf("ThreadExample: loop1 finished with a result : %d\n", *result); + + return *result; +} + +int main(int argc, char **argv) +{ + int port = 1337; + int timer = 0; + int finish = 15; + + ThreadHandle_t *thread = NULL; + + // + // Example of starting thread + // + + printf("\nThreadExample: Starting method loop.\n"); + + thread = ThreadCreate((ThreadEntryProto) loop1, &port); + + for (;;) + { + ThreadSleepSec(1); + + printf("ThreadExample: thread running: %d\n", ThreadIsRunning(thread)); + + if (ThreadIsRunning(thread) == 0) + { + printf("ThreadExample: thread is not running \n"); + + break; + } + + if (timer == finish) + { + printf("ThreadExample: going to kill thread \n"); + + ThreadKill(thread); + } + + timer++; + } + + printf("ThreadExample: FINISH THREAD EXAMPLE\n"); + + return 0; +} diff --git a/Source/Core/LibThread/Example01-simple/qcbuild.src b/Source/Core/LibThread/Example01-simple/qcbuild.src new file mode 100644 index 0000000..e84384a --- /dev/null +++ b/Source/Core/LibThread/Example01-simple/qcbuild.src @@ -0,0 +1,39 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk . # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibThread-example01-simple +CXXSRC = Example01.cpp + +LIBS = -lthread -ldebug -llock + +AUTHOR = Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), +AUTHOR += Lukasz Bienczyk (lukasz.bienczyk@gmail.com) + +.section Linux +LIBS += -lpthread +.endsection + +DEPENDS = LibThread diff --git a/Source/Core/LibThread/Example02-wait/Example02.cpp b/Source/Core/LibThread/Example02-wait/Example02.cpp new file mode 100644 index 0000000..6e3da6d --- /dev/null +++ b/Source/Core/LibThread/Example02-wait/Example02.cpp @@ -0,0 +1,92 @@ +/**************************************************************************/ +/* */ +/* This file is part of Tegenaria project. */ +/* Copyright (c) 2010, 2014 */ +/* Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), */ +/* Lukasz Bienczyk (lukasz.bienczyk@gmail.com). */ +/* */ +/* The Tegenaria library and any derived work however based on this */ +/* software are copyright of Sylwester Wysocki. Redistribution and use of */ +/* the present software is allowed according to terms specified in the */ +/* file LICENSE which comes in the source distribution. */ +/* */ +/* All rights reserved. */ +/* */ +/**************************************************************************/ + +#ifndef WIN32 +#include +#include +#include +#include +#endif + +#include +#include +#include + +using namespace Tegenaria; + +int WorkerMain(void *unused) +{ + int exitCode = 0; + + printf("-> worker\n"); + + printf("worker: Enter exit code and press enter to finish thread.\n"); + + scanf("%d", &exitCode); + + printf("<- worker\n"); + + return exitCode; +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_INIT("libthread-example02-wait.log"); + + ThreadHandle_t *thread = NULL; + + int threadResult = -1; + + // + // Create thread. + // + + printf("Creating worker thread...\n"); + + thread = ThreadCreate(WorkerMain); + + // + // Wait up to 5s to finish. + // + + if (ThreadWait(thread, &threadResult, 5000) == 0) + { + printf("Thread finished with status [%d].\n", threadResult); + } + + // + // If not finished witin 5s, kill it. + // + + else + { + printf("Thread timeout. Killing him!\n"); + + ThreadKill(thread); + } + + // + // Clean up. + // + + ThreadClose(thread); + + return 0; +} diff --git a/Source/Core/LibThread/Example02-wait/qcbuild.src b/Source/Core/LibThread/Example02-wait/qcbuild.src new file mode 100644 index 0000000..ff3b8ff --- /dev/null +++ b/Source/Core/LibThread/Example02-wait/qcbuild.src @@ -0,0 +1,41 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibThread-example02-wait +CXXSRC = Example02.cpp + +LIBS = -lthread -ldebug -llock + +AUTHOR = Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), +AUTHOR += Lukasz Bienczyk (lukasz.bienczyk@gmail.com), +AUTHOR += Sylwester Wysocki (sw143@wp.pl) + +.section Linux +LIBS += -lpthread +.endsection + +DEPENDS = LibThread diff --git a/Source/Core/LibThread/Internal.h b/Source/Core/LibThread/Internal.h new file mode 100644 index 0000000..39e8d2c --- /dev/null +++ b/Source/Core/LibThread/Internal.h @@ -0,0 +1,48 @@ +/**************************************************************************/ +/* */ +/* This file is part of Tegenaria project. */ +/* Copyright (c) 2010, 2014 */ +/* Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), */ +/* Lukasz Bienczyk (lukasz.bienczyk@gmail.com). */ +/* */ +/* The Tegenaria library and any derived work however based on this */ +/* software are copyright of Sylwester Wysocki. Redistribution and use of */ +/* the present software is allowed according to terms specified in the */ +/* file LICENSE which comes in the source distribution. */ +/* */ +/* All rights reserved. */ +/* */ +/**************************************************************************/ + +#include "Thread.h" + +#ifndef Tegenaria_Core_Thread_Internal_H +#define Tegenaria_Core_Thread_Internal_H + +namespace Tegenaria +{ + struct ThreadHandle_t + { + int id_; + int isRunning_; + int result_; + int isResultSet_; + + #ifdef WIN32 + HANDLE handle_; + #else + pthread_t handle_; + #endif + }; + + struct ThreadCtx_t + { + ThreadHandle_t *th_; + + ThreadEntryProto callerEntry_; + + void *callerCtx_; + }; +}; + +#endif /* Tegenaria_Core_Thread_Internal_H */ diff --git a/Source/Core/LibThread/Sleep.cpp b/Source/Core/LibThread/Sleep.cpp new file mode 100644 index 0000000..d2c8b33 --- /dev/null +++ b/Source/Core/LibThread/Sleep.cpp @@ -0,0 +1,92 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifdef WIN32 + #include +#else +# include +# include +# include +# include +# include +#endif + +namespace Tegenaria +{ + // -------------------------------------------------------------------------- + // + // Sleep functions + // + // -------------------------------------------------------------------------- + + // + // Sleep current thread for given number of microseconds. + // + + void ThreadSleepUs(int us) + { + // + // TODO: Handle us on Windows. + // + + #ifdef WIN32 + if (us < 1000) + { + Sleep(1); + } + else + { + Sleep(us / 1000); + } + #else + usleep(us); + #endif + } + + // + // Sleep current thread for given number of miliseconds. + // + + void ThreadSleepMs(int ms) + { + #ifdef WIN32 + Sleep(ms); + #else + usleep(ms * 1000); + #endif + } + + // + // Sleep current thread for given number of seconds. + // + + void ThreadSleepSec(double seconds) + { + #ifdef WIN32 + Sleep(seconds * 1000); + #else + usleep(seconds * 1000000); + #endif + } +} /* namespace Tehenaria */ diff --git a/Source/Core/LibThread/Thread.cpp b/Source/Core/LibThread/Thread.cpp new file mode 100644 index 0000000..a5eceb4 --- /dev/null +++ b/Source/Core/LibThread/Thread.cpp @@ -0,0 +1,576 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifdef WIN32 + #include +#else +# include +# include +# include +# include +# include +# include +#endif + +#include + +#include "Thread.h" +#include "Internal.h" + +namespace Tegenaria +{ + // + // Allocate new ProcessHandle_t struct basing on system handle/pid data. + // + // handle - underlying system handle (IN). + // id - underlying thread id (IN). + // + // RETURNS: Pointer to new allocated handle, + // or NULL if error. + // + + static ThreadHandle_t *_ThreadHandleAlloc(void *handle, int id) + { + ThreadHandle_t *rv = (ThreadHandle_t *) calloc(sizeof(ThreadHandle_t), 1); + + if (rv) + { + #ifdef WIN32 + rv -> handle_ = handle; + #else + rv -> handle_ = (pthread_t) handle; + #endif + + rv -> id_ = id; + } + else + { + Error("ERROR: Can't allocate ThreadHandle_t. Out of memory?\n"); + } + + return rv; + } + + // + // Internal wrapper over caller entry point to: + // - hide OS differences (entry point on Linux has different proto) + // - get signal, when thread finished in easy way + // + // + // + + static void *_ThreadEntryWrapperLinux(void *rawCtx) + { + ThreadCtx_t *ctx = (ThreadCtx_t *) rawCtx; + + // + // TODO: Handle thread result. + // + + if (ctx) + { + int result = ctx -> callerEntry_(ctx -> callerCtx_); + + free(ctx); + } + } + + // + // Create new thread. + // + // entry - thread entry point i.e. pointer to function, where code execution + // will be started (MUST be static) (IN). + // + // ctx - arbitrary data passed directly to the thread entry point. Can + // be NULL if not needed (IN/OPT). + // + // RETURNS: handle to new thread, + // or NULL if error. + // + + + ThreadHandle_t *ThreadCreate(ThreadEntryProto entry, void *ctx) + { + int exitCode = -1; + + ThreadHandle_t *rv = NULL; + + // + // Check args. + // + + FAILEX(entry == NULL, "ERROR: 'entry' can't be NULL in ThreadCreate().\n"); + + // + // Allocate new thread handle. + // + + rv = _ThreadHandleAlloc(NULL, -1); + + FAILEX(rv == NULL, "ERROR: Can't alloc thread space.\n"); + + // + // Dispatch to proper OS. + // + + #ifdef WIN32 + { + // + // Windows. + // + + HANDLE handle = NULL; + + DWORD id = 0; + + handle = CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE) entry, ctx, 0, &id); + + FAIL(handle == NULL); + + // + // Wrap low level {handle, threadId} into ThreadHandle_t. + // + + rv -> id_ = id; + rv -> handle_ = handle; + rv -> isRunning_ = 1; + + DBG_SET_ADD("thread", rv, "%d", id); + + DBG_MSG("Created thread ID# '%d', PTR '%0x', .\n", id, rv); + } + #else + { + // + // Linux, MacOS. + // + + pthread_t handle; + + ThreadCtx_t *threadCtx = NULL; + + // + // Allocate thread context to group all info in one structure. + // + + threadCtx = (ThreadCtx_t *) calloc(1, sizeof(ThreadCtx_t)); + + FAILEX(threadCtx == NULL, "ERROR: Can't allocate thread context."); + + // + // Fill up thread context structure. + // + + threadCtx -> th_ = rv; + threadCtx -> callerEntry_ = entry; + threadCtx -> callerCtx_ = ctx; + + // + // Create thread using wrapper entry point to hide different between + // Linux and Windows. + // + + FAILEX(pthread_create(&handle, NULL, _ThreadEntryWrapperLinux, (void *) threadCtx), + "ERROR: Can't create thread."); + + // + // Wrap low level {handle, threadId} into ThreadHandle_t. + // TODO: Get ThreadId on Linux. + // + + rv -> id_ = -1; + rv -> handle_ = handle; + rv -> isRunning_ = 1; + + DBG_SET_ADD("thread", rv, "%d", id); + + DBG_MSG("Created thread ID# '%d', PTR '%0x', .\n", -1, rv); + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create thread with entry '%p'.\n" + "System error code is : %d.\n", entry, GetLastError()); + + ThreadClose(rv); + } + + return rv; + } + + // + // Check is thread running. + // + // handle - thread handle returned by threadCreate() before (IN). + // + // RETURN: 1 if thread running, + // 0 if thread dead, + // -1 if error. + // + + int ThreadIsRunning(ThreadHandle_t *th) + { + #ifdef WIN32 + { + // + // Windows. + // + + if (WaitForSingleObject(th -> handle_, 0) == WAIT_TIMEOUT) + { + return 1; + } + else + { + th -> isRunning_ = 0; + + DBG_SET_MOVE("thread_terminated", "thread", th); + } + + return 0; + } + #else + { + // + // Linux, MacOS. + // + + Fatal("ThreadIsRunning() not implemented on this platform.\n"); + } + #endif + } + + // + // Close handle retrieved from ThreadCreate() before. + // + // WARNING: Function does NOT terminate thread if it still running. + // + // TIP#1: Use ThreadKill() if you want to terminate thread before close. + // TIP#2: Use ThreadWait() if you want to wait until thread finished before close. + // + // th - handle to thread retrieved from ThreadCreate() before (IN). + // + // RETURNS: 0 if thread finished before timeout, + // -1 if thread still working. + // + + int ThreadClose(ThreadHandle_t *th) + { + int exitCode = -1; + + // + // Check args. + // + + FAILEX(th == NULL, "ERROR: 'th' can't be NULL in ThreadClose().\n"); + + // + // Dispatch to proper OS. + // + + #ifdef WIN32 + { + // + // Windows. + // + + CloseHandle(th -> handle_); + + if (th -> id_ == GetCurrentThreadId()) + { + DBG_MSG("WARNING: Self join by thread ID#%d.\n", th -> id_); + } + + free(th); + + DBG_SET_DEL("thread", th); + DBG_SET_DEL("thread_terminated", th); + } + + // + // Linux, MacOS. + // + + #else + { + Fatal("ThreadClose() not implemented on this platform.\n"); + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot close handle '%p'.\n" + "System error code is : %d.\n", th, GetLastError()); + } + + return exitCode; + } + + // + // Unconditionaly terminate thread. + // + // th - thread handle retrieved from ThreadCrate() before (IN). + // + // RETURNS: 0 if thread terminated, + // -1 otherwise. + // + + int ThreadKill(ThreadHandle_t *th) + { + int exitCode = -1; + + // + // Check args. + // + + FAILEX(th == NULL, "ERROR: 'th' can't be NULL in ThreadKill().\n"); + + // + // Dispatch to proper OS. + // + + #ifdef WIN32 + { + // + // Windows. + // + + DBG_MSG3("Terminating thread handle '%p' ID #%d...\n", th, th -> id_); + + FAIL(TerminateThread(th -> handle_, 1) == FALSE); + + DBG_MSG("Thread handle '%p', ID #%d terminated.\n", th, th -> id_); + } + #else + { + // + // Linux, MacOS. + // + + Fatal("ThreadKill() not implemented on this platform.\n"); + } + #endif + + // + // Success, thread isn't running longer. + // + + th -> isRunning_ = 0; + + DBG_SET_MOVE("thread_terminated", "thread", th); + + exitCode = 0; + + // + // Error handler. + // + + fail: + + if (exitCode) + { + Error("ERROR: Cannot terminate thread '%p'.\n" + "System error code is : %d.\n", th, GetLastError()); + } + + return exitCode; + } + + // + // Wait until thread finished work or timeout. + // + // WARNING: Function DOES not clear resources allocated by thread event + // if thread terminated before funtion return. Use ThreadClose() + // to free thread handle, when no needed longer. + // + // th - thread handle retrieved from ThreadCreate() before (IN). + // + // result - buffer, where to store exit code returned by thread. + // Can be NULL if not needed (OUT/OPT). + // + // timeout - maximum time to wait im milisecond. Defaulted to infinite if + // skipped or set to -1. (IN/OPT). + // + // RETURNS: 0 if thread finished before timeout, + // 1 if thread still working, + // -1 if error. + // + + int ThreadWait(ThreadHandle_t *th, int *result, int timeoutMs) + { + int exitCode = -1; + + // + // Check args. + // + + FAILEX(th == NULL, "ERROR: 'th' can't be NULL in ThreadWait().\n"); + + // + // Dispatch to proper OS. + // + + #ifdef WIN32 + { + // + // Windows. + // + + DWORD waitResult = 0; + + // + // Fail if attemp to wait for current running thread detected. + // + + FAILEX(th -> id_ == GetCurrentThreadId(), + "ERROR: Can't wait for current running thread.\n"); + + DBG_MSG("Waiting for thread handle '%p', id #%d with timeout '%d' ms...\n", + th, th -> id_, timeoutMs); + + // + // Faill into wait loop. + // + + waitResult = WaitForSingleObject(th -> handle_, timeoutMs); + + // + // Wait loop finished. + // Dispatch basing on wait result. + // + + switch(waitResult) + { + // + // Thread finished. + // + + case WAIT_OBJECT_0: + { + DWORD code = 0; + + GetExitCodeThread(th -> handle_, &code); + + DBG_MSG("Thread handle '%p', ID#%d finished with result #%d.\n", + th, th -> id_, int(code)); + + DBG_SET_MOVE("thread_terminated", "thread", th); + + th -> isRunning_ = 0; + th -> result_ = (int) code; + th -> isResultSet_ = 1; + + if (result) + { + *result = code; + } + + exitCode = 0; + + break; + } + + // + // Timeout. + // + + case WAIT_TIMEOUT: + { + DBG_MSG("Thread handle '%p', ID#%d timeout.\n", th, th -> id_); + + exitCode = 1; + + break; + } + + // + // Unexpected error. + // + + default: + { + Error("ERROR: Unexpected ThreadWait() failed with code 0x%x.\n" + "Thread handle '%p', ID#%d.\n", + waitResult, th, th -> id_); + + exitCode = -1; + } + } + } + #else + { + // + // Linux, MacOS. + // + + Fatal("ThreadWait() not implemented on this platform.\n"); + } + #endif + + // + // Error handler. + // + + fail: + + if (exitCode == -1) + { + Error("ERROR: Cannot wait for thread handle '%p'.\n" + "System error code is : %d.\n", th, GetLastError()); + } + + return exitCode; + } + + // + // Get id of current running thread. + // + + int ThreadGetCurrentId() + { + #ifdef WIN32 + return GetCurrentThreadId(); + #else + Fatal("ThreadGetCurrentId() not implemented on this platform.\n"); + #endif + } + +} /* namespace Tegenaria */ diff --git a/Source/Core/LibThread/Thread.h b/Source/Core/LibThread/Thread.h new file mode 100644 index 0000000..c4bc98c --- /dev/null +++ b/Source/Core/LibThread/Thread.h @@ -0,0 +1,85 @@ +/**************************************************************************/ +/* */ +/* This file is part of Tegenaria project. */ +/* Copyright (c) 2010, 2014 */ +/* Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), */ +/* Lukasz Bienczyk (lukasz.bienczyk@gmail.com). */ +/* */ +/* The Tegenaria library and any derived work however based on this */ +/* software are copyright of Sylwester Wysocki. Redistribution and use of */ +/* the present software is allowed according to terms specified in the */ +/* file LICENSE which comes in the source distribution. */ +/* */ +/* All rights reserved. */ +/* */ +/**************************************************************************/ + +#ifndef Tegenaria_Core_Thread_h +#define Tegenaria_Core_Thread_h + +#include + +namespace Tegenaria +{ + // + // Typedef. + // + + typedef int (*ThreadEntryProto)(void *); + + // + // Structs. + // + + struct ThreadHandle_t; + + // + // Functions. + // + + ThreadHandle_t *ThreadCreate(ThreadEntryProto entry, void *ctx = NULL); + + int ThreadIsRunning(ThreadHandle_t *th); + + int ThreadWait(ThreadHandle_t *th, int *result = NULL, int timeoutMs = -1); + + int ThreadClose(ThreadHandle_t *th); + + int ThreadKill(ThreadHandle_t *th); + + // + // Template ThreadCrate() wrapper to hide type conversion for different + // pointers in entry function. Examples of correct entry point: + // + // int ThreadEntry(SomeMyClass *ctx); + // int ThreadEntry(void *ctx); + // int ThreadEntry(double *ctx); + // int ThreadEntry(string *ctx); + // etc... + // + // Generally: int ThreadEntry(T *ctx), + // where T is any data type (simple or complex). + // + + template ThreadHandle_t *ThreadCreate(int (*entry)(T *), void *ctx) + { + ThreadCreate((ThreadEntryProto) entry, ctx); + } + + // + // Sleep functions. + // + + void ThreadSleepUs(int ms); + void ThreadSleepMs(int ms); + void ThreadSleepSec(double seconds); + + // + // General utils. + // + + int ThreadGetCurrentId(); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Thread_H */ diff --git a/Source/Core/LibThread/qcbuild.src b/Source/Core/LibThread/qcbuild.src new file mode 100644 index 0000000..1ca7db2 --- /dev/null +++ b/Source/Core/LibThread/qcbuild.src @@ -0,0 +1,46 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibThread + +CXXSRC = Thread.cpp Sleep.cpp + +INC_DIR = Tegenaria +ISRC = Thread.h + +AUTHOR = Radoslaw Kolodziejczyk (radek.kolodziejczyk@gmail.com), +AUTHOR += Lukasz Bienczyk (lukasz.bienczyk@gmail.com) + +LIBS = -ldebug + +PURPOSE = Creating threads + +DEPENDS = LibDebug + +.section Linux +LIBS += -lpthread +.endsection diff --git a/Source/Core/LibVariant/Variant.cpp b/Source/Core/LibVariant/Variant.cpp new file mode 100644 index 0000000..5dd9a82 --- /dev/null +++ b/Source/Core/LibVariant/Variant.cpp @@ -0,0 +1,279 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 + +#include "Variant.h" + +namespace Tegenaria +{ + Variant::printAsText(FILE *f, unsigned int flags) + { + int rv = -1; + + switch(type_) + { + case VARIANT_STRING: + { + if (flags & VARIANT_PRINT_USE_QUOTATION) + { + rv = fprintf(f, "'%s'", dataString_ -> c_str()); + } + else + { + rv = fprintf(f, "%s", dataString_ -> c_str()); + } + + break; + } + + case VARIANT_INTEGER: rv = fprintf(f, "%d", valueInteger_); break; + case VARIANT_FLOAT: rv = fprintf(f, "%f", valueFloat_); break; + case VARIANT_DOUBLE: rv = fprintf(f, "%lf", valueDouble_); break; + case VARIANT_BOOLEAN: rv = fprintf(f, "%s", valueBoolean_ ? "true" : "false"); break; + case VARIANT_UNDEFINED: rv = fprintf(f, "undefined"); break; + case VARIANT_OBJECT: rv = fprintf(f, ""); break; + + case VARIANT_ARRAY: + { + const char *sep = ""; + + fprintf(f, "["); + + for (int i = 0; i < dataArray_ -> size(); i++) + { + fprintf(f, sep); + (*dataArray_)[i].printAsText(f, flags | VARIANT_PRINT_USE_QUOTATION); + sep = ", "; + } + + fprintf(f, "]"); + + break; + } + + case VARIANT_MAP: + { + map::iterator it; + + const char *sep = ""; + + fprintf(f, "{"); + + for (it = dataMap_ -> begin(); it != dataMap_ -> end(); it++) + { + fprintf(f, sep); + fprintf(f, "'%s': ", it -> first.c_str()); + it -> second.printAsText(f, flags | VARIANT_PRINT_USE_QUOTATION); + sep = ", "; + } + + fprintf(f, "}"); + + break; + } + + default: + { + Fatal("ERROR! Unhandled variant type [%d] while printing.\n", type_); + } + } + + return rv; + } + + const char *Variant::getTypeName() + { + const char *rv = "[error]"; + + switch (type_) + { + case VARIANT_STRING: rv = "string"; break; + case VARIANT_INTEGER: rv = "integer"; break; + case VARIANT_FLOAT: rv = "float"; break; + case VARIANT_DOUBLE: rv = "float"; break; + case VARIANT_BOOLEAN: rv = "boolean"; break; + case VARIANT_UNDEFINED: rv = "undefined"; break; + case VARIANT_ARRAY: rv = "array"; break; + case VARIANT_MAP: rv = "map"; break; + case VARIANT_OBJECT: rv = "object"; break; + + default: + { + Fatal("ERROR! Unhandled variant type [%d] while getting type name.\n", type_); + } + } + + return rv; + } + + int Variant::vaprint(FILE *f, unsigned int flags, int count, ...) + { + va_list ap; + + va_start(ap, count); + + const char *sep = ""; + + for (int i = 0; i < count; i++) + { + fprintf(f, sep); + + Variant *item = va_arg(ap, Variant*); + + item -> printAsText(f, flags); + + sep = " "; + } + + va_end(ap); + + fprintf(f, "\n"); + } + + const string Variant::toStdString() const + { + string rv; + + char buf[128]; + + switch(type_) + { + case VARIANT_UNDEFINED: rv = "undefined"; break; + case VARIANT_NULL: rv = "null"; break; + case VARIANT_INTEGER: _snprintf(buf, sizeof(buf) - 1, "%d", valueInteger_); rv = buf; break; + case VARIANT_FLOAT: _snprintf(buf, sizeof(buf) - 1, "%f", valueFloat_); rv = buf; break; + case VARIANT_DOUBLE: _snprintf(buf, sizeof(buf) - 1, "%lf", valueDouble_); rv = buf; break; + case VARIANT_STRING: rv = *dataString_; break; + case VARIANT_BOOLEAN: _snprintf(buf, sizeof(buf) - 1, "%s", valueBoolean_ ? "true" : "false"); rv = buf; break; + case VARIANT_PTR: rv = "[ptr]"; break; + case VARIANT_OBJECT: rv = "[object]"; break; + + case VARIANT_ARRAY: + { + const char *sep = ""; + + rv = "["; + + for (int i = 0; i < dataArray_ -> size(); i++) + { + rv += sep; + + if ((*dataArray_)[i].isString()) + { + rv += "'" + (*dataArray_)[i].toStdString() + "'"; + } + else + { + rv += (*dataArray_)[i].toStdString(); + } + + sep = ", "; + } + + rv += "]"; + + break; + } + + case VARIANT_MAP: + { + map::iterator it; + + const char *sep = ""; + + rv = "{"; + + for (it = dataMap_ -> begin(); it != dataMap_ -> end(); it++) + { + rv += sep; + rv += "'" + (it -> first) + "': "; + + if (it -> second.isString()) + { + rv += "'" + it -> second.toStdString() + "'"; + } + else + { + rv += it -> second.toStdString(); + } + + sep = ", "; + } + + rv += "}"; + + break; + } + + default: + { + Fatal("ERROR! Unhandled type [%d] in Variant::toString()\n", type_); + } + } + + return rv; + } + + const Variant Variant::toString() const + { + return Variant::createString(this -> toStdString().c_str()); + } + + const Variant Variant::toStringEscapedForC() const + { + string text = this -> toStdString(); + string escapedText = ""; + + for (int i = 0; i < text.size(); i++) + { + switch(text[i]) + { + case '\\': + { + escapedText += "\\\\"; + + break; + } + + case '"': + { + escapedText += "\\\""; + + break; + } + + default: + { + escapedText += text[i]; + } + } + } + + return Variant::createString(escapedText.c_str()); + } + + Variant Variant::characterPeek = Variant::createString("?"); + +} /* namespace Tegenaria */ diff --git a/Source/Core/LibVariant/Variant.h b/Source/Core/LibVariant/Variant.h new file mode 100644 index 0000000..86e70a6 --- /dev/null +++ b/Source/Core/LibVariant/Variant.h @@ -0,0 +1,983 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Variant_H +#define Tegenaria_Core_Variant_H + +#undef DEBUG + +#include +#include +#include +#include +#include + +#include +#include "VariantArray.h" +#include "VariantMap.h" +#include "VariantString.h" + +using namespace std; + +#define VARIANT_PRINT_USE_QUOTATION (1 << 0) + +#define VARIANT_DEFINE_ARITHMETIC_OP2(_FUNCTION_, _OP_) \ + Variant _FUNCTION_ (const Variant &y) \ + { \ + Variant rv = Variant::createUndefined(); \ + \ + const Variant &x = *this; \ + \ + switch (x.type_) \ + { \ + case VARIANT_INTEGER: \ + { \ + /* \ + * Integer _OP_ ... \ + */ \ + \ + switch (y.type_) \ + { \ + case VARIANT_INTEGER: \ + { \ + /* \ + * Integer _OP_ Integer = Integer \ + */ \ + \ + rv = Variant::createInteger(x.valueInteger_ _OP_ y.valueInteger_); \ + \ + break; \ + } \ + \ + case VARIANT_FLOAT: \ + { \ + /* \ + * Integer _OP_ Float = Float \ + */ \ + \ + rv = Variant::createFloat(float(x.valueInteger_) _OP_ y.valueFloat_); \ + \ + break; \ + } \ + \ + case VARIANT_DOUBLE: \ + { \ + /* \ + * Integer _OP_ Double = Double \ + */ \ + \ + rv = Variant::createDouble(double(x.valueInteger_) _OP_ y.valueDouble_); \ + \ + break; \ + } \ + } \ + \ + break; \ + } \ + \ + case VARIANT_FLOAT: \ + { \ + /* \ + * Float _OP_ ... \ + */ \ + \ + switch (y.type_) \ + { \ + case VARIANT_INTEGER: \ + { \ + /* \ + * Float _OP_ Integer = Float \ + */ \ + \ + rv = Variant::createFloat(x.valueFloat_ _OP_ float(y.valueInteger_)); \ + \ + break; \ + } \ + \ + case VARIANT_FLOAT: \ + { \ + /* \ + * Float _OP_ Float = Float \ + */ \ + \ + rv = Variant::createFloat(x.valueFloat_ _OP_ y.valueFloat_); \ + \ + break; \ + } \ + \ + case VARIANT_DOUBLE: \ + { \ + /* \ + * Float _OP_ Double = Double \ + */ \ + \ + rv = Variant::createDouble(double(x.valueFloat_) _OP_ y.valueDouble_); \ + \ + break; \ + } \ + } \ + \ + break; \ + } \ + \ + case VARIANT_DOUBLE: \ + { \ + /* \ + * Double _OP_ ... \ + */ \ + \ + switch (y.type_) \ + { \ + case VARIANT_INTEGER: \ + { \ + /* \ + * Double _OP_ Integer = Double \ + */ \ + \ + rv = Variant::createDouble(x.valueDouble_ _OP_ double(y.valueInteger_)); \ + \ + break; \ + } \ + \ + case VARIANT_FLOAT: \ + { \ + /* \ + * Double _OP_ Float = Double \ + */ \ + \ + rv = Variant::createDouble(x.valueDouble_ _OP_ double(y.valueFloat_)); \ + \ + break; \ + } \ + \ + case VARIANT_DOUBLE: \ + { \ + /* \ + * Double _OP_ Double = Double \ + */ \ + \ + rv = Variant::createDouble(x.valueDouble_ _OP_ y.valueDouble_); \ + \ + break; \ + } \ + } \ + \ + break; \ + } \ + } \ + \ + return rv; \ + } + +// +// Helper macro to define compare operators: <, >, <=, >= +// + +#define VARIANT_DEFINE_COMPARE_OP2(_FUNCTION_, _OP_) \ + Variant _FUNCTION_ (const Variant &y) \ + { \ + Variant rv = Variant::createUndefined(); \ + \ + const Variant &x = *this; \ + \ + switch (x.type_) \ + { \ + case VARIANT_INTEGER: \ + { \ + /* \ + * Integer _OP_ ... \ + */ \ + \ + switch (y.type_) \ + { \ + case VARIANT_INTEGER: \ + { \ + rv = Variant::createBoolean(x.valueInteger_ _OP_ y.valueInteger_); \ + \ + break; \ + } \ + \ + case VARIANT_FLOAT: \ + { \ + rv = Variant::createBoolean(float(x.valueInteger_) _OP_ y.valueFloat_); \ + \ + break; \ + } \ + \ + case VARIANT_DOUBLE: \ + { \ + rv = Variant::createBoolean(double(x.valueInteger_) _OP_ y.valueDouble_); \ + \ + break; \ + } \ + } \ + \ + break; \ + } \ + \ + case VARIANT_FLOAT: \ + { \ + /* \ + * Float _OP_ ... \ + */ \ + \ + switch (y.type_) \ + { \ + case VARIANT_INTEGER: \ + { \ + rv = Variant::createBoolean(x.valueFloat_ _OP_ float(y.valueInteger_)); \ + \ + break; \ + } \ + \ + case VARIANT_FLOAT: \ + { \ + rv = Variant::createBoolean(x.valueFloat_ _OP_ y.valueFloat_); \ + \ + break; \ + } \ + \ + case VARIANT_DOUBLE: \ + { \ + rv = Variant::createBoolean(double(x.valueFloat_) _OP_ y.valueDouble_); \ + \ + break; \ + } \ + } \ + \ + break; \ + } \ + \ + case VARIANT_DOUBLE: \ + { \ + /* \ + * Double _OP_ ... \ + */ \ + \ + switch (y.type_) \ + { \ + case VARIANT_INTEGER: \ + { \ + rv = Variant::createBoolean(x.valueDouble_ _OP_ double(y.valueInteger_)); \ + \ + break; \ + } \ + \ + case VARIANT_FLOAT: \ + { \ + rv = Variant::createBoolean(x.valueDouble_ _OP_ double(y.valueFloat_)); \ + \ + break; \ + } \ + \ + case VARIANT_DOUBLE: \ + { \ + rv = Variant::createBoolean(x.valueDouble_ _OP_ y.valueDouble_); \ + \ + break; \ + } \ + } \ + \ + break; \ + } \ + } \ + \ + return rv; \ + } + +namespace Tegenaria +{ + class Variant //: public Object + { + public: + + // TODO: Make it thread-safe. + static Variant characterPeek; + + enum Type + { + // + // Special cases - undefined and null. + // + + VARIANT_UNDEFINED, + VARIANT_NULL, + + // + // Primitives. + // + + VARIANT_INTEGER, + VARIANT_FLOAT, + VARIANT_DOUBLE, + VARIANT_STRING, + VARIANT_BOOLEAN, + + // + // Complex containers. + // + + VARIANT_PTR, + VARIANT_ARRAY, + VARIANT_MAP, + VARIANT_OBJECT + }; + + int type_; + int sharedDataRefCount_; + + union + { + int valueInteger_; + bool valueBoolean_; + double valueDouble_; + float valueFloat_; + + void *valuePtr_; + + VariantString *dataString_; + VariantArray *dataArray_; + VariantMap *dataMap_; + }; + + // + // Constructors and destructors. + // + + Variant(int type = VARIANT_UNDEFINED) : type_(type) //Object("Variant"), type_(VARIANT_UNDEFINED) + { + DEBUG3("Variant: Created variable PTR [%p]\n", this); + } + + Variant(const Variant &ref)// : Object("Variant") + { + switch (ref.type_) + { + case VARIANT_ARRAY: ref.dataArray_ -> addRef(); break; + case VARIANT_MAP: ref.dataMap_ -> addRef(); break; + case VARIANT_OBJECT: ref.dataMap_ -> addRef(); break; + case VARIANT_STRING: ref.dataString_ -> addRef(); break; + } + + memcpy(this, &ref, sizeof(ref)); + + DEBUG3("Variant: Duplicated variable PTR [%p] type [%d] into PTR [%p]\n", &ref, ref.type_, this); + } + + Variant &operator=(const Variant &ref) + { + switch (type_) + { + case VARIANT_ARRAY: dataArray_ -> release(); break; + case VARIANT_MAP: dataMap_ -> release(); break; + case VARIANT_OBJECT: dataMap_ -> release(); break; + case VARIANT_STRING: dataString_ -> release(); break; + } + + switch (ref.type_) + { + case VARIANT_ARRAY: ref.dataArray_ -> addRef(); break; + case VARIANT_MAP: ref.dataMap_ -> addRef(); break; + case VARIANT_OBJECT: ref.dataMap_ -> addRef(); break; + case VARIANT_STRING: ref.dataString_ -> addRef(); break; + } + + memcpy(this, &ref, sizeof(ref)); + + DEBUG3("Variant: Assigned variable PTR [%p] type [%d] into PTR [%p]\n", &ref, ref.type_, this); + + return *this; + } + + ~Variant() + { + DEBUG3("Variant: Going to destroy variable PTR [%p]\n", this); + + switch(type_) + { + case VARIANT_ARRAY: + { + dataArray_ -> release(); + + break; + } + + case VARIANT_MAP: + case VARIANT_OBJECT: + { + dataMap_ -> release(); + + break; + } + + case VARIANT_STRING: + { + dataString_ -> release(); + + break; + } + } + } + + // + // isXxx() to check current stored type. + // + + bool isInteger() {return (type_ == VARIANT_INTEGER);} + bool isBoolean() {return (type_ == VARIANT_BOOLEAN);} + bool isFloat() {return (type_ == VARIANT_FLOAT) || (type_ == VARIANT_DOUBLE);} + bool isPointer() {return (type_ == VARIANT_PTR);} + bool isString() {return (type_ == VARIANT_STRING);} + bool isArray() {return (type_ == VARIANT_ARRAY);} + bool isMap() {return (type_ == VARIANT_MAP);} + bool isObject() {return (type_ == VARIANT_OBJECT);} + + // + // createXxx() to crete new variable with selected type. + // + + static Variant createInteger(int value) + { + Variant rv; + rv.type_ = VARIANT_INTEGER; + rv.valueInteger_ = value; + return rv; + } + + static Variant createBoolean(bool value) + { + Variant rv; + rv.type_ = VARIANT_BOOLEAN; + rv.valueBoolean_ = value; + return rv; + } + + static Variant createFloat(double value) + { + return createDouble(value); + } + + static Variant createDouble(double value) + { + Variant rv; + rv.type_ = VARIANT_DOUBLE; + rv.valueDouble_ = value; + return rv; + } + + static Variant createPointer(void *ptr) + { + Variant rv; + rv.type_ = VARIANT_PTR; + rv.valuePtr_ = ptr; + return rv; + } + + static Variant createString(const char *text = NULL) + { + Variant rv; + + rv.type_ = VARIANT_STRING; + + if (text) + { + rv.dataString_ = new VariantString(text); + } + else + { + rv.dataString_ = new VariantString(); + } + + return rv; + } + + static Variant createUndefined() + { + Variant rv; + rv.type_ = VARIANT_UNDEFINED; + return rv; + } + + static Variant createNull() + { + Variant rv; + rv.type_ = VARIANT_NULL; + return rv; + } + + static Variant createArray() + { + Variant rv; + rv.type_ = VARIANT_ARRAY; + rv.dataArray_ = new VariantArray(); + return rv; + } + + static Variant createMap() + { + Variant rv; + rv.type_ = VARIANT_MAP; + rv.dataMap_ = new VariantMap(); + return rv; + } + + static Variant createObject(const char *className, const char *baseClassName = NULL) + { + Variant rv; + rv.type_ = VARIANT_OBJECT; + rv.dataMap_ = new VariantMap(); + (*rv.dataMap_)["__className"] = Variant::createString(className); + + if (baseClassName) + { + (*rv.dataMap_)["__baseClassName"] = Variant::createString(baseClassName); + } + + return rv; + } + + // + // Getters. + // + + const char *getTypeName(); + + // + // Two + // + + VARIANT_DEFINE_ARITHMETIC_OP2(defaultPlusOperator, +); + VARIANT_DEFINE_ARITHMETIC_OP2(operator-, -); + VARIANT_DEFINE_ARITHMETIC_OP2(operator*, *); + VARIANT_DEFINE_ARITHMETIC_OP2(defaultDivOperator, /); + + VARIANT_DEFINE_COMPARE_OP2(operator<, <); + VARIANT_DEFINE_COMPARE_OP2(operator>, >); + VARIANT_DEFINE_COMPARE_OP2(operator<=, <=); + VARIANT_DEFINE_COMPARE_OP2(operator>=, >=); + VARIANT_DEFINE_COMPARE_OP2(defaultEqOperator, ==); + + Variant operator/ (const Variant &y) + { + Variant rv; + + const Variant &x = *this; + + if (x.type_ == VARIANT_INTEGER && y.type_ == VARIANT_INTEGER) + { + // + // Special case: Integer / Integer = Float + // + + rv = Variant::createDouble(double(x.valueInteger_) / double(y.valueInteger_)); + } + else + { + // + // Default scenario - use C-like beheavior. + // + + rv = defaultDivOperator(y); + } + + return rv; + } + + Variant operator+ (const Variant &y) + { + Variant rv; + + const Variant &x = *this; + + if (x.type_ == VARIANT_STRING && y.type_ == VARIANT_STRING) + { + // + // Special case: Strings concatenation. + // + + rv = Variant::createString(); + + *(rv.dataString_) = *(x.dataString_); + *(rv.dataString_) += *(y.dataString_); + } + else + { + // + // Default scenario - use C-like beheavior. + // + + rv = defaultPlusOperator(y); + } + + return rv; + } + + Variant divAsInteger(const Variant &y) + { + const Variant &x = *this; + + Variant rv = defaultDivOperator(y); + + if (rv.type_ == VARIANT_FLOAT) + { + rv.type_ = VARIANT_INTEGER; + rv.valueInteger_ = int(rv.valueFloat_); + } + else if (rv.type_ == VARIANT_DOUBLE) + { + rv.type_ = VARIANT_INTEGER; + rv.valueInteger_ = int(rv.valueDouble_); + } + + return rv; + } + + Variant operator&& (const Variant &y) + { + const Variant &x = *this; + + Variant rv = Variant::createUndefined(); + + if (x.type_ == VARIANT_BOOLEAN && y.type_ == VARIANT_BOOLEAN) + { + rv.type_ = VARIANT_BOOLEAN; + rv.valueBoolean_ = x.valueBoolean_ && y.valueBoolean_; + } + + return rv; + } + + Variant operator|| (const Variant &y) + { + const Variant &x = *this; + + Variant rv = Variant::createUndefined(); + + if (x.type_ == VARIANT_BOOLEAN && y.type_ == VARIANT_BOOLEAN) + { + rv.type_ = VARIANT_BOOLEAN; + rv.valueBoolean_ = x.valueBoolean_ || y.valueBoolean_; + } + + return rv; + } + + Variant operator== (const Variant &y) + { + const Variant &x = *this; + + Variant rv = Variant::createBoolean(0); + + if (x.type_ == VARIANT_STRING && y.type_ == VARIANT_STRING) + { + // + // Special case - strings compare. + // + + rv = createBoolean((*x.dataString_) == (*y.dataString_)); + } + else if (x.type_ == VARIANT_BOOLEAN && y.type_ == VARIANT_BOOLEAN) + { + // + // Special case - (boolean == boolean) + // + + rv = createBoolean(x.valueBoolean_ == y.valueBoolean_); + } + else + { + // + // General case - use C-style buildin operator. + // + + if (defaultEqOperator(y).isTrue()) + { + rv.valueBoolean_ = true; + } + } + + return rv; + } + + Variant operator!= (const Variant &y) + { + Variant rv = operator==(y); + + rv.valueBoolean_ = !rv.valueBoolean_; + + return rv; + } + + Variant operator-() const + { + Variant rv = createUndefined(); + + switch(type_) + { + case VARIANT_INTEGER: + { + rv = createInteger(-this -> valueInteger_); + + break; + } + + case VARIANT_FLOAT: + { + rv = createFloat(-this -> valueFloat_); + + break; + } + + case VARIANT_DOUBLE: + { + rv = createDouble(-this -> valueDouble_); + + break; + } + } + + return rv; + } + + // + // Boolean helpers. + // + + bool isTrue() + { + return (type_ == VARIANT_BOOLEAN) && valueBoolean_; + } + + bool isFalse() + { + return (type_ == VARIANT_BOOLEAN) && (!valueBoolean_); + } + + // + // Array specific. + // + + const Variant arraySize() + { + Variant rv = createInteger(-1); + + if (type_ == VARIANT_ARRAY) + { + rv.valueInteger_ = dataArray_ -> size(); + } + + return rv; + } + + void arrayPush(const Variant &item) + { + if (type_ == VARIANT_ARRAY) + { + dataArray_ -> push_back(item); + } + } + + Variant &arrayAccess(size_t idx) + { + assert(type_ == VARIANT_ARRAY); + + if (dataArray_ -> size() <= idx) + { + dataArray_ -> resize(idx + 1); + } + + return (*dataArray_)[idx]; + } + + Variant &arrayAccess(const Variant &idx) + { + assert(idx.type_ == VARIANT_INTEGER); + + return arrayAccess(idx.valueInteger_); + } + + // + // Map specific. + // + + Variant &mapAccess(const string &key) + { + assert(type_ == VARIANT_MAP || type_ == VARIANT_OBJECT); + + return (*dataMap_)[key]; + } + + Variant &mapAccess(const Variant &key) + { + assert(key.type_ == VARIANT_STRING); + + return mapAccess(*key.dataString_); + } + + // + // String specific. + // + + Variant &stringAccess(const Variant &idx) + { + assert(idx.type_ == VARIANT_INTEGER); + assert(type_ == VARIANT_STRING); + + return stringAccess(idx.valueInteger_); + } + + Variant &stringAccess(size_t idx) + { + assert(type_ == VARIANT_STRING); + + if (dataString_ -> size() <= idx) + { + dataString_ -> resize(idx + 1); + } + + // TODO: Make it thread-safe. + (*characterPeek.dataString_)[0] = dataString_ -> at(idx); + return Variant::characterPeek; + } + + // + // Common helper for maps and arrays. + // + + Variant &access(const Variant &index) + { + switch(type_) + { + case VARIANT_MAP: return mapAccess(index); + case VARIANT_OBJECT: return mapAccess(index); + case VARIANT_ARRAY: return arrayAccess(index); + case VARIANT_STRING: return stringAccess(index); + + default: + { + Fatal("ERROR! array or map expected.\n"); + } + } + } + + // + // Common helper for objects. + // + + const Variant propertyGet(const Variant &name) + { + return mapAccess(name); + } + + void propertySet(const Variant &name, const Variant &value) + { + mapAccess(name) = value; + } + + const Variant getClassName() + { + return (*dataMap_)["__className"]; + } + + const Variant getBaseClassName() + { + return (*dataMap_)["__baseClassName"]; + } + + const string toStdString() const; + const Variant toString() const; + const Variant toStringEscapedForC() const; + + // + // I/O utils. + // + + int printAsText(FILE *f, unsigned int flags = 0); + + static int vaprint(FILE *f, unsigned int flags, int count, ...); + + // + // Generic len() wrapper (type-independent). + // + + Variant length() + { + int rv = 0; + + switch(type_) + { + case VARIANT_UNDEFINED: + case VARIANT_NULL: + { + rv = 0; + + break; + } + + case VARIANT_INTEGER: + case VARIANT_FLOAT: + case VARIANT_DOUBLE: + case VARIANT_BOOLEAN: + { + rv = 1; + + break; + } + + case VARIANT_STRING: + { + rv = dataString_ -> size(); + + break; + } + + case VARIANT_ARRAY: + { + rv = dataArray_ -> size(); + + break; + } + + case VARIANT_MAP: + { + rv = dataMap_ -> size(); + + break; + } + + case VARIANT_OBJECT: + { + Fatal("len(object) not implemented"); + + break; + } + } + + return Variant::createInteger(rv); + } + }; + +} /* Tegenaria */ + +#endif /* Tegenaria_Core_Variant_H */ diff --git a/Source/Core/LibVariant/VariantArray.h b/Source/Core/LibVariant/VariantArray.h new file mode 100644 index 0000000..8fc6ff0 --- /dev/null +++ b/Source/Core/LibVariant/VariantArray.h @@ -0,0 +1,51 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_VariantArray_H +#define Tegenaria_Core_VariantArray_H + +#include +#include +#include "Variant.h" + +using namespace Tegenaria; +using namespace std; + +namespace Tegenaria +{ + class Variant; + class DJB2Hasher; + + class VariantArray : public Object, public vector + { + public: + + VariantArray() : Object("VariantArray") + { + } + }; + +} /* Tegenaria */ + +#endif /* Tegenaria_Core_VariantArray_H */ diff --git a/Source/Core/LibVariant/VariantMap.h b/Source/Core/LibVariant/VariantMap.h new file mode 100644 index 0000000..1dd03b1 --- /dev/null +++ b/Source/Core/LibVariant/VariantMap.h @@ -0,0 +1,70 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_VariantMap_H +#define Tegenaria_Core_VariantMap_H + +#include +#include +#include +#include +#include "Variant.h" + +using namespace Tegenaria; +using namespace std; + +namespace Tegenaria +{ + class Variant; + + struct DJB2Hasher + { + std::size_t operator()(const string& key) const + { + unsigned long hash = 5381; + + int c; + int len = key.size(); + + for (int i = 0; i < len; i++) + { + hash = ((hash << 5) + hash) + key[i]; + } + + return hash; + } + }; + + class VariantMap : public Object, public map + { + public: + + VariantMap() : Object("VariantMap") + { + } + }; + +} /* Tegenaria */ + +#endif /* Tegenaria_Core_VariantMap_H */ diff --git a/Source/Core/LibVariant/VariantString.h b/Source/Core/LibVariant/VariantString.h new file mode 100644 index 0000000..6be305e --- /dev/null +++ b/Source/Core/LibVariant/VariantString.h @@ -0,0 +1,52 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_VariantString_H +#define Tegenaria_Core_VariantString_H + +#include +#include +#include "Variant.h" + +using namespace Tegenaria; +using namespace std; + +namespace Tegenaria +{ + class VariantString : public Object, public string + { + public: + + VariantString(const char *text) : Object("VariantString"), string(text) + { + } + + VariantString() : Object("VariantString"), string() + { + } + }; + +} /* Tegenaria */ + +#endif /* Tegenaria_Core_VariantString_H */ diff --git a/Source/Core/LibVariant/qcbuild.src b/Source/Core/LibVariant/qcbuild.src new file mode 100644 index 0000000..9f0faf6 --- /dev/null +++ b/Source/Core/LibVariant/qcbuild.src @@ -0,0 +1,36 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibVariant + +CXXSRC = Variant.cpp +INC_DIR = Tegenaria +ISRC = Variant.h VariantArray.h VariantMap.h VariantString.h +LIBS = -ldebug -lobject + +PURPOSE = Variant (mutable) variables +AUTHOR = Sylwester Wysocki + +DEPENDS = LibDebug LibObject diff --git a/Source/Core/Tegenaria-core.h b/Source/Core/Tegenaria-core.h new file mode 100644 index 0000000..eaeacb8 --- /dev/null +++ b/Source/Core/Tegenaria-core.h @@ -0,0 +1,58 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* LibLock, LibProcess, LibThread: */ +/* Copyright (c) 2010, 2014 Lukasz Bienczyk , */ +/* Radoslaw Kolodziejczyk , */ +/* Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_H +#define Tegenaria_Core_H + +#include "Debug.h" +#include "Args.h" +#include "Error.h" +#include "File.h" +#include "IOFifo.h" +#include "IOLoop.h" +#include "IOMixer.h" +#include "IOTime.h" +#include "Ipc.h" +#include "Job.h" +#include "Mutex.h" +#include "RequestPool.h" +#include "Semaphore.h" +#include "Math.h" +#include "Process.h" +#include "Reg.h" +#include "Runtime.h" +#include "Service.h" +#include "SSMap.h" +#include "Str.h" +#include "System.h" +#include "Thread.h" +#include "Object.h" +#include "Variant.h" + +#endif /* Tegenaria_Core_H */ diff --git a/Source/Core/qcbuild.src b/Source/Core/qcbuild.src new file mode 100644 index 0000000..28f51d5 --- /dev/null +++ b/Source/Core/qcbuild.src @@ -0,0 +1,55 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# LibLock, LibProcess, LibThread: # +# Copyright (c) 2010, 2014 Lukasz Bienczyk , # +# Radoslaw Kolodziejczyk , # +# Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +# +# Libs project's root. +# + +TYPE = MULTI_LIBRARY +TITLE = Tegenaria-core +AUTHOR = Sylwester Wysocki + +INC_DIR = Tegenaria +ISRC = Tegenaria-core.h + +DEPENDS = LibArgs LibDebug LibError LibFile LibIO LibIpc +DEPENDS += LibJob LibLock LibMath LibProcess LibSecure LibService +DEPENDS += LibReg LibRuntime LibSSMap LibStr LibSystem LibThread +DEPENDS += LibObject LibVariant + +.section MinGW + LIBS += -lpsapi + LIBS += -lstrptime-static +.endsection + +# +# Auto-documentation flags. +# + +AUTODOC_PRIVATE = 1 diff --git a/Source/Import/CrashReport/CrashReport.h b/Source/Import/CrashReport/CrashReport.h new file mode 100644 index 0000000..2657031 --- /dev/null +++ b/Source/Import/CrashReport/CrashReport.h @@ -0,0 +1,19 @@ +/**************************************************************************/ +/* */ +/* DIRLIGO */ +/* All rights reserved. */ +/* */ +/**************************************************************************/ + +#ifndef CrashReport_H +#define CrashReport_H + +#ifdef WIN32 +# include +# define CRASH_REPORT_INIT() LoadLibraryA("CrashReport.dll") +#else +# include +# define CRASH_REPORT_INIT() dlopen("./libcrashreport.so", RTLD_NOW); +#endif + +#endif /* CrashReport_H */ diff --git a/Source/Import/CrashReport/Example01-crash-test/Main.cpp b/Source/Import/CrashReport/Example01-crash-test/Main.cpp new file mode 100644 index 0000000..77fb76e --- /dev/null +++ b/Source/Import/CrashReport/Example01-crash-test/Main.cpp @@ -0,0 +1,40 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +void crash() +{ + int *p = NULL; + + *p = 1234; +} + +int main() +{ + CRASH_REPORT_INIT(); + + crash(); +} diff --git a/Source/Import/CrashReport/Example01-crash-test/qcbuild.src b/Source/Import/CrashReport/Example01-crash-test/qcbuild.src new file mode 100644 index 0000000..3a7a7e1 --- /dev/null +++ b/Source/Import/CrashReport/Example01-crash-test/qcbuild.src @@ -0,0 +1,30 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = CrashReport-example01-crash-test + +CXXSRC = Main.cpp + +DEPENDS = CrashReport \ No newline at end of file diff --git a/Source/Import/CrashReport/Example02-abort-test/Main.cpp b/Source/Import/CrashReport/Example02-abort-test/Main.cpp new file mode 100644 index 0000000..95c476e --- /dev/null +++ b/Source/Import/CrashReport/Example02-abort-test/Main.cpp @@ -0,0 +1,44 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include + +void abortTest() +{ + abort(); +} + +void foo() +{ + abortTest(); +} + +int main() +{ + CRASH_REPORT_INIT(); + + foo(); +} diff --git a/Source/Import/CrashReport/Example02-abort-test/qcbuild.src b/Source/Import/CrashReport/Example02-abort-test/qcbuild.src new file mode 100644 index 0000000..4edf8f2 --- /dev/null +++ b/Source/Import/CrashReport/Example02-abort-test/qcbuild.src @@ -0,0 +1,36 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = CrashReport-example02-abort-test + +CXXSRC = Main.cpp + +DEPENDS = CrashReport + +# +# Disable optimization. +# + +DEFINES = -O0 \ No newline at end of file diff --git a/Source/Import/CrashReport/LinuxHandler.cpp b/Source/Import/CrashReport/LinuxHandler.cpp new file mode 100644 index 0000000..4df3b2c --- /dev/null +++ b/Source/Import/CrashReport/LinuxHandler.cpp @@ -0,0 +1,219 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef WIN32 + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "md5.h" + +extern char *__progname; + +static int SignalCode = -1; + +// +// Print backtrace to file. +// +// fd - CRT file descriptor, where to write backtrace (IN). +// + +static void PrintBacktraceToFd(int fd) +{ + const int asize = 10; + + void *array[asize]; + + size_t size; + + size = backtrace(array, asize); + + if (size > 0) + { + backtrace_symbols_fd(array, size, fd); + } +} + +// +// Create ..dump file. +// + +static void CreateDumpFile() +{ + FILE *f = NULL; + + char fname[1024] = {0}; + + // + // Print log to ..dump + // + + if (getenv("CRASHREPORT_DIR")) + { + sprintf(fname, "%s/%d.%d.dump", getenv("CRASHREPORT_DIR"), (int) getpid(), (int) time(NULL)); + } + else + { + sprintf(fname, "%d.%d.dump", (int) getpid(), (int) time(NULL)); + } + + f = fopen(fname, "wt+"); + + if (f) + { + MD5 md5; + + const char *signalName = "Unknown"; + + struct timeval nowMs; + + int ms = 0; + + char timestamp[128] = {0}; + + time_t now = time(0); + + struct tm tstruct = *localtime(&now); + + struct utsname utsnamebuf = {0}; + + // + // Timestamp. + // + + gettimeofday(&nowMs, NULL); + + ms = nowMs.tv_usec / 1000; + + strftime(timestamp, sizeof(timestamp), "%F %X", &tstruct); + + fprintf(f, "Unhandled exception at %s %d.\n\n", timestamp, ms); + + fflush(f); + + // + // Process info. + // + + fprintf(f, "Process name : [%s].\n", __progname); + fprintf(f, "Process ID : [%d].\n", getpid()); + fprintf(f, "Thread ID : [%d].\n", (int) syscall (SYS_gettid)); + fprintf(f, "Image md5 : [%s].\n\n", md5.digestFile(__progname)); + + fflush(f); + + // + // Print signal info if any. + // + + switch(SignalCode) + { + case SIGABRT: signalName = "SIGABRT"; break; + case SIGFPE: signalName = "SIGFPE"; break; + case SIGILL: signalName = "SIGILL"; break; + case SIGINT: signalName = "SIGINT"; break; + case SIGSEGV: signalName = "SIGSEGV"; break; + case SIGTERM: signalName = "SIGTERM"; break; + } + + fprintf(f, "Signal : [%s]\n\n", signalName); + + fflush(f); + + // + // OS version info. + // + + if (uname(&utsnamebuf) == 0) + { + fprintf(f, "OS name : [%s].\n", utsnamebuf.sysname); + fprintf(f, "OS node name : [%s].\n", utsnamebuf.nodename); + fprintf(f, "OS vesion : [%s].\n", utsnamebuf.version); + fprintf(f, "OS machine : [%s].\n\n", utsnamebuf.machine); + } + else + { + fprintf(f, "OS info not available.\n\n"); + } + + fflush(f); + + // + // Architecture info. + // + + fprintf(f, "CPU cores : [%d].\n\n", (int) sysconf(_SC_NPROCESSORS_ONLN)); + + fflush(f); + + // + // Backtrace. + // + + PrintBacktraceToFd(fileno(f)); + + fflush(f); + + fclose(f); + } +} + +// +// Signal handler. Caller by OS when one of SIGXXX signal raised. +// + +static void SignalHandler(int signalCode) +{ + static int signalHandled = 0; + + if (signalHandled == 0) + { + signalHandled = 1; + + SignalCode = signalCode; + + CreateDumpFile(); + + exit(-1); + } +} + +// +// Install our handlers when shared library loaded. +// + +__attribute__((constructor)) void InitHandlers() +{ + signal(SIGABRT, SignalHandler); + signal(SIGSEGV, SignalHandler); +} + +#endif diff --git a/Source/Import/CrashReport/WindowsHandler.cpp b/Source/Import/CrashReport/WindowsHandler.cpp new file mode 100644 index 0000000..9fd4d24 --- /dev/null +++ b/Source/Import/CrashReport/WindowsHandler.cpp @@ -0,0 +1,717 @@ +/* + Copyright (c) 2010 , + Cloud Wu . All rights reserved. + + http://www.codingnow.com + + Use, modification and distribution are subject to the "New BSD License" + as listed at . + + filename: backtrace.c + + compiler: gcc 3.4.5 (mingw-win32) + + build command: gcc -O2 -shared -Wall -o backtrace.dll backtrace.c -lbfd -liberty -limagehlp + + how to use: Call LoadLibraryA("backtrace.dll"); at beginning of your program . + + */ + +#define WINVER 0x501 + +#include + +/* + +TODO: Temporary disabled due to missing bfd.h on new MinGW. + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "md5.h" + +using std::set; +using std::string; + +#define BUFFER_MAX (16*1024) + +char ProcessName[MAX_PATH] = {0}; +char ModuleDirectory[MAX_PATH] = {0}; + +LPEXCEPTION_POINTERS ExceptionPointers = NULL; + +set Modules; + +int SignalCode = -1; + +struct bfd_ctx +{ + bfd * handle; + asymbol ** symbol; +}; + +struct bfd_set +{ + char * name; + struct bfd_ctx * bc; + struct bfd_set *next; +}; + +struct find_info +{ + asymbol **symbol; + bfd_vma counter; + const char *file; + const char *func; + unsigned line; +}; + +struct output_buffer +{ + char * buf; + size_t sz; + size_t ptr; +}; + +// +// Get full directory, where current running module loaded. +// + +void GetCurrentModuleDirectory() +{ + int lastSlash = 0; + + GetModuleFileName(NULL, ModuleDirectory, sizeof(ModuleDirectory) - 1); + + // + // Remove filename from path. + // + + for (int i = 0; ModuleDirectory[i] && i < ModuleDirectory[i]; i++) + { + if (ModuleDirectory[i] == '\\' || ModuleDirectory[i] == '/') + { + lastSlash = i; + } + } + + ModuleDirectory[lastSlash] = 0; +} + +// +// Convert full path to file name only. +// E.g. it convert 'a\b\c\file.dll' to file.dll. +// + +const char *GetFileName(const char *path) +{ + int lastSlash = -1; + + for (int i = 0; path[i]; i++) + { + if (path[i] == '\\' || path[i] == '/') + { + lastSlash = i; + } + } + + if (lastSlash != -1) + { + return path + lastSlash + 1; + } + else + { + return path; + } +} + +static void output_init(struct output_buffer *ob, char * buf, size_t sz) +{ + ob->buf = buf; + ob->sz = sz; + ob->ptr = 0; + ob->buf[0] = '\0'; +} + +static void output_print(struct output_buffer *ob, const char * format, ...) +{ + if (ob->sz == ob->ptr) + return; + + ob->buf[ob->ptr] = '\0'; + va_list ap; + va_start(ap,format); + + vsnprintf(ob->buf + ob->ptr , ob->sz - ob->ptr , format, ap); + + va_end(ap); + + ob->ptr = strlen(ob->buf + ob->ptr) + ob->ptr; +} + +static void lookup_section(bfd *abfd, asection *sec, void *opaque_data) +{ + struct find_info *data = (struct find_info *) opaque_data; + + if (data->func) + return; + + if (!(bfd_get_section_flags(abfd, sec) & SEC_ALLOC)) + return; + + bfd_vma vma = bfd_get_section_vma(abfd, sec); + + if (data->counter < vma || vma + bfd_get_section_size(sec) <= data->counter) + return; + + bfd_find_nearest_line(abfd, sec, data->symbol, data->counter - vma, &(data->file), &(data->func), &(data->line)); +} + +static void find(struct bfd_ctx * b, DWORD offset, + const char **file, const char **func, unsigned *line) +{ + struct find_info data; + data.func = NULL; + data.symbol = b->symbol; + data.counter = offset; + data.file = NULL; + data.func = NULL; + data.line = 0; + + bfd_map_over_sections(b->handle, &lookup_section, &data); + if (file) { + *file = data.file; + } + if (func) { + *func = data.func; + } + if (line) { + *line = data.line; + } +} + +static int init_bfd_ctx(struct bfd_ctx *bc, + const char *procname, struct output_buffer *ob) +{ + bc -> handle = NULL; + bc -> symbol = NULL; + + bfd *b = bfd_openr(procname, 0); + + if (!b) + { + output_print(ob,"Failed to open bfd from (%s)\n" , procname); + + return 1; + } + + int r1 = bfd_check_format(b, bfd_object); + int r2 = bfd_check_format_matches(b, bfd_object, NULL); + int r3 = bfd_get_file_flags(b) & HAS_SYMS; + + if (!(r1 && r2 && r3)) + { + bfd_close(b); + + //output_print(ob,"Failed to init bfd from (%s)\n", procname); + + return 1; + } + + void *symbol_table; + + unsigned dummy = 0; + + if (bfd_read_minisymbols(b, FALSE, &symbol_table, &dummy) == 0) + { + if (bfd_read_minisymbols(b, TRUE, &symbol_table, &dummy) < 0) + { + free(symbol_table); + + bfd_close(b); + + output_print(ob, "Failed to read symbols from (%s)\n", procname); + + return 1; + } + } + + bc -> handle = b; + bc -> symbol = (asymbol **) symbol_table; + + return 0; +} + +static void close_bfd_ctx(struct bfd_ctx *bc) +{ + if (bc) + { + if (bc->symbol) + { + free(bc->symbol); + } + + if (bc->handle) + { + bfd_close(bc->handle); + } + } +} + +static struct bfd_ctx *get_bc(struct output_buffer *ob, + struct bfd_set *set, const char *procname) +{ + while(set->name) + { + if (strcmp(set->name , procname) == 0) + { + return set->bc; + } + + set = set->next; + } + + struct bfd_ctx bc; + + if (init_bfd_ctx(&bc, procname , ob)) + { + return NULL; + } + + set->next = (bfd_set *) calloc(1, sizeof(*set)); + + set -> bc = (bfd_ctx *) malloc(sizeof(struct bfd_ctx)); + + memcpy(set->bc, &bc, sizeof(bc)); + + set->name = strdup(procname); + + return set->bc; +} + +static void release_set(struct bfd_set *set) +{ + while(set) + { + struct bfd_set * temp = set->next; + + free(set->name); + + close_bfd_ctx(set->bc); + + free(set); + + set = temp; + } +} + +static void _backtrace(struct output_buffer *ob, struct bfd_set *set, + int depth , LPCONTEXT context) +{ + char procname[MAX_PATH]; + + GetModuleFileNameA(NULL, procname, sizeof procname); + + struct bfd_ctx *bc = NULL; + + STACKFRAME frame; + + strncpy(ProcessName, procname, sizeof(ProcessName) - 1); + + memset(&frame,0,sizeof(frame)); + + frame.AddrPC.Offset = context->Eip; + frame.AddrPC.Mode = AddrModeFlat; + frame.AddrStack.Offset = context->Esp; + frame.AddrStack.Mode = AddrModeFlat; + frame.AddrFrame.Offset = context->Ebp; + frame.AddrFrame.Mode = AddrModeFlat; + + HANDLE process = GetCurrentProcess(); + HANDLE thread = GetCurrentThread(); + + char symbol_buffer[sizeof(IMAGEHLP_SYMBOL) + 255]; + char module_name_raw[MAX_PATH]; + + while(StackWalk(IMAGE_FILE_MACHINE_I386, process, thread, &frame, + context, 0, SymFunctionTableAccess, SymGetModuleBase, 0)) + { + --depth; + + if (depth < 0) + { + break; + } + + IMAGEHLP_SYMBOL *symbol = (IMAGEHLP_SYMBOL *)symbol_buffer; + + symbol->SizeOfStruct = (sizeof *symbol) + 255; + + symbol->MaxNameLength = 254; + + DWORD module_base = SymGetModuleBase(process, frame.AddrPC.Offset); + + const char * module_name = "[unknown module]"; + + if (module_base && GetModuleFileNameA((HINSTANCE)module_base, module_name_raw, MAX_PATH)) + { + module_name = module_name_raw; + + bc = get_bc(ob, set, module_name); + + Modules.insert(module_name); + } + + const char * file = NULL; + const char * func = NULL; + unsigned line = 0; + + if (bc) + { + find(bc,frame.AddrPC.Offset,&file,&func,&line); + } + + if (file == NULL) + { + DWORD dummy = 0; + + if (SymGetSymFromAddr(process, frame.AddrPC.Offset, &dummy, symbol)) + { + file = symbol->Name; + } + else + { + file = ""; + } + } + + if (func == NULL) + { + if (file[0]) + { + output_print(ob, "0x%x : %s : %s \n", + frame.AddrPC.Offset, GetFileName(module_name), file); + } + else + { + output_print(ob, "0x%x : %s \n", + frame.AddrPC.Offset, GetFileName(module_name)); + } + } + else + { + output_print(ob, "0x%x : %s : %s (%d) : in function (%s) \n", + frame.AddrPC.Offset, GetFileName(module_name), file, line, func); + } + } +} + +static char * g_output = NULL; + +static LPTOP_LEVEL_EXCEPTION_FILTER g_prev = NULL; + +// +// Generate ..dump file. +// + +void CreateDumpFile() +{ + FILE *f = NULL; + + char fname[1024] = {0}; + + // + // Get path for current running process. + // + + GetModuleFileName(NULL, ProcessName, sizeof(ProcessName) - 1); + + // + // Print log to ..dump + // + + if (getenv("CRASHREPORT_DIR")) + { + sprintf(fname, "%s\\%d.%d.dump", getenv("CRASHREPORT_DIR"), GetCurrentProcessId(), time(NULL)); + } + else + { + sprintf(fname, "%s\\%d.%d.dump", ModuleDirectory, GetCurrentProcessId(), time(NULL)); + } + + f = fopen(fname, "wt+"); + + if (f) + { + MD5 md5; + + SYSTEMTIME st; + + OSVERSIONINFOEX ver = {0}; + + SYSTEM_INFO si = {0}; + + // + // Timestamp. + // + + GetSystemTime(&st); + + fprintf(f, "Unhandled exception at %d-%02d-%02d %02d:%02d:%02d %03d\n\n", + (int) st.wYear, (int) st.wMonth, (int) st.wDay, + (int) st.wHour, (int) st.wMinute, + (int) st.wSecond, (int) st.wMilliseconds); + + fflush(f); + + // + // Process info. + // + + fprintf(f, "Process name : [%s].\n", ProcessName); + fprintf(f, "Process ID : [%d].\n", GetCurrentProcessId()); + fprintf(f, "Thread ID : [%d].\n", GetCurrentThreadId()); + + if (ProcessName[0]) + { + fprintf(f, "Image md5 : [%s].\n\n", md5.digestFile(ProcessName)); + } + else + { + fprintf(f, "Image md5 : [unknown].\n\n"); + } + + fflush(f); + + // + // Print exceptions pointers if any. + // + + if (ExceptionPointers) + { + fprintf(f, "Exception code : [0x%x].\n", ExceptionPointers -> ExceptionRecord -> ExceptionCode); + fprintf(f, "Exception fags : [0x%x].\n", ExceptionPointers -> ExceptionRecord -> ExceptionFlags); + fprintf(f, "Exception address : [%p].\n\n", ExceptionPointers -> ExceptionRecord -> ExceptionAddress); + } + + // + // Print signal info if any. + // + + if (SignalCode != -1) + { + const char *signalName = "Unknown"; + + switch(SignalCode) + { + case SIGABRT: signalName = "SIGABRT"; break; + case SIGFPE: signalName = "SIGFPE"; break; + case SIGILL: signalName = "SIGILL"; break; + case SIGINT: signalName = "SIGINT"; break; + case SIGSEGV: signalName = "SIGSEGV"; break; + case SIGTERM: signalName = "SIGTERM"; break; + } + + fprintf(f, "Signal : [%s]\n\n", signalName); + + fflush(f); + } + + // + // OS version info. + // + + ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX); + + GetVersionEx((OSVERSIONINFO *) &ver); + + fprintf(f, "OS version : [%d.%d.%d].\n", ver.dwMajorVersion, ver.dwMinorVersion, ver.dwBuildNumber); + fprintf(f, "OS platform ID : [%d].\n", ver.dwPlatformId); + fprintf(f, "OS CSD version : [%s].\n", ver.szCSDVersion); + fprintf(f, "OS SP version : [%d.%d].\n", ver.wServicePackMajor, ver.wServicePackMinor); + fprintf(f, "OS suite mask : [%d].\n", (int) ver.wSuiteMask); + fprintf(f, "OS product type : [%d].\n\n", (int) ver.wProductType); + + fflush(f); + + // + // Architecture info. + // + + GetNativeSystemInfo(&si); + + fprintf(f, "CPU architecture : "); + + fflush(f); + + switch(si.wProcessorArchitecture) + { + case PROCESSOR_ARCHITECTURE_AMD64: fprintf(f, "[x64]\n"); break; + case PROCESSOR_ARCHITECTURE_ARM: fprintf(f, "[ARM]\n"); break; + case PROCESSOR_ARCHITECTURE_IA64: fprintf(f, "[IA64]\n"); break; + case PROCESSOR_ARCHITECTURE_INTEL: fprintf(f, "[i386]\n"); break; + + default: fprintf(f, "[Unknown]\n"); break; + } + + fprintf(f, "Number of cores : [%d].\n\n", si.dwNumberOfProcessors); + + fflush(f); + + // + // Backtrace. + // + + if (g_output) + { + fprintf(f, g_output); + } + + fflush(f); + + // + // MD5 sums of used modules. + // + + fprintf(f, "\nModules MD5 sums:\n"); + + for (set::iterator it = Modules.begin(); it != Modules.end(); it++) + { + fprintf(f, " [%s] : [%s]\n", md5.digestFile((char *) it -> c_str()), it -> c_str()); + } + + fclose(f); + } + +} + +// +// Handler for abort like signals. +// + +void SignalHandler(int signal) +{ + SignalCode = signal; + + // + // Prepare backtrace. + // + + RaiseException(0x666, 0, 0, NULL); +} + +// +// Crash handler. +// + +static LONG WINAPI exception_filter(LPEXCEPTION_POINTERS info) +{ + struct output_buffer ob; + + output_init(&ob, g_output, BUFFER_MAX); + + if (!SymInitialize(GetCurrentProcess(), 0, TRUE)) + { + output_print(&ob, "Failed to init symbol context\n"); + } + else + { + bfd_init(); + + struct bfd_set *set = (bfd_set *) calloc(1,sizeof(*set)); + + _backtrace(&ob , set , 128 , info->ContextRecord); + + release_set(set); + + SymCleanup(GetCurrentProcess()); + } + + ExceptionPointers = info; + + fputs(g_output, stderr); + + CreateDumpFile(); + + exit(1); + + return 0; +} + +static void backtrace_register(void) +{ + if (g_output == NULL) + { + g_output = (char *) malloc(BUFFER_MAX); + + g_prev = SetUnhandledExceptionFilter(exception_filter); + } +} + +static void backtrace_unregister(void) +{ + if (g_output) + { + free(g_output); + + SetUnhandledExceptionFilter(g_prev); + + g_prev = NULL; + g_output = NULL; + } +} +*/ + +extern "C" BOOL WINAPI DllMain(HANDLE hinstDLL, + DWORD dwReason, LPVOID lpvReserved) +{ +/* + switch (dwReason) + { + case DLL_PROCESS_ATTACH: + { + // + // Get directory where current binary stored. + // + + GetCurrentModuleDirectory(); + + // + // Crash handler. + // + + backtrace_register(); + + // + // Abort handler. + // + + typedef void (*SignalHandlerPointer)(int); + + SignalHandlerPointer previousHandler; + + previousHandler = signal(SIGABRT, SignalHandler); + + break; + } + + case DLL_PROCESS_DETACH: + { + backtrace_unregister(); + + break; + } + } +*/ + return TRUE; +} diff --git a/Source/Import/CrashReport/md5.h b/Source/Import/CrashReport/md5.h new file mode 100644 index 0000000..b1d2d8e --- /dev/null +++ b/Source/Import/CrashReport/md5.h @@ -0,0 +1,388 @@ +#ifndef MD5_H +#define MD5_H + +// Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All +// rights reserved. + +// License to copy and use this software is granted provided that it +// is identified as the "RSA Data Security, Inc. MD5 Message-Digest +// Algorithm" in all material mentioning or referencing this software +// or this function. +// +// License is also granted to make and use derivative works provided +// that such works are identified as "derived from the RSA Data +// Security, Inc. MD5 Message-Digest Algorithm" in all material +// mentioning or referencing the derived work. +// +// RSA Data Security, Inc. makes no representations concerning either +// the merchantability of this software or the suitability of this +// software for any particular purpose. It is provided "as is" +// without express or implied warranty of any kind. +// +// These notices must be retained in any copies of any part of this +// documentation and/or software. + + + +// The original md5 implementation avoids external libraries. +// This version has dependency on stdio.h for file input and +// string.h for memcpy. +#include +#include + +#pragma region MD5 defines +// Constants for MD5Transform routine. +#define S11 7 +#define S12 12 +#define S13 17 +#define S14 22 +#define S21 5 +#define S22 9 +#define S23 14 +#define S24 20 +#define S31 4 +#define S32 11 +#define S33 16 +#define S34 23 +#define S41 6 +#define S42 10 +#define S43 15 +#define S44 21 + + + + + + +static unsigned char PADDING[64] = { + 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 +}; + +// F, G, H and I are basic MD5 functions. +#define F(x, y, z) (((x) & (y)) | ((~x) & (z))) +#define G(x, y, z) (((x) & (z)) | ((y) & (~z))) +#define H(x, y, z) ((x) ^ (y) ^ (z)) +#define I(x, y, z) ((y) ^ ((x) | (~z))) + +// ROTATE_LEFT rotates x left n bits. +#define ROTATE_LEFT(x, n) (((x) << (n)) | ((x) >> (32-(n)))) + +// FF, GG, HH, and II transformations for rounds 1, 2, 3, and 4. +// Rotation is separate from addition to prevent recomputation. +#define FF(a, b, c, d, x, s, ac) { \ + (a) += F ((b), (c), (d)) + (x) + (UINT4)(ac); \ + (a) = ROTATE_LEFT ((a), (s)); \ + (a) += (b); \ + } +#define GG(a, b, c, d, x, s, ac) { \ + (a) += G ((b), (c), (d)) + (x) + (UINT4)(ac); \ + (a) = ROTATE_LEFT ((a), (s)); \ + (a) += (b); \ + } +#define HH(a, b, c, d, x, s, ac) { \ + (a) += H ((b), (c), (d)) + (x) + (UINT4)(ac); \ + (a) = ROTATE_LEFT ((a), (s)); \ + (a) += (b); \ + } +#define II(a, b, c, d, x, s, ac) { \ + (a) += I ((b), (c), (d)) + (x) + (UINT4)(ac); \ + (a) = ROTATE_LEFT ((a), (s)); \ + (a) += (b); \ + } +#pragma endregion + +typedef unsigned char BYTE ; + +// POINTER defines a generic pointer type +typedef unsigned char *POINTER; + +// UINT2 defines a two byte word +typedef unsigned short int UINT2; + +// UINT4 defines a four byte word +typedef unsigned long int UINT4; + + +// convenient object that wraps +// the C-functions for use in C++ only +class MD5 +{ +private: + struct __context_t { + UINT4 state[4]; /* state (ABCD) */ + UINT4 count[2]; /* number of bits, modulo 2^64 (lsb first) */ + unsigned char buffer[64]; /* input buffer */ + } context ; + + #pragma region static helper functions + // The core of the MD5 algorithm is here. + // MD5 basic transformation. Transforms state based on block. + static void MD5Transform( UINT4 state[4], unsigned char block[64] ) + { + UINT4 a = state[0], b = state[1], c = state[2], d = state[3], x[16]; + + Decode (x, block, 64); + + /* Round 1 */ + FF (a, b, c, d, x[ 0], S11, 0xd76aa478); /* 1 */ + FF (d, a, b, c, x[ 1], S12, 0xe8c7b756); /* 2 */ + FF (c, d, a, b, x[ 2], S13, 0x242070db); /* 3 */ + FF (b, c, d, a, x[ 3], S14, 0xc1bdceee); /* 4 */ + FF (a, b, c, d, x[ 4], S11, 0xf57c0faf); /* 5 */ + FF (d, a, b, c, x[ 5], S12, 0x4787c62a); /* 6 */ + FF (c, d, a, b, x[ 6], S13, 0xa8304613); /* 7 */ + FF (b, c, d, a, x[ 7], S14, 0xfd469501); /* 8 */ + FF (a, b, c, d, x[ 8], S11, 0x698098d8); /* 9 */ + FF (d, a, b, c, x[ 9], S12, 0x8b44f7af); /* 10 */ + FF (c, d, a, b, x[10], S13, 0xffff5bb1); /* 11 */ + FF (b, c, d, a, x[11], S14, 0x895cd7be); /* 12 */ + FF (a, b, c, d, x[12], S11, 0x6b901122); /* 13 */ + FF (d, a, b, c, x[13], S12, 0xfd987193); /* 14 */ + FF (c, d, a, b, x[14], S13, 0xa679438e); /* 15 */ + FF (b, c, d, a, x[15], S14, 0x49b40821); /* 16 */ + + /* Round 2 */ + GG (a, b, c, d, x[ 1], S21, 0xf61e2562); /* 17 */ + GG (d, a, b, c, x[ 6], S22, 0xc040b340); /* 18 */ + GG (c, d, a, b, x[11], S23, 0x265e5a51); /* 19 */ + GG (b, c, d, a, x[ 0], S24, 0xe9b6c7aa); /* 20 */ + GG (a, b, c, d, x[ 5], S21, 0xd62f105d); /* 21 */ + GG (d, a, b, c, x[10], S22, 0x2441453); /* 22 */ + GG (c, d, a, b, x[15], S23, 0xd8a1e681); /* 23 */ + GG (b, c, d, a, x[ 4], S24, 0xe7d3fbc8); /* 24 */ + GG (a, b, c, d, x[ 9], S21, 0x21e1cde6); /* 25 */ + GG (d, a, b, c, x[14], S22, 0xc33707d6); /* 26 */ + GG (c, d, a, b, x[ 3], S23, 0xf4d50d87); /* 27 */ + GG (b, c, d, a, x[ 8], S24, 0x455a14ed); /* 28 */ + GG (a, b, c, d, x[13], S21, 0xa9e3e905); /* 29 */ + GG (d, a, b, c, x[ 2], S22, 0xfcefa3f8); /* 30 */ + GG (c, d, a, b, x[ 7], S23, 0x676f02d9); /* 31 */ + GG (b, c, d, a, x[12], S24, 0x8d2a4c8a); /* 32 */ + + /* Round 3 */ + HH (a, b, c, d, x[ 5], S31, 0xfffa3942); /* 33 */ + HH (d, a, b, c, x[ 8], S32, 0x8771f681); /* 34 */ + HH (c, d, a, b, x[11], S33, 0x6d9d6122); /* 35 */ + HH (b, c, d, a, x[14], S34, 0xfde5380c); /* 36 */ + HH (a, b, c, d, x[ 1], S31, 0xa4beea44); /* 37 */ + HH (d, a, b, c, x[ 4], S32, 0x4bdecfa9); /* 38 */ + HH (c, d, a, b, x[ 7], S33, 0xf6bb4b60); /* 39 */ + HH (b, c, d, a, x[10], S34, 0xbebfbc70); /* 40 */ + HH (a, b, c, d, x[13], S31, 0x289b7ec6); /* 41 */ + HH (d, a, b, c, x[ 0], S32, 0xeaa127fa); /* 42 */ + HH (c, d, a, b, x[ 3], S33, 0xd4ef3085); /* 43 */ + HH (b, c, d, a, x[ 6], S34, 0x4881d05); /* 44 */ + HH (a, b, c, d, x[ 9], S31, 0xd9d4d039); /* 45 */ + HH (d, a, b, c, x[12], S32, 0xe6db99e5); /* 46 */ + HH (c, d, a, b, x[15], S33, 0x1fa27cf8); /* 47 */ + HH (b, c, d, a, x[ 2], S34, 0xc4ac5665); /* 48 */ + + /* Round 4 */ + II (a, b, c, d, x[ 0], S41, 0xf4292244); /* 49 */ + II (d, a, b, c, x[ 7], S42, 0x432aff97); /* 50 */ + II (c, d, a, b, x[14], S43, 0xab9423a7); /* 51 */ + II (b, c, d, a, x[ 5], S44, 0xfc93a039); /* 52 */ + II (a, b, c, d, x[12], S41, 0x655b59c3); /* 53 */ + II (d, a, b, c, x[ 3], S42, 0x8f0ccc92); /* 54 */ + II (c, d, a, b, x[10], S43, 0xffeff47d); /* 55 */ + II (b, c, d, a, x[ 1], S44, 0x85845dd1); /* 56 */ + II (a, b, c, d, x[ 8], S41, 0x6fa87e4f); /* 57 */ + II (d, a, b, c, x[15], S42, 0xfe2ce6e0); /* 58 */ + II (c, d, a, b, x[ 6], S43, 0xa3014314); /* 59 */ + II (b, c, d, a, x[13], S44, 0x4e0811a1); /* 60 */ + II (a, b, c, d, x[ 4], S41, 0xf7537e82); /* 61 */ + II (d, a, b, c, x[11], S42, 0xbd3af235); /* 62 */ + II (c, d, a, b, x[ 2], S43, 0x2ad7d2bb); /* 63 */ + II (b, c, d, a, x[ 9], S44, 0xeb86d391); /* 64 */ + + state[0] += a; + state[1] += b; + state[2] += c; + state[3] += d; + + // Zeroize sensitive information. + memset((POINTER)x, 0, sizeof (x)); + } + + // Encodes input (UINT4) into output (unsigned char). Assumes len is + // a multiple of 4. + static void Encode( unsigned char *output, UINT4 *input, unsigned int len ) + { + unsigned int i, j; + + for (i = 0, j = 0; j < len; i++, j += 4) { + output[j] = (unsigned char)(input[i] & 0xff); + output[j+1] = (unsigned char)((input[i] >> 8) & 0xff); + output[j+2] = (unsigned char)((input[i] >> 16) & 0xff); + output[j+3] = (unsigned char)((input[i] >> 24) & 0xff); + } + } + + // Decodes input (unsigned char) into output (UINT4). Assumes len is + // a multiple of 4. + static void Decode( UINT4 *output, unsigned char *input, unsigned int len ) + { + unsigned int i, j; + + for (i = 0, j = 0; j < len; i++, j += 4) + output[i] = ((UINT4)input[j]) | (((UINT4)input[j+1]) << 8) | + (((UINT4)input[j+2]) << 16) | (((UINT4)input[j+3]) << 24); + } + #pragma endregion + + +public: + // MAIN FUNCTIONS + MD5() + { + Init() ; + } + + // MD5 initialization. Begins an MD5 operation, writing a new context. + void Init() + { + context.count[0] = context.count[1] = 0; + + // Load magic initialization constants. + context.state[0] = 0x67452301; + context.state[1] = 0xefcdab89; + context.state[2] = 0x98badcfe; + context.state[3] = 0x10325476; + } + + // MD5 block update operation. Continues an MD5 message-digest + // operation, processing another message block, and updating the + // context. + void Update( + unsigned char *input, // input block + unsigned int inputLen ) // length of input block + { + unsigned int i, index, partLen; + + // Compute number of bytes mod 64 + index = (unsigned int)((context.count[0] >> 3) & 0x3F); + + // Update number of bits + if ((context.count[0] += ((UINT4)inputLen << 3)) + < ((UINT4)inputLen << 3)) + context.count[1]++; + context.count[1] += ((UINT4)inputLen >> 29); + + partLen = 64 - index; + + // Transform as many times as possible. + if (inputLen >= partLen) { + memcpy((POINTER)&context.buffer[index], (POINTER)input, partLen); + MD5Transform (context.state, context.buffer); + + for (i = partLen; i + 63 < inputLen; i += 64) + MD5Transform (context.state, &input[i]); + + index = 0; + } + else + i = 0; + + /* Buffer remaining input */ + memcpy((POINTER)&context.buffer[index], (POINTER)&input[i], inputLen-i); + } + + // MD5 finalization. Ends an MD5 message-digest operation, writing the + // the message digest and zeroizing the context. + // Writes to digestRaw + void Final() + { + unsigned char bits[8]; + unsigned int index, padLen; + + // Save number of bits + Encode( bits, context.count, 8 ); + + // Pad out to 56 mod 64. + index = (unsigned int)((context.count[0] >> 3) & 0x3f); + padLen = (index < 56) ? (56 - index) : (120 - index); + Update( PADDING, padLen ); + + // Append length (before padding) + Update( bits, 8 ); + + // Store state in digest + Encode( digestRaw, context.state, 16); + + // Zeroize sensitive information. + memset((POINTER)&context, 0, sizeof (context)); + + writeToString() ; + } + + /// Buffer must be 32+1 (nul) = 33 chars long at least + void writeToString() + { + int pos ; + + for( pos = 0 ; pos < 16 ; pos++ ) + sprintf( digestChars+(pos*2), "%02x", digestRaw[pos] ) ; + } + + +public: + // an MD5 digest is a 16-byte number (32 hex digits) + BYTE digestRaw[ 16 ] ; + + // This version of the digest is actually + // a "printf'd" version of the digest. + char digestChars[ 33 ] ; + + /// Load a file from disk and digest it + // Digests a file and returns the result. + char* digestFile( char *filename ) + { + Init() ; + + FILE *file; + + int len; + unsigned char buffer[1024] ; + + if( (file = fopen (filename, "rb")) == NULL ) + { + printf( "%s can't be opened\n", filename ) ; + + return (char *) "Unknown"; + } + else + { + while( len = fread( buffer, 1, 1024, file ) ) + Update( buffer, len ) ; + Final(); + + fclose( file ); + } + + return digestChars ; + } + + /// Digests a byte-array already in memory + char* digestMemory( BYTE *memchunk, int len ) + { + Init() ; + Update( memchunk, len ) ; + Final() ; + + return digestChars ; + } + + // Digests a string and prints the result. + char* digestString( char *string ) + { + Init() ; + Update( (unsigned char*)string, strlen(string) ) ; + Final() ; + + return digestChars ; + } +} ; + +#endif diff --git a/Source/Import/CrashReport/qcbuild.src b/Source/Import/CrashReport/qcbuild.src new file mode 100644 index 0000000..6db3615 --- /dev/null +++ b/Source/Import/CrashReport/qcbuild.src @@ -0,0 +1,57 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = CrashReport + +PURPOSE = Catch unhandled exception (eg. seg fault) and create crash dump. + +AUTHOR = Cloud Wu (Windows handler), RSA Data Security (md5) + +COPYRIGHT = Copyright (c) 2010, Cloud Wu (Windows handler), +COPYRIGHT += Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991 (md5) + +LICENSE = BSD + +INC_DIR = Tegenaria +ISRC = CrashReport.h + +# +# DLL for windows only. +# + +.section MinGW +CXXSRC = WindowsHandler.cpp +# TODO: Disabled due to missing bfd.h on new MinGW +# LIBS = -lbfd -liberty -limagehlp -lintl +DEPENDS = libintl +.endsection + +# +# SO for Linux only. +# + +.section Linux +CXXSRC = LinuxHandler.cpp +.endsection diff --git a/Source/Import/MD5/md5.h b/Source/Import/MD5/md5.h new file mode 100644 index 0000000..b1d2d8e --- /dev/null +++ b/Source/Import/MD5/md5.h @@ -0,0 +1,388 @@ +#ifndef MD5_H +#define MD5_H + +// Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All +// rights reserved. + +// License to copy and use this software is granted provided that it +// is identified as the "RSA Data Security, Inc. MD5 Message-Digest +// Algorithm" in all material mentioning or referencing this software +// or this function. +// +// License is also granted to make and use derivative works provided +// that such works are identified as "derived from the RSA Data +// Security, Inc. MD5 Message-Digest Algorithm" in all material +// mentioning or referencing the derived work. +// +// RSA Data Security, Inc. makes no representations concerning either +// the merchantability of this software or the suitability of this +// software for any particular purpose. It is provided "as is" +// without express or implied warranty of any kind. +// +// These notices must be retained in any copies of any part of this +// documentation and/or software. + + + +// The original md5 implementation avoids external libraries. +// This version has dependency on stdio.h for file input and +// string.h for memcpy. +#include +#include + +#pragma region MD5 defines +// Constants for MD5Transform routine. +#define S11 7 +#define S12 12 +#define S13 17 +#define S14 22 +#define S21 5 +#define S22 9 +#define S23 14 +#define S24 20 +#define S31 4 +#define S32 11 +#define S33 16 +#define S34 23 +#define S41 6 +#define S42 10 +#define S43 15 +#define S44 21 + + + + + + +static unsigned char PADDING[64] = { + 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 +}; + +// F, G, H and I are basic MD5 functions. +#define F(x, y, z) (((x) & (y)) | ((~x) & (z))) +#define G(x, y, z) (((x) & (z)) | ((y) & (~z))) +#define H(x, y, z) ((x) ^ (y) ^ (z)) +#define I(x, y, z) ((y) ^ ((x) | (~z))) + +// ROTATE_LEFT rotates x left n bits. +#define ROTATE_LEFT(x, n) (((x) << (n)) | ((x) >> (32-(n)))) + +// FF, GG, HH, and II transformations for rounds 1, 2, 3, and 4. +// Rotation is separate from addition to prevent recomputation. +#define FF(a, b, c, d, x, s, ac) { \ + (a) += F ((b), (c), (d)) + (x) + (UINT4)(ac); \ + (a) = ROTATE_LEFT ((a), (s)); \ + (a) += (b); \ + } +#define GG(a, b, c, d, x, s, ac) { \ + (a) += G ((b), (c), (d)) + (x) + (UINT4)(ac); \ + (a) = ROTATE_LEFT ((a), (s)); \ + (a) += (b); \ + } +#define HH(a, b, c, d, x, s, ac) { \ + (a) += H ((b), (c), (d)) + (x) + (UINT4)(ac); \ + (a) = ROTATE_LEFT ((a), (s)); \ + (a) += (b); \ + } +#define II(a, b, c, d, x, s, ac) { \ + (a) += I ((b), (c), (d)) + (x) + (UINT4)(ac); \ + (a) = ROTATE_LEFT ((a), (s)); \ + (a) += (b); \ + } +#pragma endregion + +typedef unsigned char BYTE ; + +// POINTER defines a generic pointer type +typedef unsigned char *POINTER; + +// UINT2 defines a two byte word +typedef unsigned short int UINT2; + +// UINT4 defines a four byte word +typedef unsigned long int UINT4; + + +// convenient object that wraps +// the C-functions for use in C++ only +class MD5 +{ +private: + struct __context_t { + UINT4 state[4]; /* state (ABCD) */ + UINT4 count[2]; /* number of bits, modulo 2^64 (lsb first) */ + unsigned char buffer[64]; /* input buffer */ + } context ; + + #pragma region static helper functions + // The core of the MD5 algorithm is here. + // MD5 basic transformation. Transforms state based on block. + static void MD5Transform( UINT4 state[4], unsigned char block[64] ) + { + UINT4 a = state[0], b = state[1], c = state[2], d = state[3], x[16]; + + Decode (x, block, 64); + + /* Round 1 */ + FF (a, b, c, d, x[ 0], S11, 0xd76aa478); /* 1 */ + FF (d, a, b, c, x[ 1], S12, 0xe8c7b756); /* 2 */ + FF (c, d, a, b, x[ 2], S13, 0x242070db); /* 3 */ + FF (b, c, d, a, x[ 3], S14, 0xc1bdceee); /* 4 */ + FF (a, b, c, d, x[ 4], S11, 0xf57c0faf); /* 5 */ + FF (d, a, b, c, x[ 5], S12, 0x4787c62a); /* 6 */ + FF (c, d, a, b, x[ 6], S13, 0xa8304613); /* 7 */ + FF (b, c, d, a, x[ 7], S14, 0xfd469501); /* 8 */ + FF (a, b, c, d, x[ 8], S11, 0x698098d8); /* 9 */ + FF (d, a, b, c, x[ 9], S12, 0x8b44f7af); /* 10 */ + FF (c, d, a, b, x[10], S13, 0xffff5bb1); /* 11 */ + FF (b, c, d, a, x[11], S14, 0x895cd7be); /* 12 */ + FF (a, b, c, d, x[12], S11, 0x6b901122); /* 13 */ + FF (d, a, b, c, x[13], S12, 0xfd987193); /* 14 */ + FF (c, d, a, b, x[14], S13, 0xa679438e); /* 15 */ + FF (b, c, d, a, x[15], S14, 0x49b40821); /* 16 */ + + /* Round 2 */ + GG (a, b, c, d, x[ 1], S21, 0xf61e2562); /* 17 */ + GG (d, a, b, c, x[ 6], S22, 0xc040b340); /* 18 */ + GG (c, d, a, b, x[11], S23, 0x265e5a51); /* 19 */ + GG (b, c, d, a, x[ 0], S24, 0xe9b6c7aa); /* 20 */ + GG (a, b, c, d, x[ 5], S21, 0xd62f105d); /* 21 */ + GG (d, a, b, c, x[10], S22, 0x2441453); /* 22 */ + GG (c, d, a, b, x[15], S23, 0xd8a1e681); /* 23 */ + GG (b, c, d, a, x[ 4], S24, 0xe7d3fbc8); /* 24 */ + GG (a, b, c, d, x[ 9], S21, 0x21e1cde6); /* 25 */ + GG (d, a, b, c, x[14], S22, 0xc33707d6); /* 26 */ + GG (c, d, a, b, x[ 3], S23, 0xf4d50d87); /* 27 */ + GG (b, c, d, a, x[ 8], S24, 0x455a14ed); /* 28 */ + GG (a, b, c, d, x[13], S21, 0xa9e3e905); /* 29 */ + GG (d, a, b, c, x[ 2], S22, 0xfcefa3f8); /* 30 */ + GG (c, d, a, b, x[ 7], S23, 0x676f02d9); /* 31 */ + GG (b, c, d, a, x[12], S24, 0x8d2a4c8a); /* 32 */ + + /* Round 3 */ + HH (a, b, c, d, x[ 5], S31, 0xfffa3942); /* 33 */ + HH (d, a, b, c, x[ 8], S32, 0x8771f681); /* 34 */ + HH (c, d, a, b, x[11], S33, 0x6d9d6122); /* 35 */ + HH (b, c, d, a, x[14], S34, 0xfde5380c); /* 36 */ + HH (a, b, c, d, x[ 1], S31, 0xa4beea44); /* 37 */ + HH (d, a, b, c, x[ 4], S32, 0x4bdecfa9); /* 38 */ + HH (c, d, a, b, x[ 7], S33, 0xf6bb4b60); /* 39 */ + HH (b, c, d, a, x[10], S34, 0xbebfbc70); /* 40 */ + HH (a, b, c, d, x[13], S31, 0x289b7ec6); /* 41 */ + HH (d, a, b, c, x[ 0], S32, 0xeaa127fa); /* 42 */ + HH (c, d, a, b, x[ 3], S33, 0xd4ef3085); /* 43 */ + HH (b, c, d, a, x[ 6], S34, 0x4881d05); /* 44 */ + HH (a, b, c, d, x[ 9], S31, 0xd9d4d039); /* 45 */ + HH (d, a, b, c, x[12], S32, 0xe6db99e5); /* 46 */ + HH (c, d, a, b, x[15], S33, 0x1fa27cf8); /* 47 */ + HH (b, c, d, a, x[ 2], S34, 0xc4ac5665); /* 48 */ + + /* Round 4 */ + II (a, b, c, d, x[ 0], S41, 0xf4292244); /* 49 */ + II (d, a, b, c, x[ 7], S42, 0x432aff97); /* 50 */ + II (c, d, a, b, x[14], S43, 0xab9423a7); /* 51 */ + II (b, c, d, a, x[ 5], S44, 0xfc93a039); /* 52 */ + II (a, b, c, d, x[12], S41, 0x655b59c3); /* 53 */ + II (d, a, b, c, x[ 3], S42, 0x8f0ccc92); /* 54 */ + II (c, d, a, b, x[10], S43, 0xffeff47d); /* 55 */ + II (b, c, d, a, x[ 1], S44, 0x85845dd1); /* 56 */ + II (a, b, c, d, x[ 8], S41, 0x6fa87e4f); /* 57 */ + II (d, a, b, c, x[15], S42, 0xfe2ce6e0); /* 58 */ + II (c, d, a, b, x[ 6], S43, 0xa3014314); /* 59 */ + II (b, c, d, a, x[13], S44, 0x4e0811a1); /* 60 */ + II (a, b, c, d, x[ 4], S41, 0xf7537e82); /* 61 */ + II (d, a, b, c, x[11], S42, 0xbd3af235); /* 62 */ + II (c, d, a, b, x[ 2], S43, 0x2ad7d2bb); /* 63 */ + II (b, c, d, a, x[ 9], S44, 0xeb86d391); /* 64 */ + + state[0] += a; + state[1] += b; + state[2] += c; + state[3] += d; + + // Zeroize sensitive information. + memset((POINTER)x, 0, sizeof (x)); + } + + // Encodes input (UINT4) into output (unsigned char). Assumes len is + // a multiple of 4. + static void Encode( unsigned char *output, UINT4 *input, unsigned int len ) + { + unsigned int i, j; + + for (i = 0, j = 0; j < len; i++, j += 4) { + output[j] = (unsigned char)(input[i] & 0xff); + output[j+1] = (unsigned char)((input[i] >> 8) & 0xff); + output[j+2] = (unsigned char)((input[i] >> 16) & 0xff); + output[j+3] = (unsigned char)((input[i] >> 24) & 0xff); + } + } + + // Decodes input (unsigned char) into output (UINT4). Assumes len is + // a multiple of 4. + static void Decode( UINT4 *output, unsigned char *input, unsigned int len ) + { + unsigned int i, j; + + for (i = 0, j = 0; j < len; i++, j += 4) + output[i] = ((UINT4)input[j]) | (((UINT4)input[j+1]) << 8) | + (((UINT4)input[j+2]) << 16) | (((UINT4)input[j+3]) << 24); + } + #pragma endregion + + +public: + // MAIN FUNCTIONS + MD5() + { + Init() ; + } + + // MD5 initialization. Begins an MD5 operation, writing a new context. + void Init() + { + context.count[0] = context.count[1] = 0; + + // Load magic initialization constants. + context.state[0] = 0x67452301; + context.state[1] = 0xefcdab89; + context.state[2] = 0x98badcfe; + context.state[3] = 0x10325476; + } + + // MD5 block update operation. Continues an MD5 message-digest + // operation, processing another message block, and updating the + // context. + void Update( + unsigned char *input, // input block + unsigned int inputLen ) // length of input block + { + unsigned int i, index, partLen; + + // Compute number of bytes mod 64 + index = (unsigned int)((context.count[0] >> 3) & 0x3F); + + // Update number of bits + if ((context.count[0] += ((UINT4)inputLen << 3)) + < ((UINT4)inputLen << 3)) + context.count[1]++; + context.count[1] += ((UINT4)inputLen >> 29); + + partLen = 64 - index; + + // Transform as many times as possible. + if (inputLen >= partLen) { + memcpy((POINTER)&context.buffer[index], (POINTER)input, partLen); + MD5Transform (context.state, context.buffer); + + for (i = partLen; i + 63 < inputLen; i += 64) + MD5Transform (context.state, &input[i]); + + index = 0; + } + else + i = 0; + + /* Buffer remaining input */ + memcpy((POINTER)&context.buffer[index], (POINTER)&input[i], inputLen-i); + } + + // MD5 finalization. Ends an MD5 message-digest operation, writing the + // the message digest and zeroizing the context. + // Writes to digestRaw + void Final() + { + unsigned char bits[8]; + unsigned int index, padLen; + + // Save number of bits + Encode( bits, context.count, 8 ); + + // Pad out to 56 mod 64. + index = (unsigned int)((context.count[0] >> 3) & 0x3f); + padLen = (index < 56) ? (56 - index) : (120 - index); + Update( PADDING, padLen ); + + // Append length (before padding) + Update( bits, 8 ); + + // Store state in digest + Encode( digestRaw, context.state, 16); + + // Zeroize sensitive information. + memset((POINTER)&context, 0, sizeof (context)); + + writeToString() ; + } + + /// Buffer must be 32+1 (nul) = 33 chars long at least + void writeToString() + { + int pos ; + + for( pos = 0 ; pos < 16 ; pos++ ) + sprintf( digestChars+(pos*2), "%02x", digestRaw[pos] ) ; + } + + +public: + // an MD5 digest is a 16-byte number (32 hex digits) + BYTE digestRaw[ 16 ] ; + + // This version of the digest is actually + // a "printf'd" version of the digest. + char digestChars[ 33 ] ; + + /// Load a file from disk and digest it + // Digests a file and returns the result. + char* digestFile( char *filename ) + { + Init() ; + + FILE *file; + + int len; + unsigned char buffer[1024] ; + + if( (file = fopen (filename, "rb")) == NULL ) + { + printf( "%s can't be opened\n", filename ) ; + + return (char *) "Unknown"; + } + else + { + while( len = fread( buffer, 1, 1024, file ) ) + Update( buffer, len ) ; + Final(); + + fclose( file ); + } + + return digestChars ; + } + + /// Digests a byte-array already in memory + char* digestMemory( BYTE *memchunk, int len ) + { + Init() ; + Update( memchunk, len ) ; + Final() ; + + return digestChars ; + } + + // Digests a string and prints the result. + char* digestString( char *string ) + { + Init() ; + Update( (unsigned char*)string, strlen(string) ) ; + Final() ; + + return digestChars ; + } +} ; + +#endif diff --git a/Source/Import/MD5/qcbuild.src b/Source/Import/MD5/qcbuild.src new file mode 100644 index 0000000..e4456d2 --- /dev/null +++ b/Source/Import/MD5/qcbuild.src @@ -0,0 +1,33 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = MD5 + +PURPOSE = Compute files MD5. +AUTHOR = RSA Data Security (md5) +COPYRIGHT = Copyright (C) 1991-2, RSA Data Security +LICENSE = BSD + +ISRC = md5.h diff --git a/Source/Import/OpenSSL/Include/openssl/aes.h b/Source/Import/OpenSSL/Include/openssl/aes.h new file mode 100644 index 0000000..031abf0 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/aes.h @@ -0,0 +1,147 @@ +/* crypto/aes/aes.h -*- mode:C; c-file-style: "eay" -*- */ +/* ==================================================================== + * Copyright (c) 1998-2002 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + */ + +#ifndef HEADER_AES_H +#define HEADER_AES_H + +#include + +#ifdef OPENSSL_NO_AES +#error AES is disabled. +#endif + +#include + +#define AES_ENCRYPT 1 +#define AES_DECRYPT 0 + +/* Because array size can't be a const in C, the following two are macros. + Both sizes are in bytes. */ +#define AES_MAXNR 14 +#define AES_BLOCK_SIZE 16 + +#ifdef __cplusplus +extern "C" { +#endif + +/* This should be a hidden type, but EVP requires that the size be known */ +struct aes_key_st { +#ifdef AES_LONG + unsigned long rd_key[4 *(AES_MAXNR + 1)]; +#else + unsigned int rd_key[4 *(AES_MAXNR + 1)]; +#endif + int rounds; +}; +typedef struct aes_key_st AES_KEY; + +const char *AES_options(void); + +int AES_set_encrypt_key(const unsigned char *userKey, const int bits, + AES_KEY *key); +int AES_set_decrypt_key(const unsigned char *userKey, const int bits, + AES_KEY *key); + +int private_AES_set_encrypt_key(const unsigned char *userKey, const int bits, + AES_KEY *key); +int private_AES_set_decrypt_key(const unsigned char *userKey, const int bits, + AES_KEY *key); + +void AES_encrypt(const unsigned char *in, unsigned char *out, + const AES_KEY *key); +void AES_decrypt(const unsigned char *in, unsigned char *out, + const AES_KEY *key); + +void AES_ecb_encrypt(const unsigned char *in, unsigned char *out, + const AES_KEY *key, const int enc); +void AES_cbc_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const AES_KEY *key, + unsigned char *ivec, const int enc); +void AES_cfb128_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const AES_KEY *key, + unsigned char *ivec, int *num, const int enc); +void AES_cfb1_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const AES_KEY *key, + unsigned char *ivec, int *num, const int enc); +void AES_cfb8_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const AES_KEY *key, + unsigned char *ivec, int *num, const int enc); +void AES_ofb128_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const AES_KEY *key, + unsigned char *ivec, int *num); +void AES_ctr128_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const AES_KEY *key, + unsigned char ivec[AES_BLOCK_SIZE], + unsigned char ecount_buf[AES_BLOCK_SIZE], + unsigned int *num); +/* NB: the IV is _two_ blocks long */ +void AES_ige_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const AES_KEY *key, + unsigned char *ivec, const int enc); +/* NB: the IV is _four_ blocks long */ +void AES_bi_ige_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const AES_KEY *key, + const AES_KEY *key2, const unsigned char *ivec, + const int enc); + +int AES_wrap_key(AES_KEY *key, const unsigned char *iv, + unsigned char *out, + const unsigned char *in, unsigned int inlen); +int AES_unwrap_key(AES_KEY *key, const unsigned char *iv, + unsigned char *out, + const unsigned char *in, unsigned int inlen); + + +#ifdef __cplusplus +} +#endif + +#endif /* !HEADER_AES_H */ diff --git a/Source/Import/OpenSSL/Include/openssl/asn1.h b/Source/Import/OpenSSL/Include/openssl/asn1.h new file mode 100644 index 0000000..220a0c8 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/asn1.h @@ -0,0 +1,1404 @@ +/* crypto/asn1/asn1.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_ASN1_H +#define HEADER_ASN1_H + +#include +#include +#ifndef OPENSSL_NO_BIO +#include +#endif +#include +#include + +#include + +#include +#ifndef OPENSSL_NO_DEPRECATED +#include +#endif + +#ifdef OPENSSL_BUILD_SHLIBCRYPTO +# undef OPENSSL_EXTERN +# define OPENSSL_EXTERN OPENSSL_EXPORT +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#define V_ASN1_UNIVERSAL 0x00 +#define V_ASN1_APPLICATION 0x40 +#define V_ASN1_CONTEXT_SPECIFIC 0x80 +#define V_ASN1_PRIVATE 0xc0 + +#define V_ASN1_CONSTRUCTED 0x20 +#define V_ASN1_PRIMITIVE_TAG 0x1f +#define V_ASN1_PRIMATIVE_TAG 0x1f + +#define V_ASN1_APP_CHOOSE -2 /* let the recipient choose */ +#define V_ASN1_OTHER -3 /* used in ASN1_TYPE */ +#define V_ASN1_ANY -4 /* used in ASN1 template code */ + +#define V_ASN1_NEG 0x100 /* negative flag */ + +#define V_ASN1_UNDEF -1 +#define V_ASN1_EOC 0 +#define V_ASN1_BOOLEAN 1 /**/ +#define V_ASN1_INTEGER 2 +#define V_ASN1_NEG_INTEGER (2 | V_ASN1_NEG) +#define V_ASN1_BIT_STRING 3 +#define V_ASN1_OCTET_STRING 4 +#define V_ASN1_NULL 5 +#define V_ASN1_OBJECT 6 +#define V_ASN1_OBJECT_DESCRIPTOR 7 +#define V_ASN1_EXTERNAL 8 +#define V_ASN1_REAL 9 +#define V_ASN1_ENUMERATED 10 +#define V_ASN1_NEG_ENUMERATED (10 | V_ASN1_NEG) +#define V_ASN1_UTF8STRING 12 +#define V_ASN1_SEQUENCE 16 +#define V_ASN1_SET 17 +#define V_ASN1_NUMERICSTRING 18 /**/ +#define V_ASN1_PRINTABLESTRING 19 +#define V_ASN1_T61STRING 20 +#define V_ASN1_TELETEXSTRING 20 /* alias */ +#define V_ASN1_VIDEOTEXSTRING 21 /**/ +#define V_ASN1_IA5STRING 22 +#define V_ASN1_UTCTIME 23 +#define V_ASN1_GENERALIZEDTIME 24 /**/ +#define V_ASN1_GRAPHICSTRING 25 /**/ +#define V_ASN1_ISO64STRING 26 /**/ +#define V_ASN1_VISIBLESTRING 26 /* alias */ +#define V_ASN1_GENERALSTRING 27 /**/ +#define V_ASN1_UNIVERSALSTRING 28 /**/ +#define V_ASN1_BMPSTRING 30 + +/* For use with d2i_ASN1_type_bytes() */ +#define B_ASN1_NUMERICSTRING 0x0001 +#define B_ASN1_PRINTABLESTRING 0x0002 +#define B_ASN1_T61STRING 0x0004 +#define B_ASN1_TELETEXSTRING 0x0004 +#define B_ASN1_VIDEOTEXSTRING 0x0008 +#define B_ASN1_IA5STRING 0x0010 +#define B_ASN1_GRAPHICSTRING 0x0020 +#define B_ASN1_ISO64STRING 0x0040 +#define B_ASN1_VISIBLESTRING 0x0040 +#define B_ASN1_GENERALSTRING 0x0080 +#define B_ASN1_UNIVERSALSTRING 0x0100 +#define B_ASN1_OCTET_STRING 0x0200 +#define B_ASN1_BIT_STRING 0x0400 +#define B_ASN1_BMPSTRING 0x0800 +#define B_ASN1_UNKNOWN 0x1000 +#define B_ASN1_UTF8STRING 0x2000 +#define B_ASN1_UTCTIME 0x4000 +#define B_ASN1_GENERALIZEDTIME 0x8000 +#define B_ASN1_SEQUENCE 0x10000 + +/* For use with ASN1_mbstring_copy() */ +#define MBSTRING_FLAG 0x1000 +#define MBSTRING_UTF8 (MBSTRING_FLAG) +#define MBSTRING_ASC (MBSTRING_FLAG|1) +#define MBSTRING_BMP (MBSTRING_FLAG|2) +#define MBSTRING_UNIV (MBSTRING_FLAG|4) + +#define SMIME_OLDMIME 0x400 +#define SMIME_CRLFEOL 0x800 +#define SMIME_STREAM 0x1000 + +struct X509_algor_st; +DECLARE_STACK_OF(X509_ALGOR) + +#define DECLARE_ASN1_SET_OF(type) /* filled in by mkstack.pl */ +#define IMPLEMENT_ASN1_SET_OF(type) /* nothing, no longer needed */ + +/* We MUST make sure that, except for constness, asn1_ctx_st and + asn1_const_ctx are exactly the same. Fortunately, as soon as + the old ASN1 parsing macros are gone, we can throw this away + as well... */ +typedef struct asn1_ctx_st + { + unsigned char *p;/* work char pointer */ + int eos; /* end of sequence read for indefinite encoding */ + int error; /* error code to use when returning an error */ + int inf; /* constructed if 0x20, indefinite is 0x21 */ + int tag; /* tag from last 'get object' */ + int xclass; /* class from last 'get object' */ + long slen; /* length of last 'get object' */ + unsigned char *max; /* largest value of p allowed */ + unsigned char *q;/* temporary variable */ + unsigned char **pp;/* variable */ + int line; /* used in error processing */ + } ASN1_CTX; + +typedef struct asn1_const_ctx_st + { + const unsigned char *p;/* work char pointer */ + int eos; /* end of sequence read for indefinite encoding */ + int error; /* error code to use when returning an error */ + int inf; /* constructed if 0x20, indefinite is 0x21 */ + int tag; /* tag from last 'get object' */ + int xclass; /* class from last 'get object' */ + long slen; /* length of last 'get object' */ + const unsigned char *max; /* largest value of p allowed */ + const unsigned char *q;/* temporary variable */ + const unsigned char **pp;/* variable */ + int line; /* used in error processing */ + } ASN1_const_CTX; + +/* These are used internally in the ASN1_OBJECT to keep track of + * whether the names and data need to be free()ed */ +#define ASN1_OBJECT_FLAG_DYNAMIC 0x01 /* internal use */ +#define ASN1_OBJECT_FLAG_CRITICAL 0x02 /* critical x509v3 object id */ +#define ASN1_OBJECT_FLAG_DYNAMIC_STRINGS 0x04 /* internal use */ +#define ASN1_OBJECT_FLAG_DYNAMIC_DATA 0x08 /* internal use */ +typedef struct asn1_object_st + { + const char *sn,*ln; + int nid; + int length; + const unsigned char *data; /* data remains const after init */ + int flags; /* Should we free this one */ + } ASN1_OBJECT; + +#define ASN1_STRING_FLAG_BITS_LEFT 0x08 /* Set if 0x07 has bits left value */ +/* This indicates that the ASN1_STRING is not a real value but just a place + * holder for the location where indefinite length constructed data should + * be inserted in the memory buffer + */ +#define ASN1_STRING_FLAG_NDEF 0x010 + +/* This flag is used by the CMS code to indicate that a string is not + * complete and is a place holder for content when it had all been + * accessed. The flag will be reset when content has been written to it. + */ + +#define ASN1_STRING_FLAG_CONT 0x020 +/* This flag is used by ASN1 code to indicate an ASN1_STRING is an MSTRING + * type. + */ +#define ASN1_STRING_FLAG_MSTRING 0x040 +/* This is the base type that holds just about everything :-) */ +struct asn1_string_st + { + int length; + int type; + unsigned char *data; + /* The value of the following field depends on the type being + * held. It is mostly being used for BIT_STRING so if the + * input data has a non-zero 'unused bits' value, it will be + * handled correctly */ + long flags; + }; + +/* ASN1_ENCODING structure: this is used to save the received + * encoding of an ASN1 type. This is useful to get round + * problems with invalid encodings which can break signatures. + */ + +typedef struct ASN1_ENCODING_st + { + unsigned char *enc; /* DER encoding */ + long len; /* Length of encoding */ + int modified; /* set to 1 if 'enc' is invalid */ + } ASN1_ENCODING; + +/* Used with ASN1 LONG type: if a long is set to this it is omitted */ +#define ASN1_LONG_UNDEF 0x7fffffffL + +#define STABLE_FLAGS_MALLOC 0x01 +#define STABLE_NO_MASK 0x02 +#define DIRSTRING_TYPE \ + (B_ASN1_PRINTABLESTRING|B_ASN1_T61STRING|B_ASN1_BMPSTRING|B_ASN1_UTF8STRING) +#define PKCS9STRING_TYPE (DIRSTRING_TYPE|B_ASN1_IA5STRING) + +typedef struct asn1_string_table_st { + int nid; + long minsize; + long maxsize; + unsigned long mask; + unsigned long flags; +} ASN1_STRING_TABLE; + +DECLARE_STACK_OF(ASN1_STRING_TABLE) + +/* size limits: this stuff is taken straight from RFC2459 */ + +#define ub_name 32768 +#define ub_common_name 64 +#define ub_locality_name 128 +#define ub_state_name 128 +#define ub_organization_name 64 +#define ub_organization_unit_name 64 +#define ub_title 64 +#define ub_email_address 128 + +/* Declarations for template structures: for full definitions + * see asn1t.h + */ +typedef struct ASN1_TEMPLATE_st ASN1_TEMPLATE; +typedef struct ASN1_TLC_st ASN1_TLC; +/* This is just an opaque pointer */ +typedef struct ASN1_VALUE_st ASN1_VALUE; + +/* Declare ASN1 functions: the implement macro in in asn1t.h */ + +#define DECLARE_ASN1_FUNCTIONS(type) DECLARE_ASN1_FUNCTIONS_name(type, type) + +#define DECLARE_ASN1_ALLOC_FUNCTIONS(type) \ + DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, type) + +#define DECLARE_ASN1_FUNCTIONS_name(type, name) \ + DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, name) \ + DECLARE_ASN1_ENCODE_FUNCTIONS(type, name, name) + +#define DECLARE_ASN1_FUNCTIONS_fname(type, itname, name) \ + DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, name) \ + DECLARE_ASN1_ENCODE_FUNCTIONS(type, itname, name) + +#define DECLARE_ASN1_ENCODE_FUNCTIONS(type, itname, name) \ + type *d2i_##name(type **a, const unsigned char **in, long len); \ + int i2d_##name(type *a, unsigned char **out); \ + DECLARE_ASN1_ITEM(itname) + +#define DECLARE_ASN1_ENCODE_FUNCTIONS_const(type, name) \ + type *d2i_##name(type **a, const unsigned char **in, long len); \ + int i2d_##name(const type *a, unsigned char **out); \ + DECLARE_ASN1_ITEM(name) + +#define DECLARE_ASN1_NDEF_FUNCTION(name) \ + int i2d_##name##_NDEF(name *a, unsigned char **out); + +#define DECLARE_ASN1_FUNCTIONS_const(name) \ + DECLARE_ASN1_ALLOC_FUNCTIONS(name) \ + DECLARE_ASN1_ENCODE_FUNCTIONS_const(name, name) + +#define DECLARE_ASN1_ALLOC_FUNCTIONS_name(type, name) \ + type *name##_new(void); \ + void name##_free(type *a); + +#define DECLARE_ASN1_PRINT_FUNCTION(stname) \ + DECLARE_ASN1_PRINT_FUNCTION_fname(stname, stname) + +#define DECLARE_ASN1_PRINT_FUNCTION_fname(stname, fname) \ + int fname##_print_ctx(BIO *out, stname *x, int indent, \ + const ASN1_PCTX *pctx); + +#define D2I_OF(type) type *(*)(type **,const unsigned char **,long) +#define I2D_OF(type) int (*)(type *,unsigned char **) +#define I2D_OF_const(type) int (*)(const type *,unsigned char **) + +#define CHECKED_D2I_OF(type, d2i) \ + ((d2i_of_void*) (1 ? d2i : ((D2I_OF(type))0))) +#define CHECKED_I2D_OF(type, i2d) \ + ((i2d_of_void*) (1 ? i2d : ((I2D_OF(type))0))) +#define CHECKED_NEW_OF(type, xnew) \ + ((void *(*)(void)) (1 ? xnew : ((type *(*)(void))0))) +#define CHECKED_PTR_OF(type, p) \ + ((void*) (1 ? p : (type*)0)) +#define CHECKED_PPTR_OF(type, p) \ + ((void**) (1 ? p : (type**)0)) + +#define TYPEDEF_D2I_OF(type) typedef type *d2i_of_##type(type **,const unsigned char **,long) +#define TYPEDEF_I2D_OF(type) typedef int i2d_of_##type(type *,unsigned char **) +#define TYPEDEF_D2I2D_OF(type) TYPEDEF_D2I_OF(type); TYPEDEF_I2D_OF(type) + +TYPEDEF_D2I2D_OF(void); + +/* The following macros and typedefs allow an ASN1_ITEM + * to be embedded in a structure and referenced. Since + * the ASN1_ITEM pointers need to be globally accessible + * (possibly from shared libraries) they may exist in + * different forms. On platforms that support it the + * ASN1_ITEM structure itself will be globally exported. + * Other platforms will export a function that returns + * an ASN1_ITEM pointer. + * + * To handle both cases transparently the macros below + * should be used instead of hard coding an ASN1_ITEM + * pointer in a structure. + * + * The structure will look like this: + * + * typedef struct SOMETHING_st { + * ... + * ASN1_ITEM_EXP *iptr; + * ... + * } SOMETHING; + * + * It would be initialised as e.g.: + * + * SOMETHING somevar = {...,ASN1_ITEM_ref(X509),...}; + * + * and the actual pointer extracted with: + * + * const ASN1_ITEM *it = ASN1_ITEM_ptr(somevar.iptr); + * + * Finally an ASN1_ITEM pointer can be extracted from an + * appropriate reference with: ASN1_ITEM_rptr(X509). This + * would be used when a function takes an ASN1_ITEM * argument. + * + */ + +#ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION + +/* ASN1_ITEM pointer exported type */ +typedef const ASN1_ITEM ASN1_ITEM_EXP; + +/* Macro to obtain ASN1_ITEM pointer from exported type */ +#define ASN1_ITEM_ptr(iptr) (iptr) + +/* Macro to include ASN1_ITEM pointer from base type */ +#define ASN1_ITEM_ref(iptr) (&(iptr##_it)) + +#define ASN1_ITEM_rptr(ref) (&(ref##_it)) + +#define DECLARE_ASN1_ITEM(name) \ + OPENSSL_EXTERN const ASN1_ITEM name##_it; + +#else + +/* Platforms that can't easily handle shared global variables are declared + * as functions returning ASN1_ITEM pointers. + */ + +/* ASN1_ITEM pointer exported type */ +typedef const ASN1_ITEM * ASN1_ITEM_EXP(void); + +/* Macro to obtain ASN1_ITEM pointer from exported type */ +#define ASN1_ITEM_ptr(iptr) (iptr()) + +/* Macro to include ASN1_ITEM pointer from base type */ +#define ASN1_ITEM_ref(iptr) (iptr##_it) + +#define ASN1_ITEM_rptr(ref) (ref##_it()) + +#define DECLARE_ASN1_ITEM(name) \ + const ASN1_ITEM * name##_it(void); + +#endif + +/* Parameters used by ASN1_STRING_print_ex() */ + +/* These determine which characters to escape: + * RFC2253 special characters, control characters and + * MSB set characters + */ + +#define ASN1_STRFLGS_ESC_2253 1 +#define ASN1_STRFLGS_ESC_CTRL 2 +#define ASN1_STRFLGS_ESC_MSB 4 + + +/* This flag determines how we do escaping: normally + * RC2253 backslash only, set this to use backslash and + * quote. + */ + +#define ASN1_STRFLGS_ESC_QUOTE 8 + + +/* These three flags are internal use only. */ + +/* Character is a valid PrintableString character */ +#define CHARTYPE_PRINTABLESTRING 0x10 +/* Character needs escaping if it is the first character */ +#define CHARTYPE_FIRST_ESC_2253 0x20 +/* Character needs escaping if it is the last character */ +#define CHARTYPE_LAST_ESC_2253 0x40 + +/* NB the internal flags are safely reused below by flags + * handled at the top level. + */ + +/* If this is set we convert all character strings + * to UTF8 first + */ + +#define ASN1_STRFLGS_UTF8_CONVERT 0x10 + +/* If this is set we don't attempt to interpret content: + * just assume all strings are 1 byte per character. This + * will produce some pretty odd looking output! + */ + +#define ASN1_STRFLGS_IGNORE_TYPE 0x20 + +/* If this is set we include the string type in the output */ +#define ASN1_STRFLGS_SHOW_TYPE 0x40 + +/* This determines which strings to display and which to + * 'dump' (hex dump of content octets or DER encoding). We can + * only dump non character strings or everything. If we + * don't dump 'unknown' they are interpreted as character + * strings with 1 octet per character and are subject to + * the usual escaping options. + */ + +#define ASN1_STRFLGS_DUMP_ALL 0x80 +#define ASN1_STRFLGS_DUMP_UNKNOWN 0x100 + +/* These determine what 'dumping' does, we can dump the + * content octets or the DER encoding: both use the + * RFC2253 #XXXXX notation. + */ + +#define ASN1_STRFLGS_DUMP_DER 0x200 + +/* All the string flags consistent with RFC2253, + * escaping control characters isn't essential in + * RFC2253 but it is advisable anyway. + */ + +#define ASN1_STRFLGS_RFC2253 (ASN1_STRFLGS_ESC_2253 | \ + ASN1_STRFLGS_ESC_CTRL | \ + ASN1_STRFLGS_ESC_MSB | \ + ASN1_STRFLGS_UTF8_CONVERT | \ + ASN1_STRFLGS_DUMP_UNKNOWN | \ + ASN1_STRFLGS_DUMP_DER) + +DECLARE_STACK_OF(ASN1_INTEGER) +DECLARE_ASN1_SET_OF(ASN1_INTEGER) + +DECLARE_STACK_OF(ASN1_GENERALSTRING) + +typedef struct asn1_type_st + { + int type; + union { + char *ptr; + ASN1_BOOLEAN boolean; + ASN1_STRING * asn1_string; + ASN1_OBJECT * object; + ASN1_INTEGER * integer; + ASN1_ENUMERATED * enumerated; + ASN1_BIT_STRING * bit_string; + ASN1_OCTET_STRING * octet_string; + ASN1_PRINTABLESTRING * printablestring; + ASN1_T61STRING * t61string; + ASN1_IA5STRING * ia5string; + ASN1_GENERALSTRING * generalstring; + ASN1_BMPSTRING * bmpstring; + ASN1_UNIVERSALSTRING * universalstring; + ASN1_UTCTIME * utctime; + ASN1_GENERALIZEDTIME * generalizedtime; + ASN1_VISIBLESTRING * visiblestring; + ASN1_UTF8STRING * utf8string; + /* set and sequence are left complete and still + * contain the set or sequence bytes */ + ASN1_STRING * set; + ASN1_STRING * sequence; + ASN1_VALUE * asn1_value; + } value; + } ASN1_TYPE; + +DECLARE_STACK_OF(ASN1_TYPE) +DECLARE_ASN1_SET_OF(ASN1_TYPE) + +typedef STACK_OF(ASN1_TYPE) ASN1_SEQUENCE_ANY; + +DECLARE_ASN1_ENCODE_FUNCTIONS_const(ASN1_SEQUENCE_ANY, ASN1_SEQUENCE_ANY) +DECLARE_ASN1_ENCODE_FUNCTIONS_const(ASN1_SEQUENCE_ANY, ASN1_SET_ANY) + +typedef struct NETSCAPE_X509_st + { + ASN1_OCTET_STRING *header; + X509 *cert; + } NETSCAPE_X509; + +/* This is used to contain a list of bit names */ +typedef struct BIT_STRING_BITNAME_st { + int bitnum; + const char *lname; + const char *sname; +} BIT_STRING_BITNAME; + + +#define M_ASN1_STRING_length(x) ((x)->length) +#define M_ASN1_STRING_length_set(x, n) ((x)->length = (n)) +#define M_ASN1_STRING_type(x) ((x)->type) +#define M_ASN1_STRING_data(x) ((x)->data) + +/* Macros for string operations */ +#define M_ASN1_BIT_STRING_new() (ASN1_BIT_STRING *)\ + ASN1_STRING_type_new(V_ASN1_BIT_STRING) +#define M_ASN1_BIT_STRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_ASN1_BIT_STRING_dup(a) (ASN1_BIT_STRING *)\ + ASN1_STRING_dup((const ASN1_STRING *)a) +#define M_ASN1_BIT_STRING_cmp(a,b) ASN1_STRING_cmp(\ + (const ASN1_STRING *)a,(const ASN1_STRING *)b) +#define M_ASN1_BIT_STRING_set(a,b,c) ASN1_STRING_set((ASN1_STRING *)a,b,c) + +#define M_ASN1_INTEGER_new() (ASN1_INTEGER *)\ + ASN1_STRING_type_new(V_ASN1_INTEGER) +#define M_ASN1_INTEGER_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_ASN1_INTEGER_dup(a) (ASN1_INTEGER *)\ + ASN1_STRING_dup((const ASN1_STRING *)a) +#define M_ASN1_INTEGER_cmp(a,b) ASN1_STRING_cmp(\ + (const ASN1_STRING *)a,(const ASN1_STRING *)b) + +#define M_ASN1_ENUMERATED_new() (ASN1_ENUMERATED *)\ + ASN1_STRING_type_new(V_ASN1_ENUMERATED) +#define M_ASN1_ENUMERATED_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_ASN1_ENUMERATED_dup(a) (ASN1_ENUMERATED *)\ + ASN1_STRING_dup((const ASN1_STRING *)a) +#define M_ASN1_ENUMERATED_cmp(a,b) ASN1_STRING_cmp(\ + (const ASN1_STRING *)a,(const ASN1_STRING *)b) + +#define M_ASN1_OCTET_STRING_new() (ASN1_OCTET_STRING *)\ + ASN1_STRING_type_new(V_ASN1_OCTET_STRING) +#define M_ASN1_OCTET_STRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_ASN1_OCTET_STRING_dup(a) (ASN1_OCTET_STRING *)\ + ASN1_STRING_dup((const ASN1_STRING *)a) +#define M_ASN1_OCTET_STRING_cmp(a,b) ASN1_STRING_cmp(\ + (const ASN1_STRING *)a,(const ASN1_STRING *)b) +#define M_ASN1_OCTET_STRING_set(a,b,c) ASN1_STRING_set((ASN1_STRING *)a,b,c) +#define M_ASN1_OCTET_STRING_print(a,b) ASN1_STRING_print(a,(ASN1_STRING *)b) +#define M_i2d_ASN1_OCTET_STRING(a,pp) \ + i2d_ASN1_bytes((ASN1_STRING *)a,pp,V_ASN1_OCTET_STRING,\ + V_ASN1_UNIVERSAL) + +#define B_ASN1_TIME \ + B_ASN1_UTCTIME | \ + B_ASN1_GENERALIZEDTIME + +#define B_ASN1_PRINTABLE \ + B_ASN1_NUMERICSTRING| \ + B_ASN1_PRINTABLESTRING| \ + B_ASN1_T61STRING| \ + B_ASN1_IA5STRING| \ + B_ASN1_BIT_STRING| \ + B_ASN1_UNIVERSALSTRING|\ + B_ASN1_BMPSTRING|\ + B_ASN1_UTF8STRING|\ + B_ASN1_SEQUENCE|\ + B_ASN1_UNKNOWN + +#define B_ASN1_DIRECTORYSTRING \ + B_ASN1_PRINTABLESTRING| \ + B_ASN1_TELETEXSTRING|\ + B_ASN1_BMPSTRING|\ + B_ASN1_UNIVERSALSTRING|\ + B_ASN1_UTF8STRING + +#define B_ASN1_DISPLAYTEXT \ + B_ASN1_IA5STRING| \ + B_ASN1_VISIBLESTRING| \ + B_ASN1_BMPSTRING|\ + B_ASN1_UTF8STRING + +#define M_ASN1_PRINTABLE_new() ASN1_STRING_type_new(V_ASN1_T61STRING) +#define M_ASN1_PRINTABLE_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_i2d_ASN1_PRINTABLE(a,pp) i2d_ASN1_bytes((ASN1_STRING *)a,\ + pp,a->type,V_ASN1_UNIVERSAL) +#define M_d2i_ASN1_PRINTABLE(a,pp,l) \ + d2i_ASN1_type_bytes((ASN1_STRING **)a,pp,l, \ + B_ASN1_PRINTABLE) + +#define M_DIRECTORYSTRING_new() ASN1_STRING_type_new(V_ASN1_PRINTABLESTRING) +#define M_DIRECTORYSTRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_i2d_DIRECTORYSTRING(a,pp) i2d_ASN1_bytes((ASN1_STRING *)a,\ + pp,a->type,V_ASN1_UNIVERSAL) +#define M_d2i_DIRECTORYSTRING(a,pp,l) \ + d2i_ASN1_type_bytes((ASN1_STRING **)a,pp,l, \ + B_ASN1_DIRECTORYSTRING) + +#define M_DISPLAYTEXT_new() ASN1_STRING_type_new(V_ASN1_VISIBLESTRING) +#define M_DISPLAYTEXT_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_i2d_DISPLAYTEXT(a,pp) i2d_ASN1_bytes((ASN1_STRING *)a,\ + pp,a->type,V_ASN1_UNIVERSAL) +#define M_d2i_DISPLAYTEXT(a,pp,l) \ + d2i_ASN1_type_bytes((ASN1_STRING **)a,pp,l, \ + B_ASN1_DISPLAYTEXT) + +#define M_ASN1_PRINTABLESTRING_new() (ASN1_PRINTABLESTRING *)\ + ASN1_STRING_type_new(V_ASN1_PRINTABLESTRING) +#define M_ASN1_PRINTABLESTRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_i2d_ASN1_PRINTABLESTRING(a,pp) \ + i2d_ASN1_bytes((ASN1_STRING *)a,pp,V_ASN1_PRINTABLESTRING,\ + V_ASN1_UNIVERSAL) +#define M_d2i_ASN1_PRINTABLESTRING(a,pp,l) \ + (ASN1_PRINTABLESTRING *)d2i_ASN1_type_bytes\ + ((ASN1_STRING **)a,pp,l,B_ASN1_PRINTABLESTRING) + +#define M_ASN1_T61STRING_new() (ASN1_T61STRING *)\ + ASN1_STRING_type_new(V_ASN1_T61STRING) +#define M_ASN1_T61STRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_i2d_ASN1_T61STRING(a,pp) \ + i2d_ASN1_bytes((ASN1_STRING *)a,pp,V_ASN1_T61STRING,\ + V_ASN1_UNIVERSAL) +#define M_d2i_ASN1_T61STRING(a,pp,l) \ + (ASN1_T61STRING *)d2i_ASN1_type_bytes\ + ((ASN1_STRING **)a,pp,l,B_ASN1_T61STRING) + +#define M_ASN1_IA5STRING_new() (ASN1_IA5STRING *)\ + ASN1_STRING_type_new(V_ASN1_IA5STRING) +#define M_ASN1_IA5STRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_ASN1_IA5STRING_dup(a) \ + (ASN1_IA5STRING *)ASN1_STRING_dup((const ASN1_STRING *)a) +#define M_i2d_ASN1_IA5STRING(a,pp) \ + i2d_ASN1_bytes((ASN1_STRING *)a,pp,V_ASN1_IA5STRING,\ + V_ASN1_UNIVERSAL) +#define M_d2i_ASN1_IA5STRING(a,pp,l) \ + (ASN1_IA5STRING *)d2i_ASN1_type_bytes((ASN1_STRING **)a,pp,l,\ + B_ASN1_IA5STRING) + +#define M_ASN1_UTCTIME_new() (ASN1_UTCTIME *)\ + ASN1_STRING_type_new(V_ASN1_UTCTIME) +#define M_ASN1_UTCTIME_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_ASN1_UTCTIME_dup(a) (ASN1_UTCTIME *)\ + ASN1_STRING_dup((const ASN1_STRING *)a) + +#define M_ASN1_GENERALIZEDTIME_new() (ASN1_GENERALIZEDTIME *)\ + ASN1_STRING_type_new(V_ASN1_GENERALIZEDTIME) +#define M_ASN1_GENERALIZEDTIME_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_ASN1_GENERALIZEDTIME_dup(a) (ASN1_GENERALIZEDTIME *)ASN1_STRING_dup(\ + (const ASN1_STRING *)a) + +#define M_ASN1_TIME_new() (ASN1_TIME *)\ + ASN1_STRING_type_new(V_ASN1_UTCTIME) +#define M_ASN1_TIME_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_ASN1_TIME_dup(a) (ASN1_TIME *)\ + ASN1_STRING_dup((const ASN1_STRING *)a) + +#define M_ASN1_GENERALSTRING_new() (ASN1_GENERALSTRING *)\ + ASN1_STRING_type_new(V_ASN1_GENERALSTRING) +#define M_ASN1_GENERALSTRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_i2d_ASN1_GENERALSTRING(a,pp) \ + i2d_ASN1_bytes((ASN1_STRING *)a,pp,V_ASN1_GENERALSTRING,\ + V_ASN1_UNIVERSAL) +#define M_d2i_ASN1_GENERALSTRING(a,pp,l) \ + (ASN1_GENERALSTRING *)d2i_ASN1_type_bytes\ + ((ASN1_STRING **)a,pp,l,B_ASN1_GENERALSTRING) + +#define M_ASN1_UNIVERSALSTRING_new() (ASN1_UNIVERSALSTRING *)\ + ASN1_STRING_type_new(V_ASN1_UNIVERSALSTRING) +#define M_ASN1_UNIVERSALSTRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_i2d_ASN1_UNIVERSALSTRING(a,pp) \ + i2d_ASN1_bytes((ASN1_STRING *)a,pp,V_ASN1_UNIVERSALSTRING,\ + V_ASN1_UNIVERSAL) +#define M_d2i_ASN1_UNIVERSALSTRING(a,pp,l) \ + (ASN1_UNIVERSALSTRING *)d2i_ASN1_type_bytes\ + ((ASN1_STRING **)a,pp,l,B_ASN1_UNIVERSALSTRING) + +#define M_ASN1_BMPSTRING_new() (ASN1_BMPSTRING *)\ + ASN1_STRING_type_new(V_ASN1_BMPSTRING) +#define M_ASN1_BMPSTRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_i2d_ASN1_BMPSTRING(a,pp) \ + i2d_ASN1_bytes((ASN1_STRING *)a,pp,V_ASN1_BMPSTRING,\ + V_ASN1_UNIVERSAL) +#define M_d2i_ASN1_BMPSTRING(a,pp,l) \ + (ASN1_BMPSTRING *)d2i_ASN1_type_bytes\ + ((ASN1_STRING **)a,pp,l,B_ASN1_BMPSTRING) + +#define M_ASN1_VISIBLESTRING_new() (ASN1_VISIBLESTRING *)\ + ASN1_STRING_type_new(V_ASN1_VISIBLESTRING) +#define M_ASN1_VISIBLESTRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_i2d_ASN1_VISIBLESTRING(a,pp) \ + i2d_ASN1_bytes((ASN1_STRING *)a,pp,V_ASN1_VISIBLESTRING,\ + V_ASN1_UNIVERSAL) +#define M_d2i_ASN1_VISIBLESTRING(a,pp,l) \ + (ASN1_VISIBLESTRING *)d2i_ASN1_type_bytes\ + ((ASN1_STRING **)a,pp,l,B_ASN1_VISIBLESTRING) + +#define M_ASN1_UTF8STRING_new() (ASN1_UTF8STRING *)\ + ASN1_STRING_type_new(V_ASN1_UTF8STRING) +#define M_ASN1_UTF8STRING_free(a) ASN1_STRING_free((ASN1_STRING *)a) +#define M_i2d_ASN1_UTF8STRING(a,pp) \ + i2d_ASN1_bytes((ASN1_STRING *)a,pp,V_ASN1_UTF8STRING,\ + V_ASN1_UNIVERSAL) +#define M_d2i_ASN1_UTF8STRING(a,pp,l) \ + (ASN1_UTF8STRING *)d2i_ASN1_type_bytes\ + ((ASN1_STRING **)a,pp,l,B_ASN1_UTF8STRING) + + /* for the is_set parameter to i2d_ASN1_SET */ +#define IS_SEQUENCE 0 +#define IS_SET 1 + +DECLARE_ASN1_FUNCTIONS_fname(ASN1_TYPE, ASN1_ANY, ASN1_TYPE) + +int ASN1_TYPE_get(ASN1_TYPE *a); +void ASN1_TYPE_set(ASN1_TYPE *a, int type, void *value); +int ASN1_TYPE_set1(ASN1_TYPE *a, int type, const void *value); +int ASN1_TYPE_cmp(ASN1_TYPE *a, ASN1_TYPE *b); + +ASN1_OBJECT * ASN1_OBJECT_new(void ); +void ASN1_OBJECT_free(ASN1_OBJECT *a); +int i2d_ASN1_OBJECT(ASN1_OBJECT *a,unsigned char **pp); +ASN1_OBJECT * c2i_ASN1_OBJECT(ASN1_OBJECT **a,const unsigned char **pp, + long length); +ASN1_OBJECT * d2i_ASN1_OBJECT(ASN1_OBJECT **a,const unsigned char **pp, + long length); + +DECLARE_ASN1_ITEM(ASN1_OBJECT) + +DECLARE_STACK_OF(ASN1_OBJECT) +DECLARE_ASN1_SET_OF(ASN1_OBJECT) + +ASN1_STRING * ASN1_STRING_new(void); +void ASN1_STRING_free(ASN1_STRING *a); +int ASN1_STRING_copy(ASN1_STRING *dst, const ASN1_STRING *str); +ASN1_STRING * ASN1_STRING_dup(const ASN1_STRING *a); +ASN1_STRING * ASN1_STRING_type_new(int type ); +int ASN1_STRING_cmp(const ASN1_STRING *a, const ASN1_STRING *b); + /* Since this is used to store all sorts of things, via macros, for now, make + its data void * */ +int ASN1_STRING_set(ASN1_STRING *str, const void *data, int len); +void ASN1_STRING_set0(ASN1_STRING *str, void *data, int len); +int ASN1_STRING_length(const ASN1_STRING *x); +void ASN1_STRING_length_set(ASN1_STRING *x, int n); +int ASN1_STRING_type(ASN1_STRING *x); +unsigned char * ASN1_STRING_data(ASN1_STRING *x); + +DECLARE_ASN1_FUNCTIONS(ASN1_BIT_STRING) +int i2c_ASN1_BIT_STRING(ASN1_BIT_STRING *a,unsigned char **pp); +ASN1_BIT_STRING *c2i_ASN1_BIT_STRING(ASN1_BIT_STRING **a,const unsigned char **pp, + long length); +int ASN1_BIT_STRING_set(ASN1_BIT_STRING *a, unsigned char *d, + int length ); +int ASN1_BIT_STRING_set_bit(ASN1_BIT_STRING *a, int n, int value); +int ASN1_BIT_STRING_get_bit(ASN1_BIT_STRING *a, int n); +int ASN1_BIT_STRING_check(ASN1_BIT_STRING *a, + unsigned char *flags, int flags_len); + +#ifndef OPENSSL_NO_BIO +int ASN1_BIT_STRING_name_print(BIO *out, ASN1_BIT_STRING *bs, + BIT_STRING_BITNAME *tbl, int indent); +#endif +int ASN1_BIT_STRING_num_asc(char *name, BIT_STRING_BITNAME *tbl); +int ASN1_BIT_STRING_set_asc(ASN1_BIT_STRING *bs, char *name, int value, + BIT_STRING_BITNAME *tbl); + +int i2d_ASN1_BOOLEAN(int a,unsigned char **pp); +int d2i_ASN1_BOOLEAN(int *a,const unsigned char **pp,long length); + +DECLARE_ASN1_FUNCTIONS(ASN1_INTEGER) +int i2c_ASN1_INTEGER(ASN1_INTEGER *a,unsigned char **pp); +ASN1_INTEGER *c2i_ASN1_INTEGER(ASN1_INTEGER **a,const unsigned char **pp, + long length); +ASN1_INTEGER *d2i_ASN1_UINTEGER(ASN1_INTEGER **a,const unsigned char **pp, + long length); +ASN1_INTEGER * ASN1_INTEGER_dup(const ASN1_INTEGER *x); +int ASN1_INTEGER_cmp(const ASN1_INTEGER *x, const ASN1_INTEGER *y); + +DECLARE_ASN1_FUNCTIONS(ASN1_ENUMERATED) + +int ASN1_UTCTIME_check(ASN1_UTCTIME *a); +ASN1_UTCTIME *ASN1_UTCTIME_set(ASN1_UTCTIME *s,time_t t); +ASN1_UTCTIME *ASN1_UTCTIME_adj(ASN1_UTCTIME *s, time_t t, + int offset_day, long offset_sec); +int ASN1_UTCTIME_set_string(ASN1_UTCTIME *s, const char *str); +int ASN1_UTCTIME_cmp_time_t(const ASN1_UTCTIME *s, time_t t); +#if 0 +time_t ASN1_UTCTIME_get(const ASN1_UTCTIME *s); +#endif + +int ASN1_GENERALIZEDTIME_check(ASN1_GENERALIZEDTIME *a); +ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_set(ASN1_GENERALIZEDTIME *s,time_t t); +ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_adj(ASN1_GENERALIZEDTIME *s, + time_t t, int offset_day, long offset_sec); +int ASN1_GENERALIZEDTIME_set_string(ASN1_GENERALIZEDTIME *s, const char *str); + +DECLARE_ASN1_FUNCTIONS(ASN1_OCTET_STRING) +ASN1_OCTET_STRING * ASN1_OCTET_STRING_dup(const ASN1_OCTET_STRING *a); +int ASN1_OCTET_STRING_cmp(const ASN1_OCTET_STRING *a, const ASN1_OCTET_STRING *b); +int ASN1_OCTET_STRING_set(ASN1_OCTET_STRING *str, const unsigned char *data, int len); + +DECLARE_ASN1_FUNCTIONS(ASN1_VISIBLESTRING) +DECLARE_ASN1_FUNCTIONS(ASN1_UNIVERSALSTRING) +DECLARE_ASN1_FUNCTIONS(ASN1_UTF8STRING) +DECLARE_ASN1_FUNCTIONS(ASN1_NULL) +DECLARE_ASN1_FUNCTIONS(ASN1_BMPSTRING) + +int UTF8_getc(const unsigned char *str, int len, unsigned long *val); +int UTF8_putc(unsigned char *str, int len, unsigned long value); + +DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING, ASN1_PRINTABLE) + +DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING, DIRECTORYSTRING) +DECLARE_ASN1_FUNCTIONS_name(ASN1_STRING, DISPLAYTEXT) +DECLARE_ASN1_FUNCTIONS(ASN1_PRINTABLESTRING) +DECLARE_ASN1_FUNCTIONS(ASN1_T61STRING) +DECLARE_ASN1_FUNCTIONS(ASN1_IA5STRING) +DECLARE_ASN1_FUNCTIONS(ASN1_GENERALSTRING) +DECLARE_ASN1_FUNCTIONS(ASN1_UTCTIME) +DECLARE_ASN1_FUNCTIONS(ASN1_GENERALIZEDTIME) +DECLARE_ASN1_FUNCTIONS(ASN1_TIME) + +DECLARE_ASN1_ITEM(ASN1_OCTET_STRING_NDEF) + +ASN1_TIME *ASN1_TIME_set(ASN1_TIME *s,time_t t); +ASN1_TIME *ASN1_TIME_adj(ASN1_TIME *s,time_t t, + int offset_day, long offset_sec); +int ASN1_TIME_check(ASN1_TIME *t); +ASN1_GENERALIZEDTIME *ASN1_TIME_to_generalizedtime(ASN1_TIME *t, ASN1_GENERALIZEDTIME **out); +int ASN1_TIME_set_string(ASN1_TIME *s, const char *str); + +int i2d_ASN1_SET(STACK_OF(OPENSSL_BLOCK) *a, unsigned char **pp, + i2d_of_void *i2d, int ex_tag, int ex_class, + int is_set); +STACK_OF(OPENSSL_BLOCK) *d2i_ASN1_SET(STACK_OF(OPENSSL_BLOCK) **a, + const unsigned char **pp, + long length, d2i_of_void *d2i, + void (*free_func)(OPENSSL_BLOCK), int ex_tag, + int ex_class); + +#ifndef OPENSSL_NO_BIO +int i2a_ASN1_INTEGER(BIO *bp, ASN1_INTEGER *a); +int a2i_ASN1_INTEGER(BIO *bp,ASN1_INTEGER *bs,char *buf,int size); +int i2a_ASN1_ENUMERATED(BIO *bp, ASN1_ENUMERATED *a); +int a2i_ASN1_ENUMERATED(BIO *bp,ASN1_ENUMERATED *bs,char *buf,int size); +int i2a_ASN1_OBJECT(BIO *bp,ASN1_OBJECT *a); +int a2i_ASN1_STRING(BIO *bp,ASN1_STRING *bs,char *buf,int size); +int i2a_ASN1_STRING(BIO *bp, ASN1_STRING *a, int type); +#endif +int i2t_ASN1_OBJECT(char *buf,int buf_len,ASN1_OBJECT *a); + +int a2d_ASN1_OBJECT(unsigned char *out,int olen, const char *buf, int num); +ASN1_OBJECT *ASN1_OBJECT_create(int nid, unsigned char *data,int len, + const char *sn, const char *ln); + +int ASN1_INTEGER_set(ASN1_INTEGER *a, long v); +long ASN1_INTEGER_get(const ASN1_INTEGER *a); +ASN1_INTEGER *BN_to_ASN1_INTEGER(const BIGNUM *bn, ASN1_INTEGER *ai); +BIGNUM *ASN1_INTEGER_to_BN(const ASN1_INTEGER *ai,BIGNUM *bn); + +int ASN1_ENUMERATED_set(ASN1_ENUMERATED *a, long v); +long ASN1_ENUMERATED_get(ASN1_ENUMERATED *a); +ASN1_ENUMERATED *BN_to_ASN1_ENUMERATED(BIGNUM *bn, ASN1_ENUMERATED *ai); +BIGNUM *ASN1_ENUMERATED_to_BN(ASN1_ENUMERATED *ai,BIGNUM *bn); + +/* General */ +/* given a string, return the correct type, max is the maximum length */ +int ASN1_PRINTABLE_type(const unsigned char *s, int max); + +int i2d_ASN1_bytes(ASN1_STRING *a, unsigned char **pp, int tag, int xclass); +ASN1_STRING *d2i_ASN1_bytes(ASN1_STRING **a, const unsigned char **pp, + long length, int Ptag, int Pclass); +unsigned long ASN1_tag2bit(int tag); +/* type is one or more of the B_ASN1_ values. */ +ASN1_STRING *d2i_ASN1_type_bytes(ASN1_STRING **a,const unsigned char **pp, + long length,int type); + +/* PARSING */ +int asn1_Finish(ASN1_CTX *c); +int asn1_const_Finish(ASN1_const_CTX *c); + +/* SPECIALS */ +int ASN1_get_object(const unsigned char **pp, long *plength, int *ptag, + int *pclass, long omax); +int ASN1_check_infinite_end(unsigned char **p,long len); +int ASN1_const_check_infinite_end(const unsigned char **p,long len); +void ASN1_put_object(unsigned char **pp, int constructed, int length, + int tag, int xclass); +int ASN1_put_eoc(unsigned char **pp); +int ASN1_object_size(int constructed, int length, int tag); + +/* Used to implement other functions */ +void *ASN1_dup(i2d_of_void *i2d, d2i_of_void *d2i, void *x); + +#define ASN1_dup_of(type,i2d,d2i,x) \ + ((type*)ASN1_dup(CHECKED_I2D_OF(type, i2d), \ + CHECKED_D2I_OF(type, d2i), \ + CHECKED_PTR_OF(type, x))) + +#define ASN1_dup_of_const(type,i2d,d2i,x) \ + ((type*)ASN1_dup(CHECKED_I2D_OF(const type, i2d), \ + CHECKED_D2I_OF(type, d2i), \ + CHECKED_PTR_OF(const type, x))) + +void *ASN1_item_dup(const ASN1_ITEM *it, void *x); + +/* ASN1 alloc/free macros for when a type is only used internally */ + +#define M_ASN1_new_of(type) (type *)ASN1_item_new(ASN1_ITEM_rptr(type)) +#define M_ASN1_free_of(x, type) \ + ASN1_item_free(CHECKED_PTR_OF(type, x), ASN1_ITEM_rptr(type)) + +#ifndef OPENSSL_NO_FP_API +void *ASN1_d2i_fp(void *(*xnew)(void), d2i_of_void *d2i, FILE *in, void **x); + +#define ASN1_d2i_fp_of(type,xnew,d2i,in,x) \ + ((type*)ASN1_d2i_fp(CHECKED_NEW_OF(type, xnew), \ + CHECKED_D2I_OF(type, d2i), \ + in, \ + CHECKED_PPTR_OF(type, x))) + +void *ASN1_item_d2i_fp(const ASN1_ITEM *it, FILE *in, void *x); +int ASN1_i2d_fp(i2d_of_void *i2d,FILE *out,void *x); + +#define ASN1_i2d_fp_of(type,i2d,out,x) \ + (ASN1_i2d_fp(CHECKED_I2D_OF(type, i2d), \ + out, \ + CHECKED_PTR_OF(type, x))) + +#define ASN1_i2d_fp_of_const(type,i2d,out,x) \ + (ASN1_i2d_fp(CHECKED_I2D_OF(const type, i2d), \ + out, \ + CHECKED_PTR_OF(const type, x))) + +int ASN1_item_i2d_fp(const ASN1_ITEM *it, FILE *out, void *x); +int ASN1_STRING_print_ex_fp(FILE *fp, ASN1_STRING *str, unsigned long flags); +#endif + +int ASN1_STRING_to_UTF8(unsigned char **out, ASN1_STRING *in); + +#ifndef OPENSSL_NO_BIO +void *ASN1_d2i_bio(void *(*xnew)(void), d2i_of_void *d2i, BIO *in, void **x); + +#define ASN1_d2i_bio_of(type,xnew,d2i,in,x) \ + ((type*)ASN1_d2i_bio( CHECKED_NEW_OF(type, xnew), \ + CHECKED_D2I_OF(type, d2i), \ + in, \ + CHECKED_PPTR_OF(type, x))) + +void *ASN1_item_d2i_bio(const ASN1_ITEM *it, BIO *in, void *x); +int ASN1_i2d_bio(i2d_of_void *i2d,BIO *out, unsigned char *x); + +#define ASN1_i2d_bio_of(type,i2d,out,x) \ + (ASN1_i2d_bio(CHECKED_I2D_OF(type, i2d), \ + out, \ + CHECKED_PTR_OF(type, x))) + +#define ASN1_i2d_bio_of_const(type,i2d,out,x) \ + (ASN1_i2d_bio(CHECKED_I2D_OF(const type, i2d), \ + out, \ + CHECKED_PTR_OF(const type, x))) + +int ASN1_item_i2d_bio(const ASN1_ITEM *it, BIO *out, void *x); +int ASN1_UTCTIME_print(BIO *fp, const ASN1_UTCTIME *a); +int ASN1_GENERALIZEDTIME_print(BIO *fp, const ASN1_GENERALIZEDTIME *a); +int ASN1_TIME_print(BIO *fp, const ASN1_TIME *a); +int ASN1_STRING_print(BIO *bp, const ASN1_STRING *v); +int ASN1_STRING_print_ex(BIO *out, ASN1_STRING *str, unsigned long flags); +int ASN1_bn_print(BIO *bp, const char *number, const BIGNUM *num, + unsigned char *buf, int off); +int ASN1_parse(BIO *bp,const unsigned char *pp,long len,int indent); +int ASN1_parse_dump(BIO *bp,const unsigned char *pp,long len,int indent,int dump); +#endif +const char *ASN1_tag2str(int tag); + +/* Used to load and write netscape format cert */ + +DECLARE_ASN1_FUNCTIONS(NETSCAPE_X509) + +int ASN1_UNIVERSALSTRING_to_string(ASN1_UNIVERSALSTRING *s); + +int ASN1_TYPE_set_octetstring(ASN1_TYPE *a, + unsigned char *data, int len); +int ASN1_TYPE_get_octetstring(ASN1_TYPE *a, + unsigned char *data, int max_len); +int ASN1_TYPE_set_int_octetstring(ASN1_TYPE *a, long num, + unsigned char *data, int len); +int ASN1_TYPE_get_int_octetstring(ASN1_TYPE *a,long *num, + unsigned char *data, int max_len); + +STACK_OF(OPENSSL_BLOCK) *ASN1_seq_unpack(const unsigned char *buf, int len, + d2i_of_void *d2i, void (*free_func)(OPENSSL_BLOCK)); +unsigned char *ASN1_seq_pack(STACK_OF(OPENSSL_BLOCK) *safes, i2d_of_void *i2d, + unsigned char **buf, int *len ); +void *ASN1_unpack_string(ASN1_STRING *oct, d2i_of_void *d2i); +void *ASN1_item_unpack(ASN1_STRING *oct, const ASN1_ITEM *it); +ASN1_STRING *ASN1_pack_string(void *obj, i2d_of_void *i2d, + ASN1_OCTET_STRING **oct); + +#define ASN1_pack_string_of(type,obj,i2d,oct) \ + (ASN1_pack_string(CHECKED_PTR_OF(type, obj), \ + CHECKED_I2D_OF(type, i2d), \ + oct)) + +ASN1_STRING *ASN1_item_pack(void *obj, const ASN1_ITEM *it, ASN1_OCTET_STRING **oct); + +void ASN1_STRING_set_default_mask(unsigned long mask); +int ASN1_STRING_set_default_mask_asc(const char *p); +unsigned long ASN1_STRING_get_default_mask(void); +int ASN1_mbstring_copy(ASN1_STRING **out, const unsigned char *in, int len, + int inform, unsigned long mask); +int ASN1_mbstring_ncopy(ASN1_STRING **out, const unsigned char *in, int len, + int inform, unsigned long mask, + long minsize, long maxsize); + +ASN1_STRING *ASN1_STRING_set_by_NID(ASN1_STRING **out, + const unsigned char *in, int inlen, int inform, int nid); +ASN1_STRING_TABLE *ASN1_STRING_TABLE_get(int nid); +int ASN1_STRING_TABLE_add(int, long, long, unsigned long, unsigned long); +void ASN1_STRING_TABLE_cleanup(void); + +/* ASN1 template functions */ + +/* Old API compatible functions */ +ASN1_VALUE *ASN1_item_new(const ASN1_ITEM *it); +void ASN1_item_free(ASN1_VALUE *val, const ASN1_ITEM *it); +ASN1_VALUE * ASN1_item_d2i(ASN1_VALUE **val, const unsigned char **in, long len, const ASN1_ITEM *it); +int ASN1_item_i2d(ASN1_VALUE *val, unsigned char **out, const ASN1_ITEM *it); +int ASN1_item_ndef_i2d(ASN1_VALUE *val, unsigned char **out, const ASN1_ITEM *it); + +void ASN1_add_oid_module(void); + +ASN1_TYPE *ASN1_generate_nconf(char *str, CONF *nconf); +ASN1_TYPE *ASN1_generate_v3(char *str, X509V3_CTX *cnf); + +/* ASN1 Print flags */ + +/* Indicate missing OPTIONAL fields */ +#define ASN1_PCTX_FLAGS_SHOW_ABSENT 0x001 +/* Mark start and end of SEQUENCE */ +#define ASN1_PCTX_FLAGS_SHOW_SEQUENCE 0x002 +/* Mark start and end of SEQUENCE/SET OF */ +#define ASN1_PCTX_FLAGS_SHOW_SSOF 0x004 +/* Show the ASN1 type of primitives */ +#define ASN1_PCTX_FLAGS_SHOW_TYPE 0x008 +/* Don't show ASN1 type of ANY */ +#define ASN1_PCTX_FLAGS_NO_ANY_TYPE 0x010 +/* Don't show ASN1 type of MSTRINGs */ +#define ASN1_PCTX_FLAGS_NO_MSTRING_TYPE 0x020 +/* Don't show field names in SEQUENCE */ +#define ASN1_PCTX_FLAGS_NO_FIELD_NAME 0x040 +/* Show structure names of each SEQUENCE field */ +#define ASN1_PCTX_FLAGS_SHOW_FIELD_STRUCT_NAME 0x080 +/* Don't show structure name even at top level */ +#define ASN1_PCTX_FLAGS_NO_STRUCT_NAME 0x100 + +int ASN1_item_print(BIO *out, ASN1_VALUE *ifld, int indent, + const ASN1_ITEM *it, const ASN1_PCTX *pctx); +ASN1_PCTX *ASN1_PCTX_new(void); +void ASN1_PCTX_free(ASN1_PCTX *p); +unsigned long ASN1_PCTX_get_flags(ASN1_PCTX *p); +void ASN1_PCTX_set_flags(ASN1_PCTX *p, unsigned long flags); +unsigned long ASN1_PCTX_get_nm_flags(ASN1_PCTX *p); +void ASN1_PCTX_set_nm_flags(ASN1_PCTX *p, unsigned long flags); +unsigned long ASN1_PCTX_get_cert_flags(ASN1_PCTX *p); +void ASN1_PCTX_set_cert_flags(ASN1_PCTX *p, unsigned long flags); +unsigned long ASN1_PCTX_get_oid_flags(ASN1_PCTX *p); +void ASN1_PCTX_set_oid_flags(ASN1_PCTX *p, unsigned long flags); +unsigned long ASN1_PCTX_get_str_flags(ASN1_PCTX *p); +void ASN1_PCTX_set_str_flags(ASN1_PCTX *p, unsigned long flags); + +BIO_METHOD *BIO_f_asn1(void); + +BIO *BIO_new_NDEF(BIO *out, ASN1_VALUE *val, const ASN1_ITEM *it); + +int i2d_ASN1_bio_stream(BIO *out, ASN1_VALUE *val, BIO *in, int flags, + const ASN1_ITEM *it); +int PEM_write_bio_ASN1_stream(BIO *out, ASN1_VALUE *val, BIO *in, int flags, + const char *hdr, + const ASN1_ITEM *it); +int SMIME_write_ASN1(BIO *bio, ASN1_VALUE *val, BIO *data, int flags, + int ctype_nid, int econt_nid, + STACK_OF(X509_ALGOR) *mdalgs, + const ASN1_ITEM *it); +ASN1_VALUE *SMIME_read_ASN1(BIO *bio, BIO **bcont, const ASN1_ITEM *it); +int SMIME_crlf_copy(BIO *in, BIO *out, int flags); +int SMIME_text(BIO *in, BIO *out); + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_ASN1_strings(void); + +/* Error codes for the ASN1 functions. */ + +/* Function codes. */ +#define ASN1_F_A2D_ASN1_OBJECT 100 +#define ASN1_F_A2I_ASN1_ENUMERATED 101 +#define ASN1_F_A2I_ASN1_INTEGER 102 +#define ASN1_F_A2I_ASN1_STRING 103 +#define ASN1_F_APPEND_EXP 176 +#define ASN1_F_ASN1_BIT_STRING_SET_BIT 183 +#define ASN1_F_ASN1_CB 177 +#define ASN1_F_ASN1_CHECK_TLEN 104 +#define ASN1_F_ASN1_COLLATE_PRIMITIVE 105 +#define ASN1_F_ASN1_COLLECT 106 +#define ASN1_F_ASN1_D2I_EX_PRIMITIVE 108 +#define ASN1_F_ASN1_D2I_FP 109 +#define ASN1_F_ASN1_D2I_READ_BIO 107 +#define ASN1_F_ASN1_DIGEST 184 +#define ASN1_F_ASN1_DO_ADB 110 +#define ASN1_F_ASN1_DUP 111 +#define ASN1_F_ASN1_ENUMERATED_SET 112 +#define ASN1_F_ASN1_ENUMERATED_TO_BN 113 +#define ASN1_F_ASN1_EX_C2I 204 +#define ASN1_F_ASN1_FIND_END 190 +#define ASN1_F_ASN1_GENERALIZEDTIME_ADJ 216 +#define ASN1_F_ASN1_GENERALIZEDTIME_SET 185 +#define ASN1_F_ASN1_GENERATE_V3 178 +#define ASN1_F_ASN1_GET_OBJECT 114 +#define ASN1_F_ASN1_HEADER_NEW 115 +#define ASN1_F_ASN1_I2D_BIO 116 +#define ASN1_F_ASN1_I2D_FP 117 +#define ASN1_F_ASN1_INTEGER_SET 118 +#define ASN1_F_ASN1_INTEGER_TO_BN 119 +#define ASN1_F_ASN1_ITEM_D2I_FP 206 +#define ASN1_F_ASN1_ITEM_DUP 191 +#define ASN1_F_ASN1_ITEM_EX_COMBINE_NEW 121 +#define ASN1_F_ASN1_ITEM_EX_D2I 120 +#define ASN1_F_ASN1_ITEM_I2D_BIO 192 +#define ASN1_F_ASN1_ITEM_I2D_FP 193 +#define ASN1_F_ASN1_ITEM_PACK 198 +#define ASN1_F_ASN1_ITEM_SIGN 195 +#define ASN1_F_ASN1_ITEM_SIGN_CTX 220 +#define ASN1_F_ASN1_ITEM_UNPACK 199 +#define ASN1_F_ASN1_ITEM_VERIFY 197 +#define ASN1_F_ASN1_MBSTRING_NCOPY 122 +#define ASN1_F_ASN1_OBJECT_NEW 123 +#define ASN1_F_ASN1_OUTPUT_DATA 214 +#define ASN1_F_ASN1_PACK_STRING 124 +#define ASN1_F_ASN1_PCTX_NEW 205 +#define ASN1_F_ASN1_PKCS5_PBE_SET 125 +#define ASN1_F_ASN1_SEQ_PACK 126 +#define ASN1_F_ASN1_SEQ_UNPACK 127 +#define ASN1_F_ASN1_SIGN 128 +#define ASN1_F_ASN1_STR2TYPE 179 +#define ASN1_F_ASN1_STRING_SET 186 +#define ASN1_F_ASN1_STRING_TABLE_ADD 129 +#define ASN1_F_ASN1_STRING_TYPE_NEW 130 +#define ASN1_F_ASN1_TEMPLATE_EX_D2I 132 +#define ASN1_F_ASN1_TEMPLATE_NEW 133 +#define ASN1_F_ASN1_TEMPLATE_NOEXP_D2I 131 +#define ASN1_F_ASN1_TIME_ADJ 217 +#define ASN1_F_ASN1_TIME_SET 175 +#define ASN1_F_ASN1_TYPE_GET_INT_OCTETSTRING 134 +#define ASN1_F_ASN1_TYPE_GET_OCTETSTRING 135 +#define ASN1_F_ASN1_UNPACK_STRING 136 +#define ASN1_F_ASN1_UTCTIME_ADJ 218 +#define ASN1_F_ASN1_UTCTIME_SET 187 +#define ASN1_F_ASN1_VERIFY 137 +#define ASN1_F_B64_READ_ASN1 209 +#define ASN1_F_B64_WRITE_ASN1 210 +#define ASN1_F_BIO_NEW_NDEF 208 +#define ASN1_F_BITSTR_CB 180 +#define ASN1_F_BN_TO_ASN1_ENUMERATED 138 +#define ASN1_F_BN_TO_ASN1_INTEGER 139 +#define ASN1_F_C2I_ASN1_BIT_STRING 189 +#define ASN1_F_C2I_ASN1_INTEGER 194 +#define ASN1_F_C2I_ASN1_OBJECT 196 +#define ASN1_F_COLLECT_DATA 140 +#define ASN1_F_D2I_ASN1_BIT_STRING 141 +#define ASN1_F_D2I_ASN1_BOOLEAN 142 +#define ASN1_F_D2I_ASN1_BYTES 143 +#define ASN1_F_D2I_ASN1_GENERALIZEDTIME 144 +#define ASN1_F_D2I_ASN1_HEADER 145 +#define ASN1_F_D2I_ASN1_INTEGER 146 +#define ASN1_F_D2I_ASN1_OBJECT 147 +#define ASN1_F_D2I_ASN1_SET 148 +#define ASN1_F_D2I_ASN1_TYPE_BYTES 149 +#define ASN1_F_D2I_ASN1_UINTEGER 150 +#define ASN1_F_D2I_ASN1_UTCTIME 151 +#define ASN1_F_D2I_AUTOPRIVATEKEY 207 +#define ASN1_F_D2I_NETSCAPE_RSA 152 +#define ASN1_F_D2I_NETSCAPE_RSA_2 153 +#define ASN1_F_D2I_PRIVATEKEY 154 +#define ASN1_F_D2I_PUBLICKEY 155 +#define ASN1_F_D2I_RSA_NET 200 +#define ASN1_F_D2I_RSA_NET_2 201 +#define ASN1_F_D2I_X509 156 +#define ASN1_F_D2I_X509_CINF 157 +#define ASN1_F_D2I_X509_PKEY 159 +#define ASN1_F_I2D_ASN1_BIO_STREAM 211 +#define ASN1_F_I2D_ASN1_SET 188 +#define ASN1_F_I2D_ASN1_TIME 160 +#define ASN1_F_I2D_DSA_PUBKEY 161 +#define ASN1_F_I2D_EC_PUBKEY 181 +#define ASN1_F_I2D_PRIVATEKEY 163 +#define ASN1_F_I2D_PUBLICKEY 164 +#define ASN1_F_I2D_RSA_NET 162 +#define ASN1_F_I2D_RSA_PUBKEY 165 +#define ASN1_F_LONG_C2I 166 +#define ASN1_F_OID_MODULE_INIT 174 +#define ASN1_F_PARSE_TAGGING 182 +#define ASN1_F_PKCS5_PBE2_SET_IV 167 +#define ASN1_F_PKCS5_PBE_SET 202 +#define ASN1_F_PKCS5_PBE_SET0_ALGOR 215 +#define ASN1_F_PKCS5_PBKDF2_SET 219 +#define ASN1_F_SMIME_READ_ASN1 212 +#define ASN1_F_SMIME_TEXT 213 +#define ASN1_F_X509_CINF_NEW 168 +#define ASN1_F_X509_CRL_ADD0_REVOKED 169 +#define ASN1_F_X509_INFO_NEW 170 +#define ASN1_F_X509_NAME_ENCODE 203 +#define ASN1_F_X509_NAME_EX_D2I 158 +#define ASN1_F_X509_NAME_EX_NEW 171 +#define ASN1_F_X509_NEW 172 +#define ASN1_F_X509_PKEY_NEW 173 + +/* Reason codes. */ +#define ASN1_R_ADDING_OBJECT 171 +#define ASN1_R_ASN1_PARSE_ERROR 203 +#define ASN1_R_ASN1_SIG_PARSE_ERROR 204 +#define ASN1_R_AUX_ERROR 100 +#define ASN1_R_BAD_CLASS 101 +#define ASN1_R_BAD_OBJECT_HEADER 102 +#define ASN1_R_BAD_PASSWORD_READ 103 +#define ASN1_R_BAD_TAG 104 +#define ASN1_R_BMPSTRING_IS_WRONG_LENGTH 214 +#define ASN1_R_BN_LIB 105 +#define ASN1_R_BOOLEAN_IS_WRONG_LENGTH 106 +#define ASN1_R_BUFFER_TOO_SMALL 107 +#define ASN1_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER 108 +#define ASN1_R_CONTEXT_NOT_INITIALISED 217 +#define ASN1_R_DATA_IS_WRONG 109 +#define ASN1_R_DECODE_ERROR 110 +#define ASN1_R_DECODING_ERROR 111 +#define ASN1_R_DEPTH_EXCEEDED 174 +#define ASN1_R_DIGEST_AND_KEY_TYPE_NOT_SUPPORTED 198 +#define ASN1_R_ENCODE_ERROR 112 +#define ASN1_R_ERROR_GETTING_TIME 173 +#define ASN1_R_ERROR_LOADING_SECTION 172 +#define ASN1_R_ERROR_PARSING_SET_ELEMENT 113 +#define ASN1_R_ERROR_SETTING_CIPHER_PARAMS 114 +#define ASN1_R_EXPECTING_AN_INTEGER 115 +#define ASN1_R_EXPECTING_AN_OBJECT 116 +#define ASN1_R_EXPECTING_A_BOOLEAN 117 +#define ASN1_R_EXPECTING_A_TIME 118 +#define ASN1_R_EXPLICIT_LENGTH_MISMATCH 119 +#define ASN1_R_EXPLICIT_TAG_NOT_CONSTRUCTED 120 +#define ASN1_R_FIELD_MISSING 121 +#define ASN1_R_FIRST_NUM_TOO_LARGE 122 +#define ASN1_R_HEADER_TOO_LONG 123 +#define ASN1_R_ILLEGAL_BITSTRING_FORMAT 175 +#define ASN1_R_ILLEGAL_BOOLEAN 176 +#define ASN1_R_ILLEGAL_CHARACTERS 124 +#define ASN1_R_ILLEGAL_FORMAT 177 +#define ASN1_R_ILLEGAL_HEX 178 +#define ASN1_R_ILLEGAL_IMPLICIT_TAG 179 +#define ASN1_R_ILLEGAL_INTEGER 180 +#define ASN1_R_ILLEGAL_NESTED_TAGGING 181 +#define ASN1_R_ILLEGAL_NULL 125 +#define ASN1_R_ILLEGAL_NULL_VALUE 182 +#define ASN1_R_ILLEGAL_OBJECT 183 +#define ASN1_R_ILLEGAL_OPTIONAL_ANY 126 +#define ASN1_R_ILLEGAL_OPTIONS_ON_ITEM_TEMPLATE 170 +#define ASN1_R_ILLEGAL_TAGGED_ANY 127 +#define ASN1_R_ILLEGAL_TIME_VALUE 184 +#define ASN1_R_INTEGER_NOT_ASCII_FORMAT 185 +#define ASN1_R_INTEGER_TOO_LARGE_FOR_LONG 128 +#define ASN1_R_INVALID_BMPSTRING_LENGTH 129 +#define ASN1_R_INVALID_DIGIT 130 +#define ASN1_R_INVALID_MIME_TYPE 205 +#define ASN1_R_INVALID_MODIFIER 186 +#define ASN1_R_INVALID_NUMBER 187 +#define ASN1_R_INVALID_OBJECT_ENCODING 216 +#define ASN1_R_INVALID_SEPARATOR 131 +#define ASN1_R_INVALID_TIME_FORMAT 132 +#define ASN1_R_INVALID_UNIVERSALSTRING_LENGTH 133 +#define ASN1_R_INVALID_UTF8STRING 134 +#define ASN1_R_IV_TOO_LARGE 135 +#define ASN1_R_LENGTH_ERROR 136 +#define ASN1_R_LIST_ERROR 188 +#define ASN1_R_MIME_NO_CONTENT_TYPE 206 +#define ASN1_R_MIME_PARSE_ERROR 207 +#define ASN1_R_MIME_SIG_PARSE_ERROR 208 +#define ASN1_R_MISSING_EOC 137 +#define ASN1_R_MISSING_SECOND_NUMBER 138 +#define ASN1_R_MISSING_VALUE 189 +#define ASN1_R_MSTRING_NOT_UNIVERSAL 139 +#define ASN1_R_MSTRING_WRONG_TAG 140 +#define ASN1_R_NESTED_ASN1_STRING 197 +#define ASN1_R_NON_HEX_CHARACTERS 141 +#define ASN1_R_NOT_ASCII_FORMAT 190 +#define ASN1_R_NOT_ENOUGH_DATA 142 +#define ASN1_R_NO_CONTENT_TYPE 209 +#define ASN1_R_NO_DEFAULT_DIGEST 201 +#define ASN1_R_NO_MATCHING_CHOICE_TYPE 143 +#define ASN1_R_NO_MULTIPART_BODY_FAILURE 210 +#define ASN1_R_NO_MULTIPART_BOUNDARY 211 +#define ASN1_R_NO_SIG_CONTENT_TYPE 212 +#define ASN1_R_NULL_IS_WRONG_LENGTH 144 +#define ASN1_R_OBJECT_NOT_ASCII_FORMAT 191 +#define ASN1_R_ODD_NUMBER_OF_CHARS 145 +#define ASN1_R_PRIVATE_KEY_HEADER_MISSING 146 +#define ASN1_R_SECOND_NUMBER_TOO_LARGE 147 +#define ASN1_R_SEQUENCE_LENGTH_MISMATCH 148 +#define ASN1_R_SEQUENCE_NOT_CONSTRUCTED 149 +#define ASN1_R_SEQUENCE_OR_SET_NEEDS_CONFIG 192 +#define ASN1_R_SHORT_LINE 150 +#define ASN1_R_SIG_INVALID_MIME_TYPE 213 +#define ASN1_R_STREAMING_NOT_SUPPORTED 202 +#define ASN1_R_STRING_TOO_LONG 151 +#define ASN1_R_STRING_TOO_SHORT 152 +#define ASN1_R_TAG_VALUE_TOO_HIGH 153 +#define ASN1_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 154 +#define ASN1_R_TIME_NOT_ASCII_FORMAT 193 +#define ASN1_R_TOO_LONG 155 +#define ASN1_R_TYPE_NOT_CONSTRUCTED 156 +#define ASN1_R_UNABLE_TO_DECODE_RSA_KEY 157 +#define ASN1_R_UNABLE_TO_DECODE_RSA_PRIVATE_KEY 158 +#define ASN1_R_UNEXPECTED_EOC 159 +#define ASN1_R_UNIVERSALSTRING_IS_WRONG_LENGTH 215 +#define ASN1_R_UNKNOWN_FORMAT 160 +#define ASN1_R_UNKNOWN_MESSAGE_DIGEST_ALGORITHM 161 +#define ASN1_R_UNKNOWN_OBJECT_TYPE 162 +#define ASN1_R_UNKNOWN_PUBLIC_KEY_TYPE 163 +#define ASN1_R_UNKNOWN_SIGNATURE_ALGORITHM 199 +#define ASN1_R_UNKNOWN_TAG 194 +#define ASN1_R_UNKOWN_FORMAT 195 +#define ASN1_R_UNSUPPORTED_ANY_DEFINED_BY_TYPE 164 +#define ASN1_R_UNSUPPORTED_CIPHER 165 +#define ASN1_R_UNSUPPORTED_ENCRYPTION_ALGORITHM 166 +#define ASN1_R_UNSUPPORTED_PUBLIC_KEY_TYPE 167 +#define ASN1_R_UNSUPPORTED_TYPE 196 +#define ASN1_R_WRONG_PUBLIC_KEY_TYPE 200 +#define ASN1_R_WRONG_TAG 168 +#define ASN1_R_WRONG_TYPE 169 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/asn1_mac.h b/Source/Import/OpenSSL/Include/openssl/asn1_mac.h new file mode 100644 index 0000000..87bd0e9 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/asn1_mac.h @@ -0,0 +1,578 @@ +/* crypto/asn1/asn1_mac.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_ASN1_MAC_H +#define HEADER_ASN1_MAC_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef ASN1_MAC_ERR_LIB +#define ASN1_MAC_ERR_LIB ERR_LIB_ASN1 +#endif + +#define ASN1_MAC_H_err(f,r,line) \ + ERR_PUT_error(ASN1_MAC_ERR_LIB,(f),(r),__FILE__,(line)) + +#define M_ASN1_D2I_vars(a,type,func) \ + ASN1_const_CTX c; \ + type ret=NULL; \ + \ + c.pp=(const unsigned char **)pp; \ + c.q= *(const unsigned char **)pp; \ + c.error=ERR_R_NESTED_ASN1_ERROR; \ + if ((a == NULL) || ((*a) == NULL)) \ + { if ((ret=(type)func()) == NULL) \ + { c.line=__LINE__; goto err; } } \ + else ret=(*a); + +#define M_ASN1_D2I_Init() \ + c.p= *(const unsigned char **)pp; \ + c.max=(length == 0)?0:(c.p+length); + +#define M_ASN1_D2I_Finish_2(a) \ + if (!asn1_const_Finish(&c)) \ + { c.line=__LINE__; goto err; } \ + *(const unsigned char **)pp=c.p; \ + if (a != NULL) (*a)=ret; \ + return(ret); + +#define M_ASN1_D2I_Finish(a,func,e) \ + M_ASN1_D2I_Finish_2(a); \ +err:\ + ASN1_MAC_H_err((e),c.error,c.line); \ + asn1_add_error(*(const unsigned char **)pp,(int)(c.q- *pp)); \ + if ((ret != NULL) && ((a == NULL) || (*a != ret))) func(ret); \ + return(NULL) + +#define M_ASN1_D2I_start_sequence() \ + if (!asn1_GetSequence(&c,&length)) \ + { c.line=__LINE__; goto err; } +/* Begin reading ASN1 without a surrounding sequence */ +#define M_ASN1_D2I_begin() \ + c.slen = length; + +/* End reading ASN1 with no check on length */ +#define M_ASN1_D2I_Finish_nolen(a, func, e) \ + *pp=c.p; \ + if (a != NULL) (*a)=ret; \ + return(ret); \ +err:\ + ASN1_MAC_H_err((e),c.error,c.line); \ + asn1_add_error(*pp,(int)(c.q- *pp)); \ + if ((ret != NULL) && ((a == NULL) || (*a != ret))) func(ret); \ + return(NULL) + +#define M_ASN1_D2I_end_sequence() \ + (((c.inf&1) == 0)?(c.slen <= 0): \ + (c.eos=ASN1_const_check_infinite_end(&c.p,c.slen))) + +/* Don't use this with d2i_ASN1_BOOLEAN() */ +#define M_ASN1_D2I_get(b, func) \ + c.q=c.p; \ + if (func(&(b),&c.p,c.slen) == NULL) \ + {c.line=__LINE__; goto err; } \ + c.slen-=(c.p-c.q); + +/* Don't use this with d2i_ASN1_BOOLEAN() */ +#define M_ASN1_D2I_get_x(type,b,func) \ + c.q=c.p; \ + if (((D2I_OF(type))func)(&(b),&c.p,c.slen) == NULL) \ + {c.line=__LINE__; goto err; } \ + c.slen-=(c.p-c.q); + +/* use this instead () */ +#define M_ASN1_D2I_get_int(b,func) \ + c.q=c.p; \ + if (func(&(b),&c.p,c.slen) < 0) \ + {c.line=__LINE__; goto err; } \ + c.slen-=(c.p-c.q); + +#define M_ASN1_D2I_get_opt(b,func,type) \ + if ((c.slen != 0) && ((M_ASN1_next & (~V_ASN1_CONSTRUCTED)) \ + == (V_ASN1_UNIVERSAL|(type)))) \ + { \ + M_ASN1_D2I_get(b,func); \ + } + +#define M_ASN1_D2I_get_int_opt(b,func,type) \ + if ((c.slen != 0) && ((M_ASN1_next & (~V_ASN1_CONSTRUCTED)) \ + == (V_ASN1_UNIVERSAL|(type)))) \ + { \ + M_ASN1_D2I_get_int(b,func); \ + } + +#define M_ASN1_D2I_get_imp(b,func, type) \ + M_ASN1_next=(_tmp& V_ASN1_CONSTRUCTED)|type; \ + c.q=c.p; \ + if (func(&(b),&c.p,c.slen) == NULL) \ + {c.line=__LINE__; M_ASN1_next_prev = _tmp; goto err; } \ + c.slen-=(c.p-c.q);\ + M_ASN1_next_prev=_tmp; + +#define M_ASN1_D2I_get_IMP_opt(b,func,tag,type) \ + if ((c.slen != 0) && ((M_ASN1_next & (~V_ASN1_CONSTRUCTED)) == \ + (V_ASN1_CONTEXT_SPECIFIC|(tag)))) \ + { \ + unsigned char _tmp = M_ASN1_next; \ + M_ASN1_D2I_get_imp(b,func, type);\ + } + +#define M_ASN1_D2I_get_set(r,func,free_func) \ + M_ASN1_D2I_get_imp_set(r,func,free_func, \ + V_ASN1_SET,V_ASN1_UNIVERSAL); + +#define M_ASN1_D2I_get_set_type(type,r,func,free_func) \ + M_ASN1_D2I_get_imp_set_type(type,r,func,free_func, \ + V_ASN1_SET,V_ASN1_UNIVERSAL); + +#define M_ASN1_D2I_get_set_opt(r,func,free_func) \ + if ((c.slen != 0) && (M_ASN1_next == (V_ASN1_UNIVERSAL| \ + V_ASN1_CONSTRUCTED|V_ASN1_SET)))\ + { M_ASN1_D2I_get_set(r,func,free_func); } + +#define M_ASN1_D2I_get_set_opt_type(type,r,func,free_func) \ + if ((c.slen != 0) && (M_ASN1_next == (V_ASN1_UNIVERSAL| \ + V_ASN1_CONSTRUCTED|V_ASN1_SET)))\ + { M_ASN1_D2I_get_set_type(type,r,func,free_func); } + +#define M_ASN1_I2D_len_SET_opt(a,f) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + M_ASN1_I2D_len_SET(a,f); + +#define M_ASN1_I2D_put_SET_opt(a,f) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + M_ASN1_I2D_put_SET(a,f); + +#define M_ASN1_I2D_put_SEQUENCE_opt(a,f) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + M_ASN1_I2D_put_SEQUENCE(a,f); + +#define M_ASN1_I2D_put_SEQUENCE_opt_type(type,a,f) \ + if ((a != NULL) && (sk_##type##_num(a) != 0)) \ + M_ASN1_I2D_put_SEQUENCE_type(type,a,f); + +#define M_ASN1_D2I_get_IMP_set_opt(b,func,free_func,tag) \ + if ((c.slen != 0) && \ + (M_ASN1_next == \ + (V_ASN1_CONTEXT_SPECIFIC|V_ASN1_CONSTRUCTED|(tag))))\ + { \ + M_ASN1_D2I_get_imp_set(b,func,free_func,\ + tag,V_ASN1_CONTEXT_SPECIFIC); \ + } + +#define M_ASN1_D2I_get_IMP_set_opt_type(type,b,func,free_func,tag) \ + if ((c.slen != 0) && \ + (M_ASN1_next == \ + (V_ASN1_CONTEXT_SPECIFIC|V_ASN1_CONSTRUCTED|(tag))))\ + { \ + M_ASN1_D2I_get_imp_set_type(type,b,func,free_func,\ + tag,V_ASN1_CONTEXT_SPECIFIC); \ + } + +#define M_ASN1_D2I_get_seq(r,func,free_func) \ + M_ASN1_D2I_get_imp_set(r,func,free_func,\ + V_ASN1_SEQUENCE,V_ASN1_UNIVERSAL); + +#define M_ASN1_D2I_get_seq_type(type,r,func,free_func) \ + M_ASN1_D2I_get_imp_set_type(type,r,func,free_func,\ + V_ASN1_SEQUENCE,V_ASN1_UNIVERSAL) + +#define M_ASN1_D2I_get_seq_opt(r,func,free_func) \ + if ((c.slen != 0) && (M_ASN1_next == (V_ASN1_UNIVERSAL| \ + V_ASN1_CONSTRUCTED|V_ASN1_SEQUENCE)))\ + { M_ASN1_D2I_get_seq(r,func,free_func); } + +#define M_ASN1_D2I_get_seq_opt_type(type,r,func,free_func) \ + if ((c.slen != 0) && (M_ASN1_next == (V_ASN1_UNIVERSAL| \ + V_ASN1_CONSTRUCTED|V_ASN1_SEQUENCE)))\ + { M_ASN1_D2I_get_seq_type(type,r,func,free_func); } + +#define M_ASN1_D2I_get_IMP_set(r,func,free_func,x) \ + M_ASN1_D2I_get_imp_set(r,func,free_func,\ + x,V_ASN1_CONTEXT_SPECIFIC); + +#define M_ASN1_D2I_get_IMP_set_type(type,r,func,free_func,x) \ + M_ASN1_D2I_get_imp_set_type(type,r,func,free_func,\ + x,V_ASN1_CONTEXT_SPECIFIC); + +#define M_ASN1_D2I_get_imp_set(r,func,free_func,a,b) \ + c.q=c.p; \ + if (d2i_ASN1_SET(&(r),&c.p,c.slen,(char *(*)())func,\ + (void (*)())free_func,a,b) == NULL) \ + { c.line=__LINE__; goto err; } \ + c.slen-=(c.p-c.q); + +#define M_ASN1_D2I_get_imp_set_type(type,r,func,free_func,a,b) \ + c.q=c.p; \ + if (d2i_ASN1_SET_OF_##type(&(r),&c.p,c.slen,func,\ + free_func,a,b) == NULL) \ + { c.line=__LINE__; goto err; } \ + c.slen-=(c.p-c.q); + +#define M_ASN1_D2I_get_set_strings(r,func,a,b) \ + c.q=c.p; \ + if (d2i_ASN1_STRING_SET(&(r),&c.p,c.slen,a,b) == NULL) \ + { c.line=__LINE__; goto err; } \ + c.slen-=(c.p-c.q); + +#define M_ASN1_D2I_get_EXP_opt(r,func,tag) \ + if ((c.slen != 0L) && (M_ASN1_next == \ + (V_ASN1_CONSTRUCTED|V_ASN1_CONTEXT_SPECIFIC|tag))) \ + { \ + int Tinf,Ttag,Tclass; \ + long Tlen; \ + \ + c.q=c.p; \ + Tinf=ASN1_get_object(&c.p,&Tlen,&Ttag,&Tclass,c.slen); \ + if (Tinf & 0x80) \ + { c.error=ERR_R_BAD_ASN1_OBJECT_HEADER; \ + c.line=__LINE__; goto err; } \ + if (Tinf == (V_ASN1_CONSTRUCTED+1)) \ + Tlen = c.slen - (c.p - c.q) - 2; \ + if (func(&(r),&c.p,Tlen) == NULL) \ + { c.line=__LINE__; goto err; } \ + if (Tinf == (V_ASN1_CONSTRUCTED+1)) { \ + Tlen = c.slen - (c.p - c.q); \ + if(!ASN1_const_check_infinite_end(&c.p, Tlen)) \ + { c.error=ERR_R_MISSING_ASN1_EOS; \ + c.line=__LINE__; goto err; } \ + }\ + c.slen-=(c.p-c.q); \ + } + +#define M_ASN1_D2I_get_EXP_set_opt(r,func,free_func,tag,b) \ + if ((c.slen != 0) && (M_ASN1_next == \ + (V_ASN1_CONSTRUCTED|V_ASN1_CONTEXT_SPECIFIC|tag))) \ + { \ + int Tinf,Ttag,Tclass; \ + long Tlen; \ + \ + c.q=c.p; \ + Tinf=ASN1_get_object(&c.p,&Tlen,&Ttag,&Tclass,c.slen); \ + if (Tinf & 0x80) \ + { c.error=ERR_R_BAD_ASN1_OBJECT_HEADER; \ + c.line=__LINE__; goto err; } \ + if (Tinf == (V_ASN1_CONSTRUCTED+1)) \ + Tlen = c.slen - (c.p - c.q) - 2; \ + if (d2i_ASN1_SET(&(r),&c.p,Tlen,(char *(*)())func, \ + (void (*)())free_func, \ + b,V_ASN1_UNIVERSAL) == NULL) \ + { c.line=__LINE__; goto err; } \ + if (Tinf == (V_ASN1_CONSTRUCTED+1)) { \ + Tlen = c.slen - (c.p - c.q); \ + if(!ASN1_check_infinite_end(&c.p, Tlen)) \ + { c.error=ERR_R_MISSING_ASN1_EOS; \ + c.line=__LINE__; goto err; } \ + }\ + c.slen-=(c.p-c.q); \ + } + +#define M_ASN1_D2I_get_EXP_set_opt_type(type,r,func,free_func,tag,b) \ + if ((c.slen != 0) && (M_ASN1_next == \ + (V_ASN1_CONSTRUCTED|V_ASN1_CONTEXT_SPECIFIC|tag))) \ + { \ + int Tinf,Ttag,Tclass; \ + long Tlen; \ + \ + c.q=c.p; \ + Tinf=ASN1_get_object(&c.p,&Tlen,&Ttag,&Tclass,c.slen); \ + if (Tinf & 0x80) \ + { c.error=ERR_R_BAD_ASN1_OBJECT_HEADER; \ + c.line=__LINE__; goto err; } \ + if (Tinf == (V_ASN1_CONSTRUCTED+1)) \ + Tlen = c.slen - (c.p - c.q) - 2; \ + if (d2i_ASN1_SET_OF_##type(&(r),&c.p,Tlen,func, \ + free_func,b,V_ASN1_UNIVERSAL) == NULL) \ + { c.line=__LINE__; goto err; } \ + if (Tinf == (V_ASN1_CONSTRUCTED+1)) { \ + Tlen = c.slen - (c.p - c.q); \ + if(!ASN1_check_infinite_end(&c.p, Tlen)) \ + { c.error=ERR_R_MISSING_ASN1_EOS; \ + c.line=__LINE__; goto err; } \ + }\ + c.slen-=(c.p-c.q); \ + } + +/* New macros */ +#define M_ASN1_New_Malloc(ret,type) \ + if ((ret=(type *)OPENSSL_malloc(sizeof(type))) == NULL) \ + { c.line=__LINE__; goto err2; } + +#define M_ASN1_New(arg,func) \ + if (((arg)=func()) == NULL) return(NULL) + +#define M_ASN1_New_Error(a) \ +/* err: ASN1_MAC_H_err((a),ERR_R_NESTED_ASN1_ERROR,c.line); \ + return(NULL);*/ \ + err2: ASN1_MAC_H_err((a),ERR_R_MALLOC_FAILURE,c.line); \ + return(NULL) + + +/* BIG UGLY WARNING! This is so damn ugly I wanna puke. Unfortunately, + some macros that use ASN1_const_CTX still insist on writing in the input + stream. ARGH! ARGH! ARGH! Let's get rid of this macro package. + Please? -- Richard Levitte */ +#define M_ASN1_next (*((unsigned char *)(c.p))) +#define M_ASN1_next_prev (*((unsigned char *)(c.q))) + +/*************************************************/ + +#define M_ASN1_I2D_vars(a) int r=0,ret=0; \ + unsigned char *p; \ + if (a == NULL) return(0) + +/* Length Macros */ +#define M_ASN1_I2D_len(a,f) ret+=f(a,NULL) +#define M_ASN1_I2D_len_IMP_opt(a,f) if (a != NULL) M_ASN1_I2D_len(a,f) + +#define M_ASN1_I2D_len_SET(a,f) \ + ret+=i2d_ASN1_SET(a,NULL,f,V_ASN1_SET,V_ASN1_UNIVERSAL,IS_SET); + +#define M_ASN1_I2D_len_SET_type(type,a,f) \ + ret+=i2d_ASN1_SET_OF_##type(a,NULL,f,V_ASN1_SET, \ + V_ASN1_UNIVERSAL,IS_SET); + +#define M_ASN1_I2D_len_SEQUENCE(a,f) \ + ret+=i2d_ASN1_SET(a,NULL,f,V_ASN1_SEQUENCE,V_ASN1_UNIVERSAL, \ + IS_SEQUENCE); + +#define M_ASN1_I2D_len_SEQUENCE_type(type,a,f) \ + ret+=i2d_ASN1_SET_OF_##type(a,NULL,f,V_ASN1_SEQUENCE, \ + V_ASN1_UNIVERSAL,IS_SEQUENCE) + +#define M_ASN1_I2D_len_SEQUENCE_opt(a,f) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + M_ASN1_I2D_len_SEQUENCE(a,f); + +#define M_ASN1_I2D_len_SEQUENCE_opt_type(type,a,f) \ + if ((a != NULL) && (sk_##type##_num(a) != 0)) \ + M_ASN1_I2D_len_SEQUENCE_type(type,a,f); + +#define M_ASN1_I2D_len_IMP_SET(a,f,x) \ + ret+=i2d_ASN1_SET(a,NULL,f,x,V_ASN1_CONTEXT_SPECIFIC,IS_SET); + +#define M_ASN1_I2D_len_IMP_SET_type(type,a,f,x) \ + ret+=i2d_ASN1_SET_OF_##type(a,NULL,f,x, \ + V_ASN1_CONTEXT_SPECIFIC,IS_SET); + +#define M_ASN1_I2D_len_IMP_SET_opt(a,f,x) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + ret+=i2d_ASN1_SET(a,NULL,f,x,V_ASN1_CONTEXT_SPECIFIC, \ + IS_SET); + +#define M_ASN1_I2D_len_IMP_SET_opt_type(type,a,f,x) \ + if ((a != NULL) && (sk_##type##_num(a) != 0)) \ + ret+=i2d_ASN1_SET_OF_##type(a,NULL,f,x, \ + V_ASN1_CONTEXT_SPECIFIC,IS_SET); + +#define M_ASN1_I2D_len_IMP_SEQUENCE(a,f,x) \ + ret+=i2d_ASN1_SET(a,NULL,f,x,V_ASN1_CONTEXT_SPECIFIC, \ + IS_SEQUENCE); + +#define M_ASN1_I2D_len_IMP_SEQUENCE_opt(a,f,x) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + ret+=i2d_ASN1_SET(a,NULL,f,x,V_ASN1_CONTEXT_SPECIFIC, \ + IS_SEQUENCE); + +#define M_ASN1_I2D_len_IMP_SEQUENCE_opt_type(type,a,f,x) \ + if ((a != NULL) && (sk_##type##_num(a) != 0)) \ + ret+=i2d_ASN1_SET_OF_##type(a,NULL,f,x, \ + V_ASN1_CONTEXT_SPECIFIC, \ + IS_SEQUENCE); + +#define M_ASN1_I2D_len_EXP_opt(a,f,mtag,v) \ + if (a != NULL)\ + { \ + v=f(a,NULL); \ + ret+=ASN1_object_size(1,v,mtag); \ + } + +#define M_ASN1_I2D_len_EXP_SET_opt(a,f,mtag,tag,v) \ + if ((a != NULL) && (sk_num(a) != 0))\ + { \ + v=i2d_ASN1_SET(a,NULL,f,tag,V_ASN1_UNIVERSAL,IS_SET); \ + ret+=ASN1_object_size(1,v,mtag); \ + } + +#define M_ASN1_I2D_len_EXP_SEQUENCE_opt(a,f,mtag,tag,v) \ + if ((a != NULL) && (sk_num(a) != 0))\ + { \ + v=i2d_ASN1_SET(a,NULL,f,tag,V_ASN1_UNIVERSAL, \ + IS_SEQUENCE); \ + ret+=ASN1_object_size(1,v,mtag); \ + } + +#define M_ASN1_I2D_len_EXP_SEQUENCE_opt_type(type,a,f,mtag,tag,v) \ + if ((a != NULL) && (sk_##type##_num(a) != 0))\ + { \ + v=i2d_ASN1_SET_OF_##type(a,NULL,f,tag, \ + V_ASN1_UNIVERSAL, \ + IS_SEQUENCE); \ + ret+=ASN1_object_size(1,v,mtag); \ + } + +/* Put Macros */ +#define M_ASN1_I2D_put(a,f) f(a,&p) + +#define M_ASN1_I2D_put_IMP_opt(a,f,t) \ + if (a != NULL) \ + { \ + unsigned char *q=p; \ + f(a,&p); \ + *q=(V_ASN1_CONTEXT_SPECIFIC|t|(*q&V_ASN1_CONSTRUCTED));\ + } + +#define M_ASN1_I2D_put_SET(a,f) i2d_ASN1_SET(a,&p,f,V_ASN1_SET,\ + V_ASN1_UNIVERSAL,IS_SET) +#define M_ASN1_I2D_put_SET_type(type,a,f) \ + i2d_ASN1_SET_OF_##type(a,&p,f,V_ASN1_SET,V_ASN1_UNIVERSAL,IS_SET) +#define M_ASN1_I2D_put_IMP_SET(a,f,x) i2d_ASN1_SET(a,&p,f,x,\ + V_ASN1_CONTEXT_SPECIFIC,IS_SET) +#define M_ASN1_I2D_put_IMP_SET_type(type,a,f,x) \ + i2d_ASN1_SET_OF_##type(a,&p,f,x,V_ASN1_CONTEXT_SPECIFIC,IS_SET) +#define M_ASN1_I2D_put_IMP_SEQUENCE(a,f,x) i2d_ASN1_SET(a,&p,f,x,\ + V_ASN1_CONTEXT_SPECIFIC,IS_SEQUENCE) + +#define M_ASN1_I2D_put_SEQUENCE(a,f) i2d_ASN1_SET(a,&p,f,V_ASN1_SEQUENCE,\ + V_ASN1_UNIVERSAL,IS_SEQUENCE) + +#define M_ASN1_I2D_put_SEQUENCE_type(type,a,f) \ + i2d_ASN1_SET_OF_##type(a,&p,f,V_ASN1_SEQUENCE,V_ASN1_UNIVERSAL, \ + IS_SEQUENCE) + +#define M_ASN1_I2D_put_SEQUENCE_opt(a,f) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + M_ASN1_I2D_put_SEQUENCE(a,f); + +#define M_ASN1_I2D_put_IMP_SET_opt(a,f,x) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + { i2d_ASN1_SET(a,&p,f,x,V_ASN1_CONTEXT_SPECIFIC, \ + IS_SET); } + +#define M_ASN1_I2D_put_IMP_SET_opt_type(type,a,f,x) \ + if ((a != NULL) && (sk_##type##_num(a) != 0)) \ + { i2d_ASN1_SET_OF_##type(a,&p,f,x, \ + V_ASN1_CONTEXT_SPECIFIC, \ + IS_SET); } + +#define M_ASN1_I2D_put_IMP_SEQUENCE_opt(a,f,x) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + { i2d_ASN1_SET(a,&p,f,x,V_ASN1_CONTEXT_SPECIFIC, \ + IS_SEQUENCE); } + +#define M_ASN1_I2D_put_IMP_SEQUENCE_opt_type(type,a,f,x) \ + if ((a != NULL) && (sk_##type##_num(a) != 0)) \ + { i2d_ASN1_SET_OF_##type(a,&p,f,x, \ + V_ASN1_CONTEXT_SPECIFIC, \ + IS_SEQUENCE); } + +#define M_ASN1_I2D_put_EXP_opt(a,f,tag,v) \ + if (a != NULL) \ + { \ + ASN1_put_object(&p,1,v,tag,V_ASN1_CONTEXT_SPECIFIC); \ + f(a,&p); \ + } + +#define M_ASN1_I2D_put_EXP_SET_opt(a,f,mtag,tag,v) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + { \ + ASN1_put_object(&p,1,v,mtag,V_ASN1_CONTEXT_SPECIFIC); \ + i2d_ASN1_SET(a,&p,f,tag,V_ASN1_UNIVERSAL,IS_SET); \ + } + +#define M_ASN1_I2D_put_EXP_SEQUENCE_opt(a,f,mtag,tag,v) \ + if ((a != NULL) && (sk_num(a) != 0)) \ + { \ + ASN1_put_object(&p,1,v,mtag,V_ASN1_CONTEXT_SPECIFIC); \ + i2d_ASN1_SET(a,&p,f,tag,V_ASN1_UNIVERSAL,IS_SEQUENCE); \ + } + +#define M_ASN1_I2D_put_EXP_SEQUENCE_opt_type(type,a,f,mtag,tag,v) \ + if ((a != NULL) && (sk_##type##_num(a) != 0)) \ + { \ + ASN1_put_object(&p,1,v,mtag,V_ASN1_CONTEXT_SPECIFIC); \ + i2d_ASN1_SET_OF_##type(a,&p,f,tag,V_ASN1_UNIVERSAL, \ + IS_SEQUENCE); \ + } + +#define M_ASN1_I2D_seq_total() \ + r=ASN1_object_size(1,ret,V_ASN1_SEQUENCE); \ + if (pp == NULL) return(r); \ + p= *pp; \ + ASN1_put_object(&p,1,ret,V_ASN1_SEQUENCE,V_ASN1_UNIVERSAL) + +#define M_ASN1_I2D_INF_seq_start(tag,ctx) \ + *(p++)=(V_ASN1_CONSTRUCTED|(tag)|(ctx)); \ + *(p++)=0x80 + +#define M_ASN1_I2D_INF_seq_end() *(p++)=0x00; *(p++)=0x00 + +#define M_ASN1_I2D_finish() *pp=p; \ + return(r); + +int asn1_GetSequence(ASN1_const_CTX *c, long *length); +void asn1_add_error(const unsigned char *address,int offset); +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/asn1t.h b/Source/Import/OpenSSL/Include/openssl/asn1t.h new file mode 100644 index 0000000..d230e4b --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/asn1t.h @@ -0,0 +1,960 @@ +/* asn1t.h */ +/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL + * project 2000. + */ +/* ==================================================================== + * Copyright (c) 2000-2005 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +#ifndef HEADER_ASN1T_H +#define HEADER_ASN1T_H + +#include +#include +#include + +#ifdef OPENSSL_BUILD_SHLIBCRYPTO +# undef OPENSSL_EXTERN +# define OPENSSL_EXTERN OPENSSL_EXPORT +#endif + +/* ASN1 template defines, structures and functions */ + +#ifdef __cplusplus +extern "C" { +#endif + + +#ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION + +/* Macro to obtain ASN1_ADB pointer from a type (only used internally) */ +#define ASN1_ADB_ptr(iptr) ((const ASN1_ADB *)(iptr)) + + +/* Macros for start and end of ASN1_ITEM definition */ + +#define ASN1_ITEM_start(itname) \ + OPENSSL_GLOBAL const ASN1_ITEM itname##_it = { + +#define ASN1_ITEM_end(itname) \ + }; + +#else + +/* Macro to obtain ASN1_ADB pointer from a type (only used internally) */ +#define ASN1_ADB_ptr(iptr) ((const ASN1_ADB *)(iptr())) + + +/* Macros for start and end of ASN1_ITEM definition */ + +#define ASN1_ITEM_start(itname) \ + const ASN1_ITEM * itname##_it(void) \ + { \ + static const ASN1_ITEM local_it = { + +#define ASN1_ITEM_end(itname) \ + }; \ + return &local_it; \ + } + +#endif + + +/* Macros to aid ASN1 template writing */ + +#define ASN1_ITEM_TEMPLATE(tname) \ + static const ASN1_TEMPLATE tname##_item_tt + +#define ASN1_ITEM_TEMPLATE_END(tname) \ + ;\ + ASN1_ITEM_start(tname) \ + ASN1_ITYPE_PRIMITIVE,\ + -1,\ + &tname##_item_tt,\ + 0,\ + NULL,\ + 0,\ + #tname \ + ASN1_ITEM_end(tname) + + +/* This is a ASN1 type which just embeds a template */ + +/* This pair helps declare a SEQUENCE. We can do: + * + * ASN1_SEQUENCE(stname) = { + * ... SEQUENCE components ... + * } ASN1_SEQUENCE_END(stname) + * + * This will produce an ASN1_ITEM called stname_it + * for a structure called stname. + * + * If you want the same structure but a different + * name then use: + * + * ASN1_SEQUENCE(itname) = { + * ... SEQUENCE components ... + * } ASN1_SEQUENCE_END_name(stname, itname) + * + * This will create an item called itname_it using + * a structure called stname. + */ + +#define ASN1_SEQUENCE(tname) \ + static const ASN1_TEMPLATE tname##_seq_tt[] + +#define ASN1_SEQUENCE_END(stname) ASN1_SEQUENCE_END_name(stname, stname) + +#define ASN1_SEQUENCE_END_name(stname, tname) \ + ;\ + ASN1_ITEM_start(tname) \ + ASN1_ITYPE_SEQUENCE,\ + V_ASN1_SEQUENCE,\ + tname##_seq_tt,\ + sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\ + NULL,\ + sizeof(stname),\ + #stname \ + ASN1_ITEM_end(tname) + +#define ASN1_NDEF_SEQUENCE(tname) \ + ASN1_SEQUENCE(tname) + +#define ASN1_NDEF_SEQUENCE_cb(tname, cb) \ + ASN1_SEQUENCE_cb(tname, cb) + +#define ASN1_SEQUENCE_cb(tname, cb) \ + static const ASN1_AUX tname##_aux = {NULL, 0, 0, 0, cb, 0}; \ + ASN1_SEQUENCE(tname) + +#define ASN1_BROKEN_SEQUENCE(tname) \ + static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_BROKEN, 0, 0, 0, 0}; \ + ASN1_SEQUENCE(tname) + +#define ASN1_SEQUENCE_ref(tname, cb, lck) \ + static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_REFCOUNT, offsetof(tname, references), lck, cb, 0}; \ + ASN1_SEQUENCE(tname) + +#define ASN1_SEQUENCE_enc(tname, enc, cb) \ + static const ASN1_AUX tname##_aux = {NULL, ASN1_AFLG_ENCODING, 0, 0, cb, offsetof(tname, enc)}; \ + ASN1_SEQUENCE(tname) + +#define ASN1_NDEF_SEQUENCE_END(tname) \ + ;\ + ASN1_ITEM_start(tname) \ + ASN1_ITYPE_NDEF_SEQUENCE,\ + V_ASN1_SEQUENCE,\ + tname##_seq_tt,\ + sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\ + NULL,\ + sizeof(tname),\ + #tname \ + ASN1_ITEM_end(tname) + +#define ASN1_BROKEN_SEQUENCE_END(stname) ASN1_SEQUENCE_END_ref(stname, stname) + +#define ASN1_SEQUENCE_END_enc(stname, tname) ASN1_SEQUENCE_END_ref(stname, tname) + +#define ASN1_SEQUENCE_END_cb(stname, tname) ASN1_SEQUENCE_END_ref(stname, tname) + +#define ASN1_SEQUENCE_END_ref(stname, tname) \ + ;\ + ASN1_ITEM_start(tname) \ + ASN1_ITYPE_SEQUENCE,\ + V_ASN1_SEQUENCE,\ + tname##_seq_tt,\ + sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\ + &tname##_aux,\ + sizeof(stname),\ + #stname \ + ASN1_ITEM_end(tname) + +#define ASN1_NDEF_SEQUENCE_END_cb(stname, tname) \ + ;\ + ASN1_ITEM_start(tname) \ + ASN1_ITYPE_NDEF_SEQUENCE,\ + V_ASN1_SEQUENCE,\ + tname##_seq_tt,\ + sizeof(tname##_seq_tt) / sizeof(ASN1_TEMPLATE),\ + &tname##_aux,\ + sizeof(stname),\ + #stname \ + ASN1_ITEM_end(tname) + + +/* This pair helps declare a CHOICE type. We can do: + * + * ASN1_CHOICE(chname) = { + * ... CHOICE options ... + * ASN1_CHOICE_END(chname) + * + * This will produce an ASN1_ITEM called chname_it + * for a structure called chname. The structure + * definition must look like this: + * typedef struct { + * int type; + * union { + * ASN1_SOMETHING *opt1; + * ASN1_SOMEOTHER *opt2; + * } value; + * } chname; + * + * the name of the selector must be 'type'. + * to use an alternative selector name use the + * ASN1_CHOICE_END_selector() version. + */ + +#define ASN1_CHOICE(tname) \ + static const ASN1_TEMPLATE tname##_ch_tt[] + +#define ASN1_CHOICE_cb(tname, cb) \ + static const ASN1_AUX tname##_aux = {NULL, 0, 0, 0, cb, 0}; \ + ASN1_CHOICE(tname) + +#define ASN1_CHOICE_END(stname) ASN1_CHOICE_END_name(stname, stname) + +#define ASN1_CHOICE_END_name(stname, tname) ASN1_CHOICE_END_selector(stname, tname, type) + +#define ASN1_CHOICE_END_selector(stname, tname, selname) \ + ;\ + ASN1_ITEM_start(tname) \ + ASN1_ITYPE_CHOICE,\ + offsetof(stname,selname) ,\ + tname##_ch_tt,\ + sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\ + NULL,\ + sizeof(stname),\ + #stname \ + ASN1_ITEM_end(tname) + +#define ASN1_CHOICE_END_cb(stname, tname, selname) \ + ;\ + ASN1_ITEM_start(tname) \ + ASN1_ITYPE_CHOICE,\ + offsetof(stname,selname) ,\ + tname##_ch_tt,\ + sizeof(tname##_ch_tt) / sizeof(ASN1_TEMPLATE),\ + &tname##_aux,\ + sizeof(stname),\ + #stname \ + ASN1_ITEM_end(tname) + +/* This helps with the template wrapper form of ASN1_ITEM */ + +#define ASN1_EX_TEMPLATE_TYPE(flags, tag, name, type) { \ + (flags), (tag), 0,\ + #name, ASN1_ITEM_ref(type) } + +/* These help with SEQUENCE or CHOICE components */ + +/* used to declare other types */ + +#define ASN1_EX_TYPE(flags, tag, stname, field, type) { \ + (flags), (tag), offsetof(stname, field),\ + #field, ASN1_ITEM_ref(type) } + +/* used when the structure is combined with the parent */ + +#define ASN1_EX_COMBINE(flags, tag, type) { \ + (flags)|ASN1_TFLG_COMBINE, (tag), 0, NULL, ASN1_ITEM_ref(type) } + +/* implicit and explicit helper macros */ + +#define ASN1_IMP_EX(stname, field, type, tag, ex) \ + ASN1_EX_TYPE(ASN1_TFLG_IMPLICIT | ex, tag, stname, field, type) + +#define ASN1_EXP_EX(stname, field, type, tag, ex) \ + ASN1_EX_TYPE(ASN1_TFLG_EXPLICIT | ex, tag, stname, field, type) + +/* Any defined by macros: the field used is in the table itself */ + +#ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION +#define ASN1_ADB_OBJECT(tblname) { ASN1_TFLG_ADB_OID, -1, 0, #tblname, (const ASN1_ITEM *)&(tblname##_adb) } +#define ASN1_ADB_INTEGER(tblname) { ASN1_TFLG_ADB_INT, -1, 0, #tblname, (const ASN1_ITEM *)&(tblname##_adb) } +#else +#define ASN1_ADB_OBJECT(tblname) { ASN1_TFLG_ADB_OID, -1, 0, #tblname, tblname##_adb } +#define ASN1_ADB_INTEGER(tblname) { ASN1_TFLG_ADB_INT, -1, 0, #tblname, tblname##_adb } +#endif +/* Plain simple type */ +#define ASN1_SIMPLE(stname, field, type) ASN1_EX_TYPE(0,0, stname, field, type) + +/* OPTIONAL simple type */ +#define ASN1_OPT(stname, field, type) ASN1_EX_TYPE(ASN1_TFLG_OPTIONAL, 0, stname, field, type) + +/* IMPLICIT tagged simple type */ +#define ASN1_IMP(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, 0) + +/* IMPLICIT tagged OPTIONAL simple type */ +#define ASN1_IMP_OPT(stname, field, type, tag) ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL) + +/* Same as above but EXPLICIT */ + +#define ASN1_EXP(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, 0) +#define ASN1_EXP_OPT(stname, field, type, tag) ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL) + +/* SEQUENCE OF type */ +#define ASN1_SEQUENCE_OF(stname, field, type) \ + ASN1_EX_TYPE(ASN1_TFLG_SEQUENCE_OF, 0, stname, field, type) + +/* OPTIONAL SEQUENCE OF */ +#define ASN1_SEQUENCE_OF_OPT(stname, field, type) \ + ASN1_EX_TYPE(ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL, 0, stname, field, type) + +/* Same as above but for SET OF */ + +#define ASN1_SET_OF(stname, field, type) \ + ASN1_EX_TYPE(ASN1_TFLG_SET_OF, 0, stname, field, type) + +#define ASN1_SET_OF_OPT(stname, field, type) \ + ASN1_EX_TYPE(ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL, 0, stname, field, type) + +/* Finally compound types of SEQUENCE, SET, IMPLICIT, EXPLICIT and OPTIONAL */ + +#define ASN1_IMP_SET_OF(stname, field, type, tag) \ + ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF) + +#define ASN1_EXP_SET_OF(stname, field, type, tag) \ + ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF) + +#define ASN1_IMP_SET_OF_OPT(stname, field, type, tag) \ + ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL) + +#define ASN1_EXP_SET_OF_OPT(stname, field, type, tag) \ + ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SET_OF|ASN1_TFLG_OPTIONAL) + +#define ASN1_IMP_SEQUENCE_OF(stname, field, type, tag) \ + ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF) + +#define ASN1_IMP_SEQUENCE_OF_OPT(stname, field, type, tag) \ + ASN1_IMP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL) + +#define ASN1_EXP_SEQUENCE_OF(stname, field, type, tag) \ + ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF) + +#define ASN1_EXP_SEQUENCE_OF_OPT(stname, field, type, tag) \ + ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_SEQUENCE_OF|ASN1_TFLG_OPTIONAL) + +/* EXPLICIT using indefinite length constructed form */ +#define ASN1_NDEF_EXP(stname, field, type, tag) \ + ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_NDEF) + +/* EXPLICIT OPTIONAL using indefinite length constructed form */ +#define ASN1_NDEF_EXP_OPT(stname, field, type, tag) \ + ASN1_EXP_EX(stname, field, type, tag, ASN1_TFLG_OPTIONAL|ASN1_TFLG_NDEF) + +/* Macros for the ASN1_ADB structure */ + +#define ASN1_ADB(name) \ + static const ASN1_ADB_TABLE name##_adbtbl[] + +#ifndef OPENSSL_EXPORT_VAR_AS_FUNCTION + +#define ASN1_ADB_END(name, flags, field, app_table, def, none) \ + ;\ + static const ASN1_ADB name##_adb = {\ + flags,\ + offsetof(name, field),\ + app_table,\ + name##_adbtbl,\ + sizeof(name##_adbtbl) / sizeof(ASN1_ADB_TABLE),\ + def,\ + none\ + } + +#else + +#define ASN1_ADB_END(name, flags, field, app_table, def, none) \ + ;\ + static const ASN1_ITEM *name##_adb(void) \ + { \ + static const ASN1_ADB internal_adb = \ + {\ + flags,\ + offsetof(name, field),\ + app_table,\ + name##_adbtbl,\ + sizeof(name##_adbtbl) / sizeof(ASN1_ADB_TABLE),\ + def,\ + none\ + }; \ + return (const ASN1_ITEM *) &internal_adb; \ + } \ + void dummy_function(void) + +#endif + +#define ADB_ENTRY(val, template) {val, template} + +#define ASN1_ADB_TEMPLATE(name) \ + static const ASN1_TEMPLATE name##_tt + +/* This is the ASN1 template structure that defines + * a wrapper round the actual type. It determines the + * actual position of the field in the value structure, + * various flags such as OPTIONAL and the field name. + */ + +struct ASN1_TEMPLATE_st { +unsigned long flags; /* Various flags */ +long tag; /* tag, not used if no tagging */ +unsigned long offset; /* Offset of this field in structure */ +#ifndef NO_ASN1_FIELD_NAMES +const char *field_name; /* Field name */ +#endif +ASN1_ITEM_EXP *item; /* Relevant ASN1_ITEM or ASN1_ADB */ +}; + +/* Macro to extract ASN1_ITEM and ASN1_ADB pointer from ASN1_TEMPLATE */ + +#define ASN1_TEMPLATE_item(t) (t->item_ptr) +#define ASN1_TEMPLATE_adb(t) (t->item_ptr) + +typedef struct ASN1_ADB_TABLE_st ASN1_ADB_TABLE; +typedef struct ASN1_ADB_st ASN1_ADB; + +struct ASN1_ADB_st { + unsigned long flags; /* Various flags */ + unsigned long offset; /* Offset of selector field */ + STACK_OF(ASN1_ADB_TABLE) **app_items; /* Application defined items */ + const ASN1_ADB_TABLE *tbl; /* Table of possible types */ + long tblcount; /* Number of entries in tbl */ + const ASN1_TEMPLATE *default_tt; /* Type to use if no match */ + const ASN1_TEMPLATE *null_tt; /* Type to use if selector is NULL */ +}; + +struct ASN1_ADB_TABLE_st { + long value; /* NID for an object or value for an int */ + const ASN1_TEMPLATE tt; /* item for this value */ +}; + +/* template flags */ + +/* Field is optional */ +#define ASN1_TFLG_OPTIONAL (0x1) + +/* Field is a SET OF */ +#define ASN1_TFLG_SET_OF (0x1 << 1) + +/* Field is a SEQUENCE OF */ +#define ASN1_TFLG_SEQUENCE_OF (0x2 << 1) + +/* Special case: this refers to a SET OF that + * will be sorted into DER order when encoded *and* + * the corresponding STACK will be modified to match + * the new order. + */ +#define ASN1_TFLG_SET_ORDER (0x3 << 1) + +/* Mask for SET OF or SEQUENCE OF */ +#define ASN1_TFLG_SK_MASK (0x3 << 1) + +/* These flags mean the tag should be taken from the + * tag field. If EXPLICIT then the underlying type + * is used for the inner tag. + */ + +/* IMPLICIT tagging */ +#define ASN1_TFLG_IMPTAG (0x1 << 3) + + +/* EXPLICIT tagging, inner tag from underlying type */ +#define ASN1_TFLG_EXPTAG (0x2 << 3) + +#define ASN1_TFLG_TAG_MASK (0x3 << 3) + +/* context specific IMPLICIT */ +#define ASN1_TFLG_IMPLICIT ASN1_TFLG_IMPTAG|ASN1_TFLG_CONTEXT + +/* context specific EXPLICIT */ +#define ASN1_TFLG_EXPLICIT ASN1_TFLG_EXPTAG|ASN1_TFLG_CONTEXT + +/* If tagging is in force these determine the + * type of tag to use. Otherwise the tag is + * determined by the underlying type. These + * values reflect the actual octet format. + */ + +/* Universal tag */ +#define ASN1_TFLG_UNIVERSAL (0x0<<6) +/* Application tag */ +#define ASN1_TFLG_APPLICATION (0x1<<6) +/* Context specific tag */ +#define ASN1_TFLG_CONTEXT (0x2<<6) +/* Private tag */ +#define ASN1_TFLG_PRIVATE (0x3<<6) + +#define ASN1_TFLG_TAG_CLASS (0x3<<6) + +/* These are for ANY DEFINED BY type. In this case + * the 'item' field points to an ASN1_ADB structure + * which contains a table of values to decode the + * relevant type + */ + +#define ASN1_TFLG_ADB_MASK (0x3<<8) + +#define ASN1_TFLG_ADB_OID (0x1<<8) + +#define ASN1_TFLG_ADB_INT (0x1<<9) + +/* This flag means a parent structure is passed + * instead of the field: this is useful is a + * SEQUENCE is being combined with a CHOICE for + * example. Since this means the structure and + * item name will differ we need to use the + * ASN1_CHOICE_END_name() macro for example. + */ + +#define ASN1_TFLG_COMBINE (0x1<<10) + +/* This flag when present in a SEQUENCE OF, SET OF + * or EXPLICIT causes indefinite length constructed + * encoding to be used if required. + */ + +#define ASN1_TFLG_NDEF (0x1<<11) + +/* This is the actual ASN1 item itself */ + +struct ASN1_ITEM_st { +char itype; /* The item type, primitive, SEQUENCE, CHOICE or extern */ +long utype; /* underlying type */ +const ASN1_TEMPLATE *templates; /* If SEQUENCE or CHOICE this contains the contents */ +long tcount; /* Number of templates if SEQUENCE or CHOICE */ +const void *funcs; /* functions that handle this type */ +long size; /* Structure size (usually)*/ +#ifndef NO_ASN1_FIELD_NAMES +const char *sname; /* Structure name */ +#endif +}; + +/* These are values for the itype field and + * determine how the type is interpreted. + * + * For PRIMITIVE types the underlying type + * determines the behaviour if items is NULL. + * + * Otherwise templates must contain a single + * template and the type is treated in the + * same way as the type specified in the template. + * + * For SEQUENCE types the templates field points + * to the members, the size field is the + * structure size. + * + * For CHOICE types the templates field points + * to each possible member (typically a union) + * and the 'size' field is the offset of the + * selector. + * + * The 'funcs' field is used for application + * specific functions. + * + * For COMPAT types the funcs field gives a + * set of functions that handle this type, this + * supports the old d2i, i2d convention. + * + * The EXTERN type uses a new style d2i/i2d. + * The new style should be used where possible + * because it avoids things like the d2i IMPLICIT + * hack. + * + * MSTRING is a multiple string type, it is used + * for a CHOICE of character strings where the + * actual strings all occupy an ASN1_STRING + * structure. In this case the 'utype' field + * has a special meaning, it is used as a mask + * of acceptable types using the B_ASN1 constants. + * + * NDEF_SEQUENCE is the same as SEQUENCE except + * that it will use indefinite length constructed + * encoding if requested. + * + */ + +#define ASN1_ITYPE_PRIMITIVE 0x0 + +#define ASN1_ITYPE_SEQUENCE 0x1 + +#define ASN1_ITYPE_CHOICE 0x2 + +#define ASN1_ITYPE_COMPAT 0x3 + +#define ASN1_ITYPE_EXTERN 0x4 + +#define ASN1_ITYPE_MSTRING 0x5 + +#define ASN1_ITYPE_NDEF_SEQUENCE 0x6 + +/* Cache for ASN1 tag and length, so we + * don't keep re-reading it for things + * like CHOICE + */ + +struct ASN1_TLC_st{ + char valid; /* Values below are valid */ + int ret; /* return value */ + long plen; /* length */ + int ptag; /* class value */ + int pclass; /* class value */ + int hdrlen; /* header length */ +}; + +/* Typedefs for ASN1 function pointers */ + +typedef ASN1_VALUE * ASN1_new_func(void); +typedef void ASN1_free_func(ASN1_VALUE *a); +typedef ASN1_VALUE * ASN1_d2i_func(ASN1_VALUE **a, const unsigned char ** in, long length); +typedef int ASN1_i2d_func(ASN1_VALUE * a, unsigned char **in); + +typedef int ASN1_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len, const ASN1_ITEM *it, + int tag, int aclass, char opt, ASN1_TLC *ctx); + +typedef int ASN1_ex_i2d(ASN1_VALUE **pval, unsigned char **out, const ASN1_ITEM *it, int tag, int aclass); +typedef int ASN1_ex_new_func(ASN1_VALUE **pval, const ASN1_ITEM *it); +typedef void ASN1_ex_free_func(ASN1_VALUE **pval, const ASN1_ITEM *it); + +typedef int ASN1_ex_print_func(BIO *out, ASN1_VALUE **pval, + int indent, const char *fname, + const ASN1_PCTX *pctx); + +typedef int ASN1_primitive_i2c(ASN1_VALUE **pval, unsigned char *cont, int *putype, const ASN1_ITEM *it); +typedef int ASN1_primitive_c2i(ASN1_VALUE **pval, const unsigned char *cont, int len, int utype, char *free_cont, const ASN1_ITEM *it); +typedef int ASN1_primitive_print(BIO *out, ASN1_VALUE **pval, const ASN1_ITEM *it, int indent, const ASN1_PCTX *pctx); + +typedef struct ASN1_COMPAT_FUNCS_st { + ASN1_new_func *asn1_new; + ASN1_free_func *asn1_free; + ASN1_d2i_func *asn1_d2i; + ASN1_i2d_func *asn1_i2d; +} ASN1_COMPAT_FUNCS; + +typedef struct ASN1_EXTERN_FUNCS_st { + void *app_data; + ASN1_ex_new_func *asn1_ex_new; + ASN1_ex_free_func *asn1_ex_free; + ASN1_ex_free_func *asn1_ex_clear; + ASN1_ex_d2i *asn1_ex_d2i; + ASN1_ex_i2d *asn1_ex_i2d; + ASN1_ex_print_func *asn1_ex_print; +} ASN1_EXTERN_FUNCS; + +typedef struct ASN1_PRIMITIVE_FUNCS_st { + void *app_data; + unsigned long flags; + ASN1_ex_new_func *prim_new; + ASN1_ex_free_func *prim_free; + ASN1_ex_free_func *prim_clear; + ASN1_primitive_c2i *prim_c2i; + ASN1_primitive_i2c *prim_i2c; + ASN1_primitive_print *prim_print; +} ASN1_PRIMITIVE_FUNCS; + +/* This is the ASN1_AUX structure: it handles various + * miscellaneous requirements. For example the use of + * reference counts and an informational callback. + * + * The "informational callback" is called at various + * points during the ASN1 encoding and decoding. It can + * be used to provide minor customisation of the structures + * used. This is most useful where the supplied routines + * *almost* do the right thing but need some extra help + * at a few points. If the callback returns zero then + * it is assumed a fatal error has occurred and the + * main operation should be abandoned. + * + * If major changes in the default behaviour are required + * then an external type is more appropriate. + */ + +typedef int ASN1_aux_cb(int operation, ASN1_VALUE **in, const ASN1_ITEM *it, + void *exarg); + +typedef struct ASN1_AUX_st { + void *app_data; + int flags; + int ref_offset; /* Offset of reference value */ + int ref_lock; /* Lock type to use */ + ASN1_aux_cb *asn1_cb; + int enc_offset; /* Offset of ASN1_ENCODING structure */ +} ASN1_AUX; + +/* For print related callbacks exarg points to this structure */ +typedef struct ASN1_PRINT_ARG_st { + BIO *out; + int indent; + const ASN1_PCTX *pctx; +} ASN1_PRINT_ARG; + +/* For streaming related callbacks exarg points to this structure */ +typedef struct ASN1_STREAM_ARG_st { + /* BIO to stream through */ + BIO *out; + /* BIO with filters appended */ + BIO *ndef_bio; + /* Streaming I/O boundary */ + unsigned char **boundary; +} ASN1_STREAM_ARG; + +/* Flags in ASN1_AUX */ + +/* Use a reference count */ +#define ASN1_AFLG_REFCOUNT 1 +/* Save the encoding of structure (useful for signatures) */ +#define ASN1_AFLG_ENCODING 2 +/* The Sequence length is invalid */ +#define ASN1_AFLG_BROKEN 4 + +/* operation values for asn1_cb */ + +#define ASN1_OP_NEW_PRE 0 +#define ASN1_OP_NEW_POST 1 +#define ASN1_OP_FREE_PRE 2 +#define ASN1_OP_FREE_POST 3 +#define ASN1_OP_D2I_PRE 4 +#define ASN1_OP_D2I_POST 5 +#define ASN1_OP_I2D_PRE 6 +#define ASN1_OP_I2D_POST 7 +#define ASN1_OP_PRINT_PRE 8 +#define ASN1_OP_PRINT_POST 9 +#define ASN1_OP_STREAM_PRE 10 +#define ASN1_OP_STREAM_POST 11 +#define ASN1_OP_DETACHED_PRE 12 +#define ASN1_OP_DETACHED_POST 13 + +/* Macro to implement a primitive type */ +#define IMPLEMENT_ASN1_TYPE(stname) IMPLEMENT_ASN1_TYPE_ex(stname, stname, 0) +#define IMPLEMENT_ASN1_TYPE_ex(itname, vname, ex) \ + ASN1_ITEM_start(itname) \ + ASN1_ITYPE_PRIMITIVE, V_##vname, NULL, 0, NULL, ex, #itname \ + ASN1_ITEM_end(itname) + +/* Macro to implement a multi string type */ +#define IMPLEMENT_ASN1_MSTRING(itname, mask) \ + ASN1_ITEM_start(itname) \ + ASN1_ITYPE_MSTRING, mask, NULL, 0, NULL, sizeof(ASN1_STRING), #itname \ + ASN1_ITEM_end(itname) + +/* Macro to implement an ASN1_ITEM in terms of old style funcs */ + +#define IMPLEMENT_COMPAT_ASN1(sname) IMPLEMENT_COMPAT_ASN1_type(sname, V_ASN1_SEQUENCE) + +#define IMPLEMENT_COMPAT_ASN1_type(sname, tag) \ + static const ASN1_COMPAT_FUNCS sname##_ff = { \ + (ASN1_new_func *)sname##_new, \ + (ASN1_free_func *)sname##_free, \ + (ASN1_d2i_func *)d2i_##sname, \ + (ASN1_i2d_func *)i2d_##sname, \ + }; \ + ASN1_ITEM_start(sname) \ + ASN1_ITYPE_COMPAT, \ + tag, \ + NULL, \ + 0, \ + &sname##_ff, \ + 0, \ + #sname \ + ASN1_ITEM_end(sname) + +#define IMPLEMENT_EXTERN_ASN1(sname, tag, fptrs) \ + ASN1_ITEM_start(sname) \ + ASN1_ITYPE_EXTERN, \ + tag, \ + NULL, \ + 0, \ + &fptrs, \ + 0, \ + #sname \ + ASN1_ITEM_end(sname) + +/* Macro to implement standard functions in terms of ASN1_ITEM structures */ + +#define IMPLEMENT_ASN1_FUNCTIONS(stname) IMPLEMENT_ASN1_FUNCTIONS_fname(stname, stname, stname) + +#define IMPLEMENT_ASN1_FUNCTIONS_name(stname, itname) IMPLEMENT_ASN1_FUNCTIONS_fname(stname, itname, itname) + +#define IMPLEMENT_ASN1_FUNCTIONS_ENCODE_name(stname, itname) \ + IMPLEMENT_ASN1_FUNCTIONS_ENCODE_fname(stname, itname, itname) + +#define IMPLEMENT_STATIC_ASN1_ALLOC_FUNCTIONS(stname) \ + IMPLEMENT_ASN1_ALLOC_FUNCTIONS_pfname(static, stname, stname, stname) + +#define IMPLEMENT_ASN1_ALLOC_FUNCTIONS(stname) \ + IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, stname, stname) + +#define IMPLEMENT_ASN1_ALLOC_FUNCTIONS_pfname(pre, stname, itname, fname) \ + pre stname *fname##_new(void) \ + { \ + return (stname *)ASN1_item_new(ASN1_ITEM_rptr(itname)); \ + } \ + pre void fname##_free(stname *a) \ + { \ + ASN1_item_free((ASN1_VALUE *)a, ASN1_ITEM_rptr(itname)); \ + } + +#define IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname) \ + stname *fname##_new(void) \ + { \ + return (stname *)ASN1_item_new(ASN1_ITEM_rptr(itname)); \ + } \ + void fname##_free(stname *a) \ + { \ + ASN1_item_free((ASN1_VALUE *)a, ASN1_ITEM_rptr(itname)); \ + } + +#define IMPLEMENT_ASN1_FUNCTIONS_fname(stname, itname, fname) \ + IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname) \ + IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname) + +#define IMPLEMENT_ASN1_ENCODE_FUNCTIONS_fname(stname, itname, fname) \ + stname *d2i_##fname(stname **a, const unsigned char **in, long len) \ + { \ + return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, ASN1_ITEM_rptr(itname));\ + } \ + int i2d_##fname(stname *a, unsigned char **out) \ + { \ + return ASN1_item_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(itname));\ + } + +#define IMPLEMENT_ASN1_NDEF_FUNCTION(stname) \ + int i2d_##stname##_NDEF(stname *a, unsigned char **out) \ + { \ + return ASN1_item_ndef_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(stname));\ + } + +/* This includes evil casts to remove const: they will go away when full + * ASN1 constification is done. + */ +#define IMPLEMENT_ASN1_ENCODE_FUNCTIONS_const_fname(stname, itname, fname) \ + stname *d2i_##fname(stname **a, const unsigned char **in, long len) \ + { \ + return (stname *)ASN1_item_d2i((ASN1_VALUE **)a, in, len, ASN1_ITEM_rptr(itname));\ + } \ + int i2d_##fname(const stname *a, unsigned char **out) \ + { \ + return ASN1_item_i2d((ASN1_VALUE *)a, out, ASN1_ITEM_rptr(itname));\ + } + +#define IMPLEMENT_ASN1_DUP_FUNCTION(stname) \ + stname * stname##_dup(stname *x) \ + { \ + return ASN1_item_dup(ASN1_ITEM_rptr(stname), x); \ + } + +#define IMPLEMENT_ASN1_PRINT_FUNCTION(stname) \ + IMPLEMENT_ASN1_PRINT_FUNCTION_fname(stname, stname, stname) + +#define IMPLEMENT_ASN1_PRINT_FUNCTION_fname(stname, itname, fname) \ + int fname##_print_ctx(BIO *out, stname *x, int indent, \ + const ASN1_PCTX *pctx) \ + { \ + return ASN1_item_print(out, (ASN1_VALUE *)x, indent, \ + ASN1_ITEM_rptr(itname), pctx); \ + } + +#define IMPLEMENT_ASN1_FUNCTIONS_const(name) \ + IMPLEMENT_ASN1_FUNCTIONS_const_fname(name, name, name) + +#define IMPLEMENT_ASN1_FUNCTIONS_const_fname(stname, itname, fname) \ + IMPLEMENT_ASN1_ENCODE_FUNCTIONS_const_fname(stname, itname, fname) \ + IMPLEMENT_ASN1_ALLOC_FUNCTIONS_fname(stname, itname, fname) + +/* external definitions for primitive types */ + +DECLARE_ASN1_ITEM(ASN1_BOOLEAN) +DECLARE_ASN1_ITEM(ASN1_TBOOLEAN) +DECLARE_ASN1_ITEM(ASN1_FBOOLEAN) +DECLARE_ASN1_ITEM(ASN1_SEQUENCE) +DECLARE_ASN1_ITEM(CBIGNUM) +DECLARE_ASN1_ITEM(BIGNUM) +DECLARE_ASN1_ITEM(LONG) +DECLARE_ASN1_ITEM(ZLONG) + +DECLARE_STACK_OF(ASN1_VALUE) + +/* Functions used internally by the ASN1 code */ + +int ASN1_item_ex_new(ASN1_VALUE **pval, const ASN1_ITEM *it); +void ASN1_item_ex_free(ASN1_VALUE **pval, const ASN1_ITEM *it); +int ASN1_template_new(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt); +int ASN1_primitive_new(ASN1_VALUE **pval, const ASN1_ITEM *it); + +void ASN1_template_free(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt); +int ASN1_template_d2i(ASN1_VALUE **pval, const unsigned char **in, long len, const ASN1_TEMPLATE *tt); +int ASN1_item_ex_d2i(ASN1_VALUE **pval, const unsigned char **in, long len, const ASN1_ITEM *it, + int tag, int aclass, char opt, ASN1_TLC *ctx); + +int ASN1_item_ex_i2d(ASN1_VALUE **pval, unsigned char **out, const ASN1_ITEM *it, int tag, int aclass); +int ASN1_template_i2d(ASN1_VALUE **pval, unsigned char **out, const ASN1_TEMPLATE *tt); +void ASN1_primitive_free(ASN1_VALUE **pval, const ASN1_ITEM *it); + +int asn1_ex_i2c(ASN1_VALUE **pval, unsigned char *cont, int *putype, const ASN1_ITEM *it); +int asn1_ex_c2i(ASN1_VALUE **pval, const unsigned char *cont, int len, int utype, char *free_cont, const ASN1_ITEM *it); + +int asn1_get_choice_selector(ASN1_VALUE **pval, const ASN1_ITEM *it); +int asn1_set_choice_selector(ASN1_VALUE **pval, int value, const ASN1_ITEM *it); + +ASN1_VALUE ** asn1_get_field_ptr(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt); + +const ASN1_TEMPLATE *asn1_do_adb(ASN1_VALUE **pval, const ASN1_TEMPLATE *tt, int nullerr); + +int asn1_do_lock(ASN1_VALUE **pval, int op, const ASN1_ITEM *it); + +void asn1_enc_init(ASN1_VALUE **pval, const ASN1_ITEM *it); +void asn1_enc_free(ASN1_VALUE **pval, const ASN1_ITEM *it); +int asn1_enc_restore(int *len, unsigned char **out, ASN1_VALUE **pval, const ASN1_ITEM *it); +int asn1_enc_save(ASN1_VALUE **pval, const unsigned char *in, int inlen, const ASN1_ITEM *it); + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/bio.h b/Source/Import/OpenSSL/Include/openssl/bio.h new file mode 100644 index 0000000..05699ab --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/bio.h @@ -0,0 +1,847 @@ +/* crypto/bio/bio.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_BIO_H +#define HEADER_BIO_H + +#include + +#ifndef OPENSSL_NO_FP_API +# include +#endif +#include + +#include + +#ifndef OPENSSL_NO_SCTP +# ifndef OPENSSL_SYS_VMS +# include +# else +# include +# endif +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/* These are the 'types' of BIOs */ +#define BIO_TYPE_NONE 0 +#define BIO_TYPE_MEM (1|0x0400) +#define BIO_TYPE_FILE (2|0x0400) + +#define BIO_TYPE_FD (4|0x0400|0x0100) +#define BIO_TYPE_SOCKET (5|0x0400|0x0100) +#define BIO_TYPE_NULL (6|0x0400) +#define BIO_TYPE_SSL (7|0x0200) +#define BIO_TYPE_MD (8|0x0200) /* passive filter */ +#define BIO_TYPE_BUFFER (9|0x0200) /* filter */ +#define BIO_TYPE_CIPHER (10|0x0200) /* filter */ +#define BIO_TYPE_BASE64 (11|0x0200) /* filter */ +#define BIO_TYPE_CONNECT (12|0x0400|0x0100) /* socket - connect */ +#define BIO_TYPE_ACCEPT (13|0x0400|0x0100) /* socket for accept */ +#define BIO_TYPE_PROXY_CLIENT (14|0x0200) /* client proxy BIO */ +#define BIO_TYPE_PROXY_SERVER (15|0x0200) /* server proxy BIO */ +#define BIO_TYPE_NBIO_TEST (16|0x0200) /* server proxy BIO */ +#define BIO_TYPE_NULL_FILTER (17|0x0200) +#define BIO_TYPE_BER (18|0x0200) /* BER -> bin filter */ +#define BIO_TYPE_BIO (19|0x0400) /* (half a) BIO pair */ +#define BIO_TYPE_LINEBUFFER (20|0x0200) /* filter */ +#define BIO_TYPE_DGRAM (21|0x0400|0x0100) +#ifndef OPENSSL_NO_SCTP +#define BIO_TYPE_DGRAM_SCTP (24|0x0400|0x0100) +#endif +#define BIO_TYPE_ASN1 (22|0x0200) /* filter */ +#define BIO_TYPE_COMP (23|0x0200) /* filter */ + +#define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */ +#define BIO_TYPE_FILTER 0x0200 +#define BIO_TYPE_SOURCE_SINK 0x0400 + +/* BIO_FILENAME_READ|BIO_CLOSE to open or close on free. + * BIO_set_fp(in,stdin,BIO_NOCLOSE); */ +#define BIO_NOCLOSE 0x00 +#define BIO_CLOSE 0x01 + +/* These are used in the following macros and are passed to + * BIO_ctrl() */ +#define BIO_CTRL_RESET 1 /* opt - rewind/zero etc */ +#define BIO_CTRL_EOF 2 /* opt - are we at the eof */ +#define BIO_CTRL_INFO 3 /* opt - extra tit-bits */ +#define BIO_CTRL_SET 4 /* man - set the 'IO' type */ +#define BIO_CTRL_GET 5 /* man - get the 'IO' type */ +#define BIO_CTRL_PUSH 6 /* opt - internal, used to signify change */ +#define BIO_CTRL_POP 7 /* opt - internal, used to signify change */ +#define BIO_CTRL_GET_CLOSE 8 /* man - set the 'close' on free */ +#define BIO_CTRL_SET_CLOSE 9 /* man - set the 'close' on free */ +#define BIO_CTRL_PENDING 10 /* opt - is their more data buffered */ +#define BIO_CTRL_FLUSH 11 /* opt - 'flush' buffered output */ +#define BIO_CTRL_DUP 12 /* man - extra stuff for 'duped' BIO */ +#define BIO_CTRL_WPENDING 13 /* opt - number of bytes still to write */ +/* callback is int cb(BIO *bio,state,ret); */ +#define BIO_CTRL_SET_CALLBACK 14 /* opt - set callback function */ +#define BIO_CTRL_GET_CALLBACK 15 /* opt - set callback function */ + +#define BIO_CTRL_SET_FILENAME 30 /* BIO_s_file special */ + +/* dgram BIO stuff */ +#define BIO_CTRL_DGRAM_CONNECT 31 /* BIO dgram special */ +#define BIO_CTRL_DGRAM_SET_CONNECTED 32 /* allow for an externally + * connected socket to be + * passed in */ +#define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33 /* setsockopt, essentially */ +#define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34 /* getsockopt, essentially */ +#define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35 /* setsockopt, essentially */ +#define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36 /* getsockopt, essentially */ + +#define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37 /* flag whether the last */ +#define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38 /* I/O operation tiemd out */ + +/* #ifdef IP_MTU_DISCOVER */ +#define BIO_CTRL_DGRAM_MTU_DISCOVER 39 /* set DF bit on egress packets */ +/* #endif */ + +#define BIO_CTRL_DGRAM_QUERY_MTU 40 /* as kernel for current MTU */ +#define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47 +#define BIO_CTRL_DGRAM_GET_MTU 41 /* get cached value for MTU */ +#define BIO_CTRL_DGRAM_SET_MTU 42 /* set cached value for + * MTU. want to use this + * if asking the kernel + * fails */ + +#define BIO_CTRL_DGRAM_MTU_EXCEEDED 43 /* check whether the MTU + * was exceed in the + * previous write + * operation */ + +#define BIO_CTRL_DGRAM_GET_PEER 46 +#define BIO_CTRL_DGRAM_SET_PEER 44 /* Destination for the data */ + +#define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45 /* Next DTLS handshake timeout to + * adjust socket timeouts */ + +#ifndef OPENSSL_NO_SCTP +/* SCTP stuff */ +#define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE 50 +#define BIO_CTRL_DGRAM_SCTP_ADD_AUTH_KEY 51 +#define BIO_CTRL_DGRAM_SCTP_NEXT_AUTH_KEY 52 +#define BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD 53 +#define BIO_CTRL_DGRAM_SCTP_GET_SNDINFO 60 +#define BIO_CTRL_DGRAM_SCTP_SET_SNDINFO 61 +#define BIO_CTRL_DGRAM_SCTP_GET_RCVINFO 62 +#define BIO_CTRL_DGRAM_SCTP_SET_RCVINFO 63 +#define BIO_CTRL_DGRAM_SCTP_GET_PRINFO 64 +#define BIO_CTRL_DGRAM_SCTP_SET_PRINFO 65 +#define BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN 70 +#endif + +/* modifiers */ +#define BIO_FP_READ 0x02 +#define BIO_FP_WRITE 0x04 +#define BIO_FP_APPEND 0x08 +#define BIO_FP_TEXT 0x10 + +#define BIO_FLAGS_READ 0x01 +#define BIO_FLAGS_WRITE 0x02 +#define BIO_FLAGS_IO_SPECIAL 0x04 +#define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL) +#define BIO_FLAGS_SHOULD_RETRY 0x08 +#ifndef BIO_FLAGS_UPLINK +/* "UPLINK" flag denotes file descriptors provided by application. + It defaults to 0, as most platforms don't require UPLINK interface. */ +#define BIO_FLAGS_UPLINK 0 +#endif + +/* Used in BIO_gethostbyname() */ +#define BIO_GHBN_CTRL_HITS 1 +#define BIO_GHBN_CTRL_MISSES 2 +#define BIO_GHBN_CTRL_CACHE_SIZE 3 +#define BIO_GHBN_CTRL_GET_ENTRY 4 +#define BIO_GHBN_CTRL_FLUSH 5 + +/* Mostly used in the SSL BIO */ +/* Not used anymore + * #define BIO_FLAGS_PROTOCOL_DELAYED_READ 0x10 + * #define BIO_FLAGS_PROTOCOL_DELAYED_WRITE 0x20 + * #define BIO_FLAGS_PROTOCOL_STARTUP 0x40 + */ + +#define BIO_FLAGS_BASE64_NO_NL 0x100 + +/* This is used with memory BIOs: it means we shouldn't free up or change the + * data in any way. + */ +#define BIO_FLAGS_MEM_RDONLY 0x200 + +typedef struct bio_st BIO; + +void BIO_set_flags(BIO *b, int flags); +int BIO_test_flags(const BIO *b, int flags); +void BIO_clear_flags(BIO *b, int flags); + +#define BIO_get_flags(b) BIO_test_flags(b, ~(0x0)) +#define BIO_set_retry_special(b) \ + BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY)) +#define BIO_set_retry_read(b) \ + BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY)) +#define BIO_set_retry_write(b) \ + BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY)) + +/* These are normally used internally in BIOs */ +#define BIO_clear_retry_flags(b) \ + BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY)) +#define BIO_get_retry_flags(b) \ + BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY)) + +/* These should be used by the application to tell why we should retry */ +#define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ) +#define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE) +#define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL) +#define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS) +#define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY) + +/* The next three are used in conjunction with the + * BIO_should_io_special() condition. After this returns true, + * BIO *BIO_get_retry_BIO(BIO *bio, int *reason); will walk the BIO + * stack and return the 'reason' for the special and the offending BIO. + * Given a BIO, BIO_get_retry_reason(bio) will return the code. */ +/* Returned from the SSL bio when the certificate retrieval code had an error */ +#define BIO_RR_SSL_X509_LOOKUP 0x01 +/* Returned from the connect BIO when a connect would have blocked */ +#define BIO_RR_CONNECT 0x02 +/* Returned from the accept BIO when an accept would have blocked */ +#define BIO_RR_ACCEPT 0x03 + +/* These are passed by the BIO callback */ +#define BIO_CB_FREE 0x01 +#define BIO_CB_READ 0x02 +#define BIO_CB_WRITE 0x03 +#define BIO_CB_PUTS 0x04 +#define BIO_CB_GETS 0x05 +#define BIO_CB_CTRL 0x06 + +/* The callback is called before and after the underling operation, + * The BIO_CB_RETURN flag indicates if it is after the call */ +#define BIO_CB_RETURN 0x80 +#define BIO_CB_return(a) ((a)|BIO_CB_RETURN)) +#define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN)) +#define BIO_cb_post(a) ((a)&BIO_CB_RETURN) + +long (*BIO_get_callback(const BIO *b)) (struct bio_st *,int,const char *,int, long,long); +void BIO_set_callback(BIO *b, + long (*callback)(struct bio_st *,int,const char *,int, long,long)); +char *BIO_get_callback_arg(const BIO *b); +void BIO_set_callback_arg(BIO *b, char *arg); + +const char * BIO_method_name(const BIO *b); +int BIO_method_type(const BIO *b); + +typedef void bio_info_cb(struct bio_st *, int, const char *, int, long, long); + +typedef struct bio_method_st + { + int type; + const char *name; + int (*bwrite)(BIO *, const char *, int); + int (*bread)(BIO *, char *, int); + int (*bputs)(BIO *, const char *); + int (*bgets)(BIO *, char *, int); + long (*ctrl)(BIO *, int, long, void *); + int (*create)(BIO *); + int (*destroy)(BIO *); + long (*callback_ctrl)(BIO *, int, bio_info_cb *); + } BIO_METHOD; + +struct bio_st + { + BIO_METHOD *method; + /* bio, mode, argp, argi, argl, ret */ + long (*callback)(struct bio_st *,int,const char *,int, long,long); + char *cb_arg; /* first argument for the callback */ + + int init; + int shutdown; + int flags; /* extra storage */ + int retry_reason; + int num; + void *ptr; + struct bio_st *next_bio; /* used by filter BIOs */ + struct bio_st *prev_bio; /* used by filter BIOs */ + int references; + unsigned long num_read; + unsigned long num_write; + + CRYPTO_EX_DATA ex_data; + }; + +DECLARE_STACK_OF(BIO) + +typedef struct bio_f_buffer_ctx_struct + { + /* Buffers are setup like this: + * + * <---------------------- size -----------------------> + * +---------------------------------------------------+ + * | consumed | remaining | free space | + * +---------------------------------------------------+ + * <-- off --><------- len -------> + */ + + /* BIO *bio; */ /* this is now in the BIO struct */ + int ibuf_size; /* how big is the input buffer */ + int obuf_size; /* how big is the output buffer */ + + char *ibuf; /* the char array */ + int ibuf_len; /* how many bytes are in it */ + int ibuf_off; /* write/read offset */ + + char *obuf; /* the char array */ + int obuf_len; /* how many bytes are in it */ + int obuf_off; /* write/read offset */ + } BIO_F_BUFFER_CTX; + +/* Prefix and suffix callback in ASN1 BIO */ +typedef int asn1_ps_func(BIO *b, unsigned char **pbuf, int *plen, void *parg); + +#ifndef OPENSSL_NO_SCTP +/* SCTP parameter structs */ +struct bio_dgram_sctp_sndinfo + { + uint16_t snd_sid; + uint16_t snd_flags; + uint32_t snd_ppid; + uint32_t snd_context; + }; + +struct bio_dgram_sctp_rcvinfo + { + uint16_t rcv_sid; + uint16_t rcv_ssn; + uint16_t rcv_flags; + uint32_t rcv_ppid; + uint32_t rcv_tsn; + uint32_t rcv_cumtsn; + uint32_t rcv_context; + }; + +struct bio_dgram_sctp_prinfo + { + uint16_t pr_policy; + uint32_t pr_value; + }; +#endif + +/* connect BIO stuff */ +#define BIO_CONN_S_BEFORE 1 +#define BIO_CONN_S_GET_IP 2 +#define BIO_CONN_S_GET_PORT 3 +#define BIO_CONN_S_CREATE_SOCKET 4 +#define BIO_CONN_S_CONNECT 5 +#define BIO_CONN_S_OK 6 +#define BIO_CONN_S_BLOCKED_CONNECT 7 +#define BIO_CONN_S_NBIO 8 +/*#define BIO_CONN_get_param_hostname BIO_ctrl */ + +#define BIO_C_SET_CONNECT 100 +#define BIO_C_DO_STATE_MACHINE 101 +#define BIO_C_SET_NBIO 102 +#define BIO_C_SET_PROXY_PARAM 103 +#define BIO_C_SET_FD 104 +#define BIO_C_GET_FD 105 +#define BIO_C_SET_FILE_PTR 106 +#define BIO_C_GET_FILE_PTR 107 +#define BIO_C_SET_FILENAME 108 +#define BIO_C_SET_SSL 109 +#define BIO_C_GET_SSL 110 +#define BIO_C_SET_MD 111 +#define BIO_C_GET_MD 112 +#define BIO_C_GET_CIPHER_STATUS 113 +#define BIO_C_SET_BUF_MEM 114 +#define BIO_C_GET_BUF_MEM_PTR 115 +#define BIO_C_GET_BUFF_NUM_LINES 116 +#define BIO_C_SET_BUFF_SIZE 117 +#define BIO_C_SET_ACCEPT 118 +#define BIO_C_SSL_MODE 119 +#define BIO_C_GET_MD_CTX 120 +#define BIO_C_GET_PROXY_PARAM 121 +#define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */ +#define BIO_C_GET_CONNECT 123 +#define BIO_C_GET_ACCEPT 124 +#define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125 +#define BIO_C_GET_SSL_NUM_RENEGOTIATES 126 +#define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127 +#define BIO_C_FILE_SEEK 128 +#define BIO_C_GET_CIPHER_CTX 129 +#define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/ +#define BIO_C_SET_BIND_MODE 131 +#define BIO_C_GET_BIND_MODE 132 +#define BIO_C_FILE_TELL 133 +#define BIO_C_GET_SOCKS 134 +#define BIO_C_SET_SOCKS 135 + +#define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */ +#define BIO_C_GET_WRITE_BUF_SIZE 137 +#define BIO_C_MAKE_BIO_PAIR 138 +#define BIO_C_DESTROY_BIO_PAIR 139 +#define BIO_C_GET_WRITE_GUARANTEE 140 +#define BIO_C_GET_READ_REQUEST 141 +#define BIO_C_SHUTDOWN_WR 142 +#define BIO_C_NREAD0 143 +#define BIO_C_NREAD 144 +#define BIO_C_NWRITE0 145 +#define BIO_C_NWRITE 146 +#define BIO_C_RESET_READ_REQUEST 147 +#define BIO_C_SET_MD_CTX 148 + +#define BIO_C_SET_PREFIX 149 +#define BIO_C_GET_PREFIX 150 +#define BIO_C_SET_SUFFIX 151 +#define BIO_C_GET_SUFFIX 152 + +#define BIO_C_SET_EX_ARG 153 +#define BIO_C_GET_EX_ARG 154 + +#define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg) +#define BIO_get_app_data(s) BIO_get_ex_data(s,0) + +/* BIO_s_connect() and BIO_s_socks4a_connect() */ +#define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name) +#define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port) +#define BIO_set_conn_ip(b,ip) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip) +#define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port) +#define BIO_get_conn_hostname(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0) +#define BIO_get_conn_port(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1) +#define BIO_get_conn_ip(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2) +#define BIO_get_conn_int_port(b) BIO_int_ctrl(b,BIO_C_GET_CONNECT,3,0) + + +#define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) + +/* BIO_s_accept_socket() */ +#define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name) +#define BIO_get_accept_port(b) BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0) +/* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */ +#define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?(void *)"a":NULL) +#define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio) + +#define BIO_BIND_NORMAL 0 +#define BIO_BIND_REUSEADDR_IF_UNUSED 1 +#define BIO_BIND_REUSEADDR 2 +#define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL) +#define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL) + +#define BIO_do_connect(b) BIO_do_handshake(b) +#define BIO_do_accept(b) BIO_do_handshake(b) +#define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL) + +/* BIO_s_proxy_client() */ +#define BIO_set_url(b,url) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,0,(char *)(url)) +#define BIO_set_proxies(b,p) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,1,(char *)(p)) +/* BIO_set_nbio(b,n) */ +#define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s)) +/* BIO *BIO_get_filter_bio(BIO *bio); */ +#define BIO_set_proxy_cb(b,cb) BIO_callback_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(void *(*cb)())) +#define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk) +#define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool) + +#define BIO_get_proxy_header(b,skp) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,0,(char *)skp) +#define BIO_get_proxies(b,pxy_p) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,1,(char *)(pxy_p)) +#define BIO_get_url(b,url) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,2,(char *)(url)) +#define BIO_get_no_connect_return(b) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,5,NULL) + +#define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd) +#define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c) + +#define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp) +#define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp) + +#define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL) +#define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL) + +/* name is cast to lose const, but might be better to route through a function + so we can do it safely */ +#ifdef CONST_STRICT +/* If you are wondering why this isn't defined, its because CONST_STRICT is + * purely a compile-time kludge to allow const to be checked. + */ +int BIO_read_filename(BIO *b,const char *name); +#else +#define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ + BIO_CLOSE|BIO_FP_READ,(char *)name) +#endif +#define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ + BIO_CLOSE|BIO_FP_WRITE,name) +#define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ + BIO_CLOSE|BIO_FP_APPEND,name) +#define BIO_rw_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ + BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name) + +/* WARNING WARNING, this ups the reference count on the read bio of the + * SSL structure. This is because the ssl read BIO is now pointed to by + * the next_bio field in the bio. So when you free the BIO, make sure + * you are doing a BIO_free_all() to catch the underlying BIO. */ +#define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl) +#define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp) +#define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL) +#define BIO_set_ssl_renegotiate_bytes(b,num) \ + BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL); +#define BIO_get_num_renegotiates(b) \ + BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL); +#define BIO_set_ssl_renegotiate_timeout(b,seconds) \ + BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL); + +/* defined in evp.h */ +/* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */ + +#define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp) +#define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm) +#define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp) +#define BIO_set_mem_eof_return(b,v) \ + BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL) + +/* For the BIO_f_buffer() type */ +#define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL) +#define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL) +#define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0) +#define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1) +#define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf) + +/* Don't use the next one unless you know what you are doing :-) */ +#define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret)) + +#define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL) +#define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL) +#define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL) +#define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL) +#define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL) +#define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL) +/* ...pending macros have inappropriate return type */ +size_t BIO_ctrl_pending(BIO *b); +size_t BIO_ctrl_wpending(BIO *b); +#define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL) +#define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \ + cbp) +#define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb) + +/* For the BIO_f_buffer() type */ +#define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL) + +/* For BIO_s_bio() */ +#define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL) +#define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL) +#define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2) +#define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL) +#define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL) +/* macros with inappropriate type -- but ...pending macros use int too: */ +#define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL) +#define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL) +size_t BIO_ctrl_get_write_guarantee(BIO *b); +size_t BIO_ctrl_get_read_request(BIO *b); +int BIO_ctrl_reset_read_request(BIO *b); + +/* ctrl macros for dgram */ +#define BIO_ctrl_dgram_connect(b,peer) \ + (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)peer) +#define BIO_ctrl_set_connected(b, state, peer) \ + (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, state, (char *)peer) +#define BIO_dgram_recv_timedout(b) \ + (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL) +#define BIO_dgram_send_timedout(b) \ + (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL) +#define BIO_dgram_get_peer(b,peer) \ + (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)peer) +#define BIO_dgram_set_peer(b,peer) \ + (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)peer) + +/* These two aren't currently implemented */ +/* int BIO_get_ex_num(BIO *bio); */ +/* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */ +int BIO_set_ex_data(BIO *bio,int idx,void *data); +void *BIO_get_ex_data(BIO *bio,int idx); +int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); +unsigned long BIO_number_read(BIO *bio); +unsigned long BIO_number_written(BIO *bio); + +/* For BIO_f_asn1() */ +int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix, + asn1_ps_func *prefix_free); +int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix, + asn1_ps_func **pprefix_free); +int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix, + asn1_ps_func *suffix_free); +int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix, + asn1_ps_func **psuffix_free); + +# ifndef OPENSSL_NO_FP_API +BIO_METHOD *BIO_s_file(void ); +BIO *BIO_new_file(const char *filename, const char *mode); +BIO *BIO_new_fp(FILE *stream, int close_flag); +# define BIO_s_file_internal BIO_s_file +# endif +BIO * BIO_new(BIO_METHOD *type); +int BIO_set(BIO *a,BIO_METHOD *type); +int BIO_free(BIO *a); +void BIO_vfree(BIO *a); +int BIO_read(BIO *b, void *data, int len); +int BIO_gets(BIO *bp,char *buf, int size); +int BIO_write(BIO *b, const void *data, int len); +int BIO_puts(BIO *bp,const char *buf); +int BIO_indent(BIO *b,int indent,int max); +long BIO_ctrl(BIO *bp,int cmd,long larg,void *parg); +long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long)); +char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg); +long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg); +BIO * BIO_push(BIO *b,BIO *append); +BIO * BIO_pop(BIO *b); +void BIO_free_all(BIO *a); +BIO * BIO_find_type(BIO *b,int bio_type); +BIO * BIO_next(BIO *b); +BIO * BIO_get_retry_BIO(BIO *bio, int *reason); +int BIO_get_retry_reason(BIO *bio); +BIO * BIO_dup_chain(BIO *in); + +int BIO_nread0(BIO *bio, char **buf); +int BIO_nread(BIO *bio, char **buf, int num); +int BIO_nwrite0(BIO *bio, char **buf); +int BIO_nwrite(BIO *bio, char **buf, int num); + +long BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi, + long argl,long ret); + +BIO_METHOD *BIO_s_mem(void); +BIO *BIO_new_mem_buf(void *buf, int len); +BIO_METHOD *BIO_s_socket(void); +BIO_METHOD *BIO_s_connect(void); +BIO_METHOD *BIO_s_accept(void); +BIO_METHOD *BIO_s_fd(void); +#ifndef OPENSSL_SYS_OS2 +BIO_METHOD *BIO_s_log(void); +#endif +BIO_METHOD *BIO_s_bio(void); +BIO_METHOD *BIO_s_null(void); +BIO_METHOD *BIO_f_null(void); +BIO_METHOD *BIO_f_buffer(void); +#ifdef OPENSSL_SYS_VMS +BIO_METHOD *BIO_f_linebuffer(void); +#endif +BIO_METHOD *BIO_f_nbio_test(void); +#ifndef OPENSSL_NO_DGRAM +BIO_METHOD *BIO_s_datagram(void); +#ifndef OPENSSL_NO_SCTP +BIO_METHOD *BIO_s_datagram_sctp(void); +#endif +#endif + +/* BIO_METHOD *BIO_f_ber(void); */ + +int BIO_sock_should_retry(int i); +int BIO_sock_non_fatal_error(int error); +int BIO_dgram_non_fatal_error(int error); + +int BIO_fd_should_retry(int i); +int BIO_fd_non_fatal_error(int error); +int BIO_dump_cb(int (*cb)(const void *data, size_t len, void *u), + void *u, const char *s, int len); +int BIO_dump_indent_cb(int (*cb)(const void *data, size_t len, void *u), + void *u, const char *s, int len, int indent); +int BIO_dump(BIO *b,const char *bytes,int len); +int BIO_dump_indent(BIO *b,const char *bytes,int len,int indent); +#ifndef OPENSSL_NO_FP_API +int BIO_dump_fp(FILE *fp, const char *s, int len); +int BIO_dump_indent_fp(FILE *fp, const char *s, int len, int indent); +#endif +struct hostent *BIO_gethostbyname(const char *name); +/* We might want a thread-safe interface too: + * struct hostent *BIO_gethostbyname_r(const char *name, + * struct hostent *result, void *buffer, size_t buflen); + * or something similar (caller allocates a struct hostent, + * pointed to by "result", and additional buffer space for the various + * substructures; if the buffer does not suffice, NULL is returned + * and an appropriate error code is set). + */ +int BIO_sock_error(int sock); +int BIO_socket_ioctl(int fd, long type, void *arg); +int BIO_socket_nbio(int fd,int mode); +int BIO_get_port(const char *str, unsigned short *port_ptr); +int BIO_get_host_ip(const char *str, unsigned char *ip); +int BIO_get_accept_socket(char *host_port,int mode); +int BIO_accept(int sock,char **ip_port); +int BIO_sock_init(void ); +void BIO_sock_cleanup(void); +int BIO_set_tcp_ndelay(int sock,int turn_on); + +BIO *BIO_new_socket(int sock, int close_flag); +BIO *BIO_new_dgram(int fd, int close_flag); +#ifndef OPENSSL_NO_SCTP +BIO *BIO_new_dgram_sctp(int fd, int close_flag); +int BIO_dgram_is_sctp(BIO *bio); +int BIO_dgram_sctp_notification_cb(BIO *b, + void (*handle_notifications)(BIO *bio, void *context, void *buf), + void *context); +int BIO_dgram_sctp_wait_for_dry(BIO *b); +int BIO_dgram_sctp_msg_waiting(BIO *b); +#endif +BIO *BIO_new_fd(int fd, int close_flag); +BIO *BIO_new_connect(char *host_port); +BIO *BIO_new_accept(char *host_port); + +int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, + BIO **bio2, size_t writebuf2); +/* If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints. + * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. + * Size 0 uses default value. + */ + +void BIO_copy_next_retry(BIO *b); + +/*long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);*/ + +#ifdef __GNUC__ +# define __bio_h__attr__ __attribute__ +#else +# define __bio_h__attr__(x) +#endif +int BIO_printf(BIO *bio, const char *format, ...) + __bio_h__attr__((__format__(__printf__,2,3))); +int BIO_vprintf(BIO *bio, const char *format, va_list args) + __bio_h__attr__((__format__(__printf__,2,0))); +int BIO_snprintf(char *buf, size_t n, const char *format, ...) + __bio_h__attr__((__format__(__printf__,3,4))); +int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args) + __bio_h__attr__((__format__(__printf__,3,0))); +#undef __bio_h__attr__ + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_BIO_strings(void); + +/* Error codes for the BIO functions. */ + +/* Function codes. */ +#define BIO_F_ACPT_STATE 100 +#define BIO_F_BIO_ACCEPT 101 +#define BIO_F_BIO_BER_GET_HEADER 102 +#define BIO_F_BIO_CALLBACK_CTRL 131 +#define BIO_F_BIO_CTRL 103 +#define BIO_F_BIO_GETHOSTBYNAME 120 +#define BIO_F_BIO_GETS 104 +#define BIO_F_BIO_GET_ACCEPT_SOCKET 105 +#define BIO_F_BIO_GET_HOST_IP 106 +#define BIO_F_BIO_GET_PORT 107 +#define BIO_F_BIO_MAKE_PAIR 121 +#define BIO_F_BIO_NEW 108 +#define BIO_F_BIO_NEW_FILE 109 +#define BIO_F_BIO_NEW_MEM_BUF 126 +#define BIO_F_BIO_NREAD 123 +#define BIO_F_BIO_NREAD0 124 +#define BIO_F_BIO_NWRITE 125 +#define BIO_F_BIO_NWRITE0 122 +#define BIO_F_BIO_PUTS 110 +#define BIO_F_BIO_READ 111 +#define BIO_F_BIO_SOCK_INIT 112 +#define BIO_F_BIO_WRITE 113 +#define BIO_F_BUFFER_CTRL 114 +#define BIO_F_CONN_CTRL 127 +#define BIO_F_CONN_STATE 115 +#define BIO_F_DGRAM_SCTP_READ 132 +#define BIO_F_FILE_CTRL 116 +#define BIO_F_FILE_READ 130 +#define BIO_F_LINEBUFFER_CTRL 129 +#define BIO_F_MEM_READ 128 +#define BIO_F_MEM_WRITE 117 +#define BIO_F_SSL_NEW 118 +#define BIO_F_WSASTARTUP 119 + +/* Reason codes. */ +#define BIO_R_ACCEPT_ERROR 100 +#define BIO_R_BAD_FOPEN_MODE 101 +#define BIO_R_BAD_HOSTNAME_LOOKUP 102 +#define BIO_R_BROKEN_PIPE 124 +#define BIO_R_CONNECT_ERROR 103 +#define BIO_R_EOF_ON_MEMORY_BIO 127 +#define BIO_R_ERROR_SETTING_NBIO 104 +#define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET 105 +#define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET 106 +#define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET 107 +#define BIO_R_INVALID_ARGUMENT 125 +#define BIO_R_INVALID_IP_ADDRESS 108 +#define BIO_R_IN_USE 123 +#define BIO_R_KEEPALIVE 109 +#define BIO_R_NBIO_CONNECT_ERROR 110 +#define BIO_R_NO_ACCEPT_PORT_SPECIFIED 111 +#define BIO_R_NO_HOSTNAME_SPECIFIED 112 +#define BIO_R_NO_PORT_DEFINED 113 +#define BIO_R_NO_PORT_SPECIFIED 114 +#define BIO_R_NO_SUCH_FILE 128 +#define BIO_R_NULL_PARAMETER 115 +#define BIO_R_TAG_MISMATCH 116 +#define BIO_R_UNABLE_TO_BIND_SOCKET 117 +#define BIO_R_UNABLE_TO_CREATE_SOCKET 118 +#define BIO_R_UNABLE_TO_LISTEN_SOCKET 119 +#define BIO_R_UNINITIALIZED 120 +#define BIO_R_UNSUPPORTED_METHOD 121 +#define BIO_R_WRITE_TO_READ_ONLY_BIO 126 +#define BIO_R_WSASTARTUP 122 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/blowfish.h b/Source/Import/OpenSSL/Include/openssl/blowfish.h new file mode 100644 index 0000000..4b6c892 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/blowfish.h @@ -0,0 +1,129 @@ +/* crypto/bf/blowfish.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_BLOWFISH_H +#define HEADER_BLOWFISH_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef OPENSSL_NO_BF +#error BF is disabled. +#endif + +#define BF_ENCRYPT 1 +#define BF_DECRYPT 0 + +/* + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + * ! BF_LONG has to be at least 32 bits wide. If it's wider, then ! + * ! BF_LONG_LOG2 has to be defined along. ! + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + */ + +#if defined(__LP32__) +#define BF_LONG unsigned long +#elif defined(OPENSSL_SYS_CRAY) || defined(__ILP64__) +#define BF_LONG unsigned long +#define BF_LONG_LOG2 3 +/* + * _CRAY note. I could declare short, but I have no idea what impact + * does it have on performance on none-T3E machines. I could declare + * int, but at least on C90 sizeof(int) can be chosen at compile time. + * So I've chosen long... + * + */ +#else +#define BF_LONG unsigned int +#endif + +#define BF_ROUNDS 16 +#define BF_BLOCK 8 + +typedef struct bf_key_st + { + BF_LONG P[BF_ROUNDS+2]; + BF_LONG S[4*256]; + } BF_KEY; + +#ifdef OPENSSL_FIPS +void private_BF_set_key(BF_KEY *key, int len, const unsigned char *data); +#endif +void BF_set_key(BF_KEY *key, int len, const unsigned char *data); + +void BF_encrypt(BF_LONG *data,const BF_KEY *key); +void BF_decrypt(BF_LONG *data,const BF_KEY *key); + +void BF_ecb_encrypt(const unsigned char *in, unsigned char *out, + const BF_KEY *key, int enc); +void BF_cbc_encrypt(const unsigned char *in, unsigned char *out, long length, + const BF_KEY *schedule, unsigned char *ivec, int enc); +void BF_cfb64_encrypt(const unsigned char *in, unsigned char *out, long length, + const BF_KEY *schedule, unsigned char *ivec, int *num, int enc); +void BF_ofb64_encrypt(const unsigned char *in, unsigned char *out, long length, + const BF_KEY *schedule, unsigned char *ivec, int *num); +const char *BF_options(void); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/bn.h b/Source/Import/OpenSSL/Include/openssl/bn.h new file mode 100644 index 0000000..f34248e --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/bn.h @@ -0,0 +1,891 @@ +/* crypto/bn/bn.h */ +/* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ +/* ==================================================================== + * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +/* ==================================================================== + * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. + * + * Portions of the attached software ("Contribution") are developed by + * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project. + * + * The Contribution is licensed pursuant to the Eric Young open source + * license provided above. + * + * The binary polynomial arithmetic software is originally written by + * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories. + * + */ + +#ifndef HEADER_BN_H +#define HEADER_BN_H + +#include +#ifndef OPENSSL_NO_FP_API +#include /* FILE */ +#endif +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* These preprocessor symbols control various aspects of the bignum headers and + * library code. They're not defined by any "normal" configuration, as they are + * intended for development and testing purposes. NB: defining all three can be + * useful for debugging application code as well as openssl itself. + * + * BN_DEBUG - turn on various debugging alterations to the bignum code + * BN_DEBUG_RAND - uses random poisoning of unused words to trip up + * mismanagement of bignum internals. You must also define BN_DEBUG. + */ +/* #define BN_DEBUG */ +/* #define BN_DEBUG_RAND */ + +#ifndef OPENSSL_SMALL_FOOTPRINT +#define BN_MUL_COMBA +#define BN_SQR_COMBA +#define BN_RECURSION +#endif + +/* This next option uses the C libraries (2 word)/(1 word) function. + * If it is not defined, I use my C version (which is slower). + * The reason for this flag is that when the particular C compiler + * library routine is used, and the library is linked with a different + * compiler, the library is missing. This mostly happens when the + * library is built with gcc and then linked using normal cc. This would + * be a common occurrence because gcc normally produces code that is + * 2 times faster than system compilers for the big number stuff. + * For machines with only one compiler (or shared libraries), this should + * be on. Again this in only really a problem on machines + * using "long long's", are 32bit, and are not using my assembler code. */ +#if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WINDOWS) || \ + defined(OPENSSL_SYS_WIN32) || defined(linux) +# ifndef BN_DIV2W +# define BN_DIV2W +# endif +#endif + +/* assuming long is 64bit - this is the DEC Alpha + * unsigned long long is only 64 bits :-(, don't define + * BN_LLONG for the DEC Alpha */ +#ifdef SIXTY_FOUR_BIT_LONG +#define BN_ULLONG unsigned long long +#define BN_ULONG unsigned long +#define BN_LONG long +#define BN_BITS 128 +#define BN_BYTES 8 +#define BN_BITS2 64 +#define BN_BITS4 32 +#define BN_MASK (0xffffffffffffffffffffffffffffffffLL) +#define BN_MASK2 (0xffffffffffffffffL) +#define BN_MASK2l (0xffffffffL) +#define BN_MASK2h (0xffffffff00000000L) +#define BN_MASK2h1 (0xffffffff80000000L) +#define BN_TBIT (0x8000000000000000L) +#define BN_DEC_CONV (10000000000000000000UL) +#define BN_DEC_FMT1 "%lu" +#define BN_DEC_FMT2 "%019lu" +#define BN_DEC_NUM 19 +#define BN_HEX_FMT1 "%lX" +#define BN_HEX_FMT2 "%016lX" +#endif + +/* This is where the long long data type is 64 bits, but long is 32. + * For machines where there are 64bit registers, this is the mode to use. + * IRIX, on R4000 and above should use this mode, along with the relevant + * assembler code :-). Do NOT define BN_LLONG. + */ +#ifdef SIXTY_FOUR_BIT +#undef BN_LLONG +#undef BN_ULLONG +#define BN_ULONG unsigned long long +#define BN_LONG long long +#define BN_BITS 128 +#define BN_BYTES 8 +#define BN_BITS2 64 +#define BN_BITS4 32 +#define BN_MASK2 (0xffffffffffffffffLL) +#define BN_MASK2l (0xffffffffL) +#define BN_MASK2h (0xffffffff00000000LL) +#define BN_MASK2h1 (0xffffffff80000000LL) +#define BN_TBIT (0x8000000000000000LL) +#define BN_DEC_CONV (10000000000000000000ULL) +#define BN_DEC_FMT1 "%llu" +#define BN_DEC_FMT2 "%019llu" +#define BN_DEC_NUM 19 +#define BN_HEX_FMT1 "%llX" +#define BN_HEX_FMT2 "%016llX" +#endif + +#ifdef THIRTY_TWO_BIT +#ifdef BN_LLONG +# if defined(_WIN32) && !defined(__GNUC__) +# define BN_ULLONG unsigned __int64 +# define BN_MASK (0xffffffffffffffffI64) +# else +# define BN_ULLONG unsigned long long +# define BN_MASK (0xffffffffffffffffLL) +# endif +#endif +#define BN_ULONG unsigned int +#define BN_LONG int +#define BN_BITS 64 +#define BN_BYTES 4 +#define BN_BITS2 32 +#define BN_BITS4 16 +#define BN_MASK2 (0xffffffffL) +#define BN_MASK2l (0xffff) +#define BN_MASK2h1 (0xffff8000L) +#define BN_MASK2h (0xffff0000L) +#define BN_TBIT (0x80000000L) +#define BN_DEC_CONV (1000000000L) +#define BN_DEC_FMT1 "%u" +#define BN_DEC_FMT2 "%09u" +#define BN_DEC_NUM 9 +#define BN_HEX_FMT1 "%X" +#define BN_HEX_FMT2 "%08X" +#endif + +/* 2011-02-22 SMS. + * In various places, a size_t variable or a type cast to size_t was + * used to perform integer-only operations on pointers. This failed on + * VMS with 64-bit pointers (CC /POINTER_SIZE = 64) because size_t is + * still only 32 bits. What's needed in these cases is an integer type + * with the same size as a pointer, which size_t is not certain to be. + * The only fix here is VMS-specific. + */ +#if defined(OPENSSL_SYS_VMS) +# if __INITIAL_POINTER_SIZE == 64 +# define PTR_SIZE_INT long long +# else /* __INITIAL_POINTER_SIZE == 64 */ +# define PTR_SIZE_INT int +# endif /* __INITIAL_POINTER_SIZE == 64 [else] */ +#else /* defined(OPENSSL_SYS_VMS) */ +# define PTR_SIZE_INT size_t +#endif /* defined(OPENSSL_SYS_VMS) [else] */ + +#define BN_DEFAULT_BITS 1280 + +#define BN_FLG_MALLOCED 0x01 +#define BN_FLG_STATIC_DATA 0x02 +#define BN_FLG_CONSTTIME 0x04 /* avoid leaking exponent information through timing, + * BN_mod_exp_mont() will call BN_mod_exp_mont_consttime, + * BN_div() will call BN_div_no_branch, + * BN_mod_inverse() will call BN_mod_inverse_no_branch. + */ + +#ifndef OPENSSL_NO_DEPRECATED +#define BN_FLG_EXP_CONSTTIME BN_FLG_CONSTTIME /* deprecated name for the flag */ + /* avoid leaking exponent information through timings + * (BN_mod_exp_mont() will call BN_mod_exp_mont_consttime) */ +#endif + +#ifndef OPENSSL_NO_DEPRECATED +#define BN_FLG_FREE 0x8000 /* used for debuging */ +#endif +#define BN_set_flags(b,n) ((b)->flags|=(n)) +#define BN_get_flags(b,n) ((b)->flags&(n)) + +/* get a clone of a BIGNUM with changed flags, for *temporary* use only + * (the two BIGNUMs cannot not be used in parallel!) */ +#define BN_with_flags(dest,b,n) ((dest)->d=(b)->d, \ + (dest)->top=(b)->top, \ + (dest)->dmax=(b)->dmax, \ + (dest)->neg=(b)->neg, \ + (dest)->flags=(((dest)->flags & BN_FLG_MALLOCED) \ + | ((b)->flags & ~BN_FLG_MALLOCED) \ + | BN_FLG_STATIC_DATA \ + | (n))) + +/* Already declared in ossl_typ.h */ +#if 0 +typedef struct bignum_st BIGNUM; +/* Used for temp variables (declaration hidden in bn_lcl.h) */ +typedef struct bignum_ctx BN_CTX; +typedef struct bn_blinding_st BN_BLINDING; +typedef struct bn_mont_ctx_st BN_MONT_CTX; +typedef struct bn_recp_ctx_st BN_RECP_CTX; +typedef struct bn_gencb_st BN_GENCB; +#endif + +struct bignum_st + { + BN_ULONG *d; /* Pointer to an array of 'BN_BITS2' bit chunks. */ + int top; /* Index of last used d +1. */ + /* The next are internal book keeping for bn_expand. */ + int dmax; /* Size of the d array. */ + int neg; /* one if the number is negative */ + int flags; + }; + +/* Used for montgomery multiplication */ +struct bn_mont_ctx_st + { + int ri; /* number of bits in R */ + BIGNUM RR; /* used to convert to montgomery form */ + BIGNUM N; /* The modulus */ + BIGNUM Ni; /* R*(1/R mod N) - N*Ni = 1 + * (Ni is only stored for bignum algorithm) */ + BN_ULONG n0[2];/* least significant word(s) of Ni; + (type changed with 0.9.9, was "BN_ULONG n0;" before) */ + int flags; + }; + +/* Used for reciprocal division/mod functions + * It cannot be shared between threads + */ +struct bn_recp_ctx_st + { + BIGNUM N; /* the divisor */ + BIGNUM Nr; /* the reciprocal */ + int num_bits; + int shift; + int flags; + }; + +/* Used for slow "generation" functions. */ +struct bn_gencb_st + { + unsigned int ver; /* To handle binary (in)compatibility */ + void *arg; /* callback-specific data */ + union + { + /* if(ver==1) - handles old style callbacks */ + void (*cb_1)(int, int, void *); + /* if(ver==2) - new callback style */ + int (*cb_2)(int, int, BN_GENCB *); + } cb; + }; +/* Wrapper function to make using BN_GENCB easier, */ +int BN_GENCB_call(BN_GENCB *cb, int a, int b); +/* Macro to populate a BN_GENCB structure with an "old"-style callback */ +#define BN_GENCB_set_old(gencb, callback, cb_arg) { \ + BN_GENCB *tmp_gencb = (gencb); \ + tmp_gencb->ver = 1; \ + tmp_gencb->arg = (cb_arg); \ + tmp_gencb->cb.cb_1 = (callback); } +/* Macro to populate a BN_GENCB structure with a "new"-style callback */ +#define BN_GENCB_set(gencb, callback, cb_arg) { \ + BN_GENCB *tmp_gencb = (gencb); \ + tmp_gencb->ver = 2; \ + tmp_gencb->arg = (cb_arg); \ + tmp_gencb->cb.cb_2 = (callback); } + +#define BN_prime_checks 0 /* default: select number of iterations + based on the size of the number */ + +/* number of Miller-Rabin iterations for an error rate of less than 2^-80 + * for random 'b'-bit input, b >= 100 (taken from table 4.4 in the Handbook + * of Applied Cryptography [Menezes, van Oorschot, Vanstone; CRC Press 1996]; + * original paper: Damgaard, Landrock, Pomerance: Average case error estimates + * for the strong probable prime test. -- Math. Comp. 61 (1993) 177-194) */ +#define BN_prime_checks_for_size(b) ((b) >= 1300 ? 2 : \ + (b) >= 850 ? 3 : \ + (b) >= 650 ? 4 : \ + (b) >= 550 ? 5 : \ + (b) >= 450 ? 6 : \ + (b) >= 400 ? 7 : \ + (b) >= 350 ? 8 : \ + (b) >= 300 ? 9 : \ + (b) >= 250 ? 12 : \ + (b) >= 200 ? 15 : \ + (b) >= 150 ? 18 : \ + /* b >= 100 */ 27) + +#define BN_num_bytes(a) ((BN_num_bits(a)+7)/8) + +/* Note that BN_abs_is_word didn't work reliably for w == 0 until 0.9.8 */ +#define BN_abs_is_word(a,w) ((((a)->top == 1) && ((a)->d[0] == (BN_ULONG)(w))) || \ + (((w) == 0) && ((a)->top == 0))) +#define BN_is_zero(a) ((a)->top == 0) +#define BN_is_one(a) (BN_abs_is_word((a),1) && !(a)->neg) +#define BN_is_word(a,w) (BN_abs_is_word((a),(w)) && (!(w) || !(a)->neg)) +#define BN_is_odd(a) (((a)->top > 0) && ((a)->d[0] & 1)) + +#define BN_one(a) (BN_set_word((a),1)) +#define BN_zero_ex(a) \ + do { \ + BIGNUM *_tmp_bn = (a); \ + _tmp_bn->top = 0; \ + _tmp_bn->neg = 0; \ + } while(0) +#ifdef OPENSSL_NO_DEPRECATED +#define BN_zero(a) BN_zero_ex(a) +#else +#define BN_zero(a) (BN_set_word((a),0)) +#endif + +const BIGNUM *BN_value_one(void); +char * BN_options(void); +BN_CTX *BN_CTX_new(void); +#ifndef OPENSSL_NO_DEPRECATED +void BN_CTX_init(BN_CTX *c); +#endif +void BN_CTX_free(BN_CTX *c); +void BN_CTX_start(BN_CTX *ctx); +BIGNUM *BN_CTX_get(BN_CTX *ctx); +void BN_CTX_end(BN_CTX *ctx); +int BN_rand(BIGNUM *rnd, int bits, int top,int bottom); +int BN_pseudo_rand(BIGNUM *rnd, int bits, int top,int bottom); +int BN_rand_range(BIGNUM *rnd, const BIGNUM *range); +int BN_pseudo_rand_range(BIGNUM *rnd, const BIGNUM *range); +int BN_num_bits(const BIGNUM *a); +int BN_num_bits_word(BN_ULONG); +BIGNUM *BN_new(void); +void BN_init(BIGNUM *); +void BN_clear_free(BIGNUM *a); +BIGNUM *BN_copy(BIGNUM *a, const BIGNUM *b); +void BN_swap(BIGNUM *a, BIGNUM *b); +BIGNUM *BN_bin2bn(const unsigned char *s,int len,BIGNUM *ret); +int BN_bn2bin(const BIGNUM *a, unsigned char *to); +BIGNUM *BN_mpi2bn(const unsigned char *s,int len,BIGNUM *ret); +int BN_bn2mpi(const BIGNUM *a, unsigned char *to); +int BN_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); +int BN_usub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); +int BN_uadd(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); +int BN_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); +int BN_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); +int BN_sqr(BIGNUM *r, const BIGNUM *a,BN_CTX *ctx); +/** BN_set_negative sets sign of a BIGNUM + * \param b pointer to the BIGNUM object + * \param n 0 if the BIGNUM b should be positive and a value != 0 otherwise + */ +void BN_set_negative(BIGNUM *b, int n); +/** BN_is_negative returns 1 if the BIGNUM is negative + * \param a pointer to the BIGNUM object + * \return 1 if a < 0 and 0 otherwise + */ +#define BN_is_negative(a) ((a)->neg != 0) + +int BN_div(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, const BIGNUM *d, + BN_CTX *ctx); +#define BN_mod(rem,m,d,ctx) BN_div(NULL,(rem),(m),(d),(ctx)) +int BN_nnmod(BIGNUM *r, const BIGNUM *m, const BIGNUM *d, BN_CTX *ctx); +int BN_mod_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx); +int BN_mod_add_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m); +int BN_mod_sub(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m, BN_CTX *ctx); +int BN_mod_sub_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, const BIGNUM *m); +int BN_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, + const BIGNUM *m, BN_CTX *ctx); +int BN_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx); +int BN_mod_lshift1(BIGNUM *r, const BIGNUM *a, const BIGNUM *m, BN_CTX *ctx); +int BN_mod_lshift1_quick(BIGNUM *r, const BIGNUM *a, const BIGNUM *m); +int BN_mod_lshift(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m, BN_CTX *ctx); +int BN_mod_lshift_quick(BIGNUM *r, const BIGNUM *a, int n, const BIGNUM *m); + +BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w); +BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w); +int BN_mul_word(BIGNUM *a, BN_ULONG w); +int BN_add_word(BIGNUM *a, BN_ULONG w); +int BN_sub_word(BIGNUM *a, BN_ULONG w); +int BN_set_word(BIGNUM *a, BN_ULONG w); +BN_ULONG BN_get_word(const BIGNUM *a); + +int BN_cmp(const BIGNUM *a, const BIGNUM *b); +void BN_free(BIGNUM *a); +int BN_is_bit_set(const BIGNUM *a, int n); +int BN_lshift(BIGNUM *r, const BIGNUM *a, int n); +int BN_lshift1(BIGNUM *r, const BIGNUM *a); +int BN_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p,BN_CTX *ctx); + +int BN_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, + const BIGNUM *m,BN_CTX *ctx); +int BN_mod_exp_mont(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, + const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); +int BN_mod_exp_mont_consttime(BIGNUM *rr, const BIGNUM *a, const BIGNUM *p, + const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *in_mont); +int BN_mod_exp_mont_word(BIGNUM *r, BN_ULONG a, const BIGNUM *p, + const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx); +int BN_mod_exp2_mont(BIGNUM *r, const BIGNUM *a1, const BIGNUM *p1, + const BIGNUM *a2, const BIGNUM *p2,const BIGNUM *m, + BN_CTX *ctx,BN_MONT_CTX *m_ctx); +int BN_mod_exp_simple(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, + const BIGNUM *m,BN_CTX *ctx); + +int BN_mask_bits(BIGNUM *a,int n); +#ifndef OPENSSL_NO_FP_API +int BN_print_fp(FILE *fp, const BIGNUM *a); +#endif +#ifdef HEADER_BIO_H +int BN_print(BIO *fp, const BIGNUM *a); +#else +int BN_print(void *fp, const BIGNUM *a); +#endif +int BN_reciprocal(BIGNUM *r, const BIGNUM *m, int len, BN_CTX *ctx); +int BN_rshift(BIGNUM *r, const BIGNUM *a, int n); +int BN_rshift1(BIGNUM *r, const BIGNUM *a); +void BN_clear(BIGNUM *a); +BIGNUM *BN_dup(const BIGNUM *a); +int BN_ucmp(const BIGNUM *a, const BIGNUM *b); +int BN_set_bit(BIGNUM *a, int n); +int BN_clear_bit(BIGNUM *a, int n); +char * BN_bn2hex(const BIGNUM *a); +char * BN_bn2dec(const BIGNUM *a); +int BN_hex2bn(BIGNUM **a, const char *str); +int BN_dec2bn(BIGNUM **a, const char *str); +int BN_asc2bn(BIGNUM **a, const char *str); +int BN_gcd(BIGNUM *r,const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); +int BN_kronecker(const BIGNUM *a,const BIGNUM *b,BN_CTX *ctx); /* returns -2 for error */ +BIGNUM *BN_mod_inverse(BIGNUM *ret, + const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx); +BIGNUM *BN_mod_sqrt(BIGNUM *ret, + const BIGNUM *a, const BIGNUM *n,BN_CTX *ctx); + +/* Deprecated versions */ +#ifndef OPENSSL_NO_DEPRECATED +BIGNUM *BN_generate_prime(BIGNUM *ret,int bits,int safe, + const BIGNUM *add, const BIGNUM *rem, + void (*callback)(int,int,void *),void *cb_arg); +int BN_is_prime(const BIGNUM *p,int nchecks, + void (*callback)(int,int,void *), + BN_CTX *ctx,void *cb_arg); +int BN_is_prime_fasttest(const BIGNUM *p,int nchecks, + void (*callback)(int,int,void *),BN_CTX *ctx,void *cb_arg, + int do_trial_division); +#endif /* !defined(OPENSSL_NO_DEPRECATED) */ + +/* Newer versions */ +int BN_generate_prime_ex(BIGNUM *ret,int bits,int safe, const BIGNUM *add, + const BIGNUM *rem, BN_GENCB *cb); +int BN_is_prime_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, BN_GENCB *cb); +int BN_is_prime_fasttest_ex(const BIGNUM *p,int nchecks, BN_CTX *ctx, + int do_trial_division, BN_GENCB *cb); + +int BN_X931_generate_Xpq(BIGNUM *Xp, BIGNUM *Xq, int nbits, BN_CTX *ctx); + +int BN_X931_derive_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2, + const BIGNUM *Xp, const BIGNUM *Xp1, const BIGNUM *Xp2, + const BIGNUM *e, BN_CTX *ctx, BN_GENCB *cb); +int BN_X931_generate_prime_ex(BIGNUM *p, BIGNUM *p1, BIGNUM *p2, + BIGNUM *Xp1, BIGNUM *Xp2, + const BIGNUM *Xp, + const BIGNUM *e, BN_CTX *ctx, + BN_GENCB *cb); + +BN_MONT_CTX *BN_MONT_CTX_new(void ); +void BN_MONT_CTX_init(BN_MONT_CTX *ctx); +int BN_mod_mul_montgomery(BIGNUM *r,const BIGNUM *a,const BIGNUM *b, + BN_MONT_CTX *mont, BN_CTX *ctx); +#define BN_to_montgomery(r,a,mont,ctx) BN_mod_mul_montgomery(\ + (r),(a),&((mont)->RR),(mont),(ctx)) +int BN_from_montgomery(BIGNUM *r,const BIGNUM *a, + BN_MONT_CTX *mont, BN_CTX *ctx); +void BN_MONT_CTX_free(BN_MONT_CTX *mont); +int BN_MONT_CTX_set(BN_MONT_CTX *mont,const BIGNUM *mod,BN_CTX *ctx); +BN_MONT_CTX *BN_MONT_CTX_copy(BN_MONT_CTX *to,BN_MONT_CTX *from); +BN_MONT_CTX *BN_MONT_CTX_set_locked(BN_MONT_CTX **pmont, int lock, + const BIGNUM *mod, BN_CTX *ctx); + +/* BN_BLINDING flags */ +#define BN_BLINDING_NO_UPDATE 0x00000001 +#define BN_BLINDING_NO_RECREATE 0x00000002 + +BN_BLINDING *BN_BLINDING_new(const BIGNUM *A, const BIGNUM *Ai, BIGNUM *mod); +void BN_BLINDING_free(BN_BLINDING *b); +int BN_BLINDING_update(BN_BLINDING *b,BN_CTX *ctx); +int BN_BLINDING_convert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx); +int BN_BLINDING_invert(BIGNUM *n, BN_BLINDING *b, BN_CTX *ctx); +int BN_BLINDING_convert_ex(BIGNUM *n, BIGNUM *r, BN_BLINDING *b, BN_CTX *); +int BN_BLINDING_invert_ex(BIGNUM *n, const BIGNUM *r, BN_BLINDING *b, BN_CTX *); +#ifndef OPENSSL_NO_DEPRECATED +unsigned long BN_BLINDING_get_thread_id(const BN_BLINDING *); +void BN_BLINDING_set_thread_id(BN_BLINDING *, unsigned long); +#endif +CRYPTO_THREADID *BN_BLINDING_thread_id(BN_BLINDING *); +unsigned long BN_BLINDING_get_flags(const BN_BLINDING *); +void BN_BLINDING_set_flags(BN_BLINDING *, unsigned long); +BN_BLINDING *BN_BLINDING_create_param(BN_BLINDING *b, + const BIGNUM *e, BIGNUM *m, BN_CTX *ctx, + int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, + const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx), + BN_MONT_CTX *m_ctx); + +#ifndef OPENSSL_NO_DEPRECATED +void BN_set_params(int mul,int high,int low,int mont); +int BN_get_params(int which); /* 0, mul, 1 high, 2 low, 3 mont */ +#endif + +void BN_RECP_CTX_init(BN_RECP_CTX *recp); +BN_RECP_CTX *BN_RECP_CTX_new(void); +void BN_RECP_CTX_free(BN_RECP_CTX *recp); +int BN_RECP_CTX_set(BN_RECP_CTX *recp,const BIGNUM *rdiv,BN_CTX *ctx); +int BN_mod_mul_reciprocal(BIGNUM *r, const BIGNUM *x, const BIGNUM *y, + BN_RECP_CTX *recp,BN_CTX *ctx); +int BN_mod_exp_recp(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, + const BIGNUM *m, BN_CTX *ctx); +int BN_div_recp(BIGNUM *dv, BIGNUM *rem, const BIGNUM *m, + BN_RECP_CTX *recp, BN_CTX *ctx); + +#ifndef OPENSSL_NO_EC2M + +/* Functions for arithmetic over binary polynomials represented by BIGNUMs. + * + * The BIGNUM::neg property of BIGNUMs representing binary polynomials is + * ignored. + * + * Note that input arguments are not const so that their bit arrays can + * be expanded to the appropriate size if needed. + */ + +int BN_GF2m_add(BIGNUM *r, const BIGNUM *a, const BIGNUM *b); /*r = a + b*/ +#define BN_GF2m_sub(r, a, b) BN_GF2m_add(r, a, b) +int BN_GF2m_mod(BIGNUM *r, const BIGNUM *a, const BIGNUM *p); /*r=a mod p*/ +int BN_GF2m_mod_mul(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, + const BIGNUM *p, BN_CTX *ctx); /* r = (a * b) mod p */ +int BN_GF2m_mod_sqr(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, + BN_CTX *ctx); /* r = (a * a) mod p */ +int BN_GF2m_mod_inv(BIGNUM *r, const BIGNUM *b, const BIGNUM *p, + BN_CTX *ctx); /* r = (1 / b) mod p */ +int BN_GF2m_mod_div(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, + const BIGNUM *p, BN_CTX *ctx); /* r = (a / b) mod p */ +int BN_GF2m_mod_exp(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, + const BIGNUM *p, BN_CTX *ctx); /* r = (a ^ b) mod p */ +int BN_GF2m_mod_sqrt(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, + BN_CTX *ctx); /* r = sqrt(a) mod p */ +int BN_GF2m_mod_solve_quad(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, + BN_CTX *ctx); /* r^2 + r = a mod p */ +#define BN_GF2m_cmp(a, b) BN_ucmp((a), (b)) +/* Some functions allow for representation of the irreducible polynomials + * as an unsigned int[], say p. The irreducible f(t) is then of the form: + * t^p[0] + t^p[1] + ... + t^p[k] + * where m = p[0] > p[1] > ... > p[k] = 0. + */ +int BN_GF2m_mod_arr(BIGNUM *r, const BIGNUM *a, const int p[]); + /* r = a mod p */ +int BN_GF2m_mod_mul_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, + const int p[], BN_CTX *ctx); /* r = (a * b) mod p */ +int BN_GF2m_mod_sqr_arr(BIGNUM *r, const BIGNUM *a, const int p[], + BN_CTX *ctx); /* r = (a * a) mod p */ +int BN_GF2m_mod_inv_arr(BIGNUM *r, const BIGNUM *b, const int p[], + BN_CTX *ctx); /* r = (1 / b) mod p */ +int BN_GF2m_mod_div_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, + const int p[], BN_CTX *ctx); /* r = (a / b) mod p */ +int BN_GF2m_mod_exp_arr(BIGNUM *r, const BIGNUM *a, const BIGNUM *b, + const int p[], BN_CTX *ctx); /* r = (a ^ b) mod p */ +int BN_GF2m_mod_sqrt_arr(BIGNUM *r, const BIGNUM *a, + const int p[], BN_CTX *ctx); /* r = sqrt(a) mod p */ +int BN_GF2m_mod_solve_quad_arr(BIGNUM *r, const BIGNUM *a, + const int p[], BN_CTX *ctx); /* r^2 + r = a mod p */ +int BN_GF2m_poly2arr(const BIGNUM *a, int p[], int max); +int BN_GF2m_arr2poly(const int p[], BIGNUM *a); + +#endif + +/* faster mod functions for the 'NIST primes' + * 0 <= a < p^2 */ +int BN_nist_mod_192(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); +int BN_nist_mod_224(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); +int BN_nist_mod_256(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); +int BN_nist_mod_384(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); +int BN_nist_mod_521(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, BN_CTX *ctx); + +const BIGNUM *BN_get0_nist_prime_192(void); +const BIGNUM *BN_get0_nist_prime_224(void); +const BIGNUM *BN_get0_nist_prime_256(void); +const BIGNUM *BN_get0_nist_prime_384(void); +const BIGNUM *BN_get0_nist_prime_521(void); + +/* library internal functions */ + +#define bn_expand(a,bits) ((((((bits+BN_BITS2-1))/BN_BITS2)) <= (a)->dmax)?\ + (a):bn_expand2((a),(bits+BN_BITS2-1)/BN_BITS2)) +#define bn_wexpand(a,words) (((words) <= (a)->dmax)?(a):bn_expand2((a),(words))) +BIGNUM *bn_expand2(BIGNUM *a, int words); +#ifndef OPENSSL_NO_DEPRECATED +BIGNUM *bn_dup_expand(const BIGNUM *a, int words); /* unused */ +#endif + +/* Bignum consistency macros + * There is one "API" macro, bn_fix_top(), for stripping leading zeroes from + * bignum data after direct manipulations on the data. There is also an + * "internal" macro, bn_check_top(), for verifying that there are no leading + * zeroes. Unfortunately, some auditing is required due to the fact that + * bn_fix_top() has become an overabused duct-tape because bignum data is + * occasionally passed around in an inconsistent state. So the following + * changes have been made to sort this out; + * - bn_fix_top()s implementation has been moved to bn_correct_top() + * - if BN_DEBUG isn't defined, bn_fix_top() maps to bn_correct_top(), and + * bn_check_top() is as before. + * - if BN_DEBUG *is* defined; + * - bn_check_top() tries to pollute unused words even if the bignum 'top' is + * consistent. (ed: only if BN_DEBUG_RAND is defined) + * - bn_fix_top() maps to bn_check_top() rather than "fixing" anything. + * The idea is to have debug builds flag up inconsistent bignums when they + * occur. If that occurs in a bn_fix_top(), we examine the code in question; if + * the use of bn_fix_top() was appropriate (ie. it follows directly after code + * that manipulates the bignum) it is converted to bn_correct_top(), and if it + * was not appropriate, we convert it permanently to bn_check_top() and track + * down the cause of the bug. Eventually, no internal code should be using the + * bn_fix_top() macro. External applications and libraries should try this with + * their own code too, both in terms of building against the openssl headers + * with BN_DEBUG defined *and* linking with a version of OpenSSL built with it + * defined. This not only improves external code, it provides more test + * coverage for openssl's own code. + */ + +#ifdef BN_DEBUG + +/* We only need assert() when debugging */ +#include + +#ifdef BN_DEBUG_RAND +/* To avoid "make update" cvs wars due to BN_DEBUG, use some tricks */ +#ifndef RAND_pseudo_bytes +int RAND_pseudo_bytes(unsigned char *buf,int num); +#define BN_DEBUG_TRIX +#endif +#define bn_pollute(a) \ + do { \ + const BIGNUM *_bnum1 = (a); \ + if(_bnum1->top < _bnum1->dmax) { \ + unsigned char _tmp_char; \ + /* We cast away const without the compiler knowing, any \ + * *genuinely* constant variables that aren't mutable \ + * wouldn't be constructed with top!=dmax. */ \ + BN_ULONG *_not_const; \ + memcpy(&_not_const, &_bnum1->d, sizeof(BN_ULONG*)); \ + RAND_pseudo_bytes(&_tmp_char, 1); \ + memset((unsigned char *)(_not_const + _bnum1->top), _tmp_char, \ + (_bnum1->dmax - _bnum1->top) * sizeof(BN_ULONG)); \ + } \ + } while(0) +#ifdef BN_DEBUG_TRIX +#undef RAND_pseudo_bytes +#endif +#else +#define bn_pollute(a) +#endif +#define bn_check_top(a) \ + do { \ + const BIGNUM *_bnum2 = (a); \ + if (_bnum2 != NULL) { \ + assert((_bnum2->top == 0) || \ + (_bnum2->d[_bnum2->top - 1] != 0)); \ + bn_pollute(_bnum2); \ + } \ + } while(0) + +#define bn_fix_top(a) bn_check_top(a) + +#else /* !BN_DEBUG */ + +#define bn_pollute(a) +#define bn_check_top(a) +#define bn_fix_top(a) bn_correct_top(a) + +#endif + +#define bn_correct_top(a) \ + { \ + BN_ULONG *ftl; \ + int tmp_top = (a)->top; \ + if (tmp_top > 0) \ + { \ + for (ftl= &((a)->d[tmp_top-1]); tmp_top > 0; tmp_top--) \ + if (*(ftl--)) break; \ + (a)->top = tmp_top; \ + } \ + bn_pollute(a); \ + } + +BN_ULONG bn_mul_add_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w); +BN_ULONG bn_mul_words(BN_ULONG *rp, const BN_ULONG *ap, int num, BN_ULONG w); +void bn_sqr_words(BN_ULONG *rp, const BN_ULONG *ap, int num); +BN_ULONG bn_div_words(BN_ULONG h, BN_ULONG l, BN_ULONG d); +BN_ULONG bn_add_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num); +BN_ULONG bn_sub_words(BN_ULONG *rp, const BN_ULONG *ap, const BN_ULONG *bp,int num); + +/* Primes from RFC 2409 */ +BIGNUM *get_rfc2409_prime_768(BIGNUM *bn); +BIGNUM *get_rfc2409_prime_1024(BIGNUM *bn); + +/* Primes from RFC 3526 */ +BIGNUM *get_rfc3526_prime_1536(BIGNUM *bn); +BIGNUM *get_rfc3526_prime_2048(BIGNUM *bn); +BIGNUM *get_rfc3526_prime_3072(BIGNUM *bn); +BIGNUM *get_rfc3526_prime_4096(BIGNUM *bn); +BIGNUM *get_rfc3526_prime_6144(BIGNUM *bn); +BIGNUM *get_rfc3526_prime_8192(BIGNUM *bn); + +int BN_bntest_rand(BIGNUM *rnd, int bits, int top,int bottom); + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_BN_strings(void); + +/* Error codes for the BN functions. */ + +/* Function codes. */ +#define BN_F_BNRAND 127 +#define BN_F_BN_BLINDING_CONVERT_EX 100 +#define BN_F_BN_BLINDING_CREATE_PARAM 128 +#define BN_F_BN_BLINDING_INVERT_EX 101 +#define BN_F_BN_BLINDING_NEW 102 +#define BN_F_BN_BLINDING_UPDATE 103 +#define BN_F_BN_BN2DEC 104 +#define BN_F_BN_BN2HEX 105 +#define BN_F_BN_CTX_GET 116 +#define BN_F_BN_CTX_NEW 106 +#define BN_F_BN_CTX_START 129 +#define BN_F_BN_DIV 107 +#define BN_F_BN_DIV_NO_BRANCH 138 +#define BN_F_BN_DIV_RECP 130 +#define BN_F_BN_EXP 123 +#define BN_F_BN_EXPAND2 108 +#define BN_F_BN_EXPAND_INTERNAL 120 +#define BN_F_BN_GF2M_MOD 131 +#define BN_F_BN_GF2M_MOD_EXP 132 +#define BN_F_BN_GF2M_MOD_MUL 133 +#define BN_F_BN_GF2M_MOD_SOLVE_QUAD 134 +#define BN_F_BN_GF2M_MOD_SOLVE_QUAD_ARR 135 +#define BN_F_BN_GF2M_MOD_SQR 136 +#define BN_F_BN_GF2M_MOD_SQRT 137 +#define BN_F_BN_MOD_EXP2_MONT 118 +#define BN_F_BN_MOD_EXP_MONT 109 +#define BN_F_BN_MOD_EXP_MONT_CONSTTIME 124 +#define BN_F_BN_MOD_EXP_MONT_WORD 117 +#define BN_F_BN_MOD_EXP_RECP 125 +#define BN_F_BN_MOD_EXP_SIMPLE 126 +#define BN_F_BN_MOD_INVERSE 110 +#define BN_F_BN_MOD_INVERSE_NO_BRANCH 139 +#define BN_F_BN_MOD_LSHIFT_QUICK 119 +#define BN_F_BN_MOD_MUL_RECIPROCAL 111 +#define BN_F_BN_MOD_SQRT 121 +#define BN_F_BN_MPI2BN 112 +#define BN_F_BN_NEW 113 +#define BN_F_BN_RAND 114 +#define BN_F_BN_RAND_RANGE 122 +#define BN_F_BN_USUB 115 + +/* Reason codes. */ +#define BN_R_ARG2_LT_ARG3 100 +#define BN_R_BAD_RECIPROCAL 101 +#define BN_R_BIGNUM_TOO_LONG 114 +#define BN_R_CALLED_WITH_EVEN_MODULUS 102 +#define BN_R_DIV_BY_ZERO 103 +#define BN_R_ENCODING_ERROR 104 +#define BN_R_EXPAND_ON_STATIC_BIGNUM_DATA 105 +#define BN_R_INPUT_NOT_REDUCED 110 +#define BN_R_INVALID_LENGTH 106 +#define BN_R_INVALID_RANGE 115 +#define BN_R_NOT_A_SQUARE 111 +#define BN_R_NOT_INITIALIZED 107 +#define BN_R_NO_INVERSE 108 +#define BN_R_NO_SOLUTION 116 +#define BN_R_P_IS_NOT_PRIME 112 +#define BN_R_TOO_MANY_ITERATIONS 113 +#define BN_R_TOO_MANY_TEMPORARY_VARIABLES 109 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/buffer.h b/Source/Import/OpenSSL/Include/openssl/buffer.h new file mode 100644 index 0000000..178e418 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/buffer.h @@ -0,0 +1,119 @@ +/* crypto/buffer/buffer.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_BUFFER_H +#define HEADER_BUFFER_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +#if !defined(NO_SYS_TYPES_H) +#include +#endif + +/* Already declared in ossl_typ.h */ +/* typedef struct buf_mem_st BUF_MEM; */ + +struct buf_mem_st + { + size_t length; /* current number of bytes */ + char *data; + size_t max; /* size of buffer */ + }; + +BUF_MEM *BUF_MEM_new(void); +void BUF_MEM_free(BUF_MEM *a); +int BUF_MEM_grow(BUF_MEM *str, size_t len); +int BUF_MEM_grow_clean(BUF_MEM *str, size_t len); +char * BUF_strdup(const char *str); +char * BUF_strndup(const char *str, size_t siz); +void * BUF_memdup(const void *data, size_t siz); +void BUF_reverse(unsigned char *out, unsigned char *in, size_t siz); + +/* safe string functions */ +size_t BUF_strlcpy(char *dst,const char *src,size_t siz); +size_t BUF_strlcat(char *dst,const char *src,size_t siz); + + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_BUF_strings(void); + +/* Error codes for the BUF functions. */ + +/* Function codes. */ +#define BUF_F_BUF_MEMDUP 103 +#define BUF_F_BUF_MEM_GROW 100 +#define BUF_F_BUF_MEM_GROW_CLEAN 105 +#define BUF_F_BUF_MEM_NEW 101 +#define BUF_F_BUF_STRDUP 102 +#define BUF_F_BUF_STRNDUP 104 + +/* Reason codes. */ + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/camellia.h b/Source/Import/OpenSSL/Include/openssl/camellia.h new file mode 100644 index 0000000..67911e0 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/camellia.h @@ -0,0 +1,130 @@ +/* crypto/camellia/camellia.h -*- mode:C; c-file-style: "eay" -*- */ +/* ==================================================================== + * Copyright (c) 2006 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + */ + +#ifndef HEADER_CAMELLIA_H +#define HEADER_CAMELLIA_H + +#include + +#ifdef OPENSSL_NO_CAMELLIA +#error CAMELLIA is disabled. +#endif + +#include + +#define CAMELLIA_ENCRYPT 1 +#define CAMELLIA_DECRYPT 0 + +/* Because array size can't be a const in C, the following two are macros. + Both sizes are in bytes. */ + +#ifdef __cplusplus +extern "C" { +#endif + +/* This should be a hidden type, but EVP requires that the size be known */ + +#define CAMELLIA_BLOCK_SIZE 16 +#define CAMELLIA_TABLE_BYTE_LEN 272 +#define CAMELLIA_TABLE_WORD_LEN (CAMELLIA_TABLE_BYTE_LEN / 4) + +typedef unsigned int KEY_TABLE_TYPE[CAMELLIA_TABLE_WORD_LEN]; /* to match with WORD */ + +struct camellia_key_st + { + union { + double d; /* ensures 64-bit align */ + KEY_TABLE_TYPE rd_key; + } u; + int grand_rounds; + }; +typedef struct camellia_key_st CAMELLIA_KEY; + +#ifdef OPENSSL_FIPS +int private_Camellia_set_key(const unsigned char *userKey, const int bits, + CAMELLIA_KEY *key); +#endif +int Camellia_set_key(const unsigned char *userKey, const int bits, + CAMELLIA_KEY *key); + +void Camellia_encrypt(const unsigned char *in, unsigned char *out, + const CAMELLIA_KEY *key); +void Camellia_decrypt(const unsigned char *in, unsigned char *out, + const CAMELLIA_KEY *key); + +void Camellia_ecb_encrypt(const unsigned char *in, unsigned char *out, + const CAMELLIA_KEY *key, const int enc); +void Camellia_cbc_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const CAMELLIA_KEY *key, + unsigned char *ivec, const int enc); +void Camellia_cfb128_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const CAMELLIA_KEY *key, + unsigned char *ivec, int *num, const int enc); +void Camellia_cfb1_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const CAMELLIA_KEY *key, + unsigned char *ivec, int *num, const int enc); +void Camellia_cfb8_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const CAMELLIA_KEY *key, + unsigned char *ivec, int *num, const int enc); +void Camellia_ofb128_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const CAMELLIA_KEY *key, + unsigned char *ivec, int *num); +void Camellia_ctr128_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const CAMELLIA_KEY *key, + unsigned char ivec[CAMELLIA_BLOCK_SIZE], + unsigned char ecount_buf[CAMELLIA_BLOCK_SIZE], + unsigned int *num); + +#ifdef __cplusplus +} +#endif + +#endif /* !HEADER_Camellia_H */ diff --git a/Source/Import/OpenSSL/Include/openssl/cast.h b/Source/Import/OpenSSL/Include/openssl/cast.h new file mode 100644 index 0000000..203922e --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/cast.h @@ -0,0 +1,107 @@ +/* crypto/cast/cast.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_CAST_H +#define HEADER_CAST_H + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +#ifdef OPENSSL_NO_CAST +#error CAST is disabled. +#endif + +#define CAST_ENCRYPT 1 +#define CAST_DECRYPT 0 + +#define CAST_LONG unsigned int + +#define CAST_BLOCK 8 +#define CAST_KEY_LENGTH 16 + +typedef struct cast_key_st + { + CAST_LONG data[32]; + int short_key; /* Use reduced rounds for short key */ + } CAST_KEY; + +#ifdef OPENSSL_FIPS +void private_CAST_set_key(CAST_KEY *key, int len, const unsigned char *data); +#endif +void CAST_set_key(CAST_KEY *key, int len, const unsigned char *data); +void CAST_ecb_encrypt(const unsigned char *in, unsigned char *out, const CAST_KEY *key, + int enc); +void CAST_encrypt(CAST_LONG *data, const CAST_KEY *key); +void CAST_decrypt(CAST_LONG *data, const CAST_KEY *key); +void CAST_cbc_encrypt(const unsigned char *in, unsigned char *out, long length, + const CAST_KEY *ks, unsigned char *iv, int enc); +void CAST_cfb64_encrypt(const unsigned char *in, unsigned char *out, + long length, const CAST_KEY *schedule, unsigned char *ivec, + int *num, int enc); +void CAST_ofb64_encrypt(const unsigned char *in, unsigned char *out, + long length, const CAST_KEY *schedule, unsigned char *ivec, + int *num); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/cmac.h b/Source/Import/OpenSSL/Include/openssl/cmac.h new file mode 100644 index 0000000..712e92d --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/cmac.h @@ -0,0 +1,82 @@ +/* crypto/cmac/cmac.h */ +/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL + * project. + */ +/* ==================================================================== + * Copyright (c) 2010 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + */ + + +#ifndef HEADER_CMAC_H +#define HEADER_CMAC_H + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +/* Opaque */ +typedef struct CMAC_CTX_st CMAC_CTX; + +CMAC_CTX *CMAC_CTX_new(void); +void CMAC_CTX_cleanup(CMAC_CTX *ctx); +void CMAC_CTX_free(CMAC_CTX *ctx); +EVP_CIPHER_CTX *CMAC_CTX_get0_cipher_ctx(CMAC_CTX *ctx); +int CMAC_CTX_copy(CMAC_CTX *out, const CMAC_CTX *in); + +int CMAC_Init(CMAC_CTX *ctx, const void *key, size_t keylen, + const EVP_CIPHER *cipher, ENGINE *impl); +int CMAC_Update(CMAC_CTX *ctx, const void *data, size_t dlen); +int CMAC_Final(CMAC_CTX *ctx, unsigned char *out, size_t *poutlen); +int CMAC_resume(CMAC_CTX *ctx); + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/cms.h b/Source/Import/OpenSSL/Include/openssl/cms.h new file mode 100644 index 0000000..36994fa --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/cms.h @@ -0,0 +1,501 @@ +/* crypto/cms/cms.h */ +/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL + * project. + */ +/* ==================================================================== + * Copyright (c) 2008 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + */ + + +#ifndef HEADER_CMS_H +#define HEADER_CMS_H + +#include + +#ifdef OPENSSL_NO_CMS +#error CMS is disabled. +#endif + +#ifdef __cplusplus +extern "C" { +#endif + + +typedef struct CMS_ContentInfo_st CMS_ContentInfo; +typedef struct CMS_SignerInfo_st CMS_SignerInfo; +typedef struct CMS_CertificateChoices CMS_CertificateChoices; +typedef struct CMS_RevocationInfoChoice_st CMS_RevocationInfoChoice; +typedef struct CMS_RecipientInfo_st CMS_RecipientInfo; +typedef struct CMS_ReceiptRequest_st CMS_ReceiptRequest; +typedef struct CMS_Receipt_st CMS_Receipt; + +DECLARE_STACK_OF(CMS_SignerInfo) +DECLARE_STACK_OF(GENERAL_NAMES) +DECLARE_ASN1_FUNCTIONS(CMS_ContentInfo) +DECLARE_ASN1_FUNCTIONS(CMS_ReceiptRequest) +DECLARE_ASN1_PRINT_FUNCTION(CMS_ContentInfo) + +#define CMS_SIGNERINFO_ISSUER_SERIAL 0 +#define CMS_SIGNERINFO_KEYIDENTIFIER 1 + +#define CMS_RECIPINFO_TRANS 0 +#define CMS_RECIPINFO_AGREE 1 +#define CMS_RECIPINFO_KEK 2 +#define CMS_RECIPINFO_PASS 3 +#define CMS_RECIPINFO_OTHER 4 + +/* S/MIME related flags */ + +#define CMS_TEXT 0x1 +#define CMS_NOCERTS 0x2 +#define CMS_NO_CONTENT_VERIFY 0x4 +#define CMS_NO_ATTR_VERIFY 0x8 +#define CMS_NOSIGS \ + (CMS_NO_CONTENT_VERIFY|CMS_NO_ATTR_VERIFY) +#define CMS_NOINTERN 0x10 +#define CMS_NO_SIGNER_CERT_VERIFY 0x20 +#define CMS_NOVERIFY 0x20 +#define CMS_DETACHED 0x40 +#define CMS_BINARY 0x80 +#define CMS_NOATTR 0x100 +#define CMS_NOSMIMECAP 0x200 +#define CMS_NOOLDMIMETYPE 0x400 +#define CMS_CRLFEOL 0x800 +#define CMS_STREAM 0x1000 +#define CMS_NOCRL 0x2000 +#define CMS_PARTIAL 0x4000 +#define CMS_REUSE_DIGEST 0x8000 +#define CMS_USE_KEYID 0x10000 +#define CMS_DEBUG_DECRYPT 0x20000 + +const ASN1_OBJECT *CMS_get0_type(CMS_ContentInfo *cms); + +BIO *CMS_dataInit(CMS_ContentInfo *cms, BIO *icont); +int CMS_dataFinal(CMS_ContentInfo *cms, BIO *bio); + +ASN1_OCTET_STRING **CMS_get0_content(CMS_ContentInfo *cms); +int CMS_is_detached(CMS_ContentInfo *cms); +int CMS_set_detached(CMS_ContentInfo *cms, int detached); + +#ifdef HEADER_PEM_H +DECLARE_PEM_rw_const(CMS, CMS_ContentInfo) +#endif + +int CMS_stream(unsigned char ***boundary, CMS_ContentInfo *cms); +CMS_ContentInfo *d2i_CMS_bio(BIO *bp, CMS_ContentInfo **cms); +int i2d_CMS_bio(BIO *bp, CMS_ContentInfo *cms); + +BIO *BIO_new_CMS(BIO *out, CMS_ContentInfo *cms); +int i2d_CMS_bio_stream(BIO *out, CMS_ContentInfo *cms, BIO *in, int flags); +int PEM_write_bio_CMS_stream(BIO *out, CMS_ContentInfo *cms, BIO *in, int flags); +CMS_ContentInfo *SMIME_read_CMS(BIO *bio, BIO **bcont); +int SMIME_write_CMS(BIO *bio, CMS_ContentInfo *cms, BIO *data, int flags); + +int CMS_final(CMS_ContentInfo *cms, BIO *data, BIO *dcont, unsigned int flags); + +CMS_ContentInfo *CMS_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, + BIO *data, unsigned int flags); + +CMS_ContentInfo *CMS_sign_receipt(CMS_SignerInfo *si, + X509 *signcert, EVP_PKEY *pkey, + STACK_OF(X509) *certs, + unsigned int flags); + +int CMS_data(CMS_ContentInfo *cms, BIO *out, unsigned int flags); +CMS_ContentInfo *CMS_data_create(BIO *in, unsigned int flags); + +int CMS_digest_verify(CMS_ContentInfo *cms, BIO *dcont, BIO *out, + unsigned int flags); +CMS_ContentInfo *CMS_digest_create(BIO *in, const EVP_MD *md, + unsigned int flags); + +int CMS_EncryptedData_decrypt(CMS_ContentInfo *cms, + const unsigned char *key, size_t keylen, + BIO *dcont, BIO *out, unsigned int flags); + +CMS_ContentInfo *CMS_EncryptedData_encrypt(BIO *in, const EVP_CIPHER *cipher, + const unsigned char *key, size_t keylen, + unsigned int flags); + +int CMS_EncryptedData_set1_key(CMS_ContentInfo *cms, const EVP_CIPHER *ciph, + const unsigned char *key, size_t keylen); + +int CMS_verify(CMS_ContentInfo *cms, STACK_OF(X509) *certs, + X509_STORE *store, BIO *dcont, BIO *out, unsigned int flags); + +int CMS_verify_receipt(CMS_ContentInfo *rcms, CMS_ContentInfo *ocms, + STACK_OF(X509) *certs, + X509_STORE *store, unsigned int flags); + +STACK_OF(X509) *CMS_get0_signers(CMS_ContentInfo *cms); + +CMS_ContentInfo *CMS_encrypt(STACK_OF(X509) *certs, BIO *in, + const EVP_CIPHER *cipher, unsigned int flags); + +int CMS_decrypt(CMS_ContentInfo *cms, EVP_PKEY *pkey, X509 *cert, + BIO *dcont, BIO *out, + unsigned int flags); + +int CMS_decrypt_set1_pkey(CMS_ContentInfo *cms, EVP_PKEY *pk, X509 *cert); +int CMS_decrypt_set1_key(CMS_ContentInfo *cms, + unsigned char *key, size_t keylen, + unsigned char *id, size_t idlen); +int CMS_decrypt_set1_password(CMS_ContentInfo *cms, + unsigned char *pass, ossl_ssize_t passlen); + +STACK_OF(CMS_RecipientInfo) *CMS_get0_RecipientInfos(CMS_ContentInfo *cms); +int CMS_RecipientInfo_type(CMS_RecipientInfo *ri); +CMS_ContentInfo *CMS_EnvelopedData_create(const EVP_CIPHER *cipher); +CMS_RecipientInfo *CMS_add1_recipient_cert(CMS_ContentInfo *cms, + X509 *recip, unsigned int flags); +int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pkey); +int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo *ri, X509 *cert); +int CMS_RecipientInfo_ktri_get0_algs(CMS_RecipientInfo *ri, + EVP_PKEY **pk, X509 **recip, + X509_ALGOR **palg); +int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo *ri, + ASN1_OCTET_STRING **keyid, + X509_NAME **issuer, ASN1_INTEGER **sno); + +CMS_RecipientInfo *CMS_add0_recipient_key(CMS_ContentInfo *cms, int nid, + unsigned char *key, size_t keylen, + unsigned char *id, size_t idlen, + ASN1_GENERALIZEDTIME *date, + ASN1_OBJECT *otherTypeId, + ASN1_TYPE *otherType); + +int CMS_RecipientInfo_kekri_get0_id(CMS_RecipientInfo *ri, + X509_ALGOR **palg, + ASN1_OCTET_STRING **pid, + ASN1_GENERALIZEDTIME **pdate, + ASN1_OBJECT **potherid, + ASN1_TYPE **pothertype); + +int CMS_RecipientInfo_set0_key(CMS_RecipientInfo *ri, + unsigned char *key, size_t keylen); + +int CMS_RecipientInfo_kekri_id_cmp(CMS_RecipientInfo *ri, + const unsigned char *id, size_t idlen); + +int CMS_RecipientInfo_set0_password(CMS_RecipientInfo *ri, + unsigned char *pass, + ossl_ssize_t passlen); + +CMS_RecipientInfo *CMS_add0_recipient_password(CMS_ContentInfo *cms, + int iter, int wrap_nid, int pbe_nid, + unsigned char *pass, + ossl_ssize_t passlen, + const EVP_CIPHER *kekciph); + +int CMS_RecipientInfo_decrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri); + +int CMS_uncompress(CMS_ContentInfo *cms, BIO *dcont, BIO *out, + unsigned int flags); +CMS_ContentInfo *CMS_compress(BIO *in, int comp_nid, unsigned int flags); + +int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid); +const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms); + +CMS_CertificateChoices *CMS_add0_CertificateChoices(CMS_ContentInfo *cms); +int CMS_add0_cert(CMS_ContentInfo *cms, X509 *cert); +int CMS_add1_cert(CMS_ContentInfo *cms, X509 *cert); +STACK_OF(X509) *CMS_get1_certs(CMS_ContentInfo *cms); + +CMS_RevocationInfoChoice *CMS_add0_RevocationInfoChoice(CMS_ContentInfo *cms); +int CMS_add0_crl(CMS_ContentInfo *cms, X509_CRL *crl); +int CMS_add1_crl(CMS_ContentInfo *cms, X509_CRL *crl); +STACK_OF(X509_CRL) *CMS_get1_crls(CMS_ContentInfo *cms); + +int CMS_SignedData_init(CMS_ContentInfo *cms); +CMS_SignerInfo *CMS_add1_signer(CMS_ContentInfo *cms, + X509 *signer, EVP_PKEY *pk, const EVP_MD *md, + unsigned int flags); +STACK_OF(CMS_SignerInfo) *CMS_get0_SignerInfos(CMS_ContentInfo *cms); + +void CMS_SignerInfo_set1_signer_cert(CMS_SignerInfo *si, X509 *signer); +int CMS_SignerInfo_get0_signer_id(CMS_SignerInfo *si, + ASN1_OCTET_STRING **keyid, + X509_NAME **issuer, ASN1_INTEGER **sno); +int CMS_SignerInfo_cert_cmp(CMS_SignerInfo *si, X509 *cert); +int CMS_set1_signers_certs(CMS_ContentInfo *cms, STACK_OF(X509) *certs, + unsigned int flags); +void CMS_SignerInfo_get0_algs(CMS_SignerInfo *si, EVP_PKEY **pk, X509 **signer, + X509_ALGOR **pdig, X509_ALGOR **psig); +int CMS_SignerInfo_sign(CMS_SignerInfo *si); +int CMS_SignerInfo_verify(CMS_SignerInfo *si); +int CMS_SignerInfo_verify_content(CMS_SignerInfo *si, BIO *chain); + +int CMS_add_smimecap(CMS_SignerInfo *si, STACK_OF(X509_ALGOR) *algs); +int CMS_add_simple_smimecap(STACK_OF(X509_ALGOR) **algs, + int algnid, int keysize); +int CMS_add_standard_smimecap(STACK_OF(X509_ALGOR) **smcap); + +int CMS_signed_get_attr_count(const CMS_SignerInfo *si); +int CMS_signed_get_attr_by_NID(const CMS_SignerInfo *si, int nid, + int lastpos); +int CMS_signed_get_attr_by_OBJ(const CMS_SignerInfo *si, ASN1_OBJECT *obj, + int lastpos); +X509_ATTRIBUTE *CMS_signed_get_attr(const CMS_SignerInfo *si, int loc); +X509_ATTRIBUTE *CMS_signed_delete_attr(CMS_SignerInfo *si, int loc); +int CMS_signed_add1_attr(CMS_SignerInfo *si, X509_ATTRIBUTE *attr); +int CMS_signed_add1_attr_by_OBJ(CMS_SignerInfo *si, + const ASN1_OBJECT *obj, int type, + const void *bytes, int len); +int CMS_signed_add1_attr_by_NID(CMS_SignerInfo *si, + int nid, int type, + const void *bytes, int len); +int CMS_signed_add1_attr_by_txt(CMS_SignerInfo *si, + const char *attrname, int type, + const void *bytes, int len); +void *CMS_signed_get0_data_by_OBJ(CMS_SignerInfo *si, ASN1_OBJECT *oid, + int lastpos, int type); + +int CMS_unsigned_get_attr_count(const CMS_SignerInfo *si); +int CMS_unsigned_get_attr_by_NID(const CMS_SignerInfo *si, int nid, + int lastpos); +int CMS_unsigned_get_attr_by_OBJ(const CMS_SignerInfo *si, ASN1_OBJECT *obj, + int lastpos); +X509_ATTRIBUTE *CMS_unsigned_get_attr(const CMS_SignerInfo *si, int loc); +X509_ATTRIBUTE *CMS_unsigned_delete_attr(CMS_SignerInfo *si, int loc); +int CMS_unsigned_add1_attr(CMS_SignerInfo *si, X509_ATTRIBUTE *attr); +int CMS_unsigned_add1_attr_by_OBJ(CMS_SignerInfo *si, + const ASN1_OBJECT *obj, int type, + const void *bytes, int len); +int CMS_unsigned_add1_attr_by_NID(CMS_SignerInfo *si, + int nid, int type, + const void *bytes, int len); +int CMS_unsigned_add1_attr_by_txt(CMS_SignerInfo *si, + const char *attrname, int type, + const void *bytes, int len); +void *CMS_unsigned_get0_data_by_OBJ(CMS_SignerInfo *si, ASN1_OBJECT *oid, + int lastpos, int type); + +#ifdef HEADER_X509V3_H + +int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr); +CMS_ReceiptRequest *CMS_ReceiptRequest_create0(unsigned char *id, int idlen, + int allorfirst, + STACK_OF(GENERAL_NAMES) *receiptList, + STACK_OF(GENERAL_NAMES) *receiptsTo); +int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr); +void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr, + ASN1_STRING **pcid, + int *pallorfirst, + STACK_OF(GENERAL_NAMES) **plist, + STACK_OF(GENERAL_NAMES) **prto); + +#endif + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_CMS_strings(void); + +/* Error codes for the CMS functions. */ + +/* Function codes. */ +#define CMS_F_CHECK_CONTENT 99 +#define CMS_F_CMS_ADD0_CERT 164 +#define CMS_F_CMS_ADD0_RECIPIENT_KEY 100 +#define CMS_F_CMS_ADD0_RECIPIENT_PASSWORD 165 +#define CMS_F_CMS_ADD1_RECEIPTREQUEST 158 +#define CMS_F_CMS_ADD1_RECIPIENT_CERT 101 +#define CMS_F_CMS_ADD1_SIGNER 102 +#define CMS_F_CMS_ADD1_SIGNINGTIME 103 +#define CMS_F_CMS_COMPRESS 104 +#define CMS_F_CMS_COMPRESSEDDATA_CREATE 105 +#define CMS_F_CMS_COMPRESSEDDATA_INIT_BIO 106 +#define CMS_F_CMS_COPY_CONTENT 107 +#define CMS_F_CMS_COPY_MESSAGEDIGEST 108 +#define CMS_F_CMS_DATA 109 +#define CMS_F_CMS_DATAFINAL 110 +#define CMS_F_CMS_DATAINIT 111 +#define CMS_F_CMS_DECRYPT 112 +#define CMS_F_CMS_DECRYPT_SET1_KEY 113 +#define CMS_F_CMS_DECRYPT_SET1_PASSWORD 166 +#define CMS_F_CMS_DECRYPT_SET1_PKEY 114 +#define CMS_F_CMS_DIGESTALGORITHM_FIND_CTX 115 +#define CMS_F_CMS_DIGESTALGORITHM_INIT_BIO 116 +#define CMS_F_CMS_DIGESTEDDATA_DO_FINAL 117 +#define CMS_F_CMS_DIGEST_VERIFY 118 +#define CMS_F_CMS_ENCODE_RECEIPT 161 +#define CMS_F_CMS_ENCRYPT 119 +#define CMS_F_CMS_ENCRYPTEDCONTENT_INIT_BIO 120 +#define CMS_F_CMS_ENCRYPTEDDATA_DECRYPT 121 +#define CMS_F_CMS_ENCRYPTEDDATA_ENCRYPT 122 +#define CMS_F_CMS_ENCRYPTEDDATA_SET1_KEY 123 +#define CMS_F_CMS_ENVELOPEDDATA_CREATE 124 +#define CMS_F_CMS_ENVELOPEDDATA_INIT_BIO 125 +#define CMS_F_CMS_ENVELOPED_DATA_INIT 126 +#define CMS_F_CMS_FINAL 127 +#define CMS_F_CMS_GET0_CERTIFICATE_CHOICES 128 +#define CMS_F_CMS_GET0_CONTENT 129 +#define CMS_F_CMS_GET0_ECONTENT_TYPE 130 +#define CMS_F_CMS_GET0_ENVELOPED 131 +#define CMS_F_CMS_GET0_REVOCATION_CHOICES 132 +#define CMS_F_CMS_GET0_SIGNED 133 +#define CMS_F_CMS_MSGSIGDIGEST_ADD1 162 +#define CMS_F_CMS_RECEIPTREQUEST_CREATE0 159 +#define CMS_F_CMS_RECEIPT_VERIFY 160 +#define CMS_F_CMS_RECIPIENTINFO_DECRYPT 134 +#define CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT 135 +#define CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT 136 +#define CMS_F_CMS_RECIPIENTINFO_KEKRI_GET0_ID 137 +#define CMS_F_CMS_RECIPIENTINFO_KEKRI_ID_CMP 138 +#define CMS_F_CMS_RECIPIENTINFO_KTRI_CERT_CMP 139 +#define CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT 140 +#define CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT 141 +#define CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_ALGS 142 +#define CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_SIGNER_ID 143 +#define CMS_F_CMS_RECIPIENTINFO_PWRI_CRYPT 167 +#define CMS_F_CMS_RECIPIENTINFO_SET0_KEY 144 +#define CMS_F_CMS_RECIPIENTINFO_SET0_PASSWORD 168 +#define CMS_F_CMS_RECIPIENTINFO_SET0_PKEY 145 +#define CMS_F_CMS_SET1_SIGNERIDENTIFIER 146 +#define CMS_F_CMS_SET_DETACHED 147 +#define CMS_F_CMS_SIGN 148 +#define CMS_F_CMS_SIGNED_DATA_INIT 149 +#define CMS_F_CMS_SIGNERINFO_CONTENT_SIGN 150 +#define CMS_F_CMS_SIGNERINFO_SIGN 151 +#define CMS_F_CMS_SIGNERINFO_VERIFY 152 +#define CMS_F_CMS_SIGNERINFO_VERIFY_CERT 153 +#define CMS_F_CMS_SIGNERINFO_VERIFY_CONTENT 154 +#define CMS_F_CMS_SIGN_RECEIPT 163 +#define CMS_F_CMS_STREAM 155 +#define CMS_F_CMS_UNCOMPRESS 156 +#define CMS_F_CMS_VERIFY 157 + +/* Reason codes. */ +#define CMS_R_ADD_SIGNER_ERROR 99 +#define CMS_R_CERTIFICATE_ALREADY_PRESENT 175 +#define CMS_R_CERTIFICATE_HAS_NO_KEYID 160 +#define CMS_R_CERTIFICATE_VERIFY_ERROR 100 +#define CMS_R_CIPHER_INITIALISATION_ERROR 101 +#define CMS_R_CIPHER_PARAMETER_INITIALISATION_ERROR 102 +#define CMS_R_CMS_DATAFINAL_ERROR 103 +#define CMS_R_CMS_LIB 104 +#define CMS_R_CONTENTIDENTIFIER_MISMATCH 170 +#define CMS_R_CONTENT_NOT_FOUND 105 +#define CMS_R_CONTENT_TYPE_MISMATCH 171 +#define CMS_R_CONTENT_TYPE_NOT_COMPRESSED_DATA 106 +#define CMS_R_CONTENT_TYPE_NOT_ENVELOPED_DATA 107 +#define CMS_R_CONTENT_TYPE_NOT_SIGNED_DATA 108 +#define CMS_R_CONTENT_VERIFY_ERROR 109 +#define CMS_R_CTRL_ERROR 110 +#define CMS_R_CTRL_FAILURE 111 +#define CMS_R_DECRYPT_ERROR 112 +#define CMS_R_DIGEST_ERROR 161 +#define CMS_R_ERROR_GETTING_PUBLIC_KEY 113 +#define CMS_R_ERROR_READING_MESSAGEDIGEST_ATTRIBUTE 114 +#define CMS_R_ERROR_SETTING_KEY 115 +#define CMS_R_ERROR_SETTING_RECIPIENTINFO 116 +#define CMS_R_INVALID_ENCRYPTED_KEY_LENGTH 117 +#define CMS_R_INVALID_KEY_ENCRYPTION_PARAMETER 176 +#define CMS_R_INVALID_KEY_LENGTH 118 +#define CMS_R_MD_BIO_INIT_ERROR 119 +#define CMS_R_MESSAGEDIGEST_ATTRIBUTE_WRONG_LENGTH 120 +#define CMS_R_MESSAGEDIGEST_WRONG_LENGTH 121 +#define CMS_R_MSGSIGDIGEST_ERROR 172 +#define CMS_R_MSGSIGDIGEST_VERIFICATION_FAILURE 162 +#define CMS_R_MSGSIGDIGEST_WRONG_LENGTH 163 +#define CMS_R_NEED_ONE_SIGNER 164 +#define CMS_R_NOT_A_SIGNED_RECEIPT 165 +#define CMS_R_NOT_ENCRYPTED_DATA 122 +#define CMS_R_NOT_KEK 123 +#define CMS_R_NOT_KEY_TRANSPORT 124 +#define CMS_R_NOT_PWRI 177 +#define CMS_R_NOT_SUPPORTED_FOR_THIS_KEY_TYPE 125 +#define CMS_R_NO_CIPHER 126 +#define CMS_R_NO_CONTENT 127 +#define CMS_R_NO_CONTENT_TYPE 173 +#define CMS_R_NO_DEFAULT_DIGEST 128 +#define CMS_R_NO_DIGEST_SET 129 +#define CMS_R_NO_KEY 130 +#define CMS_R_NO_KEY_OR_CERT 174 +#define CMS_R_NO_MATCHING_DIGEST 131 +#define CMS_R_NO_MATCHING_RECIPIENT 132 +#define CMS_R_NO_MATCHING_SIGNATURE 166 +#define CMS_R_NO_MSGSIGDIGEST 167 +#define CMS_R_NO_PASSWORD 178 +#define CMS_R_NO_PRIVATE_KEY 133 +#define CMS_R_NO_PUBLIC_KEY 134 +#define CMS_R_NO_RECEIPT_REQUEST 168 +#define CMS_R_NO_SIGNERS 135 +#define CMS_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 136 +#define CMS_R_RECEIPT_DECODE_ERROR 169 +#define CMS_R_RECIPIENT_ERROR 137 +#define CMS_R_SIGNER_CERTIFICATE_NOT_FOUND 138 +#define CMS_R_SIGNFINAL_ERROR 139 +#define CMS_R_SMIME_TEXT_ERROR 140 +#define CMS_R_STORE_INIT_ERROR 141 +#define CMS_R_TYPE_NOT_COMPRESSED_DATA 142 +#define CMS_R_TYPE_NOT_DATA 143 +#define CMS_R_TYPE_NOT_DIGESTED_DATA 144 +#define CMS_R_TYPE_NOT_ENCRYPTED_DATA 145 +#define CMS_R_TYPE_NOT_ENVELOPED_DATA 146 +#define CMS_R_UNABLE_TO_FINALIZE_CONTEXT 147 +#define CMS_R_UNKNOWN_CIPHER 148 +#define CMS_R_UNKNOWN_DIGEST_ALGORIHM 149 +#define CMS_R_UNKNOWN_ID 150 +#define CMS_R_UNSUPPORTED_COMPRESSION_ALGORITHM 151 +#define CMS_R_UNSUPPORTED_CONTENT_TYPE 152 +#define CMS_R_UNSUPPORTED_KEK_ALGORITHM 153 +#define CMS_R_UNSUPPORTED_KEY_ENCRYPTION_ALGORITHM 179 +#define CMS_R_UNSUPPORTED_RECIPIENT_TYPE 154 +#define CMS_R_UNSUPPORTED_RECPIENTINFO_TYPE 155 +#define CMS_R_UNSUPPORTED_TYPE 156 +#define CMS_R_UNWRAP_ERROR 157 +#define CMS_R_UNWRAP_FAILURE 180 +#define CMS_R_VERIFICATION_FAILURE 158 +#define CMS_R_WRAP_ERROR 159 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/comp.h b/Source/Import/OpenSSL/Include/openssl/comp.h new file mode 100644 index 0000000..4b405c7 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/comp.h @@ -0,0 +1,80 @@ + +#ifndef HEADER_COMP_H +#define HEADER_COMP_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct comp_ctx_st COMP_CTX; + +typedef struct comp_method_st + { + int type; /* NID for compression library */ + const char *name; /* A text string to identify the library */ + int (*init)(COMP_CTX *ctx); + void (*finish)(COMP_CTX *ctx); + int (*compress)(COMP_CTX *ctx, + unsigned char *out, unsigned int olen, + unsigned char *in, unsigned int ilen); + int (*expand)(COMP_CTX *ctx, + unsigned char *out, unsigned int olen, + unsigned char *in, unsigned int ilen); + /* The following two do NOTHING, but are kept for backward compatibility */ + long (*ctrl)(void); + long (*callback_ctrl)(void); + } COMP_METHOD; + +struct comp_ctx_st + { + COMP_METHOD *meth; + unsigned long compress_in; + unsigned long compress_out; + unsigned long expand_in; + unsigned long expand_out; + + CRYPTO_EX_DATA ex_data; + }; + + +COMP_CTX *COMP_CTX_new(COMP_METHOD *meth); +void COMP_CTX_free(COMP_CTX *ctx); +int COMP_compress_block(COMP_CTX *ctx, unsigned char *out, int olen, + unsigned char *in, int ilen); +int COMP_expand_block(COMP_CTX *ctx, unsigned char *out, int olen, + unsigned char *in, int ilen); +COMP_METHOD *COMP_rle(void ); +COMP_METHOD *COMP_zlib(void ); +void COMP_zlib_cleanup(void); + +#ifdef HEADER_BIO_H +#ifdef ZLIB +BIO_METHOD *BIO_f_zlib(void); +#endif +#endif + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_COMP_strings(void); + +/* Error codes for the COMP functions. */ + +/* Function codes. */ +#define COMP_F_BIO_ZLIB_FLUSH 99 +#define COMP_F_BIO_ZLIB_NEW 100 +#define COMP_F_BIO_ZLIB_READ 101 +#define COMP_F_BIO_ZLIB_WRITE 102 + +/* Reason codes. */ +#define COMP_R_ZLIB_DEFLATE_ERROR 99 +#define COMP_R_ZLIB_INFLATE_ERROR 100 +#define COMP_R_ZLIB_NOT_SUPPORTED 101 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/conf.h b/Source/Import/OpenSSL/Include/openssl/conf.h new file mode 100644 index 0000000..c219997 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/conf.h @@ -0,0 +1,263 @@ +/* crypto/conf/conf.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_CONF_H +#define HEADER_CONF_H + +#include +#include +#include +#include +#include + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct + { + char *section; + char *name; + char *value; + } CONF_VALUE; + +DECLARE_STACK_OF(CONF_VALUE) +DECLARE_LHASH_OF(CONF_VALUE); + +struct conf_st; +struct conf_method_st; +typedef struct conf_method_st CONF_METHOD; + +struct conf_method_st + { + const char *name; + CONF *(*create)(CONF_METHOD *meth); + int (*init)(CONF *conf); + int (*destroy)(CONF *conf); + int (*destroy_data)(CONF *conf); + int (*load_bio)(CONF *conf, BIO *bp, long *eline); + int (*dump)(const CONF *conf, BIO *bp); + int (*is_number)(const CONF *conf, char c); + int (*to_int)(const CONF *conf, char c); + int (*load)(CONF *conf, const char *name, long *eline); + }; + +/* Module definitions */ + +typedef struct conf_imodule_st CONF_IMODULE; +typedef struct conf_module_st CONF_MODULE; + +DECLARE_STACK_OF(CONF_MODULE) +DECLARE_STACK_OF(CONF_IMODULE) + +/* DSO module function typedefs */ +typedef int conf_init_func(CONF_IMODULE *md, const CONF *cnf); +typedef void conf_finish_func(CONF_IMODULE *md); + +#define CONF_MFLAGS_IGNORE_ERRORS 0x1 +#define CONF_MFLAGS_IGNORE_RETURN_CODES 0x2 +#define CONF_MFLAGS_SILENT 0x4 +#define CONF_MFLAGS_NO_DSO 0x8 +#define CONF_MFLAGS_IGNORE_MISSING_FILE 0x10 +#define CONF_MFLAGS_DEFAULT_SECTION 0x20 + +int CONF_set_default_method(CONF_METHOD *meth); +void CONF_set_nconf(CONF *conf,LHASH_OF(CONF_VALUE) *hash); +LHASH_OF(CONF_VALUE) *CONF_load(LHASH_OF(CONF_VALUE) *conf,const char *file, + long *eline); +#ifndef OPENSSL_NO_FP_API +LHASH_OF(CONF_VALUE) *CONF_load_fp(LHASH_OF(CONF_VALUE) *conf, FILE *fp, + long *eline); +#endif +LHASH_OF(CONF_VALUE) *CONF_load_bio(LHASH_OF(CONF_VALUE) *conf, BIO *bp,long *eline); +STACK_OF(CONF_VALUE) *CONF_get_section(LHASH_OF(CONF_VALUE) *conf, + const char *section); +char *CONF_get_string(LHASH_OF(CONF_VALUE) *conf,const char *group, + const char *name); +long CONF_get_number(LHASH_OF(CONF_VALUE) *conf,const char *group, + const char *name); +void CONF_free(LHASH_OF(CONF_VALUE) *conf); +int CONF_dump_fp(LHASH_OF(CONF_VALUE) *conf, FILE *out); +int CONF_dump_bio(LHASH_OF(CONF_VALUE) *conf, BIO *out); + +void OPENSSL_config(const char *config_name); +void OPENSSL_no_config(void); + +/* New conf code. The semantics are different from the functions above. + If that wasn't the case, the above functions would have been replaced */ + +struct conf_st + { + CONF_METHOD *meth; + void *meth_data; + LHASH_OF(CONF_VALUE) *data; + }; + +CONF *NCONF_new(CONF_METHOD *meth); +CONF_METHOD *NCONF_default(void); +CONF_METHOD *NCONF_WIN32(void); +#if 0 /* Just to give you an idea of what I have in mind */ +CONF_METHOD *NCONF_XML(void); +#endif +void NCONF_free(CONF *conf); +void NCONF_free_data(CONF *conf); + +int NCONF_load(CONF *conf,const char *file,long *eline); +#ifndef OPENSSL_NO_FP_API +int NCONF_load_fp(CONF *conf, FILE *fp,long *eline); +#endif +int NCONF_load_bio(CONF *conf, BIO *bp,long *eline); +STACK_OF(CONF_VALUE) *NCONF_get_section(const CONF *conf,const char *section); +char *NCONF_get_string(const CONF *conf,const char *group,const char *name); +int NCONF_get_number_e(const CONF *conf,const char *group,const char *name, + long *result); +int NCONF_dump_fp(const CONF *conf, FILE *out); +int NCONF_dump_bio(const CONF *conf, BIO *out); + +#if 0 /* The following function has no error checking, + and should therefore be avoided */ +long NCONF_get_number(CONF *conf,char *group,char *name); +#else +#define NCONF_get_number(c,g,n,r) NCONF_get_number_e(c,g,n,r) +#endif + +/* Module functions */ + +int CONF_modules_load(const CONF *cnf, const char *appname, + unsigned long flags); +int CONF_modules_load_file(const char *filename, const char *appname, + unsigned long flags); +void CONF_modules_unload(int all); +void CONF_modules_finish(void); +void CONF_modules_free(void); +int CONF_module_add(const char *name, conf_init_func *ifunc, + conf_finish_func *ffunc); + +const char *CONF_imodule_get_name(const CONF_IMODULE *md); +const char *CONF_imodule_get_value(const CONF_IMODULE *md); +void *CONF_imodule_get_usr_data(const CONF_IMODULE *md); +void CONF_imodule_set_usr_data(CONF_IMODULE *md, void *usr_data); +CONF_MODULE *CONF_imodule_get_module(const CONF_IMODULE *md); +unsigned long CONF_imodule_get_flags(const CONF_IMODULE *md); +void CONF_imodule_set_flags(CONF_IMODULE *md, unsigned long flags); +void *CONF_module_get_usr_data(CONF_MODULE *pmod); +void CONF_module_set_usr_data(CONF_MODULE *pmod, void *usr_data); + +char *CONF_get1_default_config_file(void); + +int CONF_parse_list(const char *list, int sep, int nospc, + int (*list_cb)(const char *elem, int len, void *usr), void *arg); + +void OPENSSL_load_builtin_modules(void); + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_CONF_strings(void); + +/* Error codes for the CONF functions. */ + +/* Function codes. */ +#define CONF_F_CONF_DUMP_FP 104 +#define CONF_F_CONF_LOAD 100 +#define CONF_F_CONF_LOAD_BIO 102 +#define CONF_F_CONF_LOAD_FP 103 +#define CONF_F_CONF_MODULES_LOAD 116 +#define CONF_F_CONF_PARSE_LIST 119 +#define CONF_F_DEF_LOAD 120 +#define CONF_F_DEF_LOAD_BIO 121 +#define CONF_F_MODULE_INIT 115 +#define CONF_F_MODULE_LOAD_DSO 117 +#define CONF_F_MODULE_RUN 118 +#define CONF_F_NCONF_DUMP_BIO 105 +#define CONF_F_NCONF_DUMP_FP 106 +#define CONF_F_NCONF_GET_NUMBER 107 +#define CONF_F_NCONF_GET_NUMBER_E 112 +#define CONF_F_NCONF_GET_SECTION 108 +#define CONF_F_NCONF_GET_STRING 109 +#define CONF_F_NCONF_LOAD 113 +#define CONF_F_NCONF_LOAD_BIO 110 +#define CONF_F_NCONF_LOAD_FP 114 +#define CONF_F_NCONF_NEW 111 +#define CONF_F_STR_COPY 101 + +/* Reason codes. */ +#define CONF_R_ERROR_LOADING_DSO 110 +#define CONF_R_LIST_CANNOT_BE_NULL 115 +#define CONF_R_MISSING_CLOSE_SQUARE_BRACKET 100 +#define CONF_R_MISSING_EQUAL_SIGN 101 +#define CONF_R_MISSING_FINISH_FUNCTION 111 +#define CONF_R_MISSING_INIT_FUNCTION 112 +#define CONF_R_MODULE_INITIALIZATION_ERROR 109 +#define CONF_R_NO_CLOSE_BRACE 102 +#define CONF_R_NO_CONF 105 +#define CONF_R_NO_CONF_OR_ENVIRONMENT_VARIABLE 106 +#define CONF_R_NO_SECTION 107 +#define CONF_R_NO_SUCH_FILE 114 +#define CONF_R_NO_VALUE 108 +#define CONF_R_UNABLE_TO_CREATE_NEW_SECTION 103 +#define CONF_R_UNKNOWN_MODULE_NAME 113 +#define CONF_R_VARIABLE_HAS_NO_VALUE 104 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/conf_api.h b/Source/Import/OpenSSL/Include/openssl/conf_api.h new file mode 100644 index 0000000..87a954a --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/conf_api.h @@ -0,0 +1,89 @@ +/* conf_api.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_CONF_API_H +#define HEADER_CONF_API_H + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Up until OpenSSL 0.9.5a, this was new_section */ +CONF_VALUE *_CONF_new_section(CONF *conf, const char *section); +/* Up until OpenSSL 0.9.5a, this was get_section */ +CONF_VALUE *_CONF_get_section(const CONF *conf, const char *section); +/* Up until OpenSSL 0.9.5a, this was CONF_get_section */ +STACK_OF(CONF_VALUE) *_CONF_get_section_values(const CONF *conf, + const char *section); + +int _CONF_add_string(CONF *conf, CONF_VALUE *section, CONF_VALUE *value); +char *_CONF_get_string(const CONF *conf, const char *section, + const char *name); +long _CONF_get_number(const CONF *conf, const char *section, const char *name); + +int _CONF_new_data(CONF *conf); +void _CONF_free_data(CONF *conf); + +#ifdef __cplusplus +} +#endif +#endif + diff --git a/Source/Import/OpenSSL/Include/openssl/crypto.h b/Source/Import/OpenSSL/Include/openssl/crypto.h new file mode 100644 index 0000000..6aeda0a --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/crypto.h @@ -0,0 +1,604 @@ +/* crypto/crypto.h */ +/* ==================================================================== + * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ +/* ==================================================================== + * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. + * ECDH support in OpenSSL originally developed by + * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project. + */ + +#ifndef HEADER_CRYPTO_H +#define HEADER_CRYPTO_H + +#include + +#include + +#ifndef OPENSSL_NO_FP_API +#include +#endif + +#include +#include +#include +#include + +#ifdef CHARSET_EBCDIC +#include +#endif + +/* Resolve problems on some operating systems with symbol names that clash + one way or another */ +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Backward compatibility to SSLeay */ +/* This is more to be used to check the correct DLL is being used + * in the MS world. */ +#define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER +#define SSLEAY_VERSION 0 +/* #define SSLEAY_OPTIONS 1 no longer supported */ +#define SSLEAY_CFLAGS 2 +#define SSLEAY_BUILT_ON 3 +#define SSLEAY_PLATFORM 4 +#define SSLEAY_DIR 5 + +/* Already declared in ossl_typ.h */ +#if 0 +typedef struct crypto_ex_data_st CRYPTO_EX_DATA; +/* Called when a new object is created */ +typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad, + int idx, long argl, void *argp); +/* Called when an object is free()ed */ +typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad, + int idx, long argl, void *argp); +/* Called when we need to dup an object */ +typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, + int idx, long argl, void *argp); +#endif + +/* A generic structure to pass assorted data in a expandable way */ +typedef struct openssl_item_st + { + int code; + void *value; /* Not used for flag attributes */ + size_t value_size; /* Max size of value for output, length for input */ + size_t *value_length; /* Returned length of value for output */ + } OPENSSL_ITEM; + + +/* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock + * names in cryptlib.c + */ + +#define CRYPTO_LOCK_ERR 1 +#define CRYPTO_LOCK_EX_DATA 2 +#define CRYPTO_LOCK_X509 3 +#define CRYPTO_LOCK_X509_INFO 4 +#define CRYPTO_LOCK_X509_PKEY 5 +#define CRYPTO_LOCK_X509_CRL 6 +#define CRYPTO_LOCK_X509_REQ 7 +#define CRYPTO_LOCK_DSA 8 +#define CRYPTO_LOCK_RSA 9 +#define CRYPTO_LOCK_EVP_PKEY 10 +#define CRYPTO_LOCK_X509_STORE 11 +#define CRYPTO_LOCK_SSL_CTX 12 +#define CRYPTO_LOCK_SSL_CERT 13 +#define CRYPTO_LOCK_SSL_SESSION 14 +#define CRYPTO_LOCK_SSL_SESS_CERT 15 +#define CRYPTO_LOCK_SSL 16 +#define CRYPTO_LOCK_SSL_METHOD 17 +#define CRYPTO_LOCK_RAND 18 +#define CRYPTO_LOCK_RAND2 19 +#define CRYPTO_LOCK_MALLOC 20 +#define CRYPTO_LOCK_BIO 21 +#define CRYPTO_LOCK_GETHOSTBYNAME 22 +#define CRYPTO_LOCK_GETSERVBYNAME 23 +#define CRYPTO_LOCK_READDIR 24 +#define CRYPTO_LOCK_RSA_BLINDING 25 +#define CRYPTO_LOCK_DH 26 +#define CRYPTO_LOCK_MALLOC2 27 +#define CRYPTO_LOCK_DSO 28 +#define CRYPTO_LOCK_DYNLOCK 29 +#define CRYPTO_LOCK_ENGINE 30 +#define CRYPTO_LOCK_UI 31 +#define CRYPTO_LOCK_ECDSA 32 +#define CRYPTO_LOCK_EC 33 +#define CRYPTO_LOCK_ECDH 34 +#define CRYPTO_LOCK_BN 35 +#define CRYPTO_LOCK_EC_PRE_COMP 36 +#define CRYPTO_LOCK_STORE 37 +#define CRYPTO_LOCK_COMP 38 +#define CRYPTO_LOCK_FIPS 39 +#define CRYPTO_LOCK_FIPS2 40 +#define CRYPTO_NUM_LOCKS 41 + +#define CRYPTO_LOCK 1 +#define CRYPTO_UNLOCK 2 +#define CRYPTO_READ 4 +#define CRYPTO_WRITE 8 + +#ifndef OPENSSL_NO_LOCKING +#ifndef CRYPTO_w_lock +#define CRYPTO_w_lock(type) \ + CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__) +#define CRYPTO_w_unlock(type) \ + CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__) +#define CRYPTO_r_lock(type) \ + CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__) +#define CRYPTO_r_unlock(type) \ + CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__) +#define CRYPTO_add(addr,amount,type) \ + CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__) +#endif +#else +#define CRYPTO_w_lock(a) +#define CRYPTO_w_unlock(a) +#define CRYPTO_r_lock(a) +#define CRYPTO_r_unlock(a) +#define CRYPTO_add(a,b,c) ((*(a))+=(b)) +#endif + +/* Some applications as well as some parts of OpenSSL need to allocate + and deallocate locks in a dynamic fashion. The following typedef + makes this possible in a type-safe manner. */ +/* struct CRYPTO_dynlock_value has to be defined by the application. */ +typedef struct + { + int references; + struct CRYPTO_dynlock_value *data; + } CRYPTO_dynlock; + + +/* The following can be used to detect memory leaks in the SSLeay library. + * It used, it turns on malloc checking */ + +#define CRYPTO_MEM_CHECK_OFF 0x0 /* an enume */ +#define CRYPTO_MEM_CHECK_ON 0x1 /* a bit */ +#define CRYPTO_MEM_CHECK_ENABLE 0x2 /* a bit */ +#define CRYPTO_MEM_CHECK_DISABLE 0x3 /* an enume */ + +/* The following are bit values to turn on or off options connected to the + * malloc checking functionality */ + +/* Adds time to the memory checking information */ +#define V_CRYPTO_MDEBUG_TIME 0x1 /* a bit */ +/* Adds thread number to the memory checking information */ +#define V_CRYPTO_MDEBUG_THREAD 0x2 /* a bit */ + +#define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD) + + +/* predec of the BIO type */ +typedef struct bio_st BIO_dummy; + +struct crypto_ex_data_st + { + STACK_OF(void) *sk; + int dummy; /* gcc is screwing up this data structure :-( */ + }; +DECLARE_STACK_OF(void) + +/* This stuff is basically class callback functions + * The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */ + +typedef struct crypto_ex_data_func_st + { + long argl; /* Arbitary long */ + void *argp; /* Arbitary void * */ + CRYPTO_EX_new *new_func; + CRYPTO_EX_free *free_func; + CRYPTO_EX_dup *dup_func; + } CRYPTO_EX_DATA_FUNCS; + +DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS) + +/* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA + * entry. + */ + +#define CRYPTO_EX_INDEX_BIO 0 +#define CRYPTO_EX_INDEX_SSL 1 +#define CRYPTO_EX_INDEX_SSL_CTX 2 +#define CRYPTO_EX_INDEX_SSL_SESSION 3 +#define CRYPTO_EX_INDEX_X509_STORE 4 +#define CRYPTO_EX_INDEX_X509_STORE_CTX 5 +#define CRYPTO_EX_INDEX_RSA 6 +#define CRYPTO_EX_INDEX_DSA 7 +#define CRYPTO_EX_INDEX_DH 8 +#define CRYPTO_EX_INDEX_ENGINE 9 +#define CRYPTO_EX_INDEX_X509 10 +#define CRYPTO_EX_INDEX_UI 11 +#define CRYPTO_EX_INDEX_ECDSA 12 +#define CRYPTO_EX_INDEX_ECDH 13 +#define CRYPTO_EX_INDEX_COMP 14 +#define CRYPTO_EX_INDEX_STORE 15 + +/* Dynamically assigned indexes start from this value (don't use directly, use + * via CRYPTO_ex_data_new_class). */ +#define CRYPTO_EX_INDEX_USER 100 + + +/* This is the default callbacks, but we can have others as well: + * this is needed in Win32 where the application malloc and the + * library malloc may not be the same. + */ +#define CRYPTO_malloc_init() CRYPTO_set_mem_functions(\ + malloc, realloc, free) + +#if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD +# ifndef CRYPTO_MDEBUG /* avoid duplicate #define */ +# define CRYPTO_MDEBUG +# endif +#endif + +/* Set standard debugging functions (not done by default + * unless CRYPTO_MDEBUG is defined) */ +#define CRYPTO_malloc_debug_init() do {\ + CRYPTO_set_mem_debug_functions(\ + CRYPTO_dbg_malloc,\ + CRYPTO_dbg_realloc,\ + CRYPTO_dbg_free,\ + CRYPTO_dbg_set_options,\ + CRYPTO_dbg_get_options);\ + } while(0) + +int CRYPTO_mem_ctrl(int mode); +int CRYPTO_is_mem_check_on(void); + +/* for applications */ +#define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON) +#define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF) + +/* for library-internal use */ +#define MemCheck_on() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE) +#define MemCheck_off() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE) +#define is_MemCheck_on() CRYPTO_is_mem_check_on() + +#define OPENSSL_malloc(num) CRYPTO_malloc((int)num,__FILE__,__LINE__) +#define OPENSSL_strdup(str) CRYPTO_strdup((str),__FILE__,__LINE__) +#define OPENSSL_realloc(addr,num) \ + CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__) +#define OPENSSL_realloc_clean(addr,old_num,num) \ + CRYPTO_realloc_clean(addr,old_num,num,__FILE__,__LINE__) +#define OPENSSL_remalloc(addr,num) \ + CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__) +#define OPENSSL_freeFunc CRYPTO_free +#define OPENSSL_free(addr) CRYPTO_free(addr) + +#define OPENSSL_malloc_locked(num) \ + CRYPTO_malloc_locked((int)num,__FILE__,__LINE__) +#define OPENSSL_free_locked(addr) CRYPTO_free_locked(addr) + + +const char *SSLeay_version(int type); +unsigned long SSLeay(void); + +int OPENSSL_issetugid(void); + +/* An opaque type representing an implementation of "ex_data" support */ +typedef struct st_CRYPTO_EX_DATA_IMPL CRYPTO_EX_DATA_IMPL; +/* Return an opaque pointer to the current "ex_data" implementation */ +const CRYPTO_EX_DATA_IMPL *CRYPTO_get_ex_data_implementation(void); +/* Sets the "ex_data" implementation to be used (if it's not too late) */ +int CRYPTO_set_ex_data_implementation(const CRYPTO_EX_DATA_IMPL *i); +/* Get a new "ex_data" class, and return the corresponding "class_index" */ +int CRYPTO_ex_data_new_class(void); +/* Within a given class, get/register a new index */ +int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp, + CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func, + CRYPTO_EX_free *free_func); +/* Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a given + * class (invokes whatever per-class callbacks are applicable) */ +int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad); +int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to, + CRYPTO_EX_DATA *from); +void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad); +/* Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular index + * (relative to the class type involved) */ +int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val); +void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad,int idx); +/* This function cleans up all "ex_data" state. It mustn't be called under + * potential race-conditions. */ +void CRYPTO_cleanup_all_ex_data(void); + +int CRYPTO_get_new_lockid(char *name); + +int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */ +void CRYPTO_lock(int mode, int type,const char *file,int line); +void CRYPTO_set_locking_callback(void (*func)(int mode,int type, + const char *file,int line)); +void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file, + int line); +void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type, + const char *file, int line)); +int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type, + const char *file,int line); + +/* Don't use this structure directly. */ +typedef struct crypto_threadid_st + { + void *ptr; + unsigned long val; + } CRYPTO_THREADID; +/* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */ +void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id, unsigned long val); +void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr); +int CRYPTO_THREADID_set_callback(void (*threadid_func)(CRYPTO_THREADID *)); +void (*CRYPTO_THREADID_get_callback(void))(CRYPTO_THREADID *); +void CRYPTO_THREADID_current(CRYPTO_THREADID *id); +int CRYPTO_THREADID_cmp(const CRYPTO_THREADID *a, const CRYPTO_THREADID *b); +void CRYPTO_THREADID_cpy(CRYPTO_THREADID *dest, const CRYPTO_THREADID *src); +unsigned long CRYPTO_THREADID_hash(const CRYPTO_THREADID *id); +#ifndef OPENSSL_NO_DEPRECATED +void CRYPTO_set_id_callback(unsigned long (*func)(void)); +unsigned long (*CRYPTO_get_id_callback(void))(void); +unsigned long CRYPTO_thread_id(void); +#endif + +const char *CRYPTO_get_lock_name(int type); +int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file, + int line); + +int CRYPTO_get_new_dynlockid(void); +void CRYPTO_destroy_dynlockid(int i); +struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i); +void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file, int line)); +void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)(int mode, struct CRYPTO_dynlock_value *l, const char *file, int line)); +void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l, const char *file, int line)); +struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))(const char *file,int line); +void (*CRYPTO_get_dynlock_lock_callback(void))(int mode, struct CRYPTO_dynlock_value *l, const char *file,int line); +void (*CRYPTO_get_dynlock_destroy_callback(void))(struct CRYPTO_dynlock_value *l, const char *file,int line); + +/* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions -- + * call the latter last if you need different functions */ +int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *)); +int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *)); +int CRYPTO_set_mem_ex_functions(void *(*m)(size_t,const char *,int), + void *(*r)(void *,size_t,const char *,int), + void (*f)(void *)); +int CRYPTO_set_locked_mem_ex_functions(void *(*m)(size_t,const char *,int), + void (*free_func)(void *)); +int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int), + void (*r)(void *,void *,int,const char *,int,int), + void (*f)(void *,int), + void (*so)(long), + long (*go)(void)); +void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *)); +void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *)); +void CRYPTO_get_mem_ex_functions(void *(**m)(size_t,const char *,int), + void *(**r)(void *, size_t,const char *,int), + void (**f)(void *)); +void CRYPTO_get_locked_mem_ex_functions(void *(**m)(size_t,const char *,int), + void (**f)(void *)); +void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int), + void (**r)(void *,void *,int,const char *,int,int), + void (**f)(void *,int), + void (**so)(long), + long (**go)(void)); + +void *CRYPTO_malloc_locked(int num, const char *file, int line); +void CRYPTO_free_locked(void *); +void *CRYPTO_malloc(int num, const char *file, int line); +char *CRYPTO_strdup(const char *str, const char *file, int line); +void CRYPTO_free(void *); +void *CRYPTO_realloc(void *addr,int num, const char *file, int line); +void *CRYPTO_realloc_clean(void *addr,int old_num,int num,const char *file, + int line); +void *CRYPTO_remalloc(void *addr,int num, const char *file, int line); + +void OPENSSL_cleanse(void *ptr, size_t len); + +void CRYPTO_set_mem_debug_options(long bits); +long CRYPTO_get_mem_debug_options(void); + +#define CRYPTO_push_info(info) \ + CRYPTO_push_info_(info, __FILE__, __LINE__); +int CRYPTO_push_info_(const char *info, const char *file, int line); +int CRYPTO_pop_info(void); +int CRYPTO_remove_all_info(void); + + +/* Default debugging functions (enabled by CRYPTO_malloc_debug_init() macro; + * used as default in CRYPTO_MDEBUG compilations): */ +/* The last argument has the following significance: + * + * 0: called before the actual memory allocation has taken place + * 1: called after the actual memory allocation has taken place + */ +void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p); +void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p); +void CRYPTO_dbg_free(void *addr,int before_p); +/* Tell the debugging code about options. By default, the following values + * apply: + * + * 0: Clear all options. + * V_CRYPTO_MDEBUG_TIME (1): Set the "Show Time" option. + * V_CRYPTO_MDEBUG_THREAD (2): Set the "Show Thread Number" option. + * V_CRYPTO_MDEBUG_ALL (3): 1 + 2 + */ +void CRYPTO_dbg_set_options(long bits); +long CRYPTO_dbg_get_options(void); + + +#ifndef OPENSSL_NO_FP_API +void CRYPTO_mem_leaks_fp(FILE *); +#endif +void CRYPTO_mem_leaks(struct bio_st *bio); +/* unsigned long order, char *file, int line, int num_bytes, char *addr */ +typedef void *CRYPTO_MEM_LEAK_CB(unsigned long, const char *, int, int, void *); +void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb); + +/* die if we have to */ +void OpenSSLDie(const char *file,int line,const char *assertion); +#define OPENSSL_assert(e) (void)((e) ? 0 : (OpenSSLDie(__FILE__, __LINE__, #e),1)) + +unsigned long *OPENSSL_ia32cap_loc(void); +#define OPENSSL_ia32cap (*(OPENSSL_ia32cap_loc())) +int OPENSSL_isservice(void); + +int FIPS_mode(void); +int FIPS_mode_set(int r); + +void OPENSSL_init(void); + +#define fips_md_init(alg) fips_md_init_ctx(alg, alg) + +#ifdef OPENSSL_FIPS +#define fips_md_init_ctx(alg, cx) \ + int alg##_Init(cx##_CTX *c) \ + { \ + if (FIPS_mode()) OpenSSLDie(__FILE__, __LINE__, \ + "Low level API call to digest " #alg " forbidden in FIPS mode!"); \ + return private_##alg##_Init(c); \ + } \ + int private_##alg##_Init(cx##_CTX *c) + +#define fips_cipher_abort(alg) \ + if (FIPS_mode()) OpenSSLDie(__FILE__, __LINE__, \ + "Low level API call to cipher " #alg " forbidden in FIPS mode!") + +#else +#define fips_md_init_ctx(alg, cx) \ + int alg##_Init(cx##_CTX *c) +#define fips_cipher_abort(alg) while(0) +#endif + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_CRYPTO_strings(void); + +/* Error codes for the CRYPTO functions. */ + +/* Function codes. */ +#define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX 100 +#define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID 103 +#define CRYPTO_F_CRYPTO_GET_NEW_LOCKID 101 +#define CRYPTO_F_CRYPTO_SET_EX_DATA 102 +#define CRYPTO_F_DEF_ADD_INDEX 104 +#define CRYPTO_F_DEF_GET_CLASS 105 +#define CRYPTO_F_FIPS_MODE_SET 109 +#define CRYPTO_F_INT_DUP_EX_DATA 106 +#define CRYPTO_F_INT_FREE_EX_DATA 107 +#define CRYPTO_F_INT_NEW_EX_DATA 108 + +/* Reason codes. */ +#define CRYPTO_R_FIPS_MODE_NOT_SUPPORTED 101 +#define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK 100 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/des.h b/Source/Import/OpenSSL/Include/openssl/des.h new file mode 100644 index 0000000..1eaedcb --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/des.h @@ -0,0 +1,248 @@ +/* crypto/des/des.h */ +/* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_NEW_DES_H +#define HEADER_NEW_DES_H + +#include /* OPENSSL_EXTERN, OPENSSL_NO_DES, + DES_LONG (via openssl/opensslconf.h */ + +#ifdef OPENSSL_NO_DES +#error DES is disabled. +#endif + +#ifdef OPENSSL_BUILD_SHLIBCRYPTO +# undef OPENSSL_EXTERN +# define OPENSSL_EXTERN OPENSSL_EXPORT +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +typedef unsigned char DES_cblock[8]; +typedef /* const */ unsigned char const_DES_cblock[8]; +/* With "const", gcc 2.8.1 on Solaris thinks that DES_cblock * + * and const_DES_cblock * are incompatible pointer types. */ + +typedef struct DES_ks + { + union + { + DES_cblock cblock; + /* make sure things are correct size on machines with + * 8 byte longs */ + DES_LONG deslong[2]; + } ks[16]; + } DES_key_schedule; + +#ifndef OPENSSL_DISABLE_OLD_DES_SUPPORT +# ifndef OPENSSL_ENABLE_OLD_DES_SUPPORT +# define OPENSSL_ENABLE_OLD_DES_SUPPORT +# endif +#endif + +#ifdef OPENSSL_ENABLE_OLD_DES_SUPPORT +# include +#endif + +#define DES_KEY_SZ (sizeof(DES_cblock)) +#define DES_SCHEDULE_SZ (sizeof(DES_key_schedule)) + +#define DES_ENCRYPT 1 +#define DES_DECRYPT 0 + +#define DES_CBC_MODE 0 +#define DES_PCBC_MODE 1 + +#define DES_ecb2_encrypt(i,o,k1,k2,e) \ + DES_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e)) + +#define DES_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \ + DES_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e)) + +#define DES_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \ + DES_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e)) + +#define DES_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \ + DES_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n)) + +OPENSSL_DECLARE_GLOBAL(int,DES_check_key); /* defaults to false */ +#define DES_check_key OPENSSL_GLOBAL_REF(DES_check_key) +OPENSSL_DECLARE_GLOBAL(int,DES_rw_mode); /* defaults to DES_PCBC_MODE */ +#define DES_rw_mode OPENSSL_GLOBAL_REF(DES_rw_mode) + +const char *DES_options(void); +void DES_ecb3_encrypt(const_DES_cblock *input, DES_cblock *output, + DES_key_schedule *ks1,DES_key_schedule *ks2, + DES_key_schedule *ks3, int enc); +DES_LONG DES_cbc_cksum(const unsigned char *input,DES_cblock *output, + long length,DES_key_schedule *schedule, + const_DES_cblock *ivec); +/* DES_cbc_encrypt does not update the IV! Use DES_ncbc_encrypt instead. */ +void DES_cbc_encrypt(const unsigned char *input,unsigned char *output, + long length,DES_key_schedule *schedule,DES_cblock *ivec, + int enc); +void DES_ncbc_encrypt(const unsigned char *input,unsigned char *output, + long length,DES_key_schedule *schedule,DES_cblock *ivec, + int enc); +void DES_xcbc_encrypt(const unsigned char *input,unsigned char *output, + long length,DES_key_schedule *schedule,DES_cblock *ivec, + const_DES_cblock *inw,const_DES_cblock *outw,int enc); +void DES_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits, + long length,DES_key_schedule *schedule,DES_cblock *ivec, + int enc); +void DES_ecb_encrypt(const_DES_cblock *input,DES_cblock *output, + DES_key_schedule *ks,int enc); + +/* This is the DES encryption function that gets called by just about + every other DES routine in the library. You should not use this + function except to implement 'modes' of DES. I say this because the + functions that call this routine do the conversion from 'char *' to + long, and this needs to be done to make sure 'non-aligned' memory + access do not occur. The characters are loaded 'little endian'. + Data is a pointer to 2 unsigned long's and ks is the + DES_key_schedule to use. enc, is non zero specifies encryption, + zero if decryption. */ +void DES_encrypt1(DES_LONG *data,DES_key_schedule *ks, int enc); + +/* This functions is the same as DES_encrypt1() except that the DES + initial permutation (IP) and final permutation (FP) have been left + out. As for DES_encrypt1(), you should not use this function. + It is used by the routines in the library that implement triple DES. + IP() DES_encrypt2() DES_encrypt2() DES_encrypt2() FP() is the same + as DES_encrypt1() DES_encrypt1() DES_encrypt1() except faster :-). */ +void DES_encrypt2(DES_LONG *data,DES_key_schedule *ks, int enc); + +void DES_encrypt3(DES_LONG *data, DES_key_schedule *ks1, + DES_key_schedule *ks2, DES_key_schedule *ks3); +void DES_decrypt3(DES_LONG *data, DES_key_schedule *ks1, + DES_key_schedule *ks2, DES_key_schedule *ks3); +void DES_ede3_cbc_encrypt(const unsigned char *input,unsigned char *output, + long length, + DES_key_schedule *ks1,DES_key_schedule *ks2, + DES_key_schedule *ks3,DES_cblock *ivec,int enc); +void DES_ede3_cbcm_encrypt(const unsigned char *in,unsigned char *out, + long length, + DES_key_schedule *ks1,DES_key_schedule *ks2, + DES_key_schedule *ks3, + DES_cblock *ivec1,DES_cblock *ivec2, + int enc); +void DES_ede3_cfb64_encrypt(const unsigned char *in,unsigned char *out, + long length,DES_key_schedule *ks1, + DES_key_schedule *ks2,DES_key_schedule *ks3, + DES_cblock *ivec,int *num,int enc); +void DES_ede3_cfb_encrypt(const unsigned char *in,unsigned char *out, + int numbits,long length,DES_key_schedule *ks1, + DES_key_schedule *ks2,DES_key_schedule *ks3, + DES_cblock *ivec,int enc); +void DES_ede3_ofb64_encrypt(const unsigned char *in,unsigned char *out, + long length,DES_key_schedule *ks1, + DES_key_schedule *ks2,DES_key_schedule *ks3, + DES_cblock *ivec,int *num); +#if 0 +void DES_xwhite_in2out(const_DES_cblock *DES_key,const_DES_cblock *in_white, + DES_cblock *out_white); +#endif + +int DES_enc_read(int fd,void *buf,int len,DES_key_schedule *sched, + DES_cblock *iv); +int DES_enc_write(int fd,const void *buf,int len,DES_key_schedule *sched, + DES_cblock *iv); +char *DES_fcrypt(const char *buf,const char *salt, char *ret); +char *DES_crypt(const char *buf,const char *salt); +void DES_ofb_encrypt(const unsigned char *in,unsigned char *out,int numbits, + long length,DES_key_schedule *schedule,DES_cblock *ivec); +void DES_pcbc_encrypt(const unsigned char *input,unsigned char *output, + long length,DES_key_schedule *schedule,DES_cblock *ivec, + int enc); +DES_LONG DES_quad_cksum(const unsigned char *input,DES_cblock output[], + long length,int out_count,DES_cblock *seed); +int DES_random_key(DES_cblock *ret); +void DES_set_odd_parity(DES_cblock *key); +int DES_check_key_parity(const_DES_cblock *key); +int DES_is_weak_key(const_DES_cblock *key); +/* DES_set_key (= set_key = DES_key_sched = key_sched) calls + * DES_set_key_checked if global variable DES_check_key is set, + * DES_set_key_unchecked otherwise. */ +int DES_set_key(const_DES_cblock *key,DES_key_schedule *schedule); +int DES_key_sched(const_DES_cblock *key,DES_key_schedule *schedule); +int DES_set_key_checked(const_DES_cblock *key,DES_key_schedule *schedule); +void DES_set_key_unchecked(const_DES_cblock *key,DES_key_schedule *schedule); +#ifdef OPENSSL_FIPS +void private_DES_set_key_unchecked(const_DES_cblock *key,DES_key_schedule *schedule); +#endif +void DES_string_to_key(const char *str,DES_cblock *key); +void DES_string_to_2keys(const char *str,DES_cblock *key1,DES_cblock *key2); +void DES_cfb64_encrypt(const unsigned char *in,unsigned char *out,long length, + DES_key_schedule *schedule,DES_cblock *ivec,int *num, + int enc); +void DES_ofb64_encrypt(const unsigned char *in,unsigned char *out,long length, + DES_key_schedule *schedule,DES_cblock *ivec,int *num); + +int DES_read_password(DES_cblock *key, const char *prompt, int verify); +int DES_read_2passwords(DES_cblock *key1, DES_cblock *key2, const char *prompt, + int verify); + +#define DES_fixup_key_parity DES_set_odd_parity + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/des_old.h b/Source/Import/OpenSSL/Include/openssl/des_old.h new file mode 100644 index 0000000..2b2c372 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/des_old.h @@ -0,0 +1,446 @@ +/* crypto/des/des_old.h -*- mode:C; c-file-style: "eay" -*- */ + +/* WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING + * + * The function names in here are deprecated and are only present to + * provide an interface compatible with openssl 0.9.6 and older as + * well as libdes. OpenSSL now provides functions where "des_" has + * been replaced with "DES_" in the names, to make it possible to + * make incompatible changes that are needed for C type security and + * other stuff. + * + * This include files has two compatibility modes: + * + * - If OPENSSL_DES_LIBDES_COMPATIBILITY is defined, you get an API + * that is compatible with libdes and SSLeay. + * - If OPENSSL_DES_LIBDES_COMPATIBILITY isn't defined, you get an + * API that is compatible with OpenSSL 0.9.5x to 0.9.6x. + * + * Note that these modes break earlier snapshots of OpenSSL, where + * libdes compatibility was the only available mode or (later on) the + * prefered compatibility mode. However, after much consideration + * (and more or less violent discussions with external parties), it + * was concluded that OpenSSL should be compatible with earlier versions + * of itself before anything else. Also, in all honesty, libdes is + * an old beast that shouldn't really be used any more. + * + * Please consider starting to use the DES_ functions rather than the + * des_ ones. The des_ functions will disappear completely before + * OpenSSL 1.0! + * + * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING + */ + +/* Written by Richard Levitte (richard@levitte.org) for the OpenSSL + * project 2001. + */ +/* ==================================================================== + * Copyright (c) 1998-2002 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_DES_H +#define HEADER_DES_H + +#include /* OPENSSL_EXTERN, OPENSSL_NO_DES, DES_LONG */ + +#ifdef OPENSSL_NO_DES +#error DES is disabled. +#endif + +#ifndef HEADER_NEW_DES_H +#error You must include des.h, not des_old.h directly. +#endif + +#ifdef _KERBEROS_DES_H +#error replaces . +#endif + +#include + +#ifdef OPENSSL_BUILD_SHLIBCRYPTO +# undef OPENSSL_EXTERN +# define OPENSSL_EXTERN OPENSSL_EXPORT +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef _ +#undef _ +#endif + +typedef unsigned char _ossl_old_des_cblock[8]; +typedef struct _ossl_old_des_ks_struct + { + union { + _ossl_old_des_cblock _; + /* make sure things are correct size on machines with + * 8 byte longs */ + DES_LONG pad[2]; + } ks; + } _ossl_old_des_key_schedule[16]; + +#ifndef OPENSSL_DES_LIBDES_COMPATIBILITY +#define des_cblock DES_cblock +#define const_des_cblock const_DES_cblock +#define des_key_schedule DES_key_schedule +#define des_ecb3_encrypt(i,o,k1,k2,k3,e)\ + DES_ecb3_encrypt((i),(o),&(k1),&(k2),&(k3),(e)) +#define des_ede3_cbc_encrypt(i,o,l,k1,k2,k3,iv,e)\ + DES_ede3_cbc_encrypt((i),(o),(l),&(k1),&(k2),&(k3),(iv),(e)) +#define des_ede3_cbcm_encrypt(i,o,l,k1,k2,k3,iv1,iv2,e)\ + DES_ede3_cbcm_encrypt((i),(o),(l),&(k1),&(k2),&(k3),(iv1),(iv2),(e)) +#define des_ede3_cfb64_encrypt(i,o,l,k1,k2,k3,iv,n,e)\ + DES_ede3_cfb64_encrypt((i),(o),(l),&(k1),&(k2),&(k3),(iv),(n),(e)) +#define des_ede3_ofb64_encrypt(i,o,l,k1,k2,k3,iv,n)\ + DES_ede3_ofb64_encrypt((i),(o),(l),&(k1),&(k2),&(k3),(iv),(n)) +#define des_options()\ + DES_options() +#define des_cbc_cksum(i,o,l,k,iv)\ + DES_cbc_cksum((i),(o),(l),&(k),(iv)) +#define des_cbc_encrypt(i,o,l,k,iv,e)\ + DES_cbc_encrypt((i),(o),(l),&(k),(iv),(e)) +#define des_ncbc_encrypt(i,o,l,k,iv,e)\ + DES_ncbc_encrypt((i),(o),(l),&(k),(iv),(e)) +#define des_xcbc_encrypt(i,o,l,k,iv,inw,outw,e)\ + DES_xcbc_encrypt((i),(o),(l),&(k),(iv),(inw),(outw),(e)) +#define des_cfb_encrypt(i,o,n,l,k,iv,e)\ + DES_cfb_encrypt((i),(o),(n),(l),&(k),(iv),(e)) +#define des_ecb_encrypt(i,o,k,e)\ + DES_ecb_encrypt((i),(o),&(k),(e)) +#define des_encrypt1(d,k,e)\ + DES_encrypt1((d),&(k),(e)) +#define des_encrypt2(d,k,e)\ + DES_encrypt2((d),&(k),(e)) +#define des_encrypt3(d,k1,k2,k3)\ + DES_encrypt3((d),&(k1),&(k2),&(k3)) +#define des_decrypt3(d,k1,k2,k3)\ + DES_decrypt3((d),&(k1),&(k2),&(k3)) +#define des_xwhite_in2out(k,i,o)\ + DES_xwhite_in2out((k),(i),(o)) +#define des_enc_read(f,b,l,k,iv)\ + DES_enc_read((f),(b),(l),&(k),(iv)) +#define des_enc_write(f,b,l,k,iv)\ + DES_enc_write((f),(b),(l),&(k),(iv)) +#define des_fcrypt(b,s,r)\ + DES_fcrypt((b),(s),(r)) +#if 0 +#define des_crypt(b,s)\ + DES_crypt((b),(s)) +#if !defined(PERL5) && !defined(__FreeBSD__) && !defined(NeXT) && !defined(__OpenBSD__) +#define crypt(b,s)\ + DES_crypt((b),(s)) +#endif +#endif +#define des_ofb_encrypt(i,o,n,l,k,iv)\ + DES_ofb_encrypt((i),(o),(n),(l),&(k),(iv)) +#define des_pcbc_encrypt(i,o,l,k,iv,e)\ + DES_pcbc_encrypt((i),(o),(l),&(k),(iv),(e)) +#define des_quad_cksum(i,o,l,c,s)\ + DES_quad_cksum((i),(o),(l),(c),(s)) +#define des_random_seed(k)\ + _ossl_096_des_random_seed((k)) +#define des_random_key(r)\ + DES_random_key((r)) +#define des_read_password(k,p,v) \ + DES_read_password((k),(p),(v)) +#define des_read_2passwords(k1,k2,p,v) \ + DES_read_2passwords((k1),(k2),(p),(v)) +#define des_set_odd_parity(k)\ + DES_set_odd_parity((k)) +#define des_check_key_parity(k)\ + DES_check_key_parity((k)) +#define des_is_weak_key(k)\ + DES_is_weak_key((k)) +#define des_set_key(k,ks)\ + DES_set_key((k),&(ks)) +#define des_key_sched(k,ks)\ + DES_key_sched((k),&(ks)) +#define des_set_key_checked(k,ks)\ + DES_set_key_checked((k),&(ks)) +#define des_set_key_unchecked(k,ks)\ + DES_set_key_unchecked((k),&(ks)) +#define des_string_to_key(s,k)\ + DES_string_to_key((s),(k)) +#define des_string_to_2keys(s,k1,k2)\ + DES_string_to_2keys((s),(k1),(k2)) +#define des_cfb64_encrypt(i,o,l,ks,iv,n,e)\ + DES_cfb64_encrypt((i),(o),(l),&(ks),(iv),(n),(e)) +#define des_ofb64_encrypt(i,o,l,ks,iv,n)\ + DES_ofb64_encrypt((i),(o),(l),&(ks),(iv),(n)) + + +#define des_ecb2_encrypt(i,o,k1,k2,e) \ + des_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e)) + +#define des_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \ + des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e)) + +#define des_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \ + des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e)) + +#define des_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \ + des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n)) + +#define des_check_key DES_check_key +#define des_rw_mode DES_rw_mode +#else /* libdes compatibility */ +/* Map all symbol names to _ossl_old_des_* form, so we avoid all + clashes with libdes */ +#define des_cblock _ossl_old_des_cblock +#define des_key_schedule _ossl_old_des_key_schedule +#define des_ecb3_encrypt(i,o,k1,k2,k3,e)\ + _ossl_old_des_ecb3_encrypt((i),(o),(k1),(k2),(k3),(e)) +#define des_ede3_cbc_encrypt(i,o,l,k1,k2,k3,iv,e)\ + _ossl_old_des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k3),(iv),(e)) +#define des_ede3_cfb64_encrypt(i,o,l,k1,k2,k3,iv,n,e)\ + _ossl_old_des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k3),(iv),(n),(e)) +#define des_ede3_ofb64_encrypt(i,o,l,k1,k2,k3,iv,n)\ + _ossl_old_des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k3),(iv),(n)) +#define des_options()\ + _ossl_old_des_options() +#define des_cbc_cksum(i,o,l,k,iv)\ + _ossl_old_des_cbc_cksum((i),(o),(l),(k),(iv)) +#define des_cbc_encrypt(i,o,l,k,iv,e)\ + _ossl_old_des_cbc_encrypt((i),(o),(l),(k),(iv),(e)) +#define des_ncbc_encrypt(i,o,l,k,iv,e)\ + _ossl_old_des_ncbc_encrypt((i),(o),(l),(k),(iv),(e)) +#define des_xcbc_encrypt(i,o,l,k,iv,inw,outw,e)\ + _ossl_old_des_xcbc_encrypt((i),(o),(l),(k),(iv),(inw),(outw),(e)) +#define des_cfb_encrypt(i,o,n,l,k,iv,e)\ + _ossl_old_des_cfb_encrypt((i),(o),(n),(l),(k),(iv),(e)) +#define des_ecb_encrypt(i,o,k,e)\ + _ossl_old_des_ecb_encrypt((i),(o),(k),(e)) +#define des_encrypt(d,k,e)\ + _ossl_old_des_encrypt((d),(k),(e)) +#define des_encrypt2(d,k,e)\ + _ossl_old_des_encrypt2((d),(k),(e)) +#define des_encrypt3(d,k1,k2,k3)\ + _ossl_old_des_encrypt3((d),(k1),(k2),(k3)) +#define des_decrypt3(d,k1,k2,k3)\ + _ossl_old_des_decrypt3((d),(k1),(k2),(k3)) +#define des_xwhite_in2out(k,i,o)\ + _ossl_old_des_xwhite_in2out((k),(i),(o)) +#define des_enc_read(f,b,l,k,iv)\ + _ossl_old_des_enc_read((f),(b),(l),(k),(iv)) +#define des_enc_write(f,b,l,k,iv)\ + _ossl_old_des_enc_write((f),(b),(l),(k),(iv)) +#define des_fcrypt(b,s,r)\ + _ossl_old_des_fcrypt((b),(s),(r)) +#define des_crypt(b,s)\ + _ossl_old_des_crypt((b),(s)) +#if 0 +#define crypt(b,s)\ + _ossl_old_crypt((b),(s)) +#endif +#define des_ofb_encrypt(i,o,n,l,k,iv)\ + _ossl_old_des_ofb_encrypt((i),(o),(n),(l),(k),(iv)) +#define des_pcbc_encrypt(i,o,l,k,iv,e)\ + _ossl_old_des_pcbc_encrypt((i),(o),(l),(k),(iv),(e)) +#define des_quad_cksum(i,o,l,c,s)\ + _ossl_old_des_quad_cksum((i),(o),(l),(c),(s)) +#define des_random_seed(k)\ + _ossl_old_des_random_seed((k)) +#define des_random_key(r)\ + _ossl_old_des_random_key((r)) +#define des_read_password(k,p,v) \ + _ossl_old_des_read_password((k),(p),(v)) +#define des_read_2passwords(k1,k2,p,v) \ + _ossl_old_des_read_2passwords((k1),(k2),(p),(v)) +#define des_set_odd_parity(k)\ + _ossl_old_des_set_odd_parity((k)) +#define des_is_weak_key(k)\ + _ossl_old_des_is_weak_key((k)) +#define des_set_key(k,ks)\ + _ossl_old_des_set_key((k),(ks)) +#define des_key_sched(k,ks)\ + _ossl_old_des_key_sched((k),(ks)) +#define des_string_to_key(s,k)\ + _ossl_old_des_string_to_key((s),(k)) +#define des_string_to_2keys(s,k1,k2)\ + _ossl_old_des_string_to_2keys((s),(k1),(k2)) +#define des_cfb64_encrypt(i,o,l,ks,iv,n,e)\ + _ossl_old_des_cfb64_encrypt((i),(o),(l),(ks),(iv),(n),(e)) +#define des_ofb64_encrypt(i,o,l,ks,iv,n)\ + _ossl_old_des_ofb64_encrypt((i),(o),(l),(ks),(iv),(n)) + + +#define des_ecb2_encrypt(i,o,k1,k2,e) \ + des_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e)) + +#define des_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \ + des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e)) + +#define des_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \ + des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e)) + +#define des_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \ + des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n)) + +#define des_check_key DES_check_key +#define des_rw_mode DES_rw_mode +#endif + +const char *_ossl_old_des_options(void); +void _ossl_old_des_ecb3_encrypt(_ossl_old_des_cblock *input,_ossl_old_des_cblock *output, + _ossl_old_des_key_schedule ks1,_ossl_old_des_key_schedule ks2, + _ossl_old_des_key_schedule ks3, int enc); +DES_LONG _ossl_old_des_cbc_cksum(_ossl_old_des_cblock *input,_ossl_old_des_cblock *output, + long length,_ossl_old_des_key_schedule schedule,_ossl_old_des_cblock *ivec); +void _ossl_old_des_cbc_encrypt(_ossl_old_des_cblock *input,_ossl_old_des_cblock *output,long length, + _ossl_old_des_key_schedule schedule,_ossl_old_des_cblock *ivec,int enc); +void _ossl_old_des_ncbc_encrypt(_ossl_old_des_cblock *input,_ossl_old_des_cblock *output,long length, + _ossl_old_des_key_schedule schedule,_ossl_old_des_cblock *ivec,int enc); +void _ossl_old_des_xcbc_encrypt(_ossl_old_des_cblock *input,_ossl_old_des_cblock *output,long length, + _ossl_old_des_key_schedule schedule,_ossl_old_des_cblock *ivec, + _ossl_old_des_cblock *inw,_ossl_old_des_cblock *outw,int enc); +void _ossl_old_des_cfb_encrypt(unsigned char *in,unsigned char *out,int numbits, + long length,_ossl_old_des_key_schedule schedule,_ossl_old_des_cblock *ivec,int enc); +void _ossl_old_des_ecb_encrypt(_ossl_old_des_cblock *input,_ossl_old_des_cblock *output, + _ossl_old_des_key_schedule ks,int enc); +void _ossl_old_des_encrypt(DES_LONG *data,_ossl_old_des_key_schedule ks, int enc); +void _ossl_old_des_encrypt2(DES_LONG *data,_ossl_old_des_key_schedule ks, int enc); +void _ossl_old_des_encrypt3(DES_LONG *data, _ossl_old_des_key_schedule ks1, + _ossl_old_des_key_schedule ks2, _ossl_old_des_key_schedule ks3); +void _ossl_old_des_decrypt3(DES_LONG *data, _ossl_old_des_key_schedule ks1, + _ossl_old_des_key_schedule ks2, _ossl_old_des_key_schedule ks3); +void _ossl_old_des_ede3_cbc_encrypt(_ossl_old_des_cblock *input, _ossl_old_des_cblock *output, + long length, _ossl_old_des_key_schedule ks1, _ossl_old_des_key_schedule ks2, + _ossl_old_des_key_schedule ks3, _ossl_old_des_cblock *ivec, int enc); +void _ossl_old_des_ede3_cfb64_encrypt(unsigned char *in, unsigned char *out, + long length, _ossl_old_des_key_schedule ks1, _ossl_old_des_key_schedule ks2, + _ossl_old_des_key_schedule ks3, _ossl_old_des_cblock *ivec, int *num, int enc); +void _ossl_old_des_ede3_ofb64_encrypt(unsigned char *in, unsigned char *out, + long length, _ossl_old_des_key_schedule ks1, _ossl_old_des_key_schedule ks2, + _ossl_old_des_key_schedule ks3, _ossl_old_des_cblock *ivec, int *num); +#if 0 +void _ossl_old_des_xwhite_in2out(_ossl_old_des_cblock (*des_key), _ossl_old_des_cblock (*in_white), + _ossl_old_des_cblock (*out_white)); +#endif + +int _ossl_old_des_enc_read(int fd,char *buf,int len,_ossl_old_des_key_schedule sched, + _ossl_old_des_cblock *iv); +int _ossl_old_des_enc_write(int fd,char *buf,int len,_ossl_old_des_key_schedule sched, + _ossl_old_des_cblock *iv); +char *_ossl_old_des_fcrypt(const char *buf,const char *salt, char *ret); +char *_ossl_old_des_crypt(const char *buf,const char *salt); +#if !defined(PERL5) && !defined(NeXT) +char *_ossl_old_crypt(const char *buf,const char *salt); +#endif +void _ossl_old_des_ofb_encrypt(unsigned char *in,unsigned char *out, + int numbits,long length,_ossl_old_des_key_schedule schedule,_ossl_old_des_cblock *ivec); +void _ossl_old_des_pcbc_encrypt(_ossl_old_des_cblock *input,_ossl_old_des_cblock *output,long length, + _ossl_old_des_key_schedule schedule,_ossl_old_des_cblock *ivec,int enc); +DES_LONG _ossl_old_des_quad_cksum(_ossl_old_des_cblock *input,_ossl_old_des_cblock *output, + long length,int out_count,_ossl_old_des_cblock *seed); +void _ossl_old_des_random_seed(_ossl_old_des_cblock key); +void _ossl_old_des_random_key(_ossl_old_des_cblock ret); +int _ossl_old_des_read_password(_ossl_old_des_cblock *key,const char *prompt,int verify); +int _ossl_old_des_read_2passwords(_ossl_old_des_cblock *key1,_ossl_old_des_cblock *key2, + const char *prompt,int verify); +void _ossl_old_des_set_odd_parity(_ossl_old_des_cblock *key); +int _ossl_old_des_is_weak_key(_ossl_old_des_cblock *key); +int _ossl_old_des_set_key(_ossl_old_des_cblock *key,_ossl_old_des_key_schedule schedule); +int _ossl_old_des_key_sched(_ossl_old_des_cblock *key,_ossl_old_des_key_schedule schedule); +void _ossl_old_des_string_to_key(char *str,_ossl_old_des_cblock *key); +void _ossl_old_des_string_to_2keys(char *str,_ossl_old_des_cblock *key1,_ossl_old_des_cblock *key2); +void _ossl_old_des_cfb64_encrypt(unsigned char *in, unsigned char *out, long length, + _ossl_old_des_key_schedule schedule, _ossl_old_des_cblock *ivec, int *num, int enc); +void _ossl_old_des_ofb64_encrypt(unsigned char *in, unsigned char *out, long length, + _ossl_old_des_key_schedule schedule, _ossl_old_des_cblock *ivec, int *num); + +void _ossl_096_des_random_seed(des_cblock *key); + +/* The following definitions provide compatibility with the MIT Kerberos + * library. The _ossl_old_des_key_schedule structure is not binary compatible. */ + +#define _KERBEROS_DES_H + +#define KRBDES_ENCRYPT DES_ENCRYPT +#define KRBDES_DECRYPT DES_DECRYPT + +#ifdef KERBEROS +# define ENCRYPT DES_ENCRYPT +# define DECRYPT DES_DECRYPT +#endif + +#ifndef NCOMPAT +# define C_Block des_cblock +# define Key_schedule des_key_schedule +# define KEY_SZ DES_KEY_SZ +# define string_to_key des_string_to_key +# define read_pw_string des_read_pw_string +# define random_key des_random_key +# define pcbc_encrypt des_pcbc_encrypt +# define set_key des_set_key +# define key_sched des_key_sched +# define ecb_encrypt des_ecb_encrypt +# define cbc_encrypt des_cbc_encrypt +# define ncbc_encrypt des_ncbc_encrypt +# define xcbc_encrypt des_xcbc_encrypt +# define cbc_cksum des_cbc_cksum +# define quad_cksum des_quad_cksum +# define check_parity des_check_key_parity +#endif + +#define des_fixup_key_parity DES_fixup_key_parity + +#ifdef __cplusplus +} +#endif + +/* for DES_read_pw_string et al */ +#include + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/dh.h b/Source/Import/OpenSSL/Include/openssl/dh.h new file mode 100644 index 0000000..ea59e61 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/dh.h @@ -0,0 +1,280 @@ +/* crypto/dh/dh.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_DH_H +#define HEADER_DH_H + +#include + +#ifdef OPENSSL_NO_DH +#error DH is disabled. +#endif + +#ifndef OPENSSL_NO_BIO +#include +#endif +#include +#ifndef OPENSSL_NO_DEPRECATED +#include +#endif + +#ifndef OPENSSL_DH_MAX_MODULUS_BITS +# define OPENSSL_DH_MAX_MODULUS_BITS 10000 +#endif + +#define DH_FLAG_CACHE_MONT_P 0x01 +#define DH_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the built-in DH + * implementation now uses constant time + * modular exponentiation for secret exponents + * by default. This flag causes the + * faster variable sliding window method to + * be used for all exponents. + */ + +/* If this flag is set the DH method is FIPS compliant and can be used + * in FIPS mode. This is set in the validated module method. If an + * application sets this flag in its own methods it is its reposibility + * to ensure the result is compliant. + */ + +#define DH_FLAG_FIPS_METHOD 0x0400 + +/* If this flag is set the operations normally disabled in FIPS mode are + * permitted it is then the applications responsibility to ensure that the + * usage is compliant. + */ + +#define DH_FLAG_NON_FIPS_ALLOW 0x0400 + +#ifdef __cplusplus +extern "C" { +#endif + +/* Already defined in ossl_typ.h */ +/* typedef struct dh_st DH; */ +/* typedef struct dh_method DH_METHOD; */ + +struct dh_method + { + const char *name; + /* Methods here */ + int (*generate_key)(DH *dh); + int (*compute_key)(unsigned char *key,const BIGNUM *pub_key,DH *dh); + int (*bn_mod_exp)(const DH *dh, BIGNUM *r, const BIGNUM *a, + const BIGNUM *p, const BIGNUM *m, BN_CTX *ctx, + BN_MONT_CTX *m_ctx); /* Can be null */ + + int (*init)(DH *dh); + int (*finish)(DH *dh); + int flags; + char *app_data; + /* If this is non-NULL, it will be used to generate parameters */ + int (*generate_params)(DH *dh, int prime_len, int generator, BN_GENCB *cb); + }; + +struct dh_st + { + /* This first argument is used to pick up errors when + * a DH is passed instead of a EVP_PKEY */ + int pad; + int version; + BIGNUM *p; + BIGNUM *g; + long length; /* optional */ + BIGNUM *pub_key; /* g^x */ + BIGNUM *priv_key; /* x */ + + int flags; + BN_MONT_CTX *method_mont_p; + /* Place holders if we want to do X9.42 DH */ + BIGNUM *q; + BIGNUM *j; + unsigned char *seed; + int seedlen; + BIGNUM *counter; + + int references; + CRYPTO_EX_DATA ex_data; + const DH_METHOD *meth; + ENGINE *engine; + }; + +#define DH_GENERATOR_2 2 +/* #define DH_GENERATOR_3 3 */ +#define DH_GENERATOR_5 5 + +/* DH_check error codes */ +#define DH_CHECK_P_NOT_PRIME 0x01 +#define DH_CHECK_P_NOT_SAFE_PRIME 0x02 +#define DH_UNABLE_TO_CHECK_GENERATOR 0x04 +#define DH_NOT_SUITABLE_GENERATOR 0x08 + +/* DH_check_pub_key error codes */ +#define DH_CHECK_PUBKEY_TOO_SMALL 0x01 +#define DH_CHECK_PUBKEY_TOO_LARGE 0x02 + +/* primes p where (p-1)/2 is prime too are called "safe"; we define + this for backward compatibility: */ +#define DH_CHECK_P_NOT_STRONG_PRIME DH_CHECK_P_NOT_SAFE_PRIME + +#define d2i_DHparams_fp(fp,x) (DH *)ASN1_d2i_fp((char *(*)())DH_new, \ + (char *(*)())d2i_DHparams,(fp),(unsigned char **)(x)) +#define i2d_DHparams_fp(fp,x) ASN1_i2d_fp(i2d_DHparams,(fp), \ + (unsigned char *)(x)) +#define d2i_DHparams_bio(bp,x) ASN1_d2i_bio_of(DH,DH_new,d2i_DHparams,bp,x) +#define i2d_DHparams_bio(bp,x) ASN1_i2d_bio_of_const(DH,i2d_DHparams,bp,x) + +DH *DHparams_dup(DH *); + +const DH_METHOD *DH_OpenSSL(void); + +void DH_set_default_method(const DH_METHOD *meth); +const DH_METHOD *DH_get_default_method(void); +int DH_set_method(DH *dh, const DH_METHOD *meth); +DH *DH_new_method(ENGINE *engine); + +DH * DH_new(void); +void DH_free(DH *dh); +int DH_up_ref(DH *dh); +int DH_size(const DH *dh); +int DH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); +int DH_set_ex_data(DH *d, int idx, void *arg); +void *DH_get_ex_data(DH *d, int idx); + +/* Deprecated version */ +#ifndef OPENSSL_NO_DEPRECATED +DH * DH_generate_parameters(int prime_len,int generator, + void (*callback)(int,int,void *),void *cb_arg); +#endif /* !defined(OPENSSL_NO_DEPRECATED) */ + +/* New version */ +int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb); + +int DH_check(const DH *dh,int *codes); +int DH_check_pub_key(const DH *dh,const BIGNUM *pub_key, int *codes); +int DH_generate_key(DH *dh); +int DH_compute_key(unsigned char *key,const BIGNUM *pub_key,DH *dh); +DH * d2i_DHparams(DH **a,const unsigned char **pp, long length); +int i2d_DHparams(const DH *a,unsigned char **pp); +#ifndef OPENSSL_NO_FP_API +int DHparams_print_fp(FILE *fp, const DH *x); +#endif +#ifndef OPENSSL_NO_BIO +int DHparams_print(BIO *bp, const DH *x); +#else +int DHparams_print(char *bp, const DH *x); +#endif + +#define EVP_PKEY_CTX_set_dh_paramgen_prime_len(ctx, len) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ + EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN, len, NULL) + +#define EVP_PKEY_CTX_set_dh_paramgen_generator(ctx, gen) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DH, EVP_PKEY_OP_PARAMGEN, \ + EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR, gen, NULL) + +#define EVP_PKEY_CTRL_DH_PARAMGEN_PRIME_LEN (EVP_PKEY_ALG_CTRL + 1) +#define EVP_PKEY_CTRL_DH_PARAMGEN_GENERATOR (EVP_PKEY_ALG_CTRL + 2) + + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_DH_strings(void); + +/* Error codes for the DH functions. */ + +/* Function codes. */ +#define DH_F_COMPUTE_KEY 102 +#define DH_F_DHPARAMS_PRINT_FP 101 +#define DH_F_DH_BUILTIN_GENPARAMS 106 +#define DH_F_DH_COMPUTE_KEY 114 +#define DH_F_DH_GENERATE_KEY 115 +#define DH_F_DH_GENERATE_PARAMETERS_EX 116 +#define DH_F_DH_NEW_METHOD 105 +#define DH_F_DH_PARAM_DECODE 107 +#define DH_F_DH_PRIV_DECODE 110 +#define DH_F_DH_PRIV_ENCODE 111 +#define DH_F_DH_PUB_DECODE 108 +#define DH_F_DH_PUB_ENCODE 109 +#define DH_F_DO_DH_PRINT 100 +#define DH_F_GENERATE_KEY 103 +#define DH_F_GENERATE_PARAMETERS 104 +#define DH_F_PKEY_DH_DERIVE 112 +#define DH_F_PKEY_DH_KEYGEN 113 + +/* Reason codes. */ +#define DH_R_BAD_GENERATOR 101 +#define DH_R_BN_DECODE_ERROR 109 +#define DH_R_BN_ERROR 106 +#define DH_R_DECODE_ERROR 104 +#define DH_R_INVALID_PUBKEY 102 +#define DH_R_KEYS_NOT_SET 108 +#define DH_R_KEY_SIZE_TOO_SMALL 110 +#define DH_R_MODULUS_TOO_LARGE 103 +#define DH_R_NON_FIPS_METHOD 111 +#define DH_R_NO_PARAMETERS_SET 107 +#define DH_R_NO_PRIVATE_VALUE 100 +#define DH_R_PARAMETER_ENCODING_ERROR 105 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/dsa.h b/Source/Import/OpenSSL/Include/openssl/dsa.h new file mode 100644 index 0000000..a6f6d0b --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/dsa.h @@ -0,0 +1,327 @@ +/* crypto/dsa/dsa.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +/* + * The DSS routines are based on patches supplied by + * Steven Schoch . He basically did the + * work and I have just tweaked them a little to fit into my + * stylistic vision for SSLeay :-) */ + +#ifndef HEADER_DSA_H +#define HEADER_DSA_H + +#include + +#ifdef OPENSSL_NO_DSA +#error DSA is disabled. +#endif + +#ifndef OPENSSL_NO_BIO +#include +#endif +#include +#include + +#ifndef OPENSSL_NO_DEPRECATED +#include +#ifndef OPENSSL_NO_DH +# include +#endif +#endif + +#ifndef OPENSSL_DSA_MAX_MODULUS_BITS +# define OPENSSL_DSA_MAX_MODULUS_BITS 10000 +#endif + +#define DSA_FLAG_CACHE_MONT_P 0x01 +#define DSA_FLAG_NO_EXP_CONSTTIME 0x02 /* new with 0.9.7h; the built-in DSA + * implementation now uses constant time + * modular exponentiation for secret exponents + * by default. This flag causes the + * faster variable sliding window method to + * be used for all exponents. + */ + +/* If this flag is set the DSA method is FIPS compliant and can be used + * in FIPS mode. This is set in the validated module method. If an + * application sets this flag in its own methods it is its reposibility + * to ensure the result is compliant. + */ + +#define DSA_FLAG_FIPS_METHOD 0x0400 + +/* If this flag is set the operations normally disabled in FIPS mode are + * permitted it is then the applications responsibility to ensure that the + * usage is compliant. + */ + +#define DSA_FLAG_NON_FIPS_ALLOW 0x0400 + +#ifdef __cplusplus +extern "C" { +#endif + +/* Already defined in ossl_typ.h */ +/* typedef struct dsa_st DSA; */ +/* typedef struct dsa_method DSA_METHOD; */ + +typedef struct DSA_SIG_st + { + BIGNUM *r; + BIGNUM *s; + } DSA_SIG; + +struct dsa_method + { + const char *name; + DSA_SIG * (*dsa_do_sign)(const unsigned char *dgst, int dlen, DSA *dsa); + int (*dsa_sign_setup)(DSA *dsa, BN_CTX *ctx_in, BIGNUM **kinvp, + BIGNUM **rp); + int (*dsa_do_verify)(const unsigned char *dgst, int dgst_len, + DSA_SIG *sig, DSA *dsa); + int (*dsa_mod_exp)(DSA *dsa, BIGNUM *rr, BIGNUM *a1, BIGNUM *p1, + BIGNUM *a2, BIGNUM *p2, BIGNUM *m, BN_CTX *ctx, + BN_MONT_CTX *in_mont); + int (*bn_mod_exp)(DSA *dsa, BIGNUM *r, BIGNUM *a, const BIGNUM *p, + const BIGNUM *m, BN_CTX *ctx, + BN_MONT_CTX *m_ctx); /* Can be null */ + int (*init)(DSA *dsa); + int (*finish)(DSA *dsa); + int flags; + char *app_data; + /* If this is non-NULL, it is used to generate DSA parameters */ + int (*dsa_paramgen)(DSA *dsa, int bits, + const unsigned char *seed, int seed_len, + int *counter_ret, unsigned long *h_ret, + BN_GENCB *cb); + /* If this is non-NULL, it is used to generate DSA keys */ + int (*dsa_keygen)(DSA *dsa); + }; + +struct dsa_st + { + /* This first variable is used to pick up errors where + * a DSA is passed instead of of a EVP_PKEY */ + int pad; + long version; + int write_params; + BIGNUM *p; + BIGNUM *q; /* == 20 */ + BIGNUM *g; + + BIGNUM *pub_key; /* y public key */ + BIGNUM *priv_key; /* x private key */ + + BIGNUM *kinv; /* Signing pre-calc */ + BIGNUM *r; /* Signing pre-calc */ + + int flags; + /* Normally used to cache montgomery values */ + BN_MONT_CTX *method_mont_p; + int references; + CRYPTO_EX_DATA ex_data; + const DSA_METHOD *meth; + /* functional reference if 'meth' is ENGINE-provided */ + ENGINE *engine; + }; + +#define d2i_DSAparams_fp(fp,x) (DSA *)ASN1_d2i_fp((char *(*)())DSA_new, \ + (char *(*)())d2i_DSAparams,(fp),(unsigned char **)(x)) +#define i2d_DSAparams_fp(fp,x) ASN1_i2d_fp(i2d_DSAparams,(fp), \ + (unsigned char *)(x)) +#define d2i_DSAparams_bio(bp,x) ASN1_d2i_bio_of(DSA,DSA_new,d2i_DSAparams,bp,x) +#define i2d_DSAparams_bio(bp,x) ASN1_i2d_bio_of_const(DSA,i2d_DSAparams,bp,x) + + +DSA *DSAparams_dup(DSA *x); +DSA_SIG * DSA_SIG_new(void); +void DSA_SIG_free(DSA_SIG *a); +int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp); +DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length); + +DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa); +int DSA_do_verify(const unsigned char *dgst,int dgst_len, + DSA_SIG *sig,DSA *dsa); + +const DSA_METHOD *DSA_OpenSSL(void); + +void DSA_set_default_method(const DSA_METHOD *); +const DSA_METHOD *DSA_get_default_method(void); +int DSA_set_method(DSA *dsa, const DSA_METHOD *); + +DSA * DSA_new(void); +DSA * DSA_new_method(ENGINE *engine); +void DSA_free (DSA *r); +/* "up" the DSA object's reference count */ +int DSA_up_ref(DSA *r); +int DSA_size(const DSA *); + /* next 4 return -1 on error */ +int DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp); +int DSA_sign(int type,const unsigned char *dgst,int dlen, + unsigned char *sig, unsigned int *siglen, DSA *dsa); +int DSA_verify(int type,const unsigned char *dgst,int dgst_len, + const unsigned char *sigbuf, int siglen, DSA *dsa); +int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); +int DSA_set_ex_data(DSA *d, int idx, void *arg); +void *DSA_get_ex_data(DSA *d, int idx); + +DSA * d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length); +DSA * d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length); +DSA * d2i_DSAparams(DSA **a, const unsigned char **pp, long length); + +/* Deprecated version */ +#ifndef OPENSSL_NO_DEPRECATED +DSA * DSA_generate_parameters(int bits, + unsigned char *seed,int seed_len, + int *counter_ret, unsigned long *h_ret,void + (*callback)(int, int, void *),void *cb_arg); +#endif /* !defined(OPENSSL_NO_DEPRECATED) */ + +/* New version */ +int DSA_generate_parameters_ex(DSA *dsa, int bits, + const unsigned char *seed,int seed_len, + int *counter_ret, unsigned long *h_ret, BN_GENCB *cb); + +int DSA_generate_key(DSA *a); +int i2d_DSAPublicKey(const DSA *a, unsigned char **pp); +int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp); +int i2d_DSAparams(const DSA *a,unsigned char **pp); + +#ifndef OPENSSL_NO_BIO +int DSAparams_print(BIO *bp, const DSA *x); +int DSA_print(BIO *bp, const DSA *x, int off); +#endif +#ifndef OPENSSL_NO_FP_API +int DSAparams_print_fp(FILE *fp, const DSA *x); +int DSA_print_fp(FILE *bp, const DSA *x, int off); +#endif + +#define DSS_prime_checks 50 +/* Primality test according to FIPS PUB 186[-1], Appendix 2.1: + * 50 rounds of Rabin-Miller */ +#define DSA_is_prime(n, callback, cb_arg) \ + BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg) + +#ifndef OPENSSL_NO_DH +/* Convert DSA structure (key or just parameters) into DH structure + * (be careful to avoid small subgroup attacks when using this!) */ +DH *DSA_dup_DH(const DSA *r); +#endif + +#define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \ + EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL) + +#define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1) +#define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2) +#define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3) + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_DSA_strings(void); + +/* Error codes for the DSA functions. */ + +/* Function codes. */ +#define DSA_F_D2I_DSA_SIG 110 +#define DSA_F_DO_DSA_PRINT 104 +#define DSA_F_DSAPARAMS_PRINT 100 +#define DSA_F_DSAPARAMS_PRINT_FP 101 +#define DSA_F_DSA_DO_SIGN 112 +#define DSA_F_DSA_DO_VERIFY 113 +#define DSA_F_DSA_GENERATE_KEY 124 +#define DSA_F_DSA_GENERATE_PARAMETERS_EX 123 +#define DSA_F_DSA_NEW_METHOD 103 +#define DSA_F_DSA_PARAM_DECODE 119 +#define DSA_F_DSA_PRINT_FP 105 +#define DSA_F_DSA_PRIV_DECODE 115 +#define DSA_F_DSA_PRIV_ENCODE 116 +#define DSA_F_DSA_PUB_DECODE 117 +#define DSA_F_DSA_PUB_ENCODE 118 +#define DSA_F_DSA_SIGN 106 +#define DSA_F_DSA_SIGN_SETUP 107 +#define DSA_F_DSA_SIG_NEW 109 +#define DSA_F_DSA_SIG_PRINT 125 +#define DSA_F_DSA_VERIFY 108 +#define DSA_F_I2D_DSA_SIG 111 +#define DSA_F_OLD_DSA_PRIV_DECODE 122 +#define DSA_F_PKEY_DSA_CTRL 120 +#define DSA_F_PKEY_DSA_KEYGEN 121 +#define DSA_F_SIG_CB 114 + +/* Reason codes. */ +#define DSA_R_BAD_Q_VALUE 102 +#define DSA_R_BN_DECODE_ERROR 108 +#define DSA_R_BN_ERROR 109 +#define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100 +#define DSA_R_DECODE_ERROR 104 +#define DSA_R_INVALID_DIGEST_TYPE 106 +#define DSA_R_MISSING_PARAMETERS 101 +#define DSA_R_MODULUS_TOO_LARGE 103 +#define DSA_R_NEED_NEW_SETUP_VALUES 110 +#define DSA_R_NON_FIPS_DSA_METHOD 111 +#define DSA_R_NO_PARAMETERS_SET 107 +#define DSA_R_PARAMETER_ENCODING_ERROR 105 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/dso.h b/Source/Import/OpenSSL/Include/openssl/dso.h new file mode 100644 index 0000000..839f2e0 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/dso.h @@ -0,0 +1,409 @@ +/* dso.h -*- mode:C; c-file-style: "eay" -*- */ +/* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL + * project 2000. + */ +/* ==================================================================== + * Copyright (c) 2000 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_DSO_H +#define HEADER_DSO_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* These values are used as commands to DSO_ctrl() */ +#define DSO_CTRL_GET_FLAGS 1 +#define DSO_CTRL_SET_FLAGS 2 +#define DSO_CTRL_OR_FLAGS 3 + +/* By default, DSO_load() will translate the provided filename into a form + * typical for the platform (more specifically the DSO_METHOD) using the + * dso_name_converter function of the method. Eg. win32 will transform "blah" + * into "blah.dll", and dlfcn will transform it into "libblah.so". The + * behaviour can be overriden by setting the name_converter callback in the DSO + * object (using DSO_set_name_converter()). This callback could even utilise + * the DSO_METHOD's converter too if it only wants to override behaviour for + * one or two possible DSO methods. However, the following flag can be set in a + * DSO to prevent *any* native name-translation at all - eg. if the caller has + * prompted the user for a path to a driver library so the filename should be + * interpreted as-is. */ +#define DSO_FLAG_NO_NAME_TRANSLATION 0x01 +/* An extra flag to give if only the extension should be added as + * translation. This is obviously only of importance on Unix and + * other operating systems where the translation also may prefix + * the name with something, like 'lib', and ignored everywhere else. + * This flag is also ignored if DSO_FLAG_NO_NAME_TRANSLATION is used + * at the same time. */ +#define DSO_FLAG_NAME_TRANSLATION_EXT_ONLY 0x02 + +/* The following flag controls the translation of symbol names to upper + * case. This is currently only being implemented for OpenVMS. + */ +#define DSO_FLAG_UPCASE_SYMBOL 0x10 + +/* This flag loads the library with public symbols. + * Meaning: The exported symbols of this library are public + * to all libraries loaded after this library. + * At the moment only implemented in unix. + */ +#define DSO_FLAG_GLOBAL_SYMBOLS 0x20 + + +typedef void (*DSO_FUNC_TYPE)(void); + +typedef struct dso_st DSO; + +/* The function prototype used for method functions (or caller-provided + * callbacks) that transform filenames. They are passed a DSO structure pointer + * (or NULL if they are to be used independantly of a DSO object) and a + * filename to transform. They should either return NULL (if there is an error + * condition) or a newly allocated string containing the transformed form that + * the caller will need to free with OPENSSL_free() when done. */ +typedef char* (*DSO_NAME_CONVERTER_FUNC)(DSO *, const char *); +/* The function prototype used for method functions (or caller-provided + * callbacks) that merge two file specifications. They are passed a + * DSO structure pointer (or NULL if they are to be used independantly of + * a DSO object) and two file specifications to merge. They should + * either return NULL (if there is an error condition) or a newly allocated + * string containing the result of merging that the caller will need + * to free with OPENSSL_free() when done. + * Here, merging means that bits and pieces are taken from each of the + * file specifications and added together in whatever fashion that is + * sensible for the DSO method in question. The only rule that really + * applies is that if the two specification contain pieces of the same + * type, the copy from the first string takes priority. One could see + * it as the first specification is the one given by the user and the + * second being a bunch of defaults to add on if they're missing in the + * first. */ +typedef char* (*DSO_MERGER_FUNC)(DSO *, const char *, const char *); + +typedef struct dso_meth_st + { + const char *name; + /* Loads a shared library, NB: new DSO_METHODs must ensure that a + * successful load populates the loaded_filename field, and likewise a + * successful unload OPENSSL_frees and NULLs it out. */ + int (*dso_load)(DSO *dso); + /* Unloads a shared library */ + int (*dso_unload)(DSO *dso); + /* Binds a variable */ + void *(*dso_bind_var)(DSO *dso, const char *symname); + /* Binds a function - assumes a return type of DSO_FUNC_TYPE. + * This should be cast to the real function prototype by the + * caller. Platforms that don't have compatible representations + * for different prototypes (this is possible within ANSI C) + * are highly unlikely to have shared libraries at all, let + * alone a DSO_METHOD implemented for them. */ + DSO_FUNC_TYPE (*dso_bind_func)(DSO *dso, const char *symname); + +/* I don't think this would actually be used in any circumstances. */ +#if 0 + /* Unbinds a variable */ + int (*dso_unbind_var)(DSO *dso, char *symname, void *symptr); + /* Unbinds a function */ + int (*dso_unbind_func)(DSO *dso, char *symname, DSO_FUNC_TYPE symptr); +#endif + /* The generic (yuck) "ctrl()" function. NB: Negative return + * values (rather than zero) indicate errors. */ + long (*dso_ctrl)(DSO *dso, int cmd, long larg, void *parg); + /* The default DSO_METHOD-specific function for converting filenames to + * a canonical native form. */ + DSO_NAME_CONVERTER_FUNC dso_name_converter; + /* The default DSO_METHOD-specific function for converting filenames to + * a canonical native form. */ + DSO_MERGER_FUNC dso_merger; + + /* [De]Initialisation handlers. */ + int (*init)(DSO *dso); + int (*finish)(DSO *dso); + + /* Return pathname of the module containing location */ + int (*pathbyaddr)(void *addr,char *path,int sz); + /* Perform global symbol lookup, i.e. among *all* modules */ + void *(*globallookup)(const char *symname); + } DSO_METHOD; + +/**********************************************************************/ +/* The low-level handle type used to refer to a loaded shared library */ + +struct dso_st + { + DSO_METHOD *meth; + /* Standard dlopen uses a (void *). Win32 uses a HANDLE. VMS + * doesn't use anything but will need to cache the filename + * for use in the dso_bind handler. All in all, let each + * method control its own destiny. "Handles" and such go in + * a STACK. */ + STACK_OF(void) *meth_data; + int references; + int flags; + /* For use by applications etc ... use this for your bits'n'pieces, + * don't touch meth_data! */ + CRYPTO_EX_DATA ex_data; + /* If this callback function pointer is set to non-NULL, then it will + * be used in DSO_load() in place of meth->dso_name_converter. NB: This + * should normally set using DSO_set_name_converter(). */ + DSO_NAME_CONVERTER_FUNC name_converter; + /* If this callback function pointer is set to non-NULL, then it will + * be used in DSO_load() in place of meth->dso_merger. NB: This + * should normally set using DSO_set_merger(). */ + DSO_MERGER_FUNC merger; + /* This is populated with (a copy of) the platform-independant + * filename used for this DSO. */ + char *filename; + /* This is populated with (a copy of) the translated filename by which + * the DSO was actually loaded. It is NULL iff the DSO is not currently + * loaded. NB: This is here because the filename translation process + * may involve a callback being invoked more than once not only to + * convert to a platform-specific form, but also to try different + * filenames in the process of trying to perform a load. As such, this + * variable can be used to indicate (a) whether this DSO structure + * corresponds to a loaded library or not, and (b) the filename with + * which it was actually loaded. */ + char *loaded_filename; + }; + + +DSO * DSO_new(void); +DSO * DSO_new_method(DSO_METHOD *method); +int DSO_free(DSO *dso); +int DSO_flags(DSO *dso); +int DSO_up_ref(DSO *dso); +long DSO_ctrl(DSO *dso, int cmd, long larg, void *parg); + +/* This function sets the DSO's name_converter callback. If it is non-NULL, + * then it will be used instead of the associated DSO_METHOD's function. If + * oldcb is non-NULL then it is set to the function pointer value being + * replaced. Return value is non-zero for success. */ +int DSO_set_name_converter(DSO *dso, DSO_NAME_CONVERTER_FUNC cb, + DSO_NAME_CONVERTER_FUNC *oldcb); +/* These functions can be used to get/set the platform-independant filename + * used for a DSO. NB: set will fail if the DSO is already loaded. */ +const char *DSO_get_filename(DSO *dso); +int DSO_set_filename(DSO *dso, const char *filename); +/* This function will invoke the DSO's name_converter callback to translate a + * filename, or if the callback isn't set it will instead use the DSO_METHOD's + * converter. If "filename" is NULL, the "filename" in the DSO itself will be + * used. If the DSO_FLAG_NO_NAME_TRANSLATION flag is set, then the filename is + * simply duplicated. NB: This function is usually called from within a + * DSO_METHOD during the processing of a DSO_load() call, and is exposed so that + * caller-created DSO_METHODs can do the same thing. A non-NULL return value + * will need to be OPENSSL_free()'d. */ +char *DSO_convert_filename(DSO *dso, const char *filename); +/* This function will invoke the DSO's merger callback to merge two file + * specifications, or if the callback isn't set it will instead use the + * DSO_METHOD's merger. A non-NULL return value will need to be + * OPENSSL_free()'d. */ +char *DSO_merge(DSO *dso, const char *filespec1, const char *filespec2); +/* If the DSO is currently loaded, this returns the filename that it was loaded + * under, otherwise it returns NULL. So it is also useful as a test as to + * whether the DSO is currently loaded. NB: This will not necessarily return + * the same value as DSO_convert_filename(dso, dso->filename), because the + * DSO_METHOD's load function may have tried a variety of filenames (with + * and/or without the aid of the converters) before settling on the one it + * actually loaded. */ +const char *DSO_get_loaded_filename(DSO *dso); + +void DSO_set_default_method(DSO_METHOD *meth); +DSO_METHOD *DSO_get_default_method(void); +DSO_METHOD *DSO_get_method(DSO *dso); +DSO_METHOD *DSO_set_method(DSO *dso, DSO_METHOD *meth); + +/* The all-singing all-dancing load function, you normally pass NULL + * for the first and third parameters. Use DSO_up and DSO_free for + * subsequent reference count handling. Any flags passed in will be set + * in the constructed DSO after its init() function but before the + * load operation. If 'dso' is non-NULL, 'flags' is ignored. */ +DSO *DSO_load(DSO *dso, const char *filename, DSO_METHOD *meth, int flags); + +/* This function binds to a variable inside a shared library. */ +void *DSO_bind_var(DSO *dso, const char *symname); + +/* This function binds to a function inside a shared library. */ +DSO_FUNC_TYPE DSO_bind_func(DSO *dso, const char *symname); + +/* This method is the default, but will beg, borrow, or steal whatever + * method should be the default on any particular platform (including + * DSO_METH_null() if necessary). */ +DSO_METHOD *DSO_METHOD_openssl(void); + +/* This method is defined for all platforms - if a platform has no + * DSO support then this will be the only method! */ +DSO_METHOD *DSO_METHOD_null(void); + +/* If DSO_DLFCN is defined, the standard dlfcn.h-style functions + * (dlopen, dlclose, dlsym, etc) will be used and incorporated into + * this method. If not, this method will return NULL. */ +DSO_METHOD *DSO_METHOD_dlfcn(void); + +/* If DSO_DL is defined, the standard dl.h-style functions (shl_load, + * shl_unload, shl_findsym, etc) will be used and incorporated into + * this method. If not, this method will return NULL. */ +DSO_METHOD *DSO_METHOD_dl(void); + +/* If WIN32 is defined, use DLLs. If not, return NULL. */ +DSO_METHOD *DSO_METHOD_win32(void); + +/* If VMS is defined, use shared images. If not, return NULL. */ +DSO_METHOD *DSO_METHOD_vms(void); + +/* This function writes null-terminated pathname of DSO module + * containing 'addr' into 'sz' large caller-provided 'path' and + * returns the number of characters [including trailing zero] + * written to it. If 'sz' is 0 or negative, 'path' is ignored and + * required amount of charachers [including trailing zero] to + * accomodate pathname is returned. If 'addr' is NULL, then + * pathname of cryptolib itself is returned. Negative or zero + * return value denotes error. + */ +int DSO_pathbyaddr(void *addr,char *path,int sz); + +/* This function should be used with caution! It looks up symbols in + * *all* loaded modules and if module gets unloaded by somebody else + * attempt to dereference the pointer is doomed to have fatal + * consequences. Primary usage for this function is to probe *core* + * system functionality, e.g. check if getnameinfo(3) is available + * at run-time without bothering about OS-specific details such as + * libc.so.versioning or where does it actually reside: in libc + * itself or libsocket. */ +void *DSO_global_lookup(const char *name); + +/* If BeOS is defined, use shared images. If not, return NULL. */ +DSO_METHOD *DSO_METHOD_beos(void); + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_DSO_strings(void); + +/* Error codes for the DSO functions. */ + +/* Function codes. */ +#define DSO_F_BEOS_BIND_FUNC 144 +#define DSO_F_BEOS_BIND_VAR 145 +#define DSO_F_BEOS_LOAD 146 +#define DSO_F_BEOS_NAME_CONVERTER 147 +#define DSO_F_BEOS_UNLOAD 148 +#define DSO_F_DLFCN_BIND_FUNC 100 +#define DSO_F_DLFCN_BIND_VAR 101 +#define DSO_F_DLFCN_LOAD 102 +#define DSO_F_DLFCN_MERGER 130 +#define DSO_F_DLFCN_NAME_CONVERTER 123 +#define DSO_F_DLFCN_UNLOAD 103 +#define DSO_F_DL_BIND_FUNC 104 +#define DSO_F_DL_BIND_VAR 105 +#define DSO_F_DL_LOAD 106 +#define DSO_F_DL_MERGER 131 +#define DSO_F_DL_NAME_CONVERTER 124 +#define DSO_F_DL_UNLOAD 107 +#define DSO_F_DSO_BIND_FUNC 108 +#define DSO_F_DSO_BIND_VAR 109 +#define DSO_F_DSO_CONVERT_FILENAME 126 +#define DSO_F_DSO_CTRL 110 +#define DSO_F_DSO_FREE 111 +#define DSO_F_DSO_GET_FILENAME 127 +#define DSO_F_DSO_GET_LOADED_FILENAME 128 +#define DSO_F_DSO_GLOBAL_LOOKUP 139 +#define DSO_F_DSO_LOAD 112 +#define DSO_F_DSO_MERGE 132 +#define DSO_F_DSO_NEW_METHOD 113 +#define DSO_F_DSO_PATHBYADDR 140 +#define DSO_F_DSO_SET_FILENAME 129 +#define DSO_F_DSO_SET_NAME_CONVERTER 122 +#define DSO_F_DSO_UP_REF 114 +#define DSO_F_GLOBAL_LOOKUP_FUNC 138 +#define DSO_F_PATHBYADDR 137 +#define DSO_F_VMS_BIND_SYM 115 +#define DSO_F_VMS_LOAD 116 +#define DSO_F_VMS_MERGER 133 +#define DSO_F_VMS_UNLOAD 117 +#define DSO_F_WIN32_BIND_FUNC 118 +#define DSO_F_WIN32_BIND_VAR 119 +#define DSO_F_WIN32_GLOBALLOOKUP 142 +#define DSO_F_WIN32_GLOBALLOOKUP_FUNC 143 +#define DSO_F_WIN32_JOINER 135 +#define DSO_F_WIN32_LOAD 120 +#define DSO_F_WIN32_MERGER 134 +#define DSO_F_WIN32_NAME_CONVERTER 125 +#define DSO_F_WIN32_PATHBYADDR 141 +#define DSO_F_WIN32_SPLITTER 136 +#define DSO_F_WIN32_UNLOAD 121 + +/* Reason codes. */ +#define DSO_R_CTRL_FAILED 100 +#define DSO_R_DSO_ALREADY_LOADED 110 +#define DSO_R_EMPTY_FILE_STRUCTURE 113 +#define DSO_R_FAILURE 114 +#define DSO_R_FILENAME_TOO_BIG 101 +#define DSO_R_FINISH_FAILED 102 +#define DSO_R_INCORRECT_FILE_SYNTAX 115 +#define DSO_R_LOAD_FAILED 103 +#define DSO_R_NAME_TRANSLATION_FAILED 109 +#define DSO_R_NO_FILENAME 111 +#define DSO_R_NO_FILE_SPECIFICATION 116 +#define DSO_R_NULL_HANDLE 104 +#define DSO_R_SET_FILENAME_FAILED 112 +#define DSO_R_STACK_ERROR 105 +#define DSO_R_SYM_FAILURE 106 +#define DSO_R_UNLOAD_FAILED 107 +#define DSO_R_UNSUPPORTED 108 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/dtls1.h b/Source/Import/OpenSSL/Include/openssl/dtls1.h new file mode 100644 index 0000000..5008bf6 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/dtls1.h @@ -0,0 +1,283 @@ +/* ssl/dtls1.h */ +/* + * DTLS implementation written by Nagendra Modadugu + * (nagendra@cs.stanford.edu) for the OpenSSL project 2005. + */ +/* ==================================================================== + * Copyright (c) 1999-2005 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_DTLS1_H +#define HEADER_DTLS1_H + +#include +#include +#ifdef OPENSSL_SYS_VMS +#include +#include +#endif +#ifdef OPENSSL_SYS_WIN32 +/* Needed for struct timeval */ +#include +#elif defined(OPENSSL_SYS_NETWARE) && !defined(_WINSOCK2API_) +#include +#else +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#define DTLS1_VERSION 0xFEFF +#define DTLS1_BAD_VER 0x0100 + +#if 0 +/* this alert description is not specified anywhere... */ +#define DTLS1_AD_MISSING_HANDSHAKE_MESSAGE 110 +#endif + +/* lengths of messages */ +#define DTLS1_COOKIE_LENGTH 256 + +#define DTLS1_RT_HEADER_LENGTH 13 + +#define DTLS1_HM_HEADER_LENGTH 12 + +#define DTLS1_HM_BAD_FRAGMENT -2 +#define DTLS1_HM_FRAGMENT_RETRY -3 + +#define DTLS1_CCS_HEADER_LENGTH 1 + +#ifdef DTLS1_AD_MISSING_HANDSHAKE_MESSAGE +#define DTLS1_AL_HEADER_LENGTH 7 +#else +#define DTLS1_AL_HEADER_LENGTH 2 +#endif + +#ifndef OPENSSL_NO_SSL_INTERN + +#ifndef OPENSSL_NO_SCTP +#define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP" +#endif + +typedef struct dtls1_bitmap_st + { + unsigned long map; /* track 32 packets on 32-bit systems + and 64 - on 64-bit systems */ + unsigned char max_seq_num[8]; /* max record number seen so far, + 64-bit value in big-endian + encoding */ + } DTLS1_BITMAP; + +struct dtls1_retransmit_state + { + EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */ + EVP_MD_CTX *write_hash; /* used for mac generation */ +#ifndef OPENSSL_NO_COMP + COMP_CTX *compress; /* compression */ +#else + char *compress; +#endif + SSL_SESSION *session; + unsigned short epoch; + }; + +struct hm_header_st + { + unsigned char type; + unsigned long msg_len; + unsigned short seq; + unsigned long frag_off; + unsigned long frag_len; + unsigned int is_ccs; + struct dtls1_retransmit_state saved_retransmit_state; + }; + +struct ccs_header_st + { + unsigned char type; + unsigned short seq; + }; + +struct dtls1_timeout_st + { + /* Number of read timeouts so far */ + unsigned int read_timeouts; + + /* Number of write timeouts so far */ + unsigned int write_timeouts; + + /* Number of alerts received so far */ + unsigned int num_alerts; + }; + +typedef struct record_pqueue_st + { + unsigned short epoch; + pqueue q; + } record_pqueue; + +typedef struct hm_fragment_st + { + struct hm_header_st msg_header; + unsigned char *fragment; + unsigned char *reassembly; + } hm_fragment; + +typedef struct dtls1_state_st + { + unsigned int send_cookie; + unsigned char cookie[DTLS1_COOKIE_LENGTH]; + unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH]; + unsigned int cookie_len; + + /* + * The current data and handshake epoch. This is initially + * undefined, and starts at zero once the initial handshake is + * completed + */ + unsigned short r_epoch; + unsigned short w_epoch; + + /* records being received in the current epoch */ + DTLS1_BITMAP bitmap; + + /* renegotiation starts a new set of sequence numbers */ + DTLS1_BITMAP next_bitmap; + + /* handshake message numbers */ + unsigned short handshake_write_seq; + unsigned short next_handshake_write_seq; + + unsigned short handshake_read_seq; + + /* save last sequence number for retransmissions */ + unsigned char last_write_sequence[8]; + + /* Received handshake records (processed and unprocessed) */ + record_pqueue unprocessed_rcds; + record_pqueue processed_rcds; + + /* Buffered handshake messages */ + pqueue buffered_messages; + + /* Buffered (sent) handshake records */ + pqueue sent_messages; + + /* Buffered application records. + * Only for records between CCS and Finished + * to prevent either protocol violation or + * unnecessary message loss. + */ + record_pqueue buffered_app_data; + + /* Is set when listening for new connections with dtls1_listen() */ + unsigned int listen; + + unsigned int mtu; /* max DTLS packet size */ + + struct hm_header_st w_msg_hdr; + struct hm_header_st r_msg_hdr; + + struct dtls1_timeout_st timeout; + + /* Indicates when the last handshake msg or heartbeat sent will timeout */ + struct timeval next_timeout; + + /* Timeout duration */ + unsigned short timeout_duration; + + /* storage for Alert/Handshake protocol data received but not + * yet processed by ssl3_read_bytes: */ + unsigned char alert_fragment[DTLS1_AL_HEADER_LENGTH]; + unsigned int alert_fragment_len; + unsigned char handshake_fragment[DTLS1_HM_HEADER_LENGTH]; + unsigned int handshake_fragment_len; + + unsigned int retransmitting; + unsigned int change_cipher_spec_ok; + +#ifndef OPENSSL_NO_SCTP + /* used when SSL_ST_XX_FLUSH is entered */ + int next_state; + + int shutdown_received; +#endif + + } DTLS1_STATE; + +typedef struct dtls1_record_data_st + { + unsigned char *packet; + unsigned int packet_length; + SSL3_BUFFER rbuf; + SSL3_RECORD rrec; +#ifndef OPENSSL_NO_SCTP + struct bio_dgram_sctp_rcvinfo recordinfo; +#endif + } DTLS1_RECORD_DATA; + +#endif + +/* Timeout multipliers (timeout slice is defined in apps/timeouts.h */ +#define DTLS1_TMO_READ_COUNT 2 +#define DTLS1_TMO_WRITE_COUNT 2 + +#define DTLS1_TMO_ALERT_COUNT 12 + +#ifdef __cplusplus +} +#endif +#endif + diff --git a/Source/Import/OpenSSL/Include/openssl/e_os2.h b/Source/Import/OpenSSL/Include/openssl/e_os2.h new file mode 100644 index 0000000..d22c036 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/e_os2.h @@ -0,0 +1,315 @@ +/* e_os2.h */ +/* ==================================================================== + * Copyright (c) 1998-2000 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#include + +#ifndef HEADER_E_OS2_H +#define HEADER_E_OS2_H + +#ifdef __cplusplus +extern "C" { +#endif + +/****************************************************************************** + * Detect operating systems. This probably needs completing. + * The result is that at least one OPENSSL_SYS_os macro should be defined. + * However, if none is defined, Unix is assumed. + **/ + +#define OPENSSL_SYS_UNIX + +/* ----------------------- Macintosh, before MacOS X ----------------------- */ +#if defined(__MWERKS__) && defined(macintosh) || defined(OPENSSL_SYSNAME_MAC) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_MACINTOSH_CLASSIC +#endif + +/* ----------------------- NetWare ----------------------------------------- */ +#if defined(NETWARE) || defined(OPENSSL_SYSNAME_NETWARE) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_NETWARE +#endif + +/* ---------------------- Microsoft operating systems ---------------------- */ + +/* Note that MSDOS actually denotes 32-bit environments running on top of + MS-DOS, such as DJGPP one. */ +#if defined(OPENSSL_SYSNAME_MSDOS) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_MSDOS +#endif + +/* For 32 bit environment, there seems to be the CygWin environment and then + all the others that try to do the same thing Microsoft does... */ +#if defined(OPENSSL_SYSNAME_UWIN) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_WIN32_UWIN +#else +# if defined(__CYGWIN32__) || defined(OPENSSL_SYSNAME_CYGWIN32) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_WIN32_CYGWIN +# else +# if defined(_WIN32) || defined(OPENSSL_SYSNAME_WIN32) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_WIN32 +# endif +# if defined(OPENSSL_SYSNAME_WINNT) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_WINNT +# endif +# if defined(OPENSSL_SYSNAME_WINCE) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_WINCE +# endif +# endif +#endif + +/* Anything that tries to look like Microsoft is "Windows" */ +#if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINNT) || defined(OPENSSL_SYS_WINCE) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_WINDOWS +# ifndef OPENSSL_SYS_MSDOS +# define OPENSSL_SYS_MSDOS +# endif +#endif + +/* DLL settings. This part is a bit tough, because it's up to the application + implementor how he or she will link the application, so it requires some + macro to be used. */ +#ifdef OPENSSL_SYS_WINDOWS +# ifndef OPENSSL_OPT_WINDLL +# if defined(_WINDLL) /* This is used when building OpenSSL to indicate that + DLL linkage should be used */ +# define OPENSSL_OPT_WINDLL +# endif +# endif +#endif + +/* -------------------------------- OpenVMS -------------------------------- */ +#if defined(__VMS) || defined(VMS) || defined(OPENSSL_SYSNAME_VMS) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_VMS +# if defined(__DECC) +# define OPENSSL_SYS_VMS_DECC +# elif defined(__DECCXX) +# define OPENSSL_SYS_VMS_DECC +# define OPENSSL_SYS_VMS_DECCXX +# else +# define OPENSSL_SYS_VMS_NODECC +# endif +#endif + +/* --------------------------------- OS/2 ---------------------------------- */ +#if defined(__EMX__) || defined(__OS2__) +# undef OPENSSL_SYS_UNIX +# define OPENSSL_SYS_OS2 +#endif + +/* --------------------------------- Unix ---------------------------------- */ +#ifdef OPENSSL_SYS_UNIX +# if defined(linux) || defined(__linux__) || defined(OPENSSL_SYSNAME_LINUX) +# define OPENSSL_SYS_LINUX +# endif +# ifdef OPENSSL_SYSNAME_MPE +# define OPENSSL_SYS_MPE +# endif +# ifdef OPENSSL_SYSNAME_SNI +# define OPENSSL_SYS_SNI +# endif +# ifdef OPENSSL_SYSNAME_ULTRASPARC +# define OPENSSL_SYS_ULTRASPARC +# endif +# ifdef OPENSSL_SYSNAME_NEWS4 +# define OPENSSL_SYS_NEWS4 +# endif +# ifdef OPENSSL_SYSNAME_MACOSX +# define OPENSSL_SYS_MACOSX +# endif +# ifdef OPENSSL_SYSNAME_MACOSX_RHAPSODY +# define OPENSSL_SYS_MACOSX_RHAPSODY +# define OPENSSL_SYS_MACOSX +# endif +# ifdef OPENSSL_SYSNAME_SUNOS +# define OPENSSL_SYS_SUNOS +#endif +# if defined(_CRAY) || defined(OPENSSL_SYSNAME_CRAY) +# define OPENSSL_SYS_CRAY +# endif +# if defined(_AIX) || defined(OPENSSL_SYSNAME_AIX) +# define OPENSSL_SYS_AIX +# endif +#endif + +/* --------------------------------- VOS ----------------------------------- */ +#if defined(__VOS__) || defined(OPENSSL_SYSNAME_VOS) +# define OPENSSL_SYS_VOS +#ifdef __HPPA__ +# define OPENSSL_SYS_VOS_HPPA +#endif +#ifdef __IA32__ +# define OPENSSL_SYS_VOS_IA32 +#endif +#endif + +/* ------------------------------- VxWorks --------------------------------- */ +#ifdef OPENSSL_SYSNAME_VXWORKS +# define OPENSSL_SYS_VXWORKS +#endif + +/* --------------------------------- BeOS ---------------------------------- */ +#if defined(__BEOS__) +# define OPENSSL_SYS_BEOS +# include +# if defined(BONE_VERSION) +# define OPENSSL_SYS_BEOS_BONE +# else +# define OPENSSL_SYS_BEOS_R5 +# endif +#endif + +/** + * That's it for OS-specific stuff + *****************************************************************************/ + + +/* Specials for I/O an exit */ +#ifdef OPENSSL_SYS_MSDOS +# define OPENSSL_UNISTD_IO +# define OPENSSL_DECLARE_EXIT extern void exit(int); +#else +# define OPENSSL_UNISTD_IO OPENSSL_UNISTD +# define OPENSSL_DECLARE_EXIT /* declared in unistd.h */ +#endif + +/* Definitions of OPENSSL_GLOBAL and OPENSSL_EXTERN, to define and declare + certain global symbols that, with some compilers under VMS, have to be + defined and declared explicitely with globaldef and globalref. + Definitions of OPENSSL_EXPORT and OPENSSL_IMPORT, to define and declare + DLL exports and imports for compilers under Win32. These are a little + more complicated to use. Basically, for any library that exports some + global variables, the following code must be present in the header file + that declares them, before OPENSSL_EXTERN is used: + + #ifdef SOME_BUILD_FLAG_MACRO + # undef OPENSSL_EXTERN + # define OPENSSL_EXTERN OPENSSL_EXPORT + #endif + + The default is to have OPENSSL_EXPORT, OPENSSL_IMPORT and OPENSSL_GLOBAL + have some generally sensible values, and for OPENSSL_EXTERN to have the + value OPENSSL_IMPORT. +*/ + +#if defined(OPENSSL_SYS_VMS_NODECC) +# define OPENSSL_EXPORT globalref +# define OPENSSL_IMPORT globalref +# define OPENSSL_GLOBAL globaldef +#elif defined(OPENSSL_SYS_WINDOWS) && defined(OPENSSL_OPT_WINDLL) +# define OPENSSL_EXPORT extern __declspec(dllexport) +# define OPENSSL_IMPORT extern __declspec(dllimport) +# define OPENSSL_GLOBAL +#else +# define OPENSSL_EXPORT extern +# define OPENSSL_IMPORT extern +# define OPENSSL_GLOBAL +#endif +#define OPENSSL_EXTERN OPENSSL_IMPORT + +/* Macros to allow global variables to be reached through function calls when + required (if a shared library version requires it, for example. + The way it's done allows definitions like this: + + // in foobar.c + OPENSSL_IMPLEMENT_GLOBAL(int,foobar,0) + // in foobar.h + OPENSSL_DECLARE_GLOBAL(int,foobar); + #define foobar OPENSSL_GLOBAL_REF(foobar) +*/ +#ifdef OPENSSL_EXPORT_VAR_AS_FUNCTION +# define OPENSSL_IMPLEMENT_GLOBAL(type,name,value) \ + type *_shadow_##name(void) \ + { static type _hide_##name=value; return &_hide_##name; } +# define OPENSSL_DECLARE_GLOBAL(type,name) type *_shadow_##name(void) +# define OPENSSL_GLOBAL_REF(name) (*(_shadow_##name())) +#else +# define OPENSSL_IMPLEMENT_GLOBAL(type,name,value) OPENSSL_GLOBAL type _shadow_##name=value; +# define OPENSSL_DECLARE_GLOBAL(type,name) OPENSSL_EXPORT type _shadow_##name +# define OPENSSL_GLOBAL_REF(name) _shadow_##name +#endif + +#if defined(OPENSSL_SYS_MACINTOSH_CLASSIC) && macintosh==1 && !defined(MAC_OS_GUSI_SOURCE) +# define ossl_ssize_t long +#endif + +#ifdef OPENSSL_SYS_MSDOS +# define ossl_ssize_t long +#endif + +#if defined(NeXT) || defined(OPENSSL_SYS_NEWS4) || defined(OPENSSL_SYS_SUNOS) +# define ssize_t int +#endif + +#if defined(__ultrix) && !defined(ssize_t) +# define ossl_ssize_t int +#endif + +#ifndef ossl_ssize_t +# define ossl_ssize_t ssize_t +#endif + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/ebcdic.h b/Source/Import/OpenSSL/Include/openssl/ebcdic.h new file mode 100644 index 0000000..6d65afc --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ebcdic.h @@ -0,0 +1,19 @@ +/* crypto/ebcdic.h */ + +#ifndef HEADER_EBCDIC_H +#define HEADER_EBCDIC_H + +#include + +/* Avoid name clashes with other applications */ +#define os_toascii _openssl_os_toascii +#define os_toebcdic _openssl_os_toebcdic +#define ebcdic2ascii _openssl_ebcdic2ascii +#define ascii2ebcdic _openssl_ascii2ebcdic + +extern const unsigned char os_toascii[256]; +extern const unsigned char os_toebcdic[256]; +void *ebcdic2ascii(void *dest, const void *srce, size_t count); +void *ascii2ebcdic(void *dest, const void *srce, size_t count); + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/ec.h b/Source/Import/OpenSSL/Include/openssl/ec.h new file mode 100644 index 0000000..9d01325 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ec.h @@ -0,0 +1,1159 @@ +/* crypto/ec/ec.h */ +/* + * Originally written by Bodo Moeller for the OpenSSL project. + */ +/** + * \file crypto/ec/ec.h Include file for the OpenSSL EC functions + * \author Originally written by Bodo Moeller for the OpenSSL project + */ +/* ==================================================================== + * Copyright (c) 1998-2005 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +/* ==================================================================== + * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. + * + * Portions of the attached software ("Contribution") are developed by + * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project. + * + * The Contribution is licensed pursuant to the OpenSSL open source + * license provided above. + * + * The elliptic curve binary polynomial software is originally written by + * Sheueling Chang Shantz and Douglas Stebila of Sun Microsystems Laboratories. + * + */ + +#ifndef HEADER_EC_H +#define HEADER_EC_H + +#include + +#ifdef OPENSSL_NO_EC +#error EC is disabled. +#endif + +#include +#include +#ifndef OPENSSL_NO_DEPRECATED +#include +#endif + +#ifdef __cplusplus +extern "C" { +#elif defined(__SUNPRO_C) +# if __SUNPRO_C >= 0x520 +# pragma error_messages (off,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE) +# endif +#endif + + +#ifndef OPENSSL_ECC_MAX_FIELD_BITS +# define OPENSSL_ECC_MAX_FIELD_BITS 661 +#endif + +/** Enum for the point conversion form as defined in X9.62 (ECDSA) + * for the encoding of a elliptic curve point (x,y) */ +typedef enum { + /** the point is encoded as z||x, where the octet z specifies + * which solution of the quadratic equation y is */ + POINT_CONVERSION_COMPRESSED = 2, + /** the point is encoded as z||x||y, where z is the octet 0x02 */ + POINT_CONVERSION_UNCOMPRESSED = 4, + /** the point is encoded as z||x||y, where the octet z specifies + * which solution of the quadratic equation y is */ + POINT_CONVERSION_HYBRID = 6 +} point_conversion_form_t; + + +typedef struct ec_method_st EC_METHOD; + +typedef struct ec_group_st + /* + EC_METHOD *meth; + -- field definition + -- curve coefficients + -- optional generator with associated information (order, cofactor) + -- optional extra data (precomputed table for fast computation of multiples of generator) + -- ASN1 stuff + */ + EC_GROUP; + +typedef struct ec_point_st EC_POINT; + + +/********************************************************************/ +/* EC_METHODs for curves over GF(p) */ +/********************************************************************/ + +/** Returns the basic GFp ec methods which provides the basis for the + * optimized methods. + * \return EC_METHOD object + */ +const EC_METHOD *EC_GFp_simple_method(void); + +/** Returns GFp methods using montgomery multiplication. + * \return EC_METHOD object + */ +const EC_METHOD *EC_GFp_mont_method(void); + +/** Returns GFp methods using optimized methods for NIST recommended curves + * \return EC_METHOD object + */ +const EC_METHOD *EC_GFp_nist_method(void); + +#ifndef OPENSSL_NO_EC_NISTP_64_GCC_128 +/** Returns 64-bit optimized methods for nistp224 + * \return EC_METHOD object + */ +const EC_METHOD *EC_GFp_nistp224_method(void); + +/** Returns 64-bit optimized methods for nistp256 + * \return EC_METHOD object + */ +const EC_METHOD *EC_GFp_nistp256_method(void); + +/** Returns 64-bit optimized methods for nistp521 + * \return EC_METHOD object + */ +const EC_METHOD *EC_GFp_nistp521_method(void); +#endif + +#ifndef OPENSSL_NO_EC2M +/********************************************************************/ +/* EC_METHOD for curves over GF(2^m) */ +/********************************************************************/ + +/** Returns the basic GF2m ec method + * \return EC_METHOD object + */ +const EC_METHOD *EC_GF2m_simple_method(void); + +#endif + + +/********************************************************************/ +/* EC_GROUP functions */ +/********************************************************************/ + +/** Creates a new EC_GROUP object + * \param meth EC_METHOD to use + * \return newly created EC_GROUP object or NULL in case of an error. + */ +EC_GROUP *EC_GROUP_new(const EC_METHOD *meth); + +/** Frees a EC_GROUP object + * \param group EC_GROUP object to be freed. + */ +void EC_GROUP_free(EC_GROUP *group); + +/** Clears and frees a EC_GROUP object + * \param group EC_GROUP object to be cleared and freed. + */ +void EC_GROUP_clear_free(EC_GROUP *group); + +/** Copies EC_GROUP objects. Note: both EC_GROUPs must use the same EC_METHOD. + * \param dst destination EC_GROUP object + * \param src source EC_GROUP object + * \return 1 on success and 0 if an error occurred. + */ +int EC_GROUP_copy(EC_GROUP *dst, const EC_GROUP *src); + +/** Creates a new EC_GROUP object and copies the copies the content + * form src to the newly created EC_KEY object + * \param src source EC_GROUP object + * \return newly created EC_GROUP object or NULL in case of an error. + */ +EC_GROUP *EC_GROUP_dup(const EC_GROUP *src); + +/** Returns the EC_METHOD of the EC_GROUP object. + * \param group EC_GROUP object + * \return EC_METHOD used in this EC_GROUP object. + */ +const EC_METHOD *EC_GROUP_method_of(const EC_GROUP *group); + +/** Returns the field type of the EC_METHOD. + * \param meth EC_METHOD object + * \return NID of the underlying field type OID. + */ +int EC_METHOD_get_field_type(const EC_METHOD *meth); + +/** Sets the generator and it's order/cofactor of a EC_GROUP object. + * \param group EC_GROUP object + * \param generator EC_POINT object with the generator. + * \param order the order of the group generated by the generator. + * \param cofactor the index of the sub-group generated by the generator + * in the group of all points on the elliptic curve. + * \return 1 on success and 0 if an error occured + */ +int EC_GROUP_set_generator(EC_GROUP *group, const EC_POINT *generator, const BIGNUM *order, const BIGNUM *cofactor); + +/** Returns the generator of a EC_GROUP object. + * \param group EC_GROUP object + * \return the currently used generator (possibly NULL). + */ +const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group); + +/** Gets the order of a EC_GROUP + * \param group EC_GROUP object + * \param order BIGNUM to which the order is copied + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx); + +/** Gets the cofactor of a EC_GROUP + * \param group EC_GROUP object + * \param cofactor BIGNUM to which the cofactor is copied + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx); + +/** Sets the name of a EC_GROUP object + * \param group EC_GROUP object + * \param nid NID of the curve name OID + */ +void EC_GROUP_set_curve_name(EC_GROUP *group, int nid); + +/** Returns the curve name of a EC_GROUP object + * \param group EC_GROUP object + * \return NID of the curve name OID or 0 if not set. + */ +int EC_GROUP_get_curve_name(const EC_GROUP *group); + +void EC_GROUP_set_asn1_flag(EC_GROUP *group, int flag); +int EC_GROUP_get_asn1_flag(const EC_GROUP *group); + +void EC_GROUP_set_point_conversion_form(EC_GROUP *, point_conversion_form_t); +point_conversion_form_t EC_GROUP_get_point_conversion_form(const EC_GROUP *); + +unsigned char *EC_GROUP_get0_seed(const EC_GROUP *); +size_t EC_GROUP_get_seed_len(const EC_GROUP *); +size_t EC_GROUP_set_seed(EC_GROUP *, const unsigned char *, size_t len); + +/** Sets the parameter of a ec over GFp defined by y^2 = x^3 + a*x + b + * \param group EC_GROUP object + * \param p BIGNUM with the prime number + * \param a BIGNUM with parameter a of the equation + * \param b BIGNUM with parameter b of the equation + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_GROUP_set_curve_GFp(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); + +/** Gets the parameter of the ec over GFp defined by y^2 = x^3 + a*x + b + * \param group EC_GROUP object + * \param p BIGNUM for the prime number + * \param a BIGNUM for parameter a of the equation + * \param b BIGNUM for parameter b of the equation + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_GROUP_get_curve_GFp(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx); + +#ifndef OPENSSL_NO_EC2M +/** Sets the parameter of a ec over GF2m defined by y^2 + x*y = x^3 + a*x^2 + b + * \param group EC_GROUP object + * \param p BIGNUM with the polynomial defining the underlying field + * \param a BIGNUM with parameter a of the equation + * \param b BIGNUM with parameter b of the equation + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_GROUP_set_curve_GF2m(EC_GROUP *group, const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); + +/** Gets the parameter of the ec over GF2m defined by y^2 + x*y = x^3 + a*x^2 + b + * \param group EC_GROUP object + * \param p BIGNUM for the polynomial defining the underlying field + * \param a BIGNUM for parameter a of the equation + * \param b BIGNUM for parameter b of the equation + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_GROUP_get_curve_GF2m(const EC_GROUP *group, BIGNUM *p, BIGNUM *a, BIGNUM *b, BN_CTX *ctx); +#endif +/** Returns the number of bits needed to represent a field element + * \param group EC_GROUP object + * \return number of bits needed to represent a field element + */ +int EC_GROUP_get_degree(const EC_GROUP *group); + +/** Checks whether the parameter in the EC_GROUP define a valid ec group + * \param group EC_GROUP object + * \param ctx BN_CTX object (optional) + * \return 1 if group is a valid ec group and 0 otherwise + */ +int EC_GROUP_check(const EC_GROUP *group, BN_CTX *ctx); + +/** Checks whether the discriminant of the elliptic curve is zero or not + * \param group EC_GROUP object + * \param ctx BN_CTX object (optional) + * \return 1 if the discriminant is not zero and 0 otherwise + */ +int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx); + +/** Compares two EC_GROUP objects + * \param a first EC_GROUP object + * \param b second EC_GROUP object + * \param ctx BN_CTX object (optional) + * \return 0 if both groups are equal and 1 otherwise + */ +int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx); + +/* EC_GROUP_new_GF*() calls EC_GROUP_new() and EC_GROUP_set_GF*() + * after choosing an appropriate EC_METHOD */ + +/** Creates a new EC_GROUP object with the specified parameters defined + * over GFp (defined by the equation y^2 = x^3 + a*x + b) + * \param p BIGNUM with the prime number + * \param a BIGNUM with the parameter a of the equation + * \param b BIGNUM with the parameter b of the equation + * \param ctx BN_CTX object (optional) + * \return newly created EC_GROUP object with the specified parameters + */ +EC_GROUP *EC_GROUP_new_curve_GFp(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); +#ifndef OPENSSL_NO_EC2M +/** Creates a new EC_GROUP object with the specified parameters defined + * over GF2m (defined by the equation y^2 + x*y = x^3 + a*x^2 + b) + * \param p BIGNUM with the polynomial defining the underlying field + * \param a BIGNUM with the parameter a of the equation + * \param b BIGNUM with the parameter b of the equation + * \param ctx BN_CTX object (optional) + * \return newly created EC_GROUP object with the specified parameters + */ +EC_GROUP *EC_GROUP_new_curve_GF2m(const BIGNUM *p, const BIGNUM *a, const BIGNUM *b, BN_CTX *ctx); +#endif +/** Creates a EC_GROUP object with a curve specified by a NID + * \param nid NID of the OID of the curve name + * \return newly created EC_GROUP object with specified curve or NULL + * if an error occurred + */ +EC_GROUP *EC_GROUP_new_by_curve_name(int nid); + + +/********************************************************************/ +/* handling of internal curves */ +/********************************************************************/ + +typedef struct { + int nid; + const char *comment; + } EC_builtin_curve; + +/* EC_builtin_curves(EC_builtin_curve *r, size_t size) returns number + * of all available curves or zero if a error occurred. + * In case r ist not zero nitems EC_builtin_curve structures + * are filled with the data of the first nitems internal groups */ +size_t EC_get_builtin_curves(EC_builtin_curve *r, size_t nitems); + + +/********************************************************************/ +/* EC_POINT functions */ +/********************************************************************/ + +/** Creates a new EC_POINT object for the specified EC_GROUP + * \param group EC_GROUP the underlying EC_GROUP object + * \return newly created EC_POINT object or NULL if an error occurred + */ +EC_POINT *EC_POINT_new(const EC_GROUP *group); + +/** Frees a EC_POINT object + * \param point EC_POINT object to be freed + */ +void EC_POINT_free(EC_POINT *point); + +/** Clears and frees a EC_POINT object + * \param point EC_POINT object to be cleared and freed + */ +void EC_POINT_clear_free(EC_POINT *point); + +/** Copies EC_POINT object + * \param dst destination EC_POINT object + * \param src source EC_POINT object + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_copy(EC_POINT *dst, const EC_POINT *src); + +/** Creates a new EC_POINT object and copies the content of the supplied + * EC_POINT + * \param src source EC_POINT object + * \param group underlying the EC_GROUP object + * \return newly created EC_POINT object or NULL if an error occurred + */ +EC_POINT *EC_POINT_dup(const EC_POINT *src, const EC_GROUP *group); + +/** Returns the EC_METHOD used in EC_POINT object + * \param point EC_POINT object + * \return the EC_METHOD used + */ +const EC_METHOD *EC_POINT_method_of(const EC_POINT *point); + +/** Sets a point to infinity (neutral element) + * \param group underlying EC_GROUP object + * \param point EC_POINT to set to infinity + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_set_to_infinity(const EC_GROUP *group, EC_POINT *point); + +/** Sets the jacobian projective coordinates of a EC_POINT over GFp + * \param group underlying EC_GROUP object + * \param p EC_POINT object + * \param x BIGNUM with the x-coordinate + * \param y BIGNUM with the y-coordinate + * \param z BIGNUM with the z-coordinate + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_set_Jprojective_coordinates_GFp(const EC_GROUP *group, EC_POINT *p, + const BIGNUM *x, const BIGNUM *y, const BIGNUM *z, BN_CTX *ctx); + +/** Gets the jacobian projective coordinates of a EC_POINT over GFp + * \param group underlying EC_GROUP object + * \param p EC_POINT object + * \param x BIGNUM for the x-coordinate + * \param y BIGNUM for the y-coordinate + * \param z BIGNUM for the z-coordinate + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_get_Jprojective_coordinates_GFp(const EC_GROUP *group, + const EC_POINT *p, BIGNUM *x, BIGNUM *y, BIGNUM *z, BN_CTX *ctx); + +/** Sets the affine coordinates of a EC_POINT over GFp + * \param group underlying EC_GROUP object + * \param p EC_POINT object + * \param x BIGNUM with the x-coordinate + * \param y BIGNUM with the y-coordinate + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_set_affine_coordinates_GFp(const EC_GROUP *group, EC_POINT *p, + const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx); + +/** Gets the affine coordinates of a EC_POINT over GFp + * \param group underlying EC_GROUP object + * \param p EC_POINT object + * \param x BIGNUM for the x-coordinate + * \param y BIGNUM for the y-coordinate + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_get_affine_coordinates_GFp(const EC_GROUP *group, + const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx); + +/** Sets the x9.62 compressed coordinates of a EC_POINT over GFp + * \param group underlying EC_GROUP object + * \param p EC_POINT object + * \param x BIGNUM with x-coordinate + * \param y_bit integer with the y-Bit (either 0 or 1) + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_set_compressed_coordinates_GFp(const EC_GROUP *group, EC_POINT *p, + const BIGNUM *x, int y_bit, BN_CTX *ctx); +#ifndef OPENSSL_NO_EC2M +/** Sets the affine coordinates of a EC_POINT over GF2m + * \param group underlying EC_GROUP object + * \param p EC_POINT object + * \param x BIGNUM with the x-coordinate + * \param y BIGNUM with the y-coordinate + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_set_affine_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p, + const BIGNUM *x, const BIGNUM *y, BN_CTX *ctx); + +/** Gets the affine coordinates of a EC_POINT over GF2m + * \param group underlying EC_GROUP object + * \param p EC_POINT object + * \param x BIGNUM for the x-coordinate + * \param y BIGNUM for the y-coordinate + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_get_affine_coordinates_GF2m(const EC_GROUP *group, + const EC_POINT *p, BIGNUM *x, BIGNUM *y, BN_CTX *ctx); + +/** Sets the x9.62 compressed coordinates of a EC_POINT over GF2m + * \param group underlying EC_GROUP object + * \param p EC_POINT object + * \param x BIGNUM with x-coordinate + * \param y_bit integer with the y-Bit (either 0 or 1) + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_set_compressed_coordinates_GF2m(const EC_GROUP *group, EC_POINT *p, + const BIGNUM *x, int y_bit, BN_CTX *ctx); +#endif +/** Encodes a EC_POINT object to a octet string + * \param group underlying EC_GROUP object + * \param p EC_POINT object + * \param form point conversion form + * \param buf memory buffer for the result. If NULL the function returns + * required buffer size. + * \param len length of the memory buffer + * \param ctx BN_CTX object (optional) + * \return the length of the encoded octet string or 0 if an error occurred + */ +size_t EC_POINT_point2oct(const EC_GROUP *group, const EC_POINT *p, + point_conversion_form_t form, + unsigned char *buf, size_t len, BN_CTX *ctx); + +/** Decodes a EC_POINT from a octet string + * \param group underlying EC_GROUP object + * \param p EC_POINT object + * \param buf memory buffer with the encoded ec point + * \param len length of the encoded ec point + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_oct2point(const EC_GROUP *group, EC_POINT *p, + const unsigned char *buf, size_t len, BN_CTX *ctx); + +/* other interfaces to point2oct/oct2point: */ +BIGNUM *EC_POINT_point2bn(const EC_GROUP *, const EC_POINT *, + point_conversion_form_t form, BIGNUM *, BN_CTX *); +EC_POINT *EC_POINT_bn2point(const EC_GROUP *, const BIGNUM *, + EC_POINT *, BN_CTX *); +char *EC_POINT_point2hex(const EC_GROUP *, const EC_POINT *, + point_conversion_form_t form, BN_CTX *); +EC_POINT *EC_POINT_hex2point(const EC_GROUP *, const char *, + EC_POINT *, BN_CTX *); + + +/********************************************************************/ +/* functions for doing EC_POINT arithmetic */ +/********************************************************************/ + +/** Computes the sum of two EC_POINT + * \param group underlying EC_GROUP object + * \param r EC_POINT object for the result (r = a + b) + * \param a EC_POINT object with the first summand + * \param b EC_POINT object with the second summand + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_add(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx); + +/** Computes the double of a EC_POINT + * \param group underlying EC_GROUP object + * \param r EC_POINT object for the result (r = 2 * a) + * \param a EC_POINT object + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_dbl(const EC_GROUP *group, EC_POINT *r, const EC_POINT *a, BN_CTX *ctx); + +/** Computes the inverse of a EC_POINT + * \param group underlying EC_GROUP object + * \param a EC_POINT object to be inverted (it's used for the result as well) + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_invert(const EC_GROUP *group, EC_POINT *a, BN_CTX *ctx); + +/** Checks whether the point is the neutral element of the group + * \param group the underlying EC_GROUP object + * \param p EC_POINT object + * \return 1 if the point is the neutral element and 0 otherwise + */ +int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *p); + +/** Checks whether the point is on the curve + * \param group underlying EC_GROUP object + * \param point EC_POINT object to check + * \param ctx BN_CTX object (optional) + * \return 1 if point if on the curve and 0 otherwise + */ +int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point, BN_CTX *ctx); + +/** Compares two EC_POINTs + * \param group underlying EC_GROUP object + * \param a first EC_POINT object + * \param b second EC_POINT object + * \param ctx BN_CTX object (optional) + * \return 0 if both points are equal and a value != 0 otherwise + */ +int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b, BN_CTX *ctx); + +int EC_POINT_make_affine(const EC_GROUP *, EC_POINT *, BN_CTX *); +int EC_POINTs_make_affine(const EC_GROUP *, size_t num, EC_POINT *[], BN_CTX *); + +/** Computes r = generator * n sum_{i=0}^num p[i] * m[i] + * \param group underlying EC_GROUP object + * \param r EC_POINT object for the result + * \param n BIGNUM with the multiplier for the group generator (optional) + * \param num number futher summands + * \param p array of size num of EC_POINT objects + * \param m array of size num of BIGNUM objects + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINTs_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n, size_t num, const EC_POINT *p[], const BIGNUM *m[], BN_CTX *ctx); + +/** Computes r = generator * n + q * m + * \param group underlying EC_GROUP object + * \param r EC_POINT object for the result + * \param n BIGNUM with the multiplier for the group generator (optional) + * \param q EC_POINT object with the first factor of the second summand + * \param m BIGNUM with the second factor of the second summand + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_POINT_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n, const EC_POINT *q, const BIGNUM *m, BN_CTX *ctx); + +/** Stores multiples of generator for faster point multiplication + * \param group EC_GROUP object + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occured + */ +int EC_GROUP_precompute_mult(EC_GROUP *group, BN_CTX *ctx); + +/** Reports whether a precomputation has been done + * \param group EC_GROUP object + * \return 1 if a pre-computation has been done and 0 otherwise + */ +int EC_GROUP_have_precompute_mult(const EC_GROUP *group); + + +/********************************************************************/ +/* ASN1 stuff */ +/********************************************************************/ + +/* EC_GROUP_get_basis_type() returns the NID of the basis type + * used to represent the field elements */ +int EC_GROUP_get_basis_type(const EC_GROUP *); +#ifndef OPENSSL_NO_EC2M +int EC_GROUP_get_trinomial_basis(const EC_GROUP *, unsigned int *k); +int EC_GROUP_get_pentanomial_basis(const EC_GROUP *, unsigned int *k1, + unsigned int *k2, unsigned int *k3); +#endif + +#define OPENSSL_EC_NAMED_CURVE 0x001 + +typedef struct ecpk_parameters_st ECPKPARAMETERS; + +EC_GROUP *d2i_ECPKParameters(EC_GROUP **, const unsigned char **in, long len); +int i2d_ECPKParameters(const EC_GROUP *, unsigned char **out); + +#define d2i_ECPKParameters_bio(bp,x) ASN1_d2i_bio_of(EC_GROUP,NULL,d2i_ECPKParameters,bp,x) +#define i2d_ECPKParameters_bio(bp,x) ASN1_i2d_bio_of_const(EC_GROUP,i2d_ECPKParameters,bp,x) +#define d2i_ECPKParameters_fp(fp,x) (EC_GROUP *)ASN1_d2i_fp(NULL, \ + (char *(*)())d2i_ECPKParameters,(fp),(unsigned char **)(x)) +#define i2d_ECPKParameters_fp(fp,x) ASN1_i2d_fp(i2d_ECPKParameters,(fp), \ + (unsigned char *)(x)) + +#ifndef OPENSSL_NO_BIO +int ECPKParameters_print(BIO *bp, const EC_GROUP *x, int off); +#endif +#ifndef OPENSSL_NO_FP_API +int ECPKParameters_print_fp(FILE *fp, const EC_GROUP *x, int off); +#endif + + +/********************************************************************/ +/* EC_KEY functions */ +/********************************************************************/ + +typedef struct ec_key_st EC_KEY; + +/* some values for the encoding_flag */ +#define EC_PKEY_NO_PARAMETERS 0x001 +#define EC_PKEY_NO_PUBKEY 0x002 + +/* some values for the flags field */ +#define EC_FLAG_NON_FIPS_ALLOW 0x1 +#define EC_FLAG_FIPS_CHECKED 0x2 + +/** Creates a new EC_KEY object. + * \return EC_KEY object or NULL if an error occurred. + */ +EC_KEY *EC_KEY_new(void); + +int EC_KEY_get_flags(const EC_KEY *key); + +void EC_KEY_set_flags(EC_KEY *key, int flags); + +void EC_KEY_clear_flags(EC_KEY *key, int flags); + +/** Creates a new EC_KEY object using a named curve as underlying + * EC_GROUP object. + * \param nid NID of the named curve. + * \return EC_KEY object or NULL if an error occurred. + */ +EC_KEY *EC_KEY_new_by_curve_name(int nid); + +/** Frees a EC_KEY object. + * \param key EC_KEY object to be freed. + */ +void EC_KEY_free(EC_KEY *key); + +/** Copies a EC_KEY object. + * \param dst destination EC_KEY object + * \param src src EC_KEY object + * \return dst or NULL if an error occurred. + */ +EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src); + +/** Creates a new EC_KEY object and copies the content from src to it. + * \param src the source EC_KEY object + * \return newly created EC_KEY object or NULL if an error occurred. + */ +EC_KEY *EC_KEY_dup(const EC_KEY *src); + +/** Increases the internal reference count of a EC_KEY object. + * \param key EC_KEY object + * \return 1 on success and 0 if an error occurred. + */ +int EC_KEY_up_ref(EC_KEY *key); + +/** Returns the EC_GROUP object of a EC_KEY object + * \param key EC_KEY object + * \return the EC_GROUP object (possibly NULL). + */ +const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key); + +/** Sets the EC_GROUP of a EC_KEY object. + * \param key EC_KEY object + * \param group EC_GROUP to use in the EC_KEY object (note: the EC_KEY + * object will use an own copy of the EC_GROUP). + * \return 1 on success and 0 if an error occurred. + */ +int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group); + +/** Returns the private key of a EC_KEY object. + * \param key EC_KEY object + * \return a BIGNUM with the private key (possibly NULL). + */ +const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key); + +/** Sets the private key of a EC_KEY object. + * \param key EC_KEY object + * \param prv BIGNUM with the private key (note: the EC_KEY object + * will use an own copy of the BIGNUM). + * \return 1 on success and 0 if an error occurred. + */ +int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv); + +/** Returns the public key of a EC_KEY object. + * \param key the EC_KEY object + * \return a EC_POINT object with the public key (possibly NULL) + */ +const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key); + +/** Sets the public key of a EC_KEY object. + * \param key EC_KEY object + * \param pub EC_POINT object with the public key (note: the EC_KEY object + * will use an own copy of the EC_POINT object). + * \return 1 on success and 0 if an error occurred. + */ +int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub); + +unsigned EC_KEY_get_enc_flags(const EC_KEY *key); +void EC_KEY_set_enc_flags(EC_KEY *, unsigned int); +point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *); +void EC_KEY_set_conv_form(EC_KEY *, point_conversion_form_t); +/* functions to set/get method specific data */ +void *EC_KEY_get_key_method_data(EC_KEY *, + void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *)); +void EC_KEY_insert_key_method_data(EC_KEY *, void *data, + void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *)); +/* wrapper functions for the underlying EC_GROUP object */ +void EC_KEY_set_asn1_flag(EC_KEY *, int); + +/** Creates a table of pre-computed multiples of the generator to + * accelerate further EC_KEY operations. + * \param key EC_KEY object + * \param ctx BN_CTX object (optional) + * \return 1 on success and 0 if an error occurred. + */ +int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx); + +/** Creates a new ec private (and optional a new public) key. + * \param key EC_KEY object + * \return 1 on success and 0 if an error occurred. + */ +int EC_KEY_generate_key(EC_KEY *key); + +/** Verifies that a private and/or public key is valid. + * \param key the EC_KEY object + * \return 1 on success and 0 otherwise. + */ +int EC_KEY_check_key(const EC_KEY *key); + +/** Sets a public key from affine coordindates performing + * neccessary NIST PKV tests. + * \param key the EC_KEY object + * \param x public key x coordinate + * \param y public key y coordinate + * \return 1 on success and 0 otherwise. + */ +int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y); + + +/********************************************************************/ +/* de- and encoding functions for SEC1 ECPrivateKey */ +/********************************************************************/ + +/** Decodes a private key from a memory buffer. + * \param key a pointer to a EC_KEY object which should be used (or NULL) + * \param in pointer to memory with the DER encoded private key + * \param len length of the DER encoded private key + * \return the decoded private key or NULL if an error occurred. + */ +EC_KEY *d2i_ECPrivateKey(EC_KEY **key, const unsigned char **in, long len); + +/** Encodes a private key object and stores the result in a buffer. + * \param key the EC_KEY object to encode + * \param out the buffer for the result (if NULL the function returns number + * of bytes needed). + * \return 1 on success and 0 if an error occurred. + */ +int i2d_ECPrivateKey(EC_KEY *key, unsigned char **out); + + +/********************************************************************/ +/* de- and encoding functions for EC parameters */ +/********************************************************************/ + +/** Decodes ec parameter from a memory buffer. + * \param key a pointer to a EC_KEY object which should be used (or NULL) + * \param in pointer to memory with the DER encoded ec parameters + * \param len length of the DER encoded ec parameters + * \return a EC_KEY object with the decoded parameters or NULL if an error + * occurred. + */ +EC_KEY *d2i_ECParameters(EC_KEY **key, const unsigned char **in, long len); + +/** Encodes ec parameter and stores the result in a buffer. + * \param key the EC_KEY object with ec paramters to encode + * \param out the buffer for the result (if NULL the function returns number + * of bytes needed). + * \return 1 on success and 0 if an error occurred. + */ +int i2d_ECParameters(EC_KEY *key, unsigned char **out); + + +/********************************************************************/ +/* de- and encoding functions for EC public key */ +/* (octet string, not DER -- hence 'o2i' and 'i2o') */ +/********************************************************************/ + +/** Decodes a ec public key from a octet string. + * \param key a pointer to a EC_KEY object which should be used + * \param in memory buffer with the encoded public key + * \param len length of the encoded public key + * \return EC_KEY object with decoded public key or NULL if an error + * occurred. + */ +EC_KEY *o2i_ECPublicKey(EC_KEY **key, const unsigned char **in, long len); + +/** Encodes a ec public key in an octet string. + * \param key the EC_KEY object with the public key + * \param out the buffer for the result (if NULL the function returns number + * of bytes needed). + * \return 1 on success and 0 if an error occurred + */ +int i2o_ECPublicKey(EC_KEY *key, unsigned char **out); + +#ifndef OPENSSL_NO_BIO +/** Prints out the ec parameters on human readable form. + * \param bp BIO object to which the information is printed + * \param key EC_KEY object + * \return 1 on success and 0 if an error occurred + */ +int ECParameters_print(BIO *bp, const EC_KEY *key); + +/** Prints out the contents of a EC_KEY object + * \param bp BIO object to which the information is printed + * \param key EC_KEY object + * \param off line offset + * \return 1 on success and 0 if an error occurred + */ +int EC_KEY_print(BIO *bp, const EC_KEY *key, int off); + +#endif +#ifndef OPENSSL_NO_FP_API +/** Prints out the ec parameters on human readable form. + * \param fp file descriptor to which the information is printed + * \param key EC_KEY object + * \return 1 on success and 0 if an error occurred + */ +int ECParameters_print_fp(FILE *fp, const EC_KEY *key); + +/** Prints out the contents of a EC_KEY object + * \param fp file descriptor to which the information is printed + * \param key EC_KEY object + * \param off line offset + * \return 1 on success and 0 if an error occurred + */ +int EC_KEY_print_fp(FILE *fp, const EC_KEY *key, int off); + +#endif + +#define ECParameters_dup(x) ASN1_dup_of(EC_KEY,i2d_ECParameters,d2i_ECParameters,x) + +#ifndef __cplusplus +#if defined(__SUNPRO_C) +# if __SUNPRO_C >= 0x520 +# pragma error_messages (default,E_ARRAY_OF_INCOMPLETE_NONAME,E_ARRAY_OF_INCOMPLETE) +# endif +# endif +#endif + +#define EVP_PKEY_CTX_set_ec_paramgen_curve_nid(ctx, nid) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_EC, EVP_PKEY_OP_PARAMGEN, \ + EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID, nid, NULL) + + +#define EVP_PKEY_CTRL_EC_PARAMGEN_CURVE_NID (EVP_PKEY_ALG_CTRL + 1) + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_EC_strings(void); + +/* Error codes for the EC functions. */ + +/* Function codes. */ +#define EC_F_BN_TO_FELEM 224 +#define EC_F_COMPUTE_WNAF 143 +#define EC_F_D2I_ECPARAMETERS 144 +#define EC_F_D2I_ECPKPARAMETERS 145 +#define EC_F_D2I_ECPRIVATEKEY 146 +#define EC_F_DO_EC_KEY_PRINT 221 +#define EC_F_ECKEY_PARAM2TYPE 223 +#define EC_F_ECKEY_PARAM_DECODE 212 +#define EC_F_ECKEY_PRIV_DECODE 213 +#define EC_F_ECKEY_PRIV_ENCODE 214 +#define EC_F_ECKEY_PUB_DECODE 215 +#define EC_F_ECKEY_PUB_ENCODE 216 +#define EC_F_ECKEY_TYPE2PARAM 220 +#define EC_F_ECPARAMETERS_PRINT 147 +#define EC_F_ECPARAMETERS_PRINT_FP 148 +#define EC_F_ECPKPARAMETERS_PRINT 149 +#define EC_F_ECPKPARAMETERS_PRINT_FP 150 +#define EC_F_ECP_NIST_MOD_192 203 +#define EC_F_ECP_NIST_MOD_224 204 +#define EC_F_ECP_NIST_MOD_256 205 +#define EC_F_ECP_NIST_MOD_521 206 +#define EC_F_EC_ASN1_GROUP2CURVE 153 +#define EC_F_EC_ASN1_GROUP2FIELDID 154 +#define EC_F_EC_ASN1_GROUP2PARAMETERS 155 +#define EC_F_EC_ASN1_GROUP2PKPARAMETERS 156 +#define EC_F_EC_ASN1_PARAMETERS2GROUP 157 +#define EC_F_EC_ASN1_PKPARAMETERS2GROUP 158 +#define EC_F_EC_EX_DATA_SET_DATA 211 +#define EC_F_EC_GF2M_MONTGOMERY_POINT_MULTIPLY 208 +#define EC_F_EC_GF2M_SIMPLE_GROUP_CHECK_DISCRIMINANT 159 +#define EC_F_EC_GF2M_SIMPLE_GROUP_SET_CURVE 195 +#define EC_F_EC_GF2M_SIMPLE_OCT2POINT 160 +#define EC_F_EC_GF2M_SIMPLE_POINT2OCT 161 +#define EC_F_EC_GF2M_SIMPLE_POINT_GET_AFFINE_COORDINATES 162 +#define EC_F_EC_GF2M_SIMPLE_POINT_SET_AFFINE_COORDINATES 163 +#define EC_F_EC_GF2M_SIMPLE_SET_COMPRESSED_COORDINATES 164 +#define EC_F_EC_GFP_MONT_FIELD_DECODE 133 +#define EC_F_EC_GFP_MONT_FIELD_ENCODE 134 +#define EC_F_EC_GFP_MONT_FIELD_MUL 131 +#define EC_F_EC_GFP_MONT_FIELD_SET_TO_ONE 209 +#define EC_F_EC_GFP_MONT_FIELD_SQR 132 +#define EC_F_EC_GFP_MONT_GROUP_SET_CURVE 189 +#define EC_F_EC_GFP_MONT_GROUP_SET_CURVE_GFP 135 +#define EC_F_EC_GFP_NISTP224_GROUP_SET_CURVE 225 +#define EC_F_EC_GFP_NISTP224_POINTS_MUL 228 +#define EC_F_EC_GFP_NISTP224_POINT_GET_AFFINE_COORDINATES 226 +#define EC_F_EC_GFP_NISTP256_GROUP_SET_CURVE 230 +#define EC_F_EC_GFP_NISTP256_POINTS_MUL 231 +#define EC_F_EC_GFP_NISTP256_POINT_GET_AFFINE_COORDINATES 232 +#define EC_F_EC_GFP_NISTP521_GROUP_SET_CURVE 233 +#define EC_F_EC_GFP_NISTP521_POINTS_MUL 234 +#define EC_F_EC_GFP_NISTP521_POINT_GET_AFFINE_COORDINATES 235 +#define EC_F_EC_GFP_NIST_FIELD_MUL 200 +#define EC_F_EC_GFP_NIST_FIELD_SQR 201 +#define EC_F_EC_GFP_NIST_GROUP_SET_CURVE 202 +#define EC_F_EC_GFP_SIMPLE_GROUP_CHECK_DISCRIMINANT 165 +#define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE 166 +#define EC_F_EC_GFP_SIMPLE_GROUP_SET_CURVE_GFP 100 +#define EC_F_EC_GFP_SIMPLE_GROUP_SET_GENERATOR 101 +#define EC_F_EC_GFP_SIMPLE_MAKE_AFFINE 102 +#define EC_F_EC_GFP_SIMPLE_OCT2POINT 103 +#define EC_F_EC_GFP_SIMPLE_POINT2OCT 104 +#define EC_F_EC_GFP_SIMPLE_POINTS_MAKE_AFFINE 137 +#define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES 167 +#define EC_F_EC_GFP_SIMPLE_POINT_GET_AFFINE_COORDINATES_GFP 105 +#define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES 168 +#define EC_F_EC_GFP_SIMPLE_POINT_SET_AFFINE_COORDINATES_GFP 128 +#define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES 169 +#define EC_F_EC_GFP_SIMPLE_SET_COMPRESSED_COORDINATES_GFP 129 +#define EC_F_EC_GROUP_CHECK 170 +#define EC_F_EC_GROUP_CHECK_DISCRIMINANT 171 +#define EC_F_EC_GROUP_COPY 106 +#define EC_F_EC_GROUP_GET0_GENERATOR 139 +#define EC_F_EC_GROUP_GET_COFACTOR 140 +#define EC_F_EC_GROUP_GET_CURVE_GF2M 172 +#define EC_F_EC_GROUP_GET_CURVE_GFP 130 +#define EC_F_EC_GROUP_GET_DEGREE 173 +#define EC_F_EC_GROUP_GET_ORDER 141 +#define EC_F_EC_GROUP_GET_PENTANOMIAL_BASIS 193 +#define EC_F_EC_GROUP_GET_TRINOMIAL_BASIS 194 +#define EC_F_EC_GROUP_NEW 108 +#define EC_F_EC_GROUP_NEW_BY_CURVE_NAME 174 +#define EC_F_EC_GROUP_NEW_FROM_DATA 175 +#define EC_F_EC_GROUP_PRECOMPUTE_MULT 142 +#define EC_F_EC_GROUP_SET_CURVE_GF2M 176 +#define EC_F_EC_GROUP_SET_CURVE_GFP 109 +#define EC_F_EC_GROUP_SET_EXTRA_DATA 110 +#define EC_F_EC_GROUP_SET_GENERATOR 111 +#define EC_F_EC_KEY_CHECK_KEY 177 +#define EC_F_EC_KEY_COPY 178 +#define EC_F_EC_KEY_GENERATE_KEY 179 +#define EC_F_EC_KEY_NEW 182 +#define EC_F_EC_KEY_PRINT 180 +#define EC_F_EC_KEY_PRINT_FP 181 +#define EC_F_EC_KEY_SET_PUBLIC_KEY_AFFINE_COORDINATES 229 +#define EC_F_EC_POINTS_MAKE_AFFINE 136 +#define EC_F_EC_POINT_ADD 112 +#define EC_F_EC_POINT_CMP 113 +#define EC_F_EC_POINT_COPY 114 +#define EC_F_EC_POINT_DBL 115 +#define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GF2M 183 +#define EC_F_EC_POINT_GET_AFFINE_COORDINATES_GFP 116 +#define EC_F_EC_POINT_GET_JPROJECTIVE_COORDINATES_GFP 117 +#define EC_F_EC_POINT_INVERT 210 +#define EC_F_EC_POINT_IS_AT_INFINITY 118 +#define EC_F_EC_POINT_IS_ON_CURVE 119 +#define EC_F_EC_POINT_MAKE_AFFINE 120 +#define EC_F_EC_POINT_MUL 184 +#define EC_F_EC_POINT_NEW 121 +#define EC_F_EC_POINT_OCT2POINT 122 +#define EC_F_EC_POINT_POINT2OCT 123 +#define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GF2M 185 +#define EC_F_EC_POINT_SET_AFFINE_COORDINATES_GFP 124 +#define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GF2M 186 +#define EC_F_EC_POINT_SET_COMPRESSED_COORDINATES_GFP 125 +#define EC_F_EC_POINT_SET_JPROJECTIVE_COORDINATES_GFP 126 +#define EC_F_EC_POINT_SET_TO_INFINITY 127 +#define EC_F_EC_PRE_COMP_DUP 207 +#define EC_F_EC_PRE_COMP_NEW 196 +#define EC_F_EC_WNAF_MUL 187 +#define EC_F_EC_WNAF_PRECOMPUTE_MULT 188 +#define EC_F_I2D_ECPARAMETERS 190 +#define EC_F_I2D_ECPKPARAMETERS 191 +#define EC_F_I2D_ECPRIVATEKEY 192 +#define EC_F_I2O_ECPUBLICKEY 151 +#define EC_F_NISTP224_PRE_COMP_NEW 227 +#define EC_F_NISTP256_PRE_COMP_NEW 236 +#define EC_F_NISTP521_PRE_COMP_NEW 237 +#define EC_F_O2I_ECPUBLICKEY 152 +#define EC_F_OLD_EC_PRIV_DECODE 222 +#define EC_F_PKEY_EC_CTRL 197 +#define EC_F_PKEY_EC_CTRL_STR 198 +#define EC_F_PKEY_EC_DERIVE 217 +#define EC_F_PKEY_EC_KEYGEN 199 +#define EC_F_PKEY_EC_PARAMGEN 219 +#define EC_F_PKEY_EC_SIGN 218 + +/* Reason codes. */ +#define EC_R_ASN1_ERROR 115 +#define EC_R_ASN1_UNKNOWN_FIELD 116 +#define EC_R_BIGNUM_OUT_OF_RANGE 144 +#define EC_R_BUFFER_TOO_SMALL 100 +#define EC_R_COORDINATES_OUT_OF_RANGE 146 +#define EC_R_D2I_ECPKPARAMETERS_FAILURE 117 +#define EC_R_DECODE_ERROR 142 +#define EC_R_DISCRIMINANT_IS_ZERO 118 +#define EC_R_EC_GROUP_NEW_BY_NAME_FAILURE 119 +#define EC_R_FIELD_TOO_LARGE 143 +#define EC_R_GF2M_NOT_SUPPORTED 147 +#define EC_R_GROUP2PKPARAMETERS_FAILURE 120 +#define EC_R_I2D_ECPKPARAMETERS_FAILURE 121 +#define EC_R_INCOMPATIBLE_OBJECTS 101 +#define EC_R_INVALID_ARGUMENT 112 +#define EC_R_INVALID_COMPRESSED_POINT 110 +#define EC_R_INVALID_COMPRESSION_BIT 109 +#define EC_R_INVALID_CURVE 141 +#define EC_R_INVALID_DIGEST_TYPE 138 +#define EC_R_INVALID_ENCODING 102 +#define EC_R_INVALID_FIELD 103 +#define EC_R_INVALID_FORM 104 +#define EC_R_INVALID_GROUP_ORDER 122 +#define EC_R_INVALID_PENTANOMIAL_BASIS 132 +#define EC_R_INVALID_PRIVATE_KEY 123 +#define EC_R_INVALID_TRINOMIAL_BASIS 137 +#define EC_R_KEYS_NOT_SET 140 +#define EC_R_MISSING_PARAMETERS 124 +#define EC_R_MISSING_PRIVATE_KEY 125 +#define EC_R_NOT_A_NIST_PRIME 135 +#define EC_R_NOT_A_SUPPORTED_NIST_PRIME 136 +#define EC_R_NOT_IMPLEMENTED 126 +#define EC_R_NOT_INITIALIZED 111 +#define EC_R_NO_FIELD_MOD 133 +#define EC_R_NO_PARAMETERS_SET 139 +#define EC_R_PASSED_NULL_PARAMETER 134 +#define EC_R_PKPARAMETERS2GROUP_FAILURE 127 +#define EC_R_POINT_AT_INFINITY 106 +#define EC_R_POINT_IS_NOT_ON_CURVE 107 +#define EC_R_SLOT_FULL 108 +#define EC_R_UNDEFINED_GENERATOR 113 +#define EC_R_UNDEFINED_ORDER 128 +#define EC_R_UNKNOWN_GROUP 129 +#define EC_R_UNKNOWN_ORDER 114 +#define EC_R_UNSUPPORTED_FIELD 131 +#define EC_R_WRONG_CURVE_PARAMETERS 145 +#define EC_R_WRONG_ORDER 130 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/ecdh.h b/Source/Import/OpenSSL/Include/openssl/ecdh.h new file mode 100644 index 0000000..8887102 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ecdh.h @@ -0,0 +1,125 @@ +/* crypto/ecdh/ecdh.h */ +/* ==================================================================== + * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. + * + * The Elliptic Curve Public-Key Crypto Library (ECC Code) included + * herein is developed by SUN MICROSYSTEMS, INC., and is contributed + * to the OpenSSL project. + * + * The ECC Code is licensed pursuant to the OpenSSL open source + * license provided below. + * + * The ECDH software is originally written by Douglas Stebila of + * Sun Microsystems Laboratories. + * + */ +/* ==================================================================== + * Copyright (c) 2000-2002 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +#ifndef HEADER_ECDH_H +#define HEADER_ECDH_H + +#include + +#ifdef OPENSSL_NO_ECDH +#error ECDH is disabled. +#endif + +#include +#include +#ifndef OPENSSL_NO_DEPRECATED +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +const ECDH_METHOD *ECDH_OpenSSL(void); + +void ECDH_set_default_method(const ECDH_METHOD *); +const ECDH_METHOD *ECDH_get_default_method(void); +int ECDH_set_method(EC_KEY *, const ECDH_METHOD *); + +int ECDH_compute_key(void *out, size_t outlen, const EC_POINT *pub_key, EC_KEY *ecdh, + void *(*KDF)(const void *in, size_t inlen, void *out, size_t *outlen)); + +int ECDH_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new + *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); +int ECDH_set_ex_data(EC_KEY *d, int idx, void *arg); +void *ECDH_get_ex_data(EC_KEY *d, int idx); + + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_ECDH_strings(void); + +/* Error codes for the ECDH functions. */ + +/* Function codes. */ +#define ECDH_F_ECDH_CHECK 102 +#define ECDH_F_ECDH_COMPUTE_KEY 100 +#define ECDH_F_ECDH_DATA_NEW_METHOD 101 + +/* Reason codes. */ +#define ECDH_R_KDF_FAILED 102 +#define ECDH_R_NON_FIPS_METHOD 103 +#define ECDH_R_NO_PRIVATE_VALUE 100 +#define ECDH_R_POINT_ARITHMETIC_FAILURE 101 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/ecdsa.h b/Source/Import/OpenSSL/Include/openssl/ecdsa.h new file mode 100644 index 0000000..7fb5254 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ecdsa.h @@ -0,0 +1,260 @@ +/* crypto/ecdsa/ecdsa.h */ +/** + * \file crypto/ecdsa/ecdsa.h Include file for the OpenSSL ECDSA functions + * \author Written by Nils Larsch for the OpenSSL project + */ +/* ==================================================================== + * Copyright (c) 2000-2005 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +#ifndef HEADER_ECDSA_H +#define HEADER_ECDSA_H + +#include + +#ifdef OPENSSL_NO_ECDSA +#error ECDSA is disabled. +#endif + +#include +#include +#ifndef OPENSSL_NO_DEPRECATED +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct ECDSA_SIG_st + { + BIGNUM *r; + BIGNUM *s; + } ECDSA_SIG; + +/** Allocates and initialize a ECDSA_SIG structure + * \return pointer to a ECDSA_SIG structure or NULL if an error occurred + */ +ECDSA_SIG *ECDSA_SIG_new(void); + +/** frees a ECDSA_SIG structure + * \param sig pointer to the ECDSA_SIG structure + */ +void ECDSA_SIG_free(ECDSA_SIG *sig); + +/** DER encode content of ECDSA_SIG object (note: this function modifies *pp + * (*pp += length of the DER encoded signature)). + * \param sig pointer to the ECDSA_SIG object + * \param pp pointer to a unsigned char pointer for the output or NULL + * \return the length of the DER encoded ECDSA_SIG object or 0 + */ +int i2d_ECDSA_SIG(const ECDSA_SIG *sig, unsigned char **pp); + +/** Decodes a DER encoded ECDSA signature (note: this function changes *pp + * (*pp += len)). + * \param sig pointer to ECDSA_SIG pointer (may be NULL) + * \param pp memory buffer with the DER encoded signature + * \param len length of the buffer + * \return pointer to the decoded ECDSA_SIG structure (or NULL) + */ +ECDSA_SIG *d2i_ECDSA_SIG(ECDSA_SIG **sig, const unsigned char **pp, long len); + +/** Computes the ECDSA signature of the given hash value using + * the supplied private key and returns the created signature. + * \param dgst pointer to the hash value + * \param dgst_len length of the hash value + * \param eckey EC_KEY object containing a private EC key + * \return pointer to a ECDSA_SIG structure or NULL if an error occurred + */ +ECDSA_SIG *ECDSA_do_sign(const unsigned char *dgst,int dgst_len,EC_KEY *eckey); + +/** Computes ECDSA signature of a given hash value using the supplied + * private key (note: sig must point to ECDSA_size(eckey) bytes of memory). + * \param dgst pointer to the hash value to sign + * \param dgstlen length of the hash value + * \param kinv BIGNUM with a pre-computed inverse k (optional) + * \param rp BIGNUM with a pre-computed rp value (optioanl), + * see ECDSA_sign_setup + * \param eckey EC_KEY object containing a private EC key + * \return pointer to a ECDSA_SIG structure or NULL if an error occurred + */ +ECDSA_SIG *ECDSA_do_sign_ex(const unsigned char *dgst, int dgstlen, + const BIGNUM *kinv, const BIGNUM *rp, EC_KEY *eckey); + +/** Verifies that the supplied signature is a valid ECDSA + * signature of the supplied hash value using the supplied public key. + * \param dgst pointer to the hash value + * \param dgst_len length of the hash value + * \param sig ECDSA_SIG structure + * \param eckey EC_KEY object containing a public EC key + * \return 1 if the signature is valid, 0 if the signature is invalid + * and -1 on error + */ +int ECDSA_do_verify(const unsigned char *dgst, int dgst_len, + const ECDSA_SIG *sig, EC_KEY* eckey); + +const ECDSA_METHOD *ECDSA_OpenSSL(void); + +/** Sets the default ECDSA method + * \param meth new default ECDSA_METHOD + */ +void ECDSA_set_default_method(const ECDSA_METHOD *meth); + +/** Returns the default ECDSA method + * \return pointer to ECDSA_METHOD structure containing the default method + */ +const ECDSA_METHOD *ECDSA_get_default_method(void); + +/** Sets method to be used for the ECDSA operations + * \param eckey EC_KEY object + * \param meth new method + * \return 1 on success and 0 otherwise + */ +int ECDSA_set_method(EC_KEY *eckey, const ECDSA_METHOD *meth); + +/** Returns the maximum length of the DER encoded signature + * \param eckey EC_KEY object + * \return numbers of bytes required for the DER encoded signature + */ +int ECDSA_size(const EC_KEY *eckey); + +/** Precompute parts of the signing operation + * \param eckey EC_KEY object containing a private EC key + * \param ctx BN_CTX object (optional) + * \param kinv BIGNUM pointer for the inverse of k + * \param rp BIGNUM pointer for x coordinate of k * generator + * \return 1 on success and 0 otherwise + */ +int ECDSA_sign_setup(EC_KEY *eckey, BN_CTX *ctx, BIGNUM **kinv, + BIGNUM **rp); + +/** Computes ECDSA signature of a given hash value using the supplied + * private key (note: sig must point to ECDSA_size(eckey) bytes of memory). + * \param type this parameter is ignored + * \param dgst pointer to the hash value to sign + * \param dgstlen length of the hash value + * \param sig memory for the DER encoded created signature + * \param siglen pointer to the length of the returned signature + * \param eckey EC_KEY object containing a private EC key + * \return 1 on success and 0 otherwise + */ +int ECDSA_sign(int type, const unsigned char *dgst, int dgstlen, + unsigned char *sig, unsigned int *siglen, EC_KEY *eckey); + + +/** Computes ECDSA signature of a given hash value using the supplied + * private key (note: sig must point to ECDSA_size(eckey) bytes of memory). + * \param type this parameter is ignored + * \param dgst pointer to the hash value to sign + * \param dgstlen length of the hash value + * \param sig buffer to hold the DER encoded signature + * \param siglen pointer to the length of the returned signature + * \param kinv BIGNUM with a pre-computed inverse k (optional) + * \param rp BIGNUM with a pre-computed rp value (optioanl), + * see ECDSA_sign_setup + * \param eckey EC_KEY object containing a private EC key + * \return 1 on success and 0 otherwise + */ +int ECDSA_sign_ex(int type, const unsigned char *dgst, int dgstlen, + unsigned char *sig, unsigned int *siglen, const BIGNUM *kinv, + const BIGNUM *rp, EC_KEY *eckey); + +/** Verifies that the given signature is valid ECDSA signature + * of the supplied hash value using the specified public key. + * \param type this parameter is ignored + * \param dgst pointer to the hash value + * \param dgstlen length of the hash value + * \param sig pointer to the DER encoded signature + * \param siglen length of the DER encoded signature + * \param eckey EC_KEY object containing a public EC key + * \return 1 if the signature is valid, 0 if the signature is invalid + * and -1 on error + */ +int ECDSA_verify(int type, const unsigned char *dgst, int dgstlen, + const unsigned char *sig, int siglen, EC_KEY *eckey); + +/* the standard ex_data functions */ +int ECDSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new + *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); +int ECDSA_set_ex_data(EC_KEY *d, int idx, void *arg); +void *ECDSA_get_ex_data(EC_KEY *d, int idx); + + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_ECDSA_strings(void); + +/* Error codes for the ECDSA functions. */ + +/* Function codes. */ +#define ECDSA_F_ECDSA_CHECK 104 +#define ECDSA_F_ECDSA_DATA_NEW_METHOD 100 +#define ECDSA_F_ECDSA_DO_SIGN 101 +#define ECDSA_F_ECDSA_DO_VERIFY 102 +#define ECDSA_F_ECDSA_SIGN_SETUP 103 + +/* Reason codes. */ +#define ECDSA_R_BAD_SIGNATURE 100 +#define ECDSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 101 +#define ECDSA_R_ERR_EC_LIB 102 +#define ECDSA_R_MISSING_PARAMETERS 103 +#define ECDSA_R_NEED_NEW_SETUP_VALUES 106 +#define ECDSA_R_NON_FIPS_METHOD 107 +#define ECDSA_R_RANDOM_NUMBER_GENERATION_FAILED 104 +#define ECDSA_R_SIGNATURE_MALLOC_FAILED 105 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/engine.h b/Source/Import/OpenSSL/Include/openssl/engine.h new file mode 100644 index 0000000..f8be497 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/engine.h @@ -0,0 +1,842 @@ +/* openssl/engine.h */ +/* Written by Geoff Thorpe (geoff@geoffthorpe.net) for the OpenSSL + * project 2000. + */ +/* ==================================================================== + * Copyright (c) 1999-2004 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +/* ==================================================================== + * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. + * ECDH support in OpenSSL originally developed by + * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project. + */ + +#ifndef HEADER_ENGINE_H +#define HEADER_ENGINE_H + +#include + +#ifdef OPENSSL_NO_ENGINE +#error ENGINE is disabled. +#endif + +#ifndef OPENSSL_NO_DEPRECATED +#include +#ifndef OPENSSL_NO_RSA +#include +#endif +#ifndef OPENSSL_NO_DSA +#include +#endif +#ifndef OPENSSL_NO_DH +#include +#endif +#ifndef OPENSSL_NO_ECDH +#include +#endif +#ifndef OPENSSL_NO_ECDSA +#include +#endif +#include +#include +#include +#endif + +#include +#include + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* These flags are used to control combinations of algorithm (methods) + * by bitwise "OR"ing. */ +#define ENGINE_METHOD_RSA (unsigned int)0x0001 +#define ENGINE_METHOD_DSA (unsigned int)0x0002 +#define ENGINE_METHOD_DH (unsigned int)0x0004 +#define ENGINE_METHOD_RAND (unsigned int)0x0008 +#define ENGINE_METHOD_ECDH (unsigned int)0x0010 +#define ENGINE_METHOD_ECDSA (unsigned int)0x0020 +#define ENGINE_METHOD_CIPHERS (unsigned int)0x0040 +#define ENGINE_METHOD_DIGESTS (unsigned int)0x0080 +#define ENGINE_METHOD_STORE (unsigned int)0x0100 +#define ENGINE_METHOD_PKEY_METHS (unsigned int)0x0200 +#define ENGINE_METHOD_PKEY_ASN1_METHS (unsigned int)0x0400 +/* Obvious all-or-nothing cases. */ +#define ENGINE_METHOD_ALL (unsigned int)0xFFFF +#define ENGINE_METHOD_NONE (unsigned int)0x0000 + +/* This(ese) flag(s) controls behaviour of the ENGINE_TABLE mechanism used + * internally to control registration of ENGINE implementations, and can be set + * by ENGINE_set_table_flags(). The "NOINIT" flag prevents attempts to + * initialise registered ENGINEs if they are not already initialised. */ +#define ENGINE_TABLE_FLAG_NOINIT (unsigned int)0x0001 + +/* ENGINE flags that can be set by ENGINE_set_flags(). */ +/* #define ENGINE_FLAGS_MALLOCED 0x0001 */ /* Not used */ + +/* This flag is for ENGINEs that wish to handle the various 'CMD'-related + * control commands on their own. Without this flag, ENGINE_ctrl() handles these + * control commands on behalf of the ENGINE using their "cmd_defns" data. */ +#define ENGINE_FLAGS_MANUAL_CMD_CTRL (int)0x0002 + +/* This flag is for ENGINEs who return new duplicate structures when found via + * "ENGINE_by_id()". When an ENGINE must store state (eg. if ENGINE_ctrl() + * commands are called in sequence as part of some stateful process like + * key-generation setup and execution), it can set this flag - then each attempt + * to obtain the ENGINE will result in it being copied into a new structure. + * Normally, ENGINEs don't declare this flag so ENGINE_by_id() just increments + * the existing ENGINE's structural reference count. */ +#define ENGINE_FLAGS_BY_ID_COPY (int)0x0004 + +/* This flag if for an ENGINE that does not want its methods registered as + * part of ENGINE_register_all_complete() for example if the methods are + * not usable as default methods. + */ + +#define ENGINE_FLAGS_NO_REGISTER_ALL (int)0x0008 + +/* ENGINEs can support their own command types, and these flags are used in + * ENGINE_CTRL_GET_CMD_FLAGS to indicate to the caller what kind of input each + * command expects. Currently only numeric and string input is supported. If a + * control command supports none of the _NUMERIC, _STRING, or _NO_INPUT options, + * then it is regarded as an "internal" control command - and not for use in + * config setting situations. As such, they're not available to the + * ENGINE_ctrl_cmd_string() function, only raw ENGINE_ctrl() access. Changes to + * this list of 'command types' should be reflected carefully in + * ENGINE_cmd_is_executable() and ENGINE_ctrl_cmd_string(). */ + +/* accepts a 'long' input value (3rd parameter to ENGINE_ctrl) */ +#define ENGINE_CMD_FLAG_NUMERIC (unsigned int)0x0001 +/* accepts string input (cast from 'void*' to 'const char *', 4th parameter to + * ENGINE_ctrl) */ +#define ENGINE_CMD_FLAG_STRING (unsigned int)0x0002 +/* Indicates that the control command takes *no* input. Ie. the control command + * is unparameterised. */ +#define ENGINE_CMD_FLAG_NO_INPUT (unsigned int)0x0004 +/* Indicates that the control command is internal. This control command won't + * be shown in any output, and is only usable through the ENGINE_ctrl_cmd() + * function. */ +#define ENGINE_CMD_FLAG_INTERNAL (unsigned int)0x0008 + +/* NB: These 3 control commands are deprecated and should not be used. ENGINEs + * relying on these commands should compile conditional support for + * compatibility (eg. if these symbols are defined) but should also migrate the + * same functionality to their own ENGINE-specific control functions that can be + * "discovered" by calling applications. The fact these control commands + * wouldn't be "executable" (ie. usable by text-based config) doesn't change the + * fact that application code can find and use them without requiring per-ENGINE + * hacking. */ + +/* These flags are used to tell the ctrl function what should be done. + * All command numbers are shared between all engines, even if some don't + * make sense to some engines. In such a case, they do nothing but return + * the error ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED. */ +#define ENGINE_CTRL_SET_LOGSTREAM 1 +#define ENGINE_CTRL_SET_PASSWORD_CALLBACK 2 +#define ENGINE_CTRL_HUP 3 /* Close and reinitialise any + handles/connections etc. */ +#define ENGINE_CTRL_SET_USER_INTERFACE 4 /* Alternative to callback */ +#define ENGINE_CTRL_SET_CALLBACK_DATA 5 /* User-specific data, used + when calling the password + callback and the user + interface */ +#define ENGINE_CTRL_LOAD_CONFIGURATION 6 /* Load a configuration, given + a string that represents a + file name or so */ +#define ENGINE_CTRL_LOAD_SECTION 7 /* Load data from a given + section in the already loaded + configuration */ + +/* These control commands allow an application to deal with an arbitrary engine + * in a dynamic way. Warn: Negative return values indicate errors FOR THESE + * COMMANDS because zero is used to indicate 'end-of-list'. Other commands, + * including ENGINE-specific command types, return zero for an error. + * + * An ENGINE can choose to implement these ctrl functions, and can internally + * manage things however it chooses - it does so by setting the + * ENGINE_FLAGS_MANUAL_CMD_CTRL flag (using ENGINE_set_flags()). Otherwise the + * ENGINE_ctrl() code handles this on the ENGINE's behalf using the cmd_defns + * data (set using ENGINE_set_cmd_defns()). This means an ENGINE's ctrl() + * handler need only implement its own commands - the above "meta" commands will + * be taken care of. */ + +/* Returns non-zero if the supplied ENGINE has a ctrl() handler. If "not", then + * all the remaining control commands will return failure, so it is worth + * checking this first if the caller is trying to "discover" the engine's + * capabilities and doesn't want errors generated unnecessarily. */ +#define ENGINE_CTRL_HAS_CTRL_FUNCTION 10 +/* Returns a positive command number for the first command supported by the + * engine. Returns zero if no ctrl commands are supported. */ +#define ENGINE_CTRL_GET_FIRST_CMD_TYPE 11 +/* The 'long' argument specifies a command implemented by the engine, and the + * return value is the next command supported, or zero if there are no more. */ +#define ENGINE_CTRL_GET_NEXT_CMD_TYPE 12 +/* The 'void*' argument is a command name (cast from 'const char *'), and the + * return value is the command that corresponds to it. */ +#define ENGINE_CTRL_GET_CMD_FROM_NAME 13 +/* The next two allow a command to be converted into its corresponding string + * form. In each case, the 'long' argument supplies the command. In the NAME_LEN + * case, the return value is the length of the command name (not counting a + * trailing EOL). In the NAME case, the 'void*' argument must be a string buffer + * large enough, and it will be populated with the name of the command (WITH a + * trailing EOL). */ +#define ENGINE_CTRL_GET_NAME_LEN_FROM_CMD 14 +#define ENGINE_CTRL_GET_NAME_FROM_CMD 15 +/* The next two are similar but give a "short description" of a command. */ +#define ENGINE_CTRL_GET_DESC_LEN_FROM_CMD 16 +#define ENGINE_CTRL_GET_DESC_FROM_CMD 17 +/* With this command, the return value is the OR'd combination of + * ENGINE_CMD_FLAG_*** values that indicate what kind of input a given + * engine-specific ctrl command expects. */ +#define ENGINE_CTRL_GET_CMD_FLAGS 18 + +/* ENGINE implementations should start the numbering of their own control + * commands from this value. (ie. ENGINE_CMD_BASE, ENGINE_CMD_BASE + 1, etc). */ +#define ENGINE_CMD_BASE 200 + +/* NB: These 2 nCipher "chil" control commands are deprecated, and their + * functionality is now available through ENGINE-specific control commands + * (exposed through the above-mentioned 'CMD'-handling). Code using these 2 + * commands should be migrated to the more general command handling before these + * are removed. */ + +/* Flags specific to the nCipher "chil" engine */ +#define ENGINE_CTRL_CHIL_SET_FORKCHECK 100 + /* Depending on the value of the (long)i argument, this sets or + * unsets the SimpleForkCheck flag in the CHIL API to enable or + * disable checking and workarounds for applications that fork(). + */ +#define ENGINE_CTRL_CHIL_NO_LOCKING 101 + /* This prevents the initialisation function from providing mutex + * callbacks to the nCipher library. */ + +/* If an ENGINE supports its own specific control commands and wishes the + * framework to handle the above 'ENGINE_CMD_***'-manipulation commands on its + * behalf, it should supply a null-terminated array of ENGINE_CMD_DEFN entries + * to ENGINE_set_cmd_defns(). It should also implement a ctrl() handler that + * supports the stated commands (ie. the "cmd_num" entries as described by the + * array). NB: The array must be ordered in increasing order of cmd_num. + * "null-terminated" means that the last ENGINE_CMD_DEFN element has cmd_num set + * to zero and/or cmd_name set to NULL. */ +typedef struct ENGINE_CMD_DEFN_st + { + unsigned int cmd_num; /* The command number */ + const char *cmd_name; /* The command name itself */ + const char *cmd_desc; /* A short description of the command */ + unsigned int cmd_flags; /* The input the command expects */ + } ENGINE_CMD_DEFN; + +/* Generic function pointer */ +typedef int (*ENGINE_GEN_FUNC_PTR)(void); +/* Generic function pointer taking no arguments */ +typedef int (*ENGINE_GEN_INT_FUNC_PTR)(ENGINE *); +/* Specific control function pointer */ +typedef int (*ENGINE_CTRL_FUNC_PTR)(ENGINE *, int, long, void *, void (*f)(void)); +/* Generic load_key function pointer */ +typedef EVP_PKEY * (*ENGINE_LOAD_KEY_PTR)(ENGINE *, const char *, + UI_METHOD *ui_method, void *callback_data); +typedef int (*ENGINE_SSL_CLIENT_CERT_PTR)(ENGINE *, SSL *ssl, + STACK_OF(X509_NAME) *ca_dn, X509 **pcert, EVP_PKEY **pkey, + STACK_OF(X509) **pother, UI_METHOD *ui_method, void *callback_data); +/* These callback types are for an ENGINE's handler for cipher and digest logic. + * These handlers have these prototypes; + * int foo(ENGINE *e, const EVP_CIPHER **cipher, const int **nids, int nid); + * int foo(ENGINE *e, const EVP_MD **digest, const int **nids, int nid); + * Looking at how to implement these handlers in the case of cipher support, if + * the framework wants the EVP_CIPHER for 'nid', it will call; + * foo(e, &p_evp_cipher, NULL, nid); (return zero for failure) + * If the framework wants a list of supported 'nid's, it will call; + * foo(e, NULL, &p_nids, 0); (returns number of 'nids' or -1 for error) + */ +/* Returns to a pointer to the array of supported cipher 'nid's. If the second + * parameter is non-NULL it is set to the size of the returned array. */ +typedef int (*ENGINE_CIPHERS_PTR)(ENGINE *, const EVP_CIPHER **, const int **, int); +typedef int (*ENGINE_DIGESTS_PTR)(ENGINE *, const EVP_MD **, const int **, int); +typedef int (*ENGINE_PKEY_METHS_PTR)(ENGINE *, EVP_PKEY_METHOD **, const int **, int); +typedef int (*ENGINE_PKEY_ASN1_METHS_PTR)(ENGINE *, EVP_PKEY_ASN1_METHOD **, const int **, int); +/* STRUCTURE functions ... all of these functions deal with pointers to ENGINE + * structures where the pointers have a "structural reference". This means that + * their reference is to allowed access to the structure but it does not imply + * that the structure is functional. To simply increment or decrement the + * structural reference count, use ENGINE_by_id and ENGINE_free. NB: This is not + * required when iterating using ENGINE_get_next as it will automatically + * decrement the structural reference count of the "current" ENGINE and + * increment the structural reference count of the ENGINE it returns (unless it + * is NULL). */ + +/* Get the first/last "ENGINE" type available. */ +ENGINE *ENGINE_get_first(void); +ENGINE *ENGINE_get_last(void); +/* Iterate to the next/previous "ENGINE" type (NULL = end of the list). */ +ENGINE *ENGINE_get_next(ENGINE *e); +ENGINE *ENGINE_get_prev(ENGINE *e); +/* Add another "ENGINE" type into the array. */ +int ENGINE_add(ENGINE *e); +/* Remove an existing "ENGINE" type from the array. */ +int ENGINE_remove(ENGINE *e); +/* Retrieve an engine from the list by its unique "id" value. */ +ENGINE *ENGINE_by_id(const char *id); +/* Add all the built-in engines. */ +void ENGINE_load_openssl(void); +void ENGINE_load_dynamic(void); +#ifndef OPENSSL_NO_STATIC_ENGINE +void ENGINE_load_4758cca(void); +void ENGINE_load_aep(void); +void ENGINE_load_atalla(void); +void ENGINE_load_chil(void); +void ENGINE_load_cswift(void); +void ENGINE_load_nuron(void); +void ENGINE_load_sureware(void); +void ENGINE_load_ubsec(void); +void ENGINE_load_padlock(void); +void ENGINE_load_capi(void); +#ifndef OPENSSL_NO_GMP +void ENGINE_load_gmp(void); +#endif +#ifndef OPENSSL_NO_GOST +void ENGINE_load_gost(void); +#endif +#endif +void ENGINE_load_cryptodev(void); +void ENGINE_load_rsax(void); +void ENGINE_load_rdrand(void); +void ENGINE_load_builtin_engines(void); + +/* Get and set global flags (ENGINE_TABLE_FLAG_***) for the implementation + * "registry" handling. */ +unsigned int ENGINE_get_table_flags(void); +void ENGINE_set_table_flags(unsigned int flags); + +/* Manage registration of ENGINEs per "table". For each type, there are 3 + * functions; + * ENGINE_register_***(e) - registers the implementation from 'e' (if it has one) + * ENGINE_unregister_***(e) - unregister the implementation from 'e' + * ENGINE_register_all_***() - call ENGINE_register_***() for each 'e' in the list + * Cleanup is automatically registered from each table when required, so + * ENGINE_cleanup() will reverse any "register" operations. */ + +int ENGINE_register_RSA(ENGINE *e); +void ENGINE_unregister_RSA(ENGINE *e); +void ENGINE_register_all_RSA(void); + +int ENGINE_register_DSA(ENGINE *e); +void ENGINE_unregister_DSA(ENGINE *e); +void ENGINE_register_all_DSA(void); + +int ENGINE_register_ECDH(ENGINE *e); +void ENGINE_unregister_ECDH(ENGINE *e); +void ENGINE_register_all_ECDH(void); + +int ENGINE_register_ECDSA(ENGINE *e); +void ENGINE_unregister_ECDSA(ENGINE *e); +void ENGINE_register_all_ECDSA(void); + +int ENGINE_register_DH(ENGINE *e); +void ENGINE_unregister_DH(ENGINE *e); +void ENGINE_register_all_DH(void); + +int ENGINE_register_RAND(ENGINE *e); +void ENGINE_unregister_RAND(ENGINE *e); +void ENGINE_register_all_RAND(void); + +int ENGINE_register_STORE(ENGINE *e); +void ENGINE_unregister_STORE(ENGINE *e); +void ENGINE_register_all_STORE(void); + +int ENGINE_register_ciphers(ENGINE *e); +void ENGINE_unregister_ciphers(ENGINE *e); +void ENGINE_register_all_ciphers(void); + +int ENGINE_register_digests(ENGINE *e); +void ENGINE_unregister_digests(ENGINE *e); +void ENGINE_register_all_digests(void); + +int ENGINE_register_pkey_meths(ENGINE *e); +void ENGINE_unregister_pkey_meths(ENGINE *e); +void ENGINE_register_all_pkey_meths(void); + +int ENGINE_register_pkey_asn1_meths(ENGINE *e); +void ENGINE_unregister_pkey_asn1_meths(ENGINE *e); +void ENGINE_register_all_pkey_asn1_meths(void); + +/* These functions register all support from the above categories. Note, use of + * these functions can result in static linkage of code your application may not + * need. If you only need a subset of functionality, consider using more + * selective initialisation. */ +int ENGINE_register_complete(ENGINE *e); +int ENGINE_register_all_complete(void); + +/* Send parametrised control commands to the engine. The possibilities to send + * down an integer, a pointer to data or a function pointer are provided. Any of + * the parameters may or may not be NULL, depending on the command number. In + * actuality, this function only requires a structural (rather than functional) + * reference to an engine, but many control commands may require the engine be + * functional. The caller should be aware of trying commands that require an + * operational ENGINE, and only use functional references in such situations. */ +int ENGINE_ctrl(ENGINE *e, int cmd, long i, void *p, void (*f)(void)); + +/* This function tests if an ENGINE-specific command is usable as a "setting". + * Eg. in an application's config file that gets processed through + * ENGINE_ctrl_cmd_string(). If this returns zero, it is not available to + * ENGINE_ctrl_cmd_string(), only ENGINE_ctrl(). */ +int ENGINE_cmd_is_executable(ENGINE *e, int cmd); + +/* This function works like ENGINE_ctrl() with the exception of taking a + * command name instead of a command number, and can handle optional commands. + * See the comment on ENGINE_ctrl_cmd_string() for an explanation on how to + * use the cmd_name and cmd_optional. */ +int ENGINE_ctrl_cmd(ENGINE *e, const char *cmd_name, + long i, void *p, void (*f)(void), int cmd_optional); + +/* This function passes a command-name and argument to an ENGINE. The cmd_name + * is converted to a command number and the control command is called using + * 'arg' as an argument (unless the ENGINE doesn't support such a command, in + * which case no control command is called). The command is checked for input + * flags, and if necessary the argument will be converted to a numeric value. If + * cmd_optional is non-zero, then if the ENGINE doesn't support the given + * cmd_name the return value will be success anyway. This function is intended + * for applications to use so that users (or config files) can supply + * engine-specific config data to the ENGINE at run-time to control behaviour of + * specific engines. As such, it shouldn't be used for calling ENGINE_ctrl() + * functions that return data, deal with binary data, or that are otherwise + * supposed to be used directly through ENGINE_ctrl() in application code. Any + * "return" data from an ENGINE_ctrl() operation in this function will be lost - + * the return value is interpreted as failure if the return value is zero, + * success otherwise, and this function returns a boolean value as a result. In + * other words, vendors of 'ENGINE'-enabled devices should write ENGINE + * implementations with parameterisations that work in this scheme, so that + * compliant ENGINE-based applications can work consistently with the same + * configuration for the same ENGINE-enabled devices, across applications. */ +int ENGINE_ctrl_cmd_string(ENGINE *e, const char *cmd_name, const char *arg, + int cmd_optional); + +/* These functions are useful for manufacturing new ENGINE structures. They + * don't address reference counting at all - one uses them to populate an ENGINE + * structure with personalised implementations of things prior to using it + * directly or adding it to the builtin ENGINE list in OpenSSL. These are also + * here so that the ENGINE structure doesn't have to be exposed and break binary + * compatibility! */ +ENGINE *ENGINE_new(void); +int ENGINE_free(ENGINE *e); +int ENGINE_up_ref(ENGINE *e); +int ENGINE_set_id(ENGINE *e, const char *id); +int ENGINE_set_name(ENGINE *e, const char *name); +int ENGINE_set_RSA(ENGINE *e, const RSA_METHOD *rsa_meth); +int ENGINE_set_DSA(ENGINE *e, const DSA_METHOD *dsa_meth); +int ENGINE_set_ECDH(ENGINE *e, const ECDH_METHOD *ecdh_meth); +int ENGINE_set_ECDSA(ENGINE *e, const ECDSA_METHOD *ecdsa_meth); +int ENGINE_set_DH(ENGINE *e, const DH_METHOD *dh_meth); +int ENGINE_set_RAND(ENGINE *e, const RAND_METHOD *rand_meth); +int ENGINE_set_STORE(ENGINE *e, const STORE_METHOD *store_meth); +int ENGINE_set_destroy_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR destroy_f); +int ENGINE_set_init_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR init_f); +int ENGINE_set_finish_function(ENGINE *e, ENGINE_GEN_INT_FUNC_PTR finish_f); +int ENGINE_set_ctrl_function(ENGINE *e, ENGINE_CTRL_FUNC_PTR ctrl_f); +int ENGINE_set_load_privkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpriv_f); +int ENGINE_set_load_pubkey_function(ENGINE *e, ENGINE_LOAD_KEY_PTR loadpub_f); +int ENGINE_set_load_ssl_client_cert_function(ENGINE *e, + ENGINE_SSL_CLIENT_CERT_PTR loadssl_f); +int ENGINE_set_ciphers(ENGINE *e, ENGINE_CIPHERS_PTR f); +int ENGINE_set_digests(ENGINE *e, ENGINE_DIGESTS_PTR f); +int ENGINE_set_pkey_meths(ENGINE *e, ENGINE_PKEY_METHS_PTR f); +int ENGINE_set_pkey_asn1_meths(ENGINE *e, ENGINE_PKEY_ASN1_METHS_PTR f); +int ENGINE_set_flags(ENGINE *e, int flags); +int ENGINE_set_cmd_defns(ENGINE *e, const ENGINE_CMD_DEFN *defns); +/* These functions allow control over any per-structure ENGINE data. */ +int ENGINE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); +int ENGINE_set_ex_data(ENGINE *e, int idx, void *arg); +void *ENGINE_get_ex_data(const ENGINE *e, int idx); + +/* This function cleans up anything that needs it. Eg. the ENGINE_add() function + * automatically ensures the list cleanup function is registered to be called + * from ENGINE_cleanup(). Similarly, all ENGINE_register_*** functions ensure + * ENGINE_cleanup() will clean up after them. */ +void ENGINE_cleanup(void); + +/* These return values from within the ENGINE structure. These can be useful + * with functional references as well as structural references - it depends + * which you obtained. Using the result for functional purposes if you only + * obtained a structural reference may be problematic! */ +const char *ENGINE_get_id(const ENGINE *e); +const char *ENGINE_get_name(const ENGINE *e); +const RSA_METHOD *ENGINE_get_RSA(const ENGINE *e); +const DSA_METHOD *ENGINE_get_DSA(const ENGINE *e); +const ECDH_METHOD *ENGINE_get_ECDH(const ENGINE *e); +const ECDSA_METHOD *ENGINE_get_ECDSA(const ENGINE *e); +const DH_METHOD *ENGINE_get_DH(const ENGINE *e); +const RAND_METHOD *ENGINE_get_RAND(const ENGINE *e); +const STORE_METHOD *ENGINE_get_STORE(const ENGINE *e); +ENGINE_GEN_INT_FUNC_PTR ENGINE_get_destroy_function(const ENGINE *e); +ENGINE_GEN_INT_FUNC_PTR ENGINE_get_init_function(const ENGINE *e); +ENGINE_GEN_INT_FUNC_PTR ENGINE_get_finish_function(const ENGINE *e); +ENGINE_CTRL_FUNC_PTR ENGINE_get_ctrl_function(const ENGINE *e); +ENGINE_LOAD_KEY_PTR ENGINE_get_load_privkey_function(const ENGINE *e); +ENGINE_LOAD_KEY_PTR ENGINE_get_load_pubkey_function(const ENGINE *e); +ENGINE_SSL_CLIENT_CERT_PTR ENGINE_get_ssl_client_cert_function(const ENGINE *e); +ENGINE_CIPHERS_PTR ENGINE_get_ciphers(const ENGINE *e); +ENGINE_DIGESTS_PTR ENGINE_get_digests(const ENGINE *e); +ENGINE_PKEY_METHS_PTR ENGINE_get_pkey_meths(const ENGINE *e); +ENGINE_PKEY_ASN1_METHS_PTR ENGINE_get_pkey_asn1_meths(const ENGINE *e); +const EVP_CIPHER *ENGINE_get_cipher(ENGINE *e, int nid); +const EVP_MD *ENGINE_get_digest(ENGINE *e, int nid); +const EVP_PKEY_METHOD *ENGINE_get_pkey_meth(ENGINE *e, int nid); +const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth(ENGINE *e, int nid); +const EVP_PKEY_ASN1_METHOD *ENGINE_get_pkey_asn1_meth_str(ENGINE *e, + const char *str, int len); +const EVP_PKEY_ASN1_METHOD *ENGINE_pkey_asn1_find_str(ENGINE **pe, + const char *str, int len); +const ENGINE_CMD_DEFN *ENGINE_get_cmd_defns(const ENGINE *e); +int ENGINE_get_flags(const ENGINE *e); + +/* FUNCTIONAL functions. These functions deal with ENGINE structures + * that have (or will) be initialised for use. Broadly speaking, the + * structural functions are useful for iterating the list of available + * engine types, creating new engine types, and other "list" operations. + * These functions actually deal with ENGINEs that are to be used. As + * such these functions can fail (if applicable) when particular + * engines are unavailable - eg. if a hardware accelerator is not + * attached or not functioning correctly. Each ENGINE has 2 reference + * counts; structural and functional. Every time a functional reference + * is obtained or released, a corresponding structural reference is + * automatically obtained or released too. */ + +/* Initialise a engine type for use (or up its reference count if it's + * already in use). This will fail if the engine is not currently + * operational and cannot initialise. */ +int ENGINE_init(ENGINE *e); +/* Free a functional reference to a engine type. This does not require + * a corresponding call to ENGINE_free as it also releases a structural + * reference. */ +int ENGINE_finish(ENGINE *e); + +/* The following functions handle keys that are stored in some secondary + * location, handled by the engine. The storage may be on a card or + * whatever. */ +EVP_PKEY *ENGINE_load_private_key(ENGINE *e, const char *key_id, + UI_METHOD *ui_method, void *callback_data); +EVP_PKEY *ENGINE_load_public_key(ENGINE *e, const char *key_id, + UI_METHOD *ui_method, void *callback_data); +int ENGINE_load_ssl_client_cert(ENGINE *e, SSL *s, + STACK_OF(X509_NAME) *ca_dn, X509 **pcert, EVP_PKEY **ppkey, + STACK_OF(X509) **pother, + UI_METHOD *ui_method, void *callback_data); + +/* This returns a pointer for the current ENGINE structure that + * is (by default) performing any RSA operations. The value returned + * is an incremented reference, so it should be free'd (ENGINE_finish) + * before it is discarded. */ +ENGINE *ENGINE_get_default_RSA(void); +/* Same for the other "methods" */ +ENGINE *ENGINE_get_default_DSA(void); +ENGINE *ENGINE_get_default_ECDH(void); +ENGINE *ENGINE_get_default_ECDSA(void); +ENGINE *ENGINE_get_default_DH(void); +ENGINE *ENGINE_get_default_RAND(void); +/* These functions can be used to get a functional reference to perform + * ciphering or digesting corresponding to "nid". */ +ENGINE *ENGINE_get_cipher_engine(int nid); +ENGINE *ENGINE_get_digest_engine(int nid); +ENGINE *ENGINE_get_pkey_meth_engine(int nid); +ENGINE *ENGINE_get_pkey_asn1_meth_engine(int nid); + +/* This sets a new default ENGINE structure for performing RSA + * operations. If the result is non-zero (success) then the ENGINE + * structure will have had its reference count up'd so the caller + * should still free their own reference 'e'. */ +int ENGINE_set_default_RSA(ENGINE *e); +int ENGINE_set_default_string(ENGINE *e, const char *def_list); +/* Same for the other "methods" */ +int ENGINE_set_default_DSA(ENGINE *e); +int ENGINE_set_default_ECDH(ENGINE *e); +int ENGINE_set_default_ECDSA(ENGINE *e); +int ENGINE_set_default_DH(ENGINE *e); +int ENGINE_set_default_RAND(ENGINE *e); +int ENGINE_set_default_ciphers(ENGINE *e); +int ENGINE_set_default_digests(ENGINE *e); +int ENGINE_set_default_pkey_meths(ENGINE *e); +int ENGINE_set_default_pkey_asn1_meths(ENGINE *e); + +/* The combination "set" - the flags are bitwise "OR"d from the + * ENGINE_METHOD_*** defines above. As with the "ENGINE_register_complete()" + * function, this function can result in unnecessary static linkage. If your + * application requires only specific functionality, consider using more + * selective functions. */ +int ENGINE_set_default(ENGINE *e, unsigned int flags); + +void ENGINE_add_conf_module(void); + +/* Deprecated functions ... */ +/* int ENGINE_clear_defaults(void); */ + +/**************************/ +/* DYNAMIC ENGINE SUPPORT */ +/**************************/ + +/* Binary/behaviour compatibility levels */ +#define OSSL_DYNAMIC_VERSION (unsigned long)0x00020000 +/* Binary versions older than this are too old for us (whether we're a loader or + * a loadee) */ +#define OSSL_DYNAMIC_OLDEST (unsigned long)0x00020000 + +/* When compiling an ENGINE entirely as an external shared library, loadable by + * the "dynamic" ENGINE, these types are needed. The 'dynamic_fns' structure + * type provides the calling application's (or library's) error functionality + * and memory management function pointers to the loaded library. These should + * be used/set in the loaded library code so that the loading application's + * 'state' will be used/changed in all operations. The 'static_state' pointer + * allows the loaded library to know if it shares the same static data as the + * calling application (or library), and thus whether these callbacks need to be + * set or not. */ +typedef void *(*dyn_MEM_malloc_cb)(size_t); +typedef void *(*dyn_MEM_realloc_cb)(void *, size_t); +typedef void (*dyn_MEM_free_cb)(void *); +typedef struct st_dynamic_MEM_fns { + dyn_MEM_malloc_cb malloc_cb; + dyn_MEM_realloc_cb realloc_cb; + dyn_MEM_free_cb free_cb; + } dynamic_MEM_fns; +/* FIXME: Perhaps the memory and locking code (crypto.h) should declare and use + * these types so we (and any other dependant code) can simplify a bit?? */ +typedef void (*dyn_lock_locking_cb)(int,int,const char *,int); +typedef int (*dyn_lock_add_lock_cb)(int*,int,int,const char *,int); +typedef struct CRYPTO_dynlock_value *(*dyn_dynlock_create_cb)( + const char *,int); +typedef void (*dyn_dynlock_lock_cb)(int,struct CRYPTO_dynlock_value *, + const char *,int); +typedef void (*dyn_dynlock_destroy_cb)(struct CRYPTO_dynlock_value *, + const char *,int); +typedef struct st_dynamic_LOCK_fns { + dyn_lock_locking_cb lock_locking_cb; + dyn_lock_add_lock_cb lock_add_lock_cb; + dyn_dynlock_create_cb dynlock_create_cb; + dyn_dynlock_lock_cb dynlock_lock_cb; + dyn_dynlock_destroy_cb dynlock_destroy_cb; + } dynamic_LOCK_fns; +/* The top-level structure */ +typedef struct st_dynamic_fns { + void *static_state; + const ERR_FNS *err_fns; + const CRYPTO_EX_DATA_IMPL *ex_data_fns; + dynamic_MEM_fns mem_fns; + dynamic_LOCK_fns lock_fns; + } dynamic_fns; + +/* The version checking function should be of this prototype. NB: The + * ossl_version value passed in is the OSSL_DYNAMIC_VERSION of the loading code. + * If this function returns zero, it indicates a (potential) version + * incompatibility and the loaded library doesn't believe it can proceed. + * Otherwise, the returned value is the (latest) version supported by the + * loading library. The loader may still decide that the loaded code's version + * is unsatisfactory and could veto the load. The function is expected to + * be implemented with the symbol name "v_check", and a default implementation + * can be fully instantiated with IMPLEMENT_DYNAMIC_CHECK_FN(). */ +typedef unsigned long (*dynamic_v_check_fn)(unsigned long ossl_version); +#define IMPLEMENT_DYNAMIC_CHECK_FN() \ + OPENSSL_EXPORT unsigned long v_check(unsigned long v); \ + OPENSSL_EXPORT unsigned long v_check(unsigned long v) { \ + if(v >= OSSL_DYNAMIC_OLDEST) return OSSL_DYNAMIC_VERSION; \ + return 0; } + +/* This function is passed the ENGINE structure to initialise with its own + * function and command settings. It should not adjust the structural or + * functional reference counts. If this function returns zero, (a) the load will + * be aborted, (b) the previous ENGINE state will be memcpy'd back onto the + * structure, and (c) the shared library will be unloaded. So implementations + * should do their own internal cleanup in failure circumstances otherwise they + * could leak. The 'id' parameter, if non-NULL, represents the ENGINE id that + * the loader is looking for. If this is NULL, the shared library can choose to + * return failure or to initialise a 'default' ENGINE. If non-NULL, the shared + * library must initialise only an ENGINE matching the passed 'id'. The function + * is expected to be implemented with the symbol name "bind_engine". A standard + * implementation can be instantiated with IMPLEMENT_DYNAMIC_BIND_FN(fn) where + * the parameter 'fn' is a callback function that populates the ENGINE structure + * and returns an int value (zero for failure). 'fn' should have prototype; + * [static] int fn(ENGINE *e, const char *id); */ +typedef int (*dynamic_bind_engine)(ENGINE *e, const char *id, + const dynamic_fns *fns); +#define IMPLEMENT_DYNAMIC_BIND_FN(fn) \ + OPENSSL_EXPORT \ + int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns); \ + OPENSSL_EXPORT \ + int bind_engine(ENGINE *e, const char *id, const dynamic_fns *fns) { \ + if(ENGINE_get_static_state() == fns->static_state) goto skip_cbs; \ + if(!CRYPTO_set_mem_functions(fns->mem_fns.malloc_cb, \ + fns->mem_fns.realloc_cb, fns->mem_fns.free_cb)) \ + return 0; \ + CRYPTO_set_locking_callback(fns->lock_fns.lock_locking_cb); \ + CRYPTO_set_add_lock_callback(fns->lock_fns.lock_add_lock_cb); \ + CRYPTO_set_dynlock_create_callback(fns->lock_fns.dynlock_create_cb); \ + CRYPTO_set_dynlock_lock_callback(fns->lock_fns.dynlock_lock_cb); \ + CRYPTO_set_dynlock_destroy_callback(fns->lock_fns.dynlock_destroy_cb); \ + if(!CRYPTO_set_ex_data_implementation(fns->ex_data_fns)) \ + return 0; \ + if(!ERR_set_implementation(fns->err_fns)) return 0; \ + skip_cbs: \ + if(!fn(e,id)) return 0; \ + return 1; } + +/* If the loading application (or library) and the loaded ENGINE library share + * the same static data (eg. they're both dynamically linked to the same + * libcrypto.so) we need a way to avoid trying to set system callbacks - this + * would fail, and for the same reason that it's unnecessary to try. If the + * loaded ENGINE has (or gets from through the loader) its own copy of the + * libcrypto static data, we will need to set the callbacks. The easiest way to + * detect this is to have a function that returns a pointer to some static data + * and let the loading application and loaded ENGINE compare their respective + * values. */ +void *ENGINE_get_static_state(void); + +#if defined(__OpenBSD__) || defined(__FreeBSD__) || defined(HAVE_CRYPTODEV) +void ENGINE_setup_bsd_cryptodev(void); +#endif + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_ENGINE_strings(void); + +/* Error codes for the ENGINE functions. */ + +/* Function codes. */ +#define ENGINE_F_DYNAMIC_CTRL 180 +#define ENGINE_F_DYNAMIC_GET_DATA_CTX 181 +#define ENGINE_F_DYNAMIC_LOAD 182 +#define ENGINE_F_DYNAMIC_SET_DATA_CTX 183 +#define ENGINE_F_ENGINE_ADD 105 +#define ENGINE_F_ENGINE_BY_ID 106 +#define ENGINE_F_ENGINE_CMD_IS_EXECUTABLE 170 +#define ENGINE_F_ENGINE_CTRL 142 +#define ENGINE_F_ENGINE_CTRL_CMD 178 +#define ENGINE_F_ENGINE_CTRL_CMD_STRING 171 +#define ENGINE_F_ENGINE_FINISH 107 +#define ENGINE_F_ENGINE_FREE_UTIL 108 +#define ENGINE_F_ENGINE_GET_CIPHER 185 +#define ENGINE_F_ENGINE_GET_DEFAULT_TYPE 177 +#define ENGINE_F_ENGINE_GET_DIGEST 186 +#define ENGINE_F_ENGINE_GET_NEXT 115 +#define ENGINE_F_ENGINE_GET_PKEY_ASN1_METH 193 +#define ENGINE_F_ENGINE_GET_PKEY_METH 192 +#define ENGINE_F_ENGINE_GET_PREV 116 +#define ENGINE_F_ENGINE_INIT 119 +#define ENGINE_F_ENGINE_LIST_ADD 120 +#define ENGINE_F_ENGINE_LIST_REMOVE 121 +#define ENGINE_F_ENGINE_LOAD_PRIVATE_KEY 150 +#define ENGINE_F_ENGINE_LOAD_PUBLIC_KEY 151 +#define ENGINE_F_ENGINE_LOAD_SSL_CLIENT_CERT 194 +#define ENGINE_F_ENGINE_NEW 122 +#define ENGINE_F_ENGINE_REMOVE 123 +#define ENGINE_F_ENGINE_SET_DEFAULT_STRING 189 +#define ENGINE_F_ENGINE_SET_DEFAULT_TYPE 126 +#define ENGINE_F_ENGINE_SET_ID 129 +#define ENGINE_F_ENGINE_SET_NAME 130 +#define ENGINE_F_ENGINE_TABLE_REGISTER 184 +#define ENGINE_F_ENGINE_UNLOAD_KEY 152 +#define ENGINE_F_ENGINE_UNLOCKED_FINISH 191 +#define ENGINE_F_ENGINE_UP_REF 190 +#define ENGINE_F_INT_CTRL_HELPER 172 +#define ENGINE_F_INT_ENGINE_CONFIGURE 188 +#define ENGINE_F_INT_ENGINE_MODULE_INIT 187 +#define ENGINE_F_LOG_MESSAGE 141 + +/* Reason codes. */ +#define ENGINE_R_ALREADY_LOADED 100 +#define ENGINE_R_ARGUMENT_IS_NOT_A_NUMBER 133 +#define ENGINE_R_CMD_NOT_EXECUTABLE 134 +#define ENGINE_R_COMMAND_TAKES_INPUT 135 +#define ENGINE_R_COMMAND_TAKES_NO_INPUT 136 +#define ENGINE_R_CONFLICTING_ENGINE_ID 103 +#define ENGINE_R_CTRL_COMMAND_NOT_IMPLEMENTED 119 +#define ENGINE_R_DH_NOT_IMPLEMENTED 139 +#define ENGINE_R_DSA_NOT_IMPLEMENTED 140 +#define ENGINE_R_DSO_FAILURE 104 +#define ENGINE_R_DSO_NOT_FOUND 132 +#define ENGINE_R_ENGINES_SECTION_ERROR 148 +#define ENGINE_R_ENGINE_CONFIGURATION_ERROR 102 +#define ENGINE_R_ENGINE_IS_NOT_IN_LIST 105 +#define ENGINE_R_ENGINE_SECTION_ERROR 149 +#define ENGINE_R_FAILED_LOADING_PRIVATE_KEY 128 +#define ENGINE_R_FAILED_LOADING_PUBLIC_KEY 129 +#define ENGINE_R_FINISH_FAILED 106 +#define ENGINE_R_GET_HANDLE_FAILED 107 +#define ENGINE_R_ID_OR_NAME_MISSING 108 +#define ENGINE_R_INIT_FAILED 109 +#define ENGINE_R_INTERNAL_LIST_ERROR 110 +#define ENGINE_R_INVALID_ARGUMENT 143 +#define ENGINE_R_INVALID_CMD_NAME 137 +#define ENGINE_R_INVALID_CMD_NUMBER 138 +#define ENGINE_R_INVALID_INIT_VALUE 151 +#define ENGINE_R_INVALID_STRING 150 +#define ENGINE_R_NOT_INITIALISED 117 +#define ENGINE_R_NOT_LOADED 112 +#define ENGINE_R_NO_CONTROL_FUNCTION 120 +#define ENGINE_R_NO_INDEX 144 +#define ENGINE_R_NO_LOAD_FUNCTION 125 +#define ENGINE_R_NO_REFERENCE 130 +#define ENGINE_R_NO_SUCH_ENGINE 116 +#define ENGINE_R_NO_UNLOAD_FUNCTION 126 +#define ENGINE_R_PROVIDE_PARAMETERS 113 +#define ENGINE_R_RSA_NOT_IMPLEMENTED 141 +#define ENGINE_R_UNIMPLEMENTED_CIPHER 146 +#define ENGINE_R_UNIMPLEMENTED_DIGEST 147 +#define ENGINE_R_UNIMPLEMENTED_PUBLIC_KEY_METHOD 101 +#define ENGINE_R_VERSION_INCOMPATIBILITY 145 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/err.h b/Source/Import/OpenSSL/Include/openssl/err.h new file mode 100644 index 0000000..974cc9c --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/err.h @@ -0,0 +1,386 @@ +/* crypto/err/err.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ +/* ==================================================================== + * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_ERR_H +#define HEADER_ERR_H + +#include + +#ifndef OPENSSL_NO_FP_API +#include +#include +#endif + +#include +#ifndef OPENSSL_NO_BIO +#include +#endif +#ifndef OPENSSL_NO_LHASH +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef OPENSSL_NO_ERR +#define ERR_PUT_error(a,b,c,d,e) ERR_put_error(a,b,c,d,e) +#else +#define ERR_PUT_error(a,b,c,d,e) ERR_put_error(a,b,c,NULL,0) +#endif + +#include + +#define ERR_TXT_MALLOCED 0x01 +#define ERR_TXT_STRING 0x02 + +#define ERR_FLAG_MARK 0x01 + +#define ERR_NUM_ERRORS 16 +typedef struct err_state_st + { + CRYPTO_THREADID tid; + int err_flags[ERR_NUM_ERRORS]; + unsigned long err_buffer[ERR_NUM_ERRORS]; + char *err_data[ERR_NUM_ERRORS]; + int err_data_flags[ERR_NUM_ERRORS]; + const char *err_file[ERR_NUM_ERRORS]; + int err_line[ERR_NUM_ERRORS]; + int top,bottom; + } ERR_STATE; + +/* library */ +#define ERR_LIB_NONE 1 +#define ERR_LIB_SYS 2 +#define ERR_LIB_BN 3 +#define ERR_LIB_RSA 4 +#define ERR_LIB_DH 5 +#define ERR_LIB_EVP 6 +#define ERR_LIB_BUF 7 +#define ERR_LIB_OBJ 8 +#define ERR_LIB_PEM 9 +#define ERR_LIB_DSA 10 +#define ERR_LIB_X509 11 +/* #define ERR_LIB_METH 12 */ +#define ERR_LIB_ASN1 13 +#define ERR_LIB_CONF 14 +#define ERR_LIB_CRYPTO 15 +#define ERR_LIB_EC 16 +#define ERR_LIB_SSL 20 +/* #define ERR_LIB_SSL23 21 */ +/* #define ERR_LIB_SSL2 22 */ +/* #define ERR_LIB_SSL3 23 */ +/* #define ERR_LIB_RSAREF 30 */ +/* #define ERR_LIB_PROXY 31 */ +#define ERR_LIB_BIO 32 +#define ERR_LIB_PKCS7 33 +#define ERR_LIB_X509V3 34 +#define ERR_LIB_PKCS12 35 +#define ERR_LIB_RAND 36 +#define ERR_LIB_DSO 37 +#define ERR_LIB_ENGINE 38 +#define ERR_LIB_OCSP 39 +#define ERR_LIB_UI 40 +#define ERR_LIB_COMP 41 +#define ERR_LIB_ECDSA 42 +#define ERR_LIB_ECDH 43 +#define ERR_LIB_STORE 44 +#define ERR_LIB_FIPS 45 +#define ERR_LIB_CMS 46 +#define ERR_LIB_TS 47 +#define ERR_LIB_HMAC 48 +#define ERR_LIB_JPAKE 49 + +#define ERR_LIB_USER 128 + +#define SYSerr(f,r) ERR_PUT_error(ERR_LIB_SYS,(f),(r),__FILE__,__LINE__) +#define BNerr(f,r) ERR_PUT_error(ERR_LIB_BN,(f),(r),__FILE__,__LINE__) +#define RSAerr(f,r) ERR_PUT_error(ERR_LIB_RSA,(f),(r),__FILE__,__LINE__) +#define DHerr(f,r) ERR_PUT_error(ERR_LIB_DH,(f),(r),__FILE__,__LINE__) +#define EVPerr(f,r) ERR_PUT_error(ERR_LIB_EVP,(f),(r),__FILE__,__LINE__) +#define BUFerr(f,r) ERR_PUT_error(ERR_LIB_BUF,(f),(r),__FILE__,__LINE__) +#define OBJerr(f,r) ERR_PUT_error(ERR_LIB_OBJ,(f),(r),__FILE__,__LINE__) +#define PEMerr(f,r) ERR_PUT_error(ERR_LIB_PEM,(f),(r),__FILE__,__LINE__) +#define DSAerr(f,r) ERR_PUT_error(ERR_LIB_DSA,(f),(r),__FILE__,__LINE__) +#define X509err(f,r) ERR_PUT_error(ERR_LIB_X509,(f),(r),__FILE__,__LINE__) +#define ASN1err(f,r) ERR_PUT_error(ERR_LIB_ASN1,(f),(r),__FILE__,__LINE__) +#define CONFerr(f,r) ERR_PUT_error(ERR_LIB_CONF,(f),(r),__FILE__,__LINE__) +#define CRYPTOerr(f,r) ERR_PUT_error(ERR_LIB_CRYPTO,(f),(r),__FILE__,__LINE__) +#define ECerr(f,r) ERR_PUT_error(ERR_LIB_EC,(f),(r),__FILE__,__LINE__) +#define SSLerr(f,r) ERR_PUT_error(ERR_LIB_SSL,(f),(r),__FILE__,__LINE__) +#define BIOerr(f,r) ERR_PUT_error(ERR_LIB_BIO,(f),(r),__FILE__,__LINE__) +#define PKCS7err(f,r) ERR_PUT_error(ERR_LIB_PKCS7,(f),(r),__FILE__,__LINE__) +#define X509V3err(f,r) ERR_PUT_error(ERR_LIB_X509V3,(f),(r),__FILE__,__LINE__) +#define PKCS12err(f,r) ERR_PUT_error(ERR_LIB_PKCS12,(f),(r),__FILE__,__LINE__) +#define RANDerr(f,r) ERR_PUT_error(ERR_LIB_RAND,(f),(r),__FILE__,__LINE__) +#define DSOerr(f,r) ERR_PUT_error(ERR_LIB_DSO,(f),(r),__FILE__,__LINE__) +#define ENGINEerr(f,r) ERR_PUT_error(ERR_LIB_ENGINE,(f),(r),__FILE__,__LINE__) +#define OCSPerr(f,r) ERR_PUT_error(ERR_LIB_OCSP,(f),(r),__FILE__,__LINE__) +#define UIerr(f,r) ERR_PUT_error(ERR_LIB_UI,(f),(r),__FILE__,__LINE__) +#define COMPerr(f,r) ERR_PUT_error(ERR_LIB_COMP,(f),(r),__FILE__,__LINE__) +#define ECDSAerr(f,r) ERR_PUT_error(ERR_LIB_ECDSA,(f),(r),__FILE__,__LINE__) +#define ECDHerr(f,r) ERR_PUT_error(ERR_LIB_ECDH,(f),(r),__FILE__,__LINE__) +#define STOREerr(f,r) ERR_PUT_error(ERR_LIB_STORE,(f),(r),__FILE__,__LINE__) +#define FIPSerr(f,r) ERR_PUT_error(ERR_LIB_FIPS,(f),(r),__FILE__,__LINE__) +#define CMSerr(f,r) ERR_PUT_error(ERR_LIB_CMS,(f),(r),__FILE__,__LINE__) +#define TSerr(f,r) ERR_PUT_error(ERR_LIB_TS,(f),(r),__FILE__,__LINE__) +#define HMACerr(f,r) ERR_PUT_error(ERR_LIB_HMAC,(f),(r),__FILE__,__LINE__) +#define JPAKEerr(f,r) ERR_PUT_error(ERR_LIB_JPAKE,(f),(r),__FILE__,__LINE__) + +/* Borland C seems too stupid to be able to shift and do longs in + * the pre-processor :-( */ +#define ERR_PACK(l,f,r) (((((unsigned long)l)&0xffL)*0x1000000)| \ + ((((unsigned long)f)&0xfffL)*0x1000)| \ + ((((unsigned long)r)&0xfffL))) +#define ERR_GET_LIB(l) (int)((((unsigned long)l)>>24L)&0xffL) +#define ERR_GET_FUNC(l) (int)((((unsigned long)l)>>12L)&0xfffL) +#define ERR_GET_REASON(l) (int)((l)&0xfffL) +#define ERR_FATAL_ERROR(l) (int)((l)&ERR_R_FATAL) + + +/* OS functions */ +#define SYS_F_FOPEN 1 +#define SYS_F_CONNECT 2 +#define SYS_F_GETSERVBYNAME 3 +#define SYS_F_SOCKET 4 +#define SYS_F_IOCTLSOCKET 5 +#define SYS_F_BIND 6 +#define SYS_F_LISTEN 7 +#define SYS_F_ACCEPT 8 +#define SYS_F_WSASTARTUP 9 /* Winsock stuff */ +#define SYS_F_OPENDIR 10 +#define SYS_F_FREAD 11 + + +/* reasons */ +#define ERR_R_SYS_LIB ERR_LIB_SYS /* 2 */ +#define ERR_R_BN_LIB ERR_LIB_BN /* 3 */ +#define ERR_R_RSA_LIB ERR_LIB_RSA /* 4 */ +#define ERR_R_DH_LIB ERR_LIB_DH /* 5 */ +#define ERR_R_EVP_LIB ERR_LIB_EVP /* 6 */ +#define ERR_R_BUF_LIB ERR_LIB_BUF /* 7 */ +#define ERR_R_OBJ_LIB ERR_LIB_OBJ /* 8 */ +#define ERR_R_PEM_LIB ERR_LIB_PEM /* 9 */ +#define ERR_R_DSA_LIB ERR_LIB_DSA /* 10 */ +#define ERR_R_X509_LIB ERR_LIB_X509 /* 11 */ +#define ERR_R_ASN1_LIB ERR_LIB_ASN1 /* 13 */ +#define ERR_R_CONF_LIB ERR_LIB_CONF /* 14 */ +#define ERR_R_CRYPTO_LIB ERR_LIB_CRYPTO /* 15 */ +#define ERR_R_EC_LIB ERR_LIB_EC /* 16 */ +#define ERR_R_SSL_LIB ERR_LIB_SSL /* 20 */ +#define ERR_R_BIO_LIB ERR_LIB_BIO /* 32 */ +#define ERR_R_PKCS7_LIB ERR_LIB_PKCS7 /* 33 */ +#define ERR_R_X509V3_LIB ERR_LIB_X509V3 /* 34 */ +#define ERR_R_PKCS12_LIB ERR_LIB_PKCS12 /* 35 */ +#define ERR_R_RAND_LIB ERR_LIB_RAND /* 36 */ +#define ERR_R_DSO_LIB ERR_LIB_DSO /* 37 */ +#define ERR_R_ENGINE_LIB ERR_LIB_ENGINE /* 38 */ +#define ERR_R_OCSP_LIB ERR_LIB_OCSP /* 39 */ +#define ERR_R_UI_LIB ERR_LIB_UI /* 40 */ +#define ERR_R_COMP_LIB ERR_LIB_COMP /* 41 */ +#define ERR_R_ECDSA_LIB ERR_LIB_ECDSA /* 42 */ +#define ERR_R_ECDH_LIB ERR_LIB_ECDH /* 43 */ +#define ERR_R_STORE_LIB ERR_LIB_STORE /* 44 */ +#define ERR_R_TS_LIB ERR_LIB_TS /* 45 */ + +#define ERR_R_NESTED_ASN1_ERROR 58 +#define ERR_R_BAD_ASN1_OBJECT_HEADER 59 +#define ERR_R_BAD_GET_ASN1_OBJECT_CALL 60 +#define ERR_R_EXPECTING_AN_ASN1_SEQUENCE 61 +#define ERR_R_ASN1_LENGTH_MISMATCH 62 +#define ERR_R_MISSING_ASN1_EOS 63 + +/* fatal error */ +#define ERR_R_FATAL 64 +#define ERR_R_MALLOC_FAILURE (1|ERR_R_FATAL) +#define ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED (2|ERR_R_FATAL) +#define ERR_R_PASSED_NULL_PARAMETER (3|ERR_R_FATAL) +#define ERR_R_INTERNAL_ERROR (4|ERR_R_FATAL) +#define ERR_R_DISABLED (5|ERR_R_FATAL) + +/* 99 is the maximum possible ERR_R_... code, higher values + * are reserved for the individual libraries */ + + +typedef struct ERR_string_data_st + { + unsigned long error; + const char *string; + } ERR_STRING_DATA; + +void ERR_put_error(int lib, int func,int reason,const char *file,int line); +void ERR_set_error_data(char *data,int flags); + +unsigned long ERR_get_error(void); +unsigned long ERR_get_error_line(const char **file,int *line); +unsigned long ERR_get_error_line_data(const char **file,int *line, + const char **data, int *flags); +unsigned long ERR_peek_error(void); +unsigned long ERR_peek_error_line(const char **file,int *line); +unsigned long ERR_peek_error_line_data(const char **file,int *line, + const char **data,int *flags); +unsigned long ERR_peek_last_error(void); +unsigned long ERR_peek_last_error_line(const char **file,int *line); +unsigned long ERR_peek_last_error_line_data(const char **file,int *line, + const char **data,int *flags); +void ERR_clear_error(void ); +char *ERR_error_string(unsigned long e,char *buf); +void ERR_error_string_n(unsigned long e, char *buf, size_t len); +const char *ERR_lib_error_string(unsigned long e); +const char *ERR_func_error_string(unsigned long e); +const char *ERR_reason_error_string(unsigned long e); +void ERR_print_errors_cb(int (*cb)(const char *str, size_t len, void *u), + void *u); +#ifndef OPENSSL_NO_FP_API +void ERR_print_errors_fp(FILE *fp); +#endif +#ifndef OPENSSL_NO_BIO +void ERR_print_errors(BIO *bp); +#endif +void ERR_add_error_data(int num, ...); +void ERR_add_error_vdata(int num, va_list args); +void ERR_load_strings(int lib,ERR_STRING_DATA str[]); +void ERR_unload_strings(int lib,ERR_STRING_DATA str[]); +void ERR_load_ERR_strings(void); +void ERR_load_crypto_strings(void); +void ERR_free_strings(void); + +void ERR_remove_thread_state(const CRYPTO_THREADID *tid); +#ifndef OPENSSL_NO_DEPRECATED +void ERR_remove_state(unsigned long pid); /* if zero we look it up */ +#endif +ERR_STATE *ERR_get_state(void); + +#ifndef OPENSSL_NO_LHASH +LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void); +LHASH_OF(ERR_STATE) *ERR_get_err_state_table(void); +void ERR_release_err_state_table(LHASH_OF(ERR_STATE) **hash); +#endif + +int ERR_get_next_error_library(void); + +int ERR_set_mark(void); +int ERR_pop_to_mark(void); + +/* Already defined in ossl_typ.h */ +/* typedef struct st_ERR_FNS ERR_FNS; */ +/* An application can use this function and provide the return value to loaded + * modules that should use the application's ERR state/functionality */ +const ERR_FNS *ERR_get_implementation(void); +/* A loaded module should call this function prior to any ERR operations using + * the application's "ERR_FNS". */ +int ERR_set_implementation(const ERR_FNS *fns); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/evp.h b/Source/Import/OpenSSL/Include/openssl/evp.h new file mode 100644 index 0000000..0d1b20a --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/evp.h @@ -0,0 +1,1402 @@ +/* crypto/evp/evp.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_ENVELOPE_H +#define HEADER_ENVELOPE_H + +#ifdef OPENSSL_ALGORITHM_DEFINES +# include +#else +# define OPENSSL_ALGORITHM_DEFINES +# include +# undef OPENSSL_ALGORITHM_DEFINES +#endif + +#include + +#include + +#ifndef OPENSSL_NO_BIO +#include +#endif + +/* +#define EVP_RC2_KEY_SIZE 16 +#define EVP_RC4_KEY_SIZE 16 +#define EVP_BLOWFISH_KEY_SIZE 16 +#define EVP_CAST5_KEY_SIZE 16 +#define EVP_RC5_32_12_16_KEY_SIZE 16 +*/ +#define EVP_MAX_MD_SIZE 64 /* longest known is SHA512 */ +#define EVP_MAX_KEY_LENGTH 64 +#define EVP_MAX_IV_LENGTH 16 +#define EVP_MAX_BLOCK_LENGTH 32 + +#define PKCS5_SALT_LEN 8 +/* Default PKCS#5 iteration count */ +#define PKCS5_DEFAULT_ITER 2048 + +#include + +#define EVP_PK_RSA 0x0001 +#define EVP_PK_DSA 0x0002 +#define EVP_PK_DH 0x0004 +#define EVP_PK_EC 0x0008 +#define EVP_PKT_SIGN 0x0010 +#define EVP_PKT_ENC 0x0020 +#define EVP_PKT_EXCH 0x0040 +#define EVP_PKS_RSA 0x0100 +#define EVP_PKS_DSA 0x0200 +#define EVP_PKS_EC 0x0400 +#define EVP_PKT_EXP 0x1000 /* <= 512 bit key */ + +#define EVP_PKEY_NONE NID_undef +#define EVP_PKEY_RSA NID_rsaEncryption +#define EVP_PKEY_RSA2 NID_rsa +#define EVP_PKEY_DSA NID_dsa +#define EVP_PKEY_DSA1 NID_dsa_2 +#define EVP_PKEY_DSA2 NID_dsaWithSHA +#define EVP_PKEY_DSA3 NID_dsaWithSHA1 +#define EVP_PKEY_DSA4 NID_dsaWithSHA1_2 +#define EVP_PKEY_DH NID_dhKeyAgreement +#define EVP_PKEY_EC NID_X9_62_id_ecPublicKey +#define EVP_PKEY_HMAC NID_hmac +#define EVP_PKEY_CMAC NID_cmac + +#ifdef __cplusplus +extern "C" { +#endif + +/* Type needs to be a bit field + * Sub-type needs to be for variations on the method, as in, can it do + * arbitrary encryption.... */ +struct evp_pkey_st + { + int type; + int save_type; + int references; + const EVP_PKEY_ASN1_METHOD *ameth; + ENGINE *engine; + union { + char *ptr; +#ifndef OPENSSL_NO_RSA + struct rsa_st *rsa; /* RSA */ +#endif +#ifndef OPENSSL_NO_DSA + struct dsa_st *dsa; /* DSA */ +#endif +#ifndef OPENSSL_NO_DH + struct dh_st *dh; /* DH */ +#endif +#ifndef OPENSSL_NO_EC + struct ec_key_st *ec; /* ECC */ +#endif + } pkey; + int save_parameters; + STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */ + } /* EVP_PKEY */; + +#define EVP_PKEY_MO_SIGN 0x0001 +#define EVP_PKEY_MO_VERIFY 0x0002 +#define EVP_PKEY_MO_ENCRYPT 0x0004 +#define EVP_PKEY_MO_DECRYPT 0x0008 + +#ifndef EVP_MD +struct env_md_st + { + int type; + int pkey_type; + int md_size; + unsigned long flags; + int (*init)(EVP_MD_CTX *ctx); + int (*update)(EVP_MD_CTX *ctx,const void *data,size_t count); + int (*final)(EVP_MD_CTX *ctx,unsigned char *md); + int (*copy)(EVP_MD_CTX *to,const EVP_MD_CTX *from); + int (*cleanup)(EVP_MD_CTX *ctx); + + /* FIXME: prototype these some day */ + int (*sign)(int type, const unsigned char *m, unsigned int m_length, + unsigned char *sigret, unsigned int *siglen, void *key); + int (*verify)(int type, const unsigned char *m, unsigned int m_length, + const unsigned char *sigbuf, unsigned int siglen, + void *key); + int required_pkey_type[5]; /*EVP_PKEY_xxx */ + int block_size; + int ctx_size; /* how big does the ctx->md_data need to be */ + /* control function */ + int (*md_ctrl)(EVP_MD_CTX *ctx, int cmd, int p1, void *p2); + } /* EVP_MD */; + +typedef int evp_sign_method(int type,const unsigned char *m, + unsigned int m_length,unsigned char *sigret, + unsigned int *siglen, void *key); +typedef int evp_verify_method(int type,const unsigned char *m, + unsigned int m_length,const unsigned char *sigbuf, + unsigned int siglen, void *key); + +#define EVP_MD_FLAG_ONESHOT 0x0001 /* digest can only handle a single + * block */ + +#define EVP_MD_FLAG_PKEY_DIGEST 0x0002 /* digest is a "clone" digest used + * which is a copy of an existing + * one for a specific public key type. + * EVP_dss1() etc */ + +/* Digest uses EVP_PKEY_METHOD for signing instead of MD specific signing */ + +#define EVP_MD_FLAG_PKEY_METHOD_SIGNATURE 0x0004 + +/* DigestAlgorithmIdentifier flags... */ + +#define EVP_MD_FLAG_DIGALGID_MASK 0x0018 + +/* NULL or absent parameter accepted. Use NULL */ + +#define EVP_MD_FLAG_DIGALGID_NULL 0x0000 + +/* NULL or absent parameter accepted. Use NULL for PKCS#1 otherwise absent */ + +#define EVP_MD_FLAG_DIGALGID_ABSENT 0x0008 + +/* Custom handling via ctrl */ + +#define EVP_MD_FLAG_DIGALGID_CUSTOM 0x0018 + +#define EVP_MD_FLAG_FIPS 0x0400 /* Note if suitable for use in FIPS mode */ + +/* Digest ctrls */ + +#define EVP_MD_CTRL_DIGALGID 0x1 +#define EVP_MD_CTRL_MICALG 0x2 + +/* Minimum Algorithm specific ctrl value */ + +#define EVP_MD_CTRL_ALG_CTRL 0x1000 + +#define EVP_PKEY_NULL_method NULL,NULL,{0,0,0,0} + +#ifndef OPENSSL_NO_DSA +#define EVP_PKEY_DSA_method (evp_sign_method *)DSA_sign, \ + (evp_verify_method *)DSA_verify, \ + {EVP_PKEY_DSA,EVP_PKEY_DSA2,EVP_PKEY_DSA3, \ + EVP_PKEY_DSA4,0} +#else +#define EVP_PKEY_DSA_method EVP_PKEY_NULL_method +#endif + +#ifndef OPENSSL_NO_ECDSA +#define EVP_PKEY_ECDSA_method (evp_sign_method *)ECDSA_sign, \ + (evp_verify_method *)ECDSA_verify, \ + {EVP_PKEY_EC,0,0,0} +#else +#define EVP_PKEY_ECDSA_method EVP_PKEY_NULL_method +#endif + +#ifndef OPENSSL_NO_RSA +#define EVP_PKEY_RSA_method (evp_sign_method *)RSA_sign, \ + (evp_verify_method *)RSA_verify, \ + {EVP_PKEY_RSA,EVP_PKEY_RSA2,0,0} +#define EVP_PKEY_RSA_ASN1_OCTET_STRING_method \ + (evp_sign_method *)RSA_sign_ASN1_OCTET_STRING, \ + (evp_verify_method *)RSA_verify_ASN1_OCTET_STRING, \ + {EVP_PKEY_RSA,EVP_PKEY_RSA2,0,0} +#else +#define EVP_PKEY_RSA_method EVP_PKEY_NULL_method +#define EVP_PKEY_RSA_ASN1_OCTET_STRING_method EVP_PKEY_NULL_method +#endif + +#endif /* !EVP_MD */ + +struct env_md_ctx_st + { + const EVP_MD *digest; + ENGINE *engine; /* functional reference if 'digest' is ENGINE-provided */ + unsigned long flags; + void *md_data; + /* Public key context for sign/verify */ + EVP_PKEY_CTX *pctx; + /* Update function: usually copied from EVP_MD */ + int (*update)(EVP_MD_CTX *ctx,const void *data,size_t count); + } /* EVP_MD_CTX */; + +/* values for EVP_MD_CTX flags */ + +#define EVP_MD_CTX_FLAG_ONESHOT 0x0001 /* digest update will be called + * once only */ +#define EVP_MD_CTX_FLAG_CLEANED 0x0002 /* context has already been + * cleaned */ +#define EVP_MD_CTX_FLAG_REUSE 0x0004 /* Don't free up ctx->md_data + * in EVP_MD_CTX_cleanup */ +/* FIPS and pad options are ignored in 1.0.0, definitions are here + * so we don't accidentally reuse the values for other purposes. + */ + +#define EVP_MD_CTX_FLAG_NON_FIPS_ALLOW 0x0008 /* Allow use of non FIPS digest + * in FIPS mode */ + +/* The following PAD options are also currently ignored in 1.0.0, digest + * parameters are handled through EVP_DigestSign*() and EVP_DigestVerify*() + * instead. + */ +#define EVP_MD_CTX_FLAG_PAD_MASK 0xF0 /* RSA mode to use */ +#define EVP_MD_CTX_FLAG_PAD_PKCS1 0x00 /* PKCS#1 v1.5 mode */ +#define EVP_MD_CTX_FLAG_PAD_X931 0x10 /* X9.31 mode */ +#define EVP_MD_CTX_FLAG_PAD_PSS 0x20 /* PSS mode */ + +#define EVP_MD_CTX_FLAG_NO_INIT 0x0100 /* Don't initialize md_data */ + +struct evp_cipher_st + { + int nid; + int block_size; + int key_len; /* Default value for variable length ciphers */ + int iv_len; + unsigned long flags; /* Various flags */ + int (*init)(EVP_CIPHER_CTX *ctx, const unsigned char *key, + const unsigned char *iv, int enc); /* init key */ + int (*do_cipher)(EVP_CIPHER_CTX *ctx, unsigned char *out, + const unsigned char *in, size_t inl);/* encrypt/decrypt data */ + int (*cleanup)(EVP_CIPHER_CTX *); /* cleanup ctx */ + int ctx_size; /* how big ctx->cipher_data needs to be */ + int (*set_asn1_parameters)(EVP_CIPHER_CTX *, ASN1_TYPE *); /* Populate a ASN1_TYPE with parameters */ + int (*get_asn1_parameters)(EVP_CIPHER_CTX *, ASN1_TYPE *); /* Get parameters from a ASN1_TYPE */ + int (*ctrl)(EVP_CIPHER_CTX *, int type, int arg, void *ptr); /* Miscellaneous operations */ + void *app_data; /* Application data */ + } /* EVP_CIPHER */; + +/* Values for cipher flags */ + +/* Modes for ciphers */ + +#define EVP_CIPH_STREAM_CIPHER 0x0 +#define EVP_CIPH_ECB_MODE 0x1 +#define EVP_CIPH_CBC_MODE 0x2 +#define EVP_CIPH_CFB_MODE 0x3 +#define EVP_CIPH_OFB_MODE 0x4 +#define EVP_CIPH_CTR_MODE 0x5 +#define EVP_CIPH_GCM_MODE 0x6 +#define EVP_CIPH_CCM_MODE 0x7 +#define EVP_CIPH_XTS_MODE 0x10001 +#define EVP_CIPH_MODE 0xF0007 +/* Set if variable length cipher */ +#define EVP_CIPH_VARIABLE_LENGTH 0x8 +/* Set if the iv handling should be done by the cipher itself */ +#define EVP_CIPH_CUSTOM_IV 0x10 +/* Set if the cipher's init() function should be called if key is NULL */ +#define EVP_CIPH_ALWAYS_CALL_INIT 0x20 +/* Call ctrl() to init cipher parameters */ +#define EVP_CIPH_CTRL_INIT 0x40 +/* Don't use standard key length function */ +#define EVP_CIPH_CUSTOM_KEY_LENGTH 0x80 +/* Don't use standard block padding */ +#define EVP_CIPH_NO_PADDING 0x100 +/* cipher handles random key generation */ +#define EVP_CIPH_RAND_KEY 0x200 +/* cipher has its own additional copying logic */ +#define EVP_CIPH_CUSTOM_COPY 0x400 +/* Allow use default ASN1 get/set iv */ +#define EVP_CIPH_FLAG_DEFAULT_ASN1 0x1000 +/* Buffer length in bits not bytes: CFB1 mode only */ +#define EVP_CIPH_FLAG_LENGTH_BITS 0x2000 +/* Note if suitable for use in FIPS mode */ +#define EVP_CIPH_FLAG_FIPS 0x4000 +/* Allow non FIPS cipher in FIPS mode */ +#define EVP_CIPH_FLAG_NON_FIPS_ALLOW 0x8000 +/* Cipher handles any and all padding logic as well + * as finalisation. + */ +#define EVP_CIPH_FLAG_CUSTOM_CIPHER 0x100000 +#define EVP_CIPH_FLAG_AEAD_CIPHER 0x200000 + +/* ctrl() values */ + +#define EVP_CTRL_INIT 0x0 +#define EVP_CTRL_SET_KEY_LENGTH 0x1 +#define EVP_CTRL_GET_RC2_KEY_BITS 0x2 +#define EVP_CTRL_SET_RC2_KEY_BITS 0x3 +#define EVP_CTRL_GET_RC5_ROUNDS 0x4 +#define EVP_CTRL_SET_RC5_ROUNDS 0x5 +#define EVP_CTRL_RAND_KEY 0x6 +#define EVP_CTRL_PBE_PRF_NID 0x7 +#define EVP_CTRL_COPY 0x8 +#define EVP_CTRL_GCM_SET_IVLEN 0x9 +#define EVP_CTRL_GCM_GET_TAG 0x10 +#define EVP_CTRL_GCM_SET_TAG 0x11 +#define EVP_CTRL_GCM_SET_IV_FIXED 0x12 +#define EVP_CTRL_GCM_IV_GEN 0x13 +#define EVP_CTRL_CCM_SET_IVLEN EVP_CTRL_GCM_SET_IVLEN +#define EVP_CTRL_CCM_GET_TAG EVP_CTRL_GCM_GET_TAG +#define EVP_CTRL_CCM_SET_TAG EVP_CTRL_GCM_SET_TAG +#define EVP_CTRL_CCM_SET_L 0x14 +#define EVP_CTRL_CCM_SET_MSGLEN 0x15 +/* AEAD cipher deduces payload length and returns number of bytes + * required to store MAC and eventual padding. Subsequent call to + * EVP_Cipher even appends/verifies MAC. + */ +#define EVP_CTRL_AEAD_TLS1_AAD 0x16 +/* Used by composite AEAD ciphers, no-op in GCM, CCM... */ +#define EVP_CTRL_AEAD_SET_MAC_KEY 0x17 +/* Set the GCM invocation field, decrypt only */ +#define EVP_CTRL_GCM_SET_IV_INV 0x18 + +/* GCM TLS constants */ +/* Length of fixed part of IV derived from PRF */ +#define EVP_GCM_TLS_FIXED_IV_LEN 4 +/* Length of explicit part of IV part of TLS records */ +#define EVP_GCM_TLS_EXPLICIT_IV_LEN 8 +/* Length of tag for TLS */ +#define EVP_GCM_TLS_TAG_LEN 16 + + +typedef struct evp_cipher_info_st + { + const EVP_CIPHER *cipher; + unsigned char iv[EVP_MAX_IV_LENGTH]; + } EVP_CIPHER_INFO; + +struct evp_cipher_ctx_st + { + const EVP_CIPHER *cipher; + ENGINE *engine; /* functional reference if 'cipher' is ENGINE-provided */ + int encrypt; /* encrypt or decrypt */ + int buf_len; /* number we have left */ + + unsigned char oiv[EVP_MAX_IV_LENGTH]; /* original iv */ + unsigned char iv[EVP_MAX_IV_LENGTH]; /* working iv */ + unsigned char buf[EVP_MAX_BLOCK_LENGTH];/* saved partial block */ + int num; /* used by cfb/ofb/ctr mode */ + + void *app_data; /* application stuff */ + int key_len; /* May change for variable length cipher */ + unsigned long flags; /* Various flags */ + void *cipher_data; /* per EVP data */ + int final_used; + int block_mask; + unsigned char final[EVP_MAX_BLOCK_LENGTH];/* possible final block */ + } /* EVP_CIPHER_CTX */; + +typedef struct evp_Encode_Ctx_st + { + int num; /* number saved in a partial encode/decode */ + int length; /* The length is either the output line length + * (in input bytes) or the shortest input line + * length that is ok. Once decoding begins, + * the length is adjusted up each time a longer + * line is decoded */ + unsigned char enc_data[80]; /* data to encode */ + int line_num; /* number read on current line */ + int expect_nl; + } EVP_ENCODE_CTX; + +/* Password based encryption function */ +typedef int (EVP_PBE_KEYGEN)(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, + ASN1_TYPE *param, const EVP_CIPHER *cipher, + const EVP_MD *md, int en_de); + +#ifndef OPENSSL_NO_RSA +#define EVP_PKEY_assign_RSA(pkey,rsa) EVP_PKEY_assign((pkey),EVP_PKEY_RSA,\ + (char *)(rsa)) +#endif + +#ifndef OPENSSL_NO_DSA +#define EVP_PKEY_assign_DSA(pkey,dsa) EVP_PKEY_assign((pkey),EVP_PKEY_DSA,\ + (char *)(dsa)) +#endif + +#ifndef OPENSSL_NO_DH +#define EVP_PKEY_assign_DH(pkey,dh) EVP_PKEY_assign((pkey),EVP_PKEY_DH,\ + (char *)(dh)) +#endif + +#ifndef OPENSSL_NO_EC +#define EVP_PKEY_assign_EC_KEY(pkey,eckey) EVP_PKEY_assign((pkey),EVP_PKEY_EC,\ + (char *)(eckey)) +#endif + +/* Add some extra combinations */ +#define EVP_get_digestbynid(a) EVP_get_digestbyname(OBJ_nid2sn(a)) +#define EVP_get_digestbyobj(a) EVP_get_digestbynid(OBJ_obj2nid(a)) +#define EVP_get_cipherbynid(a) EVP_get_cipherbyname(OBJ_nid2sn(a)) +#define EVP_get_cipherbyobj(a) EVP_get_cipherbynid(OBJ_obj2nid(a)) + +int EVP_MD_type(const EVP_MD *md); +#define EVP_MD_nid(e) EVP_MD_type(e) +#define EVP_MD_name(e) OBJ_nid2sn(EVP_MD_nid(e)) +int EVP_MD_pkey_type(const EVP_MD *md); +int EVP_MD_size(const EVP_MD *md); +int EVP_MD_block_size(const EVP_MD *md); +unsigned long EVP_MD_flags(const EVP_MD *md); + +const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx); +#define EVP_MD_CTX_size(e) EVP_MD_size(EVP_MD_CTX_md(e)) +#define EVP_MD_CTX_block_size(e) EVP_MD_block_size(EVP_MD_CTX_md(e)) +#define EVP_MD_CTX_type(e) EVP_MD_type(EVP_MD_CTX_md(e)) + +int EVP_CIPHER_nid(const EVP_CIPHER *cipher); +#define EVP_CIPHER_name(e) OBJ_nid2sn(EVP_CIPHER_nid(e)) +int EVP_CIPHER_block_size(const EVP_CIPHER *cipher); +int EVP_CIPHER_key_length(const EVP_CIPHER *cipher); +int EVP_CIPHER_iv_length(const EVP_CIPHER *cipher); +unsigned long EVP_CIPHER_flags(const EVP_CIPHER *cipher); +#define EVP_CIPHER_mode(e) (EVP_CIPHER_flags(e) & EVP_CIPH_MODE) + +const EVP_CIPHER * EVP_CIPHER_CTX_cipher(const EVP_CIPHER_CTX *ctx); +int EVP_CIPHER_CTX_nid(const EVP_CIPHER_CTX *ctx); +int EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx); +int EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx); +int EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx); +int EVP_CIPHER_CTX_copy(EVP_CIPHER_CTX *out, const EVP_CIPHER_CTX *in); +void * EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx); +void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *ctx, void *data); +#define EVP_CIPHER_CTX_type(c) EVP_CIPHER_type(EVP_CIPHER_CTX_cipher(c)) +unsigned long EVP_CIPHER_CTX_flags(const EVP_CIPHER_CTX *ctx); +#define EVP_CIPHER_CTX_mode(e) (EVP_CIPHER_CTX_flags(e) & EVP_CIPH_MODE) + +#define EVP_ENCODE_LENGTH(l) (((l+2)/3*4)+(l/48+1)*2+80) +#define EVP_DECODE_LENGTH(l) ((l+3)/4*3+80) + +#define EVP_SignInit_ex(a,b,c) EVP_DigestInit_ex(a,b,c) +#define EVP_SignInit(a,b) EVP_DigestInit(a,b) +#define EVP_SignUpdate(a,b,c) EVP_DigestUpdate(a,b,c) +#define EVP_VerifyInit_ex(a,b,c) EVP_DigestInit_ex(a,b,c) +#define EVP_VerifyInit(a,b) EVP_DigestInit(a,b) +#define EVP_VerifyUpdate(a,b,c) EVP_DigestUpdate(a,b,c) +#define EVP_OpenUpdate(a,b,c,d,e) EVP_DecryptUpdate(a,b,c,d,e) +#define EVP_SealUpdate(a,b,c,d,e) EVP_EncryptUpdate(a,b,c,d,e) +#define EVP_DigestSignUpdate(a,b,c) EVP_DigestUpdate(a,b,c) +#define EVP_DigestVerifyUpdate(a,b,c) EVP_DigestUpdate(a,b,c) + +#ifdef CONST_STRICT +void BIO_set_md(BIO *,const EVP_MD *md); +#else +# define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,0,(char *)md) +#endif +#define BIO_get_md(b,mdp) BIO_ctrl(b,BIO_C_GET_MD,0,(char *)mdp) +#define BIO_get_md_ctx(b,mdcp) BIO_ctrl(b,BIO_C_GET_MD_CTX,0,(char *)mdcp) +#define BIO_set_md_ctx(b,mdcp) BIO_ctrl(b,BIO_C_SET_MD_CTX,0,(char *)mdcp) +#define BIO_get_cipher_status(b) BIO_ctrl(b,BIO_C_GET_CIPHER_STATUS,0,NULL) +#define BIO_get_cipher_ctx(b,c_pp) BIO_ctrl(b,BIO_C_GET_CIPHER_CTX,0,(char *)c_pp) + +int EVP_Cipher(EVP_CIPHER_CTX *c, + unsigned char *out, + const unsigned char *in, + unsigned int inl); + +#define EVP_add_cipher_alias(n,alias) \ + OBJ_NAME_add((alias),OBJ_NAME_TYPE_CIPHER_METH|OBJ_NAME_ALIAS,(n)) +#define EVP_add_digest_alias(n,alias) \ + OBJ_NAME_add((alias),OBJ_NAME_TYPE_MD_METH|OBJ_NAME_ALIAS,(n)) +#define EVP_delete_cipher_alias(alias) \ + OBJ_NAME_remove(alias,OBJ_NAME_TYPE_CIPHER_METH|OBJ_NAME_ALIAS); +#define EVP_delete_digest_alias(alias) \ + OBJ_NAME_remove(alias,OBJ_NAME_TYPE_MD_METH|OBJ_NAME_ALIAS); + +void EVP_MD_CTX_init(EVP_MD_CTX *ctx); +int EVP_MD_CTX_cleanup(EVP_MD_CTX *ctx); +EVP_MD_CTX *EVP_MD_CTX_create(void); +void EVP_MD_CTX_destroy(EVP_MD_CTX *ctx); +int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out,const EVP_MD_CTX *in); +void EVP_MD_CTX_set_flags(EVP_MD_CTX *ctx, int flags); +void EVP_MD_CTX_clear_flags(EVP_MD_CTX *ctx, int flags); +int EVP_MD_CTX_test_flags(const EVP_MD_CTX *ctx,int flags); +int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl); +int EVP_DigestUpdate(EVP_MD_CTX *ctx,const void *d, + size_t cnt); +int EVP_DigestFinal_ex(EVP_MD_CTX *ctx,unsigned char *md,unsigned int *s); +int EVP_Digest(const void *data, size_t count, + unsigned char *md, unsigned int *size, const EVP_MD *type, ENGINE *impl); + +int EVP_MD_CTX_copy(EVP_MD_CTX *out,const EVP_MD_CTX *in); +int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type); +int EVP_DigestFinal(EVP_MD_CTX *ctx,unsigned char *md,unsigned int *s); + +int EVP_read_pw_string(char *buf,int length,const char *prompt,int verify); +int EVP_read_pw_string_min(char *buf,int minlen,int maxlen,const char *prompt,int verify); +void EVP_set_pw_prompt(const char *prompt); +char * EVP_get_pw_prompt(void); + +int EVP_BytesToKey(const EVP_CIPHER *type,const EVP_MD *md, + const unsigned char *salt, const unsigned char *data, + int datal, int count, unsigned char *key,unsigned char *iv); + +void EVP_CIPHER_CTX_set_flags(EVP_CIPHER_CTX *ctx, int flags); +void EVP_CIPHER_CTX_clear_flags(EVP_CIPHER_CTX *ctx, int flags); +int EVP_CIPHER_CTX_test_flags(const EVP_CIPHER_CTX *ctx,int flags); + +int EVP_EncryptInit(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *cipher, + const unsigned char *key, const unsigned char *iv); +int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *cipher, ENGINE *impl, + const unsigned char *key, const unsigned char *iv); +int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, + int *outl, const unsigned char *in, int inl); +int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl); +int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl); + +int EVP_DecryptInit(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *cipher, + const unsigned char *key, const unsigned char *iv); +int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *cipher, ENGINE *impl, + const unsigned char *key, const unsigned char *iv); +int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, + int *outl, const unsigned char *in, int inl); +int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl); +int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl); + +int EVP_CipherInit(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *cipher, + const unsigned char *key,const unsigned char *iv, + int enc); +int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *cipher, ENGINE *impl, + const unsigned char *key,const unsigned char *iv, + int enc); +int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, + int *outl, const unsigned char *in, int inl); +int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl); +int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl); + +int EVP_SignFinal(EVP_MD_CTX *ctx,unsigned char *md,unsigned int *s, + EVP_PKEY *pkey); + +int EVP_VerifyFinal(EVP_MD_CTX *ctx,const unsigned char *sigbuf, + unsigned int siglen,EVP_PKEY *pkey); + +int EVP_DigestSignInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx, + const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey); +int EVP_DigestSignFinal(EVP_MD_CTX *ctx, + unsigned char *sigret, size_t *siglen); + +int EVP_DigestVerifyInit(EVP_MD_CTX *ctx, EVP_PKEY_CTX **pctx, + const EVP_MD *type, ENGINE *e, EVP_PKEY *pkey); +int EVP_DigestVerifyFinal(EVP_MD_CTX *ctx, + unsigned char *sig, size_t siglen); + +int EVP_OpenInit(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *type, + const unsigned char *ek, int ekl, const unsigned char *iv, + EVP_PKEY *priv); +int EVP_OpenFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl); + +int EVP_SealInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type, + unsigned char **ek, int *ekl, unsigned char *iv, + EVP_PKEY **pubk, int npubk); +int EVP_SealFinal(EVP_CIPHER_CTX *ctx,unsigned char *out,int *outl); + +void EVP_EncodeInit(EVP_ENCODE_CTX *ctx); +void EVP_EncodeUpdate(EVP_ENCODE_CTX *ctx,unsigned char *out,int *outl, + const unsigned char *in,int inl); +void EVP_EncodeFinal(EVP_ENCODE_CTX *ctx,unsigned char *out,int *outl); +int EVP_EncodeBlock(unsigned char *t, const unsigned char *f, int n); + +void EVP_DecodeInit(EVP_ENCODE_CTX *ctx); +int EVP_DecodeUpdate(EVP_ENCODE_CTX *ctx,unsigned char *out,int *outl, + const unsigned char *in, int inl); +int EVP_DecodeFinal(EVP_ENCODE_CTX *ctx, unsigned + char *out, int *outl); +int EVP_DecodeBlock(unsigned char *t, const unsigned char *f, int n); + +void EVP_CIPHER_CTX_init(EVP_CIPHER_CTX *a); +int EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *a); +EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void); +void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *a); +int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *x, int keylen); +int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *c, int pad); +int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr); +int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key); + +#ifndef OPENSSL_NO_BIO +BIO_METHOD *BIO_f_md(void); +BIO_METHOD *BIO_f_base64(void); +BIO_METHOD *BIO_f_cipher(void); +BIO_METHOD *BIO_f_reliable(void); +void BIO_set_cipher(BIO *b,const EVP_CIPHER *c,const unsigned char *k, + const unsigned char *i, int enc); +#endif + +const EVP_MD *EVP_md_null(void); +#ifndef OPENSSL_NO_MD2 +const EVP_MD *EVP_md2(void); +#endif +#ifndef OPENSSL_NO_MD4 +const EVP_MD *EVP_md4(void); +#endif +#ifndef OPENSSL_NO_MD5 +const EVP_MD *EVP_md5(void); +#endif +#ifndef OPENSSL_NO_SHA +const EVP_MD *EVP_sha(void); +const EVP_MD *EVP_sha1(void); +const EVP_MD *EVP_dss(void); +const EVP_MD *EVP_dss1(void); +const EVP_MD *EVP_ecdsa(void); +#endif +#ifndef OPENSSL_NO_SHA256 +const EVP_MD *EVP_sha224(void); +const EVP_MD *EVP_sha256(void); +#endif +#ifndef OPENSSL_NO_SHA512 +const EVP_MD *EVP_sha384(void); +const EVP_MD *EVP_sha512(void); +#endif +#ifndef OPENSSL_NO_MDC2 +const EVP_MD *EVP_mdc2(void); +#endif +#ifndef OPENSSL_NO_RIPEMD +const EVP_MD *EVP_ripemd160(void); +#endif +#ifndef OPENSSL_NO_WHIRLPOOL +const EVP_MD *EVP_whirlpool(void); +#endif +const EVP_CIPHER *EVP_enc_null(void); /* does nothing :-) */ +#ifndef OPENSSL_NO_DES +const EVP_CIPHER *EVP_des_ecb(void); +const EVP_CIPHER *EVP_des_ede(void); +const EVP_CIPHER *EVP_des_ede3(void); +const EVP_CIPHER *EVP_des_ede_ecb(void); +const EVP_CIPHER *EVP_des_ede3_ecb(void); +const EVP_CIPHER *EVP_des_cfb64(void); +# define EVP_des_cfb EVP_des_cfb64 +const EVP_CIPHER *EVP_des_cfb1(void); +const EVP_CIPHER *EVP_des_cfb8(void); +const EVP_CIPHER *EVP_des_ede_cfb64(void); +# define EVP_des_ede_cfb EVP_des_ede_cfb64 +#if 0 +const EVP_CIPHER *EVP_des_ede_cfb1(void); +const EVP_CIPHER *EVP_des_ede_cfb8(void); +#endif +const EVP_CIPHER *EVP_des_ede3_cfb64(void); +# define EVP_des_ede3_cfb EVP_des_ede3_cfb64 +const EVP_CIPHER *EVP_des_ede3_cfb1(void); +const EVP_CIPHER *EVP_des_ede3_cfb8(void); +const EVP_CIPHER *EVP_des_ofb(void); +const EVP_CIPHER *EVP_des_ede_ofb(void); +const EVP_CIPHER *EVP_des_ede3_ofb(void); +const EVP_CIPHER *EVP_des_cbc(void); +const EVP_CIPHER *EVP_des_ede_cbc(void); +const EVP_CIPHER *EVP_des_ede3_cbc(void); +const EVP_CIPHER *EVP_desx_cbc(void); +/* This should now be supported through the dev_crypto ENGINE. But also, why are + * rc4 and md5 declarations made here inside a "NO_DES" precompiler branch? */ +#if 0 +# ifdef OPENSSL_OPENBSD_DEV_CRYPTO +const EVP_CIPHER *EVP_dev_crypto_des_ede3_cbc(void); +const EVP_CIPHER *EVP_dev_crypto_rc4(void); +const EVP_MD *EVP_dev_crypto_md5(void); +# endif +#endif +#endif +#ifndef OPENSSL_NO_RC4 +const EVP_CIPHER *EVP_rc4(void); +const EVP_CIPHER *EVP_rc4_40(void); +#ifndef OPENSSL_NO_MD5 +const EVP_CIPHER *EVP_rc4_hmac_md5(void); +#endif +#endif +#ifndef OPENSSL_NO_IDEA +const EVP_CIPHER *EVP_idea_ecb(void); +const EVP_CIPHER *EVP_idea_cfb64(void); +# define EVP_idea_cfb EVP_idea_cfb64 +const EVP_CIPHER *EVP_idea_ofb(void); +const EVP_CIPHER *EVP_idea_cbc(void); +#endif +#ifndef OPENSSL_NO_RC2 +const EVP_CIPHER *EVP_rc2_ecb(void); +const EVP_CIPHER *EVP_rc2_cbc(void); +const EVP_CIPHER *EVP_rc2_40_cbc(void); +const EVP_CIPHER *EVP_rc2_64_cbc(void); +const EVP_CIPHER *EVP_rc2_cfb64(void); +# define EVP_rc2_cfb EVP_rc2_cfb64 +const EVP_CIPHER *EVP_rc2_ofb(void); +#endif +#ifndef OPENSSL_NO_BF +const EVP_CIPHER *EVP_bf_ecb(void); +const EVP_CIPHER *EVP_bf_cbc(void); +const EVP_CIPHER *EVP_bf_cfb64(void); +# define EVP_bf_cfb EVP_bf_cfb64 +const EVP_CIPHER *EVP_bf_ofb(void); +#endif +#ifndef OPENSSL_NO_CAST +const EVP_CIPHER *EVP_cast5_ecb(void); +const EVP_CIPHER *EVP_cast5_cbc(void); +const EVP_CIPHER *EVP_cast5_cfb64(void); +# define EVP_cast5_cfb EVP_cast5_cfb64 +const EVP_CIPHER *EVP_cast5_ofb(void); +#endif +#ifndef OPENSSL_NO_RC5 +const EVP_CIPHER *EVP_rc5_32_12_16_cbc(void); +const EVP_CIPHER *EVP_rc5_32_12_16_ecb(void); +const EVP_CIPHER *EVP_rc5_32_12_16_cfb64(void); +# define EVP_rc5_32_12_16_cfb EVP_rc5_32_12_16_cfb64 +const EVP_CIPHER *EVP_rc5_32_12_16_ofb(void); +#endif +#ifndef OPENSSL_NO_AES +const EVP_CIPHER *EVP_aes_128_ecb(void); +const EVP_CIPHER *EVP_aes_128_cbc(void); +const EVP_CIPHER *EVP_aes_128_cfb1(void); +const EVP_CIPHER *EVP_aes_128_cfb8(void); +const EVP_CIPHER *EVP_aes_128_cfb128(void); +# define EVP_aes_128_cfb EVP_aes_128_cfb128 +const EVP_CIPHER *EVP_aes_128_ofb(void); +const EVP_CIPHER *EVP_aes_128_ctr(void); +const EVP_CIPHER *EVP_aes_128_gcm(void); +const EVP_CIPHER *EVP_aes_128_ccm(void); +const EVP_CIPHER *EVP_aes_128_xts(void); +const EVP_CIPHER *EVP_aes_192_ecb(void); +const EVP_CIPHER *EVP_aes_192_cbc(void); +const EVP_CIPHER *EVP_aes_192_cfb1(void); +const EVP_CIPHER *EVP_aes_192_cfb8(void); +const EVP_CIPHER *EVP_aes_192_cfb128(void); +# define EVP_aes_192_cfb EVP_aes_192_cfb128 +const EVP_CIPHER *EVP_aes_192_ofb(void); +const EVP_CIPHER *EVP_aes_192_ctr(void); +const EVP_CIPHER *EVP_aes_192_gcm(void); +const EVP_CIPHER *EVP_aes_192_ccm(void); +const EVP_CIPHER *EVP_aes_256_ecb(void); +const EVP_CIPHER *EVP_aes_256_cbc(void); +const EVP_CIPHER *EVP_aes_256_cfb1(void); +const EVP_CIPHER *EVP_aes_256_cfb8(void); +const EVP_CIPHER *EVP_aes_256_cfb128(void); +# define EVP_aes_256_cfb EVP_aes_256_cfb128 +const EVP_CIPHER *EVP_aes_256_ofb(void); +const EVP_CIPHER *EVP_aes_256_ctr(void); +const EVP_CIPHER *EVP_aes_256_gcm(void); +const EVP_CIPHER *EVP_aes_256_ccm(void); +const EVP_CIPHER *EVP_aes_256_xts(void); +#if !defined(OPENSSL_NO_SHA) && !defined(OPENSSL_NO_SHA1) +const EVP_CIPHER *EVP_aes_128_cbc_hmac_sha1(void); +const EVP_CIPHER *EVP_aes_256_cbc_hmac_sha1(void); +#endif +#endif +#ifndef OPENSSL_NO_CAMELLIA +const EVP_CIPHER *EVP_camellia_128_ecb(void); +const EVP_CIPHER *EVP_camellia_128_cbc(void); +const EVP_CIPHER *EVP_camellia_128_cfb1(void); +const EVP_CIPHER *EVP_camellia_128_cfb8(void); +const EVP_CIPHER *EVP_camellia_128_cfb128(void); +# define EVP_camellia_128_cfb EVP_camellia_128_cfb128 +const EVP_CIPHER *EVP_camellia_128_ofb(void); +const EVP_CIPHER *EVP_camellia_192_ecb(void); +const EVP_CIPHER *EVP_camellia_192_cbc(void); +const EVP_CIPHER *EVP_camellia_192_cfb1(void); +const EVP_CIPHER *EVP_camellia_192_cfb8(void); +const EVP_CIPHER *EVP_camellia_192_cfb128(void); +# define EVP_camellia_192_cfb EVP_camellia_192_cfb128 +const EVP_CIPHER *EVP_camellia_192_ofb(void); +const EVP_CIPHER *EVP_camellia_256_ecb(void); +const EVP_CIPHER *EVP_camellia_256_cbc(void); +const EVP_CIPHER *EVP_camellia_256_cfb1(void); +const EVP_CIPHER *EVP_camellia_256_cfb8(void); +const EVP_CIPHER *EVP_camellia_256_cfb128(void); +# define EVP_camellia_256_cfb EVP_camellia_256_cfb128 +const EVP_CIPHER *EVP_camellia_256_ofb(void); +#endif + +#ifndef OPENSSL_NO_SEED +const EVP_CIPHER *EVP_seed_ecb(void); +const EVP_CIPHER *EVP_seed_cbc(void); +const EVP_CIPHER *EVP_seed_cfb128(void); +# define EVP_seed_cfb EVP_seed_cfb128 +const EVP_CIPHER *EVP_seed_ofb(void); +#endif + +void OPENSSL_add_all_algorithms_noconf(void); +void OPENSSL_add_all_algorithms_conf(void); + +#ifdef OPENSSL_LOAD_CONF +#define OpenSSL_add_all_algorithms() \ + OPENSSL_add_all_algorithms_conf() +#else +#define OpenSSL_add_all_algorithms() \ + OPENSSL_add_all_algorithms_noconf() +#endif + +void OpenSSL_add_all_ciphers(void); +void OpenSSL_add_all_digests(void); +#define SSLeay_add_all_algorithms() OpenSSL_add_all_algorithms() +#define SSLeay_add_all_ciphers() OpenSSL_add_all_ciphers() +#define SSLeay_add_all_digests() OpenSSL_add_all_digests() + +int EVP_add_cipher(const EVP_CIPHER *cipher); +int EVP_add_digest(const EVP_MD *digest); + +const EVP_CIPHER *EVP_get_cipherbyname(const char *name); +const EVP_MD *EVP_get_digestbyname(const char *name); +void EVP_cleanup(void); + +void EVP_CIPHER_do_all(void (*fn)(const EVP_CIPHER *ciph, + const char *from, const char *to, void *x), void *arg); +void EVP_CIPHER_do_all_sorted(void (*fn)(const EVP_CIPHER *ciph, + const char *from, const char *to, void *x), void *arg); + +void EVP_MD_do_all(void (*fn)(const EVP_MD *ciph, + const char *from, const char *to, void *x), void *arg); +void EVP_MD_do_all_sorted(void (*fn)(const EVP_MD *ciph, + const char *from, const char *to, void *x), void *arg); + +int EVP_PKEY_decrypt_old(unsigned char *dec_key, + const unsigned char *enc_key,int enc_key_len, + EVP_PKEY *private_key); +int EVP_PKEY_encrypt_old(unsigned char *enc_key, + const unsigned char *key,int key_len, + EVP_PKEY *pub_key); +int EVP_PKEY_type(int type); +int EVP_PKEY_id(const EVP_PKEY *pkey); +int EVP_PKEY_base_id(const EVP_PKEY *pkey); +int EVP_PKEY_bits(EVP_PKEY *pkey); +int EVP_PKEY_size(EVP_PKEY *pkey); +int EVP_PKEY_set_type(EVP_PKEY *pkey,int type); +int EVP_PKEY_set_type_str(EVP_PKEY *pkey, const char *str, int len); +int EVP_PKEY_assign(EVP_PKEY *pkey,int type,void *key); +void * EVP_PKEY_get0(EVP_PKEY *pkey); + +#ifndef OPENSSL_NO_RSA +struct rsa_st; +int EVP_PKEY_set1_RSA(EVP_PKEY *pkey,struct rsa_st *key); +struct rsa_st *EVP_PKEY_get1_RSA(EVP_PKEY *pkey); +#endif +#ifndef OPENSSL_NO_DSA +struct dsa_st; +int EVP_PKEY_set1_DSA(EVP_PKEY *pkey,struct dsa_st *key); +struct dsa_st *EVP_PKEY_get1_DSA(EVP_PKEY *pkey); +#endif +#ifndef OPENSSL_NO_DH +struct dh_st; +int EVP_PKEY_set1_DH(EVP_PKEY *pkey,struct dh_st *key); +struct dh_st *EVP_PKEY_get1_DH(EVP_PKEY *pkey); +#endif +#ifndef OPENSSL_NO_EC +struct ec_key_st; +int EVP_PKEY_set1_EC_KEY(EVP_PKEY *pkey,struct ec_key_st *key); +struct ec_key_st *EVP_PKEY_get1_EC_KEY(EVP_PKEY *pkey); +#endif + +EVP_PKEY * EVP_PKEY_new(void); +void EVP_PKEY_free(EVP_PKEY *pkey); + +EVP_PKEY * d2i_PublicKey(int type,EVP_PKEY **a, const unsigned char **pp, + long length); +int i2d_PublicKey(EVP_PKEY *a, unsigned char **pp); + +EVP_PKEY * d2i_PrivateKey(int type,EVP_PKEY **a, const unsigned char **pp, + long length); +EVP_PKEY * d2i_AutoPrivateKey(EVP_PKEY **a, const unsigned char **pp, + long length); +int i2d_PrivateKey(EVP_PKEY *a, unsigned char **pp); + +int EVP_PKEY_copy_parameters(EVP_PKEY *to, const EVP_PKEY *from); +int EVP_PKEY_missing_parameters(const EVP_PKEY *pkey); +int EVP_PKEY_save_parameters(EVP_PKEY *pkey,int mode); +int EVP_PKEY_cmp_parameters(const EVP_PKEY *a, const EVP_PKEY *b); + +int EVP_PKEY_cmp(const EVP_PKEY *a, const EVP_PKEY *b); + +int EVP_PKEY_print_public(BIO *out, const EVP_PKEY *pkey, + int indent, ASN1_PCTX *pctx); +int EVP_PKEY_print_private(BIO *out, const EVP_PKEY *pkey, + int indent, ASN1_PCTX *pctx); +int EVP_PKEY_print_params(BIO *out, const EVP_PKEY *pkey, + int indent, ASN1_PCTX *pctx); + +int EVP_PKEY_get_default_digest_nid(EVP_PKEY *pkey, int *pnid); + +int EVP_CIPHER_type(const EVP_CIPHER *ctx); + +/* calls methods */ +int EVP_CIPHER_param_to_asn1(EVP_CIPHER_CTX *c, ASN1_TYPE *type); +int EVP_CIPHER_asn1_to_param(EVP_CIPHER_CTX *c, ASN1_TYPE *type); + +/* These are used by EVP_CIPHER methods */ +int EVP_CIPHER_set_asn1_iv(EVP_CIPHER_CTX *c,ASN1_TYPE *type); +int EVP_CIPHER_get_asn1_iv(EVP_CIPHER_CTX *c,ASN1_TYPE *type); + +/* PKCS5 password based encryption */ +int PKCS5_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, + ASN1_TYPE *param, const EVP_CIPHER *cipher, const EVP_MD *md, + int en_de); +int PKCS5_PBKDF2_HMAC_SHA1(const char *pass, int passlen, + const unsigned char *salt, int saltlen, int iter, + int keylen, unsigned char *out); +int PKCS5_PBKDF2_HMAC(const char *pass, int passlen, + const unsigned char *salt, int saltlen, int iter, + const EVP_MD *digest, + int keylen, unsigned char *out); +int PKCS5_v2_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, + ASN1_TYPE *param, const EVP_CIPHER *cipher, const EVP_MD *md, + int en_de); + +void PKCS5_PBE_add(void); + +int EVP_PBE_CipherInit (ASN1_OBJECT *pbe_obj, const char *pass, int passlen, + ASN1_TYPE *param, EVP_CIPHER_CTX *ctx, int en_de); + +/* PBE type */ + +/* Can appear as the outermost AlgorithmIdentifier */ +#define EVP_PBE_TYPE_OUTER 0x0 +/* Is an PRF type OID */ +#define EVP_PBE_TYPE_PRF 0x1 + +int EVP_PBE_alg_add_type(int pbe_type, int pbe_nid, int cipher_nid, int md_nid, + EVP_PBE_KEYGEN *keygen); +int EVP_PBE_alg_add(int nid, const EVP_CIPHER *cipher, const EVP_MD *md, + EVP_PBE_KEYGEN *keygen); +int EVP_PBE_find(int type, int pbe_nid, + int *pcnid, int *pmnid, EVP_PBE_KEYGEN **pkeygen); +void EVP_PBE_cleanup(void); + +#define ASN1_PKEY_ALIAS 0x1 +#define ASN1_PKEY_DYNAMIC 0x2 +#define ASN1_PKEY_SIGPARAM_NULL 0x4 + +#define ASN1_PKEY_CTRL_PKCS7_SIGN 0x1 +#define ASN1_PKEY_CTRL_PKCS7_ENCRYPT 0x2 +#define ASN1_PKEY_CTRL_DEFAULT_MD_NID 0x3 +#define ASN1_PKEY_CTRL_CMS_SIGN 0x5 +#define ASN1_PKEY_CTRL_CMS_ENVELOPE 0x7 + +int EVP_PKEY_asn1_get_count(void); +const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_get0(int idx); +const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find(ENGINE **pe, int type); +const EVP_PKEY_ASN1_METHOD *EVP_PKEY_asn1_find_str(ENGINE **pe, + const char *str, int len); +int EVP_PKEY_asn1_add0(const EVP_PKEY_ASN1_METHOD *ameth); +int EVP_PKEY_asn1_add_alias(int to, int from); +int EVP_PKEY_asn1_get0_info(int *ppkey_id, int *pkey_base_id, int *ppkey_flags, + const char **pinfo, const char **ppem_str, + const EVP_PKEY_ASN1_METHOD *ameth); + +const EVP_PKEY_ASN1_METHOD* EVP_PKEY_get0_asn1(EVP_PKEY *pkey); +EVP_PKEY_ASN1_METHOD* EVP_PKEY_asn1_new(int id, int flags, + const char *pem_str, const char *info); +void EVP_PKEY_asn1_copy(EVP_PKEY_ASN1_METHOD *dst, + const EVP_PKEY_ASN1_METHOD *src); +void EVP_PKEY_asn1_free(EVP_PKEY_ASN1_METHOD *ameth); +void EVP_PKEY_asn1_set_public(EVP_PKEY_ASN1_METHOD *ameth, + int (*pub_decode)(EVP_PKEY *pk, X509_PUBKEY *pub), + int (*pub_encode)(X509_PUBKEY *pub, const EVP_PKEY *pk), + int (*pub_cmp)(const EVP_PKEY *a, const EVP_PKEY *b), + int (*pub_print)(BIO *out, const EVP_PKEY *pkey, int indent, + ASN1_PCTX *pctx), + int (*pkey_size)(const EVP_PKEY *pk), + int (*pkey_bits)(const EVP_PKEY *pk)); +void EVP_PKEY_asn1_set_private(EVP_PKEY_ASN1_METHOD *ameth, + int (*priv_decode)(EVP_PKEY *pk, PKCS8_PRIV_KEY_INFO *p8inf), + int (*priv_encode)(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pk), + int (*priv_print)(BIO *out, const EVP_PKEY *pkey, int indent, + ASN1_PCTX *pctx)); +void EVP_PKEY_asn1_set_param(EVP_PKEY_ASN1_METHOD *ameth, + int (*param_decode)(EVP_PKEY *pkey, + const unsigned char **pder, int derlen), + int (*param_encode)(const EVP_PKEY *pkey, unsigned char **pder), + int (*param_missing)(const EVP_PKEY *pk), + int (*param_copy)(EVP_PKEY *to, const EVP_PKEY *from), + int (*param_cmp)(const EVP_PKEY *a, const EVP_PKEY *b), + int (*param_print)(BIO *out, const EVP_PKEY *pkey, int indent, + ASN1_PCTX *pctx)); + +void EVP_PKEY_asn1_set_free(EVP_PKEY_ASN1_METHOD *ameth, + void (*pkey_free)(EVP_PKEY *pkey)); +void EVP_PKEY_asn1_set_ctrl(EVP_PKEY_ASN1_METHOD *ameth, + int (*pkey_ctrl)(EVP_PKEY *pkey, int op, + long arg1, void *arg2)); + + +#define EVP_PKEY_OP_UNDEFINED 0 +#define EVP_PKEY_OP_PARAMGEN (1<<1) +#define EVP_PKEY_OP_KEYGEN (1<<2) +#define EVP_PKEY_OP_SIGN (1<<3) +#define EVP_PKEY_OP_VERIFY (1<<4) +#define EVP_PKEY_OP_VERIFYRECOVER (1<<5) +#define EVP_PKEY_OP_SIGNCTX (1<<6) +#define EVP_PKEY_OP_VERIFYCTX (1<<7) +#define EVP_PKEY_OP_ENCRYPT (1<<8) +#define EVP_PKEY_OP_DECRYPT (1<<9) +#define EVP_PKEY_OP_DERIVE (1<<10) + +#define EVP_PKEY_OP_TYPE_SIG \ + (EVP_PKEY_OP_SIGN | EVP_PKEY_OP_VERIFY | EVP_PKEY_OP_VERIFYRECOVER \ + | EVP_PKEY_OP_SIGNCTX | EVP_PKEY_OP_VERIFYCTX) + +#define EVP_PKEY_OP_TYPE_CRYPT \ + (EVP_PKEY_OP_ENCRYPT | EVP_PKEY_OP_DECRYPT) + +#define EVP_PKEY_OP_TYPE_NOGEN \ + (EVP_PKEY_OP_SIG | EVP_PKEY_OP_CRYPT | EVP_PKEY_OP_DERIVE) + +#define EVP_PKEY_OP_TYPE_GEN \ + (EVP_PKEY_OP_PARAMGEN | EVP_PKEY_OP_KEYGEN) + +#define EVP_PKEY_CTX_set_signature_md(ctx, md) \ + EVP_PKEY_CTX_ctrl(ctx, -1, EVP_PKEY_OP_TYPE_SIG, \ + EVP_PKEY_CTRL_MD, 0, (void *)md) + +#define EVP_PKEY_CTRL_MD 1 +#define EVP_PKEY_CTRL_PEER_KEY 2 + +#define EVP_PKEY_CTRL_PKCS7_ENCRYPT 3 +#define EVP_PKEY_CTRL_PKCS7_DECRYPT 4 + +#define EVP_PKEY_CTRL_PKCS7_SIGN 5 + +#define EVP_PKEY_CTRL_SET_MAC_KEY 6 + +#define EVP_PKEY_CTRL_DIGESTINIT 7 + +/* Used by GOST key encryption in TLS */ +#define EVP_PKEY_CTRL_SET_IV 8 + +#define EVP_PKEY_CTRL_CMS_ENCRYPT 9 +#define EVP_PKEY_CTRL_CMS_DECRYPT 10 +#define EVP_PKEY_CTRL_CMS_SIGN 11 + +#define EVP_PKEY_CTRL_CIPHER 12 + +#define EVP_PKEY_ALG_CTRL 0x1000 + + +#define EVP_PKEY_FLAG_AUTOARGLEN 2 +/* Method handles all operations: don't assume any digest related + * defaults. + */ +#define EVP_PKEY_FLAG_SIGCTX_CUSTOM 4 + +const EVP_PKEY_METHOD *EVP_PKEY_meth_find(int type); +EVP_PKEY_METHOD* EVP_PKEY_meth_new(int id, int flags); +void EVP_PKEY_meth_get0_info(int *ppkey_id, int *pflags, + const EVP_PKEY_METHOD *meth); +void EVP_PKEY_meth_copy(EVP_PKEY_METHOD *dst, const EVP_PKEY_METHOD *src); +void EVP_PKEY_meth_free(EVP_PKEY_METHOD *pmeth); +int EVP_PKEY_meth_add0(const EVP_PKEY_METHOD *pmeth); + +EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e); +EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e); +EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *ctx); +void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx); + +int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype, + int cmd, int p1, void *p2); +int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx, const char *type, + const char *value); + +int EVP_PKEY_CTX_get_operation(EVP_PKEY_CTX *ctx); +void EVP_PKEY_CTX_set0_keygen_info(EVP_PKEY_CTX *ctx, int *dat, int datlen); + +EVP_PKEY *EVP_PKEY_new_mac_key(int type, ENGINE *e, + const unsigned char *key, int keylen); + +void EVP_PKEY_CTX_set_data(EVP_PKEY_CTX *ctx, void *data); +void *EVP_PKEY_CTX_get_data(EVP_PKEY_CTX *ctx); +EVP_PKEY *EVP_PKEY_CTX_get0_pkey(EVP_PKEY_CTX *ctx); + +EVP_PKEY *EVP_PKEY_CTX_get0_peerkey(EVP_PKEY_CTX *ctx); + +void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data); +void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx); + +int EVP_PKEY_sign_init(EVP_PKEY_CTX *ctx); +int EVP_PKEY_sign(EVP_PKEY_CTX *ctx, + unsigned char *sig, size_t *siglen, + const unsigned char *tbs, size_t tbslen); +int EVP_PKEY_verify_init(EVP_PKEY_CTX *ctx); +int EVP_PKEY_verify(EVP_PKEY_CTX *ctx, + const unsigned char *sig, size_t siglen, + const unsigned char *tbs, size_t tbslen); +int EVP_PKEY_verify_recover_init(EVP_PKEY_CTX *ctx); +int EVP_PKEY_verify_recover(EVP_PKEY_CTX *ctx, + unsigned char *rout, size_t *routlen, + const unsigned char *sig, size_t siglen); +int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx); +int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx, + unsigned char *out, size_t *outlen, + const unsigned char *in, size_t inlen); +int EVP_PKEY_decrypt_init(EVP_PKEY_CTX *ctx); +int EVP_PKEY_decrypt(EVP_PKEY_CTX *ctx, + unsigned char *out, size_t *outlen, + const unsigned char *in, size_t inlen); + +int EVP_PKEY_derive_init(EVP_PKEY_CTX *ctx); +int EVP_PKEY_derive_set_peer(EVP_PKEY_CTX *ctx, EVP_PKEY *peer); +int EVP_PKEY_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen); + +typedef int EVP_PKEY_gen_cb(EVP_PKEY_CTX *ctx); + +int EVP_PKEY_paramgen_init(EVP_PKEY_CTX *ctx); +int EVP_PKEY_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY **ppkey); +int EVP_PKEY_keygen_init(EVP_PKEY_CTX *ctx); +int EVP_PKEY_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY **ppkey); + +void EVP_PKEY_CTX_set_cb(EVP_PKEY_CTX *ctx, EVP_PKEY_gen_cb *cb); +EVP_PKEY_gen_cb *EVP_PKEY_CTX_get_cb(EVP_PKEY_CTX *ctx); + +int EVP_PKEY_CTX_get_keygen_info(EVP_PKEY_CTX *ctx, int idx); + +void EVP_PKEY_meth_set_init(EVP_PKEY_METHOD *pmeth, + int (*init)(EVP_PKEY_CTX *ctx)); + +void EVP_PKEY_meth_set_copy(EVP_PKEY_METHOD *pmeth, + int (*copy)(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)); + +void EVP_PKEY_meth_set_cleanup(EVP_PKEY_METHOD *pmeth, + void (*cleanup)(EVP_PKEY_CTX *ctx)); + +void EVP_PKEY_meth_set_paramgen(EVP_PKEY_METHOD *pmeth, + int (*paramgen_init)(EVP_PKEY_CTX *ctx), + int (*paramgen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)); + +void EVP_PKEY_meth_set_keygen(EVP_PKEY_METHOD *pmeth, + int (*keygen_init)(EVP_PKEY_CTX *ctx), + int (*keygen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)); + +void EVP_PKEY_meth_set_sign(EVP_PKEY_METHOD *pmeth, + int (*sign_init)(EVP_PKEY_CTX *ctx), + int (*sign)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen, + const unsigned char *tbs, size_t tbslen)); + +void EVP_PKEY_meth_set_verify(EVP_PKEY_METHOD *pmeth, + int (*verify_init)(EVP_PKEY_CTX *ctx), + int (*verify)(EVP_PKEY_CTX *ctx, const unsigned char *sig, size_t siglen, + const unsigned char *tbs, size_t tbslen)); + +void EVP_PKEY_meth_set_verify_recover(EVP_PKEY_METHOD *pmeth, + int (*verify_recover_init)(EVP_PKEY_CTX *ctx), + int (*verify_recover)(EVP_PKEY_CTX *ctx, + unsigned char *sig, size_t *siglen, + const unsigned char *tbs, size_t tbslen)); + +void EVP_PKEY_meth_set_signctx(EVP_PKEY_METHOD *pmeth, + int (*signctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx), + int (*signctx)(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen, + EVP_MD_CTX *mctx)); + +void EVP_PKEY_meth_set_verifyctx(EVP_PKEY_METHOD *pmeth, + int (*verifyctx_init)(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx), + int (*verifyctx)(EVP_PKEY_CTX *ctx, const unsigned char *sig,int siglen, + EVP_MD_CTX *mctx)); + +void EVP_PKEY_meth_set_encrypt(EVP_PKEY_METHOD *pmeth, + int (*encrypt_init)(EVP_PKEY_CTX *ctx), + int (*encryptfn)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, + const unsigned char *in, size_t inlen)); + +void EVP_PKEY_meth_set_decrypt(EVP_PKEY_METHOD *pmeth, + int (*decrypt_init)(EVP_PKEY_CTX *ctx), + int (*decrypt)(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, + const unsigned char *in, size_t inlen)); + +void EVP_PKEY_meth_set_derive(EVP_PKEY_METHOD *pmeth, + int (*derive_init)(EVP_PKEY_CTX *ctx), + int (*derive)(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen)); + +void EVP_PKEY_meth_set_ctrl(EVP_PKEY_METHOD *pmeth, + int (*ctrl)(EVP_PKEY_CTX *ctx, int type, int p1, void *p2), + int (*ctrl_str)(EVP_PKEY_CTX *ctx, + const char *type, const char *value)); + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_EVP_strings(void); + +/* Error codes for the EVP functions. */ + +/* Function codes. */ +#define EVP_F_AESNI_INIT_KEY 165 +#define EVP_F_AESNI_XTS_CIPHER 176 +#define EVP_F_AES_INIT_KEY 133 +#define EVP_F_AES_XTS 172 +#define EVP_F_AES_XTS_CIPHER 175 +#define EVP_F_CAMELLIA_INIT_KEY 159 +#define EVP_F_CMAC_INIT 173 +#define EVP_F_D2I_PKEY 100 +#define EVP_F_DO_SIGVER_INIT 161 +#define EVP_F_DSAPKEY2PKCS8 134 +#define EVP_F_DSA_PKEY2PKCS8 135 +#define EVP_F_ECDSA_PKEY2PKCS8 129 +#define EVP_F_ECKEY_PKEY2PKCS8 132 +#define EVP_F_EVP_CIPHERINIT_EX 123 +#define EVP_F_EVP_CIPHER_CTX_COPY 163 +#define EVP_F_EVP_CIPHER_CTX_CTRL 124 +#define EVP_F_EVP_CIPHER_CTX_SET_KEY_LENGTH 122 +#define EVP_F_EVP_DECRYPTFINAL_EX 101 +#define EVP_F_EVP_DIGESTINIT_EX 128 +#define EVP_F_EVP_ENCRYPTFINAL_EX 127 +#define EVP_F_EVP_MD_CTX_COPY_EX 110 +#define EVP_F_EVP_MD_SIZE 162 +#define EVP_F_EVP_OPENINIT 102 +#define EVP_F_EVP_PBE_ALG_ADD 115 +#define EVP_F_EVP_PBE_ALG_ADD_TYPE 160 +#define EVP_F_EVP_PBE_CIPHERINIT 116 +#define EVP_F_EVP_PKCS82PKEY 111 +#define EVP_F_EVP_PKCS82PKEY_BROKEN 136 +#define EVP_F_EVP_PKEY2PKCS8_BROKEN 113 +#define EVP_F_EVP_PKEY_COPY_PARAMETERS 103 +#define EVP_F_EVP_PKEY_CTX_CTRL 137 +#define EVP_F_EVP_PKEY_CTX_CTRL_STR 150 +#define EVP_F_EVP_PKEY_CTX_DUP 156 +#define EVP_F_EVP_PKEY_DECRYPT 104 +#define EVP_F_EVP_PKEY_DECRYPT_INIT 138 +#define EVP_F_EVP_PKEY_DECRYPT_OLD 151 +#define EVP_F_EVP_PKEY_DERIVE 153 +#define EVP_F_EVP_PKEY_DERIVE_INIT 154 +#define EVP_F_EVP_PKEY_DERIVE_SET_PEER 155 +#define EVP_F_EVP_PKEY_ENCRYPT 105 +#define EVP_F_EVP_PKEY_ENCRYPT_INIT 139 +#define EVP_F_EVP_PKEY_ENCRYPT_OLD 152 +#define EVP_F_EVP_PKEY_GET1_DH 119 +#define EVP_F_EVP_PKEY_GET1_DSA 120 +#define EVP_F_EVP_PKEY_GET1_ECDSA 130 +#define EVP_F_EVP_PKEY_GET1_EC_KEY 131 +#define EVP_F_EVP_PKEY_GET1_RSA 121 +#define EVP_F_EVP_PKEY_KEYGEN 146 +#define EVP_F_EVP_PKEY_KEYGEN_INIT 147 +#define EVP_F_EVP_PKEY_NEW 106 +#define EVP_F_EVP_PKEY_PARAMGEN 148 +#define EVP_F_EVP_PKEY_PARAMGEN_INIT 149 +#define EVP_F_EVP_PKEY_SIGN 140 +#define EVP_F_EVP_PKEY_SIGN_INIT 141 +#define EVP_F_EVP_PKEY_VERIFY 142 +#define EVP_F_EVP_PKEY_VERIFY_INIT 143 +#define EVP_F_EVP_PKEY_VERIFY_RECOVER 144 +#define EVP_F_EVP_PKEY_VERIFY_RECOVER_INIT 145 +#define EVP_F_EVP_RIJNDAEL 126 +#define EVP_F_EVP_SIGNFINAL 107 +#define EVP_F_EVP_VERIFYFINAL 108 +#define EVP_F_FIPS_CIPHERINIT 166 +#define EVP_F_FIPS_CIPHER_CTX_COPY 170 +#define EVP_F_FIPS_CIPHER_CTX_CTRL 167 +#define EVP_F_FIPS_CIPHER_CTX_SET_KEY_LENGTH 171 +#define EVP_F_FIPS_DIGESTINIT 168 +#define EVP_F_FIPS_MD_CTX_COPY 169 +#define EVP_F_HMAC_INIT_EX 174 +#define EVP_F_INT_CTX_NEW 157 +#define EVP_F_PKCS5_PBE_KEYIVGEN 117 +#define EVP_F_PKCS5_V2_PBE_KEYIVGEN 118 +#define EVP_F_PKCS5_V2_PBKDF2_KEYIVGEN 164 +#define EVP_F_PKCS8_SET_BROKEN 112 +#define EVP_F_PKEY_SET_TYPE 158 +#define EVP_F_RC2_MAGIC_TO_METH 109 +#define EVP_F_RC5_CTRL 125 + +/* Reason codes. */ +#define EVP_R_AES_IV_SETUP_FAILED 162 +#define EVP_R_AES_KEY_SETUP_FAILED 143 +#define EVP_R_ASN1_LIB 140 +#define EVP_R_BAD_BLOCK_LENGTH 136 +#define EVP_R_BAD_DECRYPT 100 +#define EVP_R_BAD_KEY_LENGTH 137 +#define EVP_R_BN_DECODE_ERROR 112 +#define EVP_R_BN_PUBKEY_ERROR 113 +#define EVP_R_BUFFER_TOO_SMALL 155 +#define EVP_R_CAMELLIA_KEY_SETUP_FAILED 157 +#define EVP_R_CIPHER_PARAMETER_ERROR 122 +#define EVP_R_COMMAND_NOT_SUPPORTED 147 +#define EVP_R_CTRL_NOT_IMPLEMENTED 132 +#define EVP_R_CTRL_OPERATION_NOT_IMPLEMENTED 133 +#define EVP_R_DATA_NOT_MULTIPLE_OF_BLOCK_LENGTH 138 +#define EVP_R_DECODE_ERROR 114 +#define EVP_R_DIFFERENT_KEY_TYPES 101 +#define EVP_R_DIFFERENT_PARAMETERS 153 +#define EVP_R_DISABLED_FOR_FIPS 163 +#define EVP_R_ENCODE_ERROR 115 +#define EVP_R_EVP_PBE_CIPHERINIT_ERROR 119 +#define EVP_R_EXPECTING_AN_RSA_KEY 127 +#define EVP_R_EXPECTING_A_DH_KEY 128 +#define EVP_R_EXPECTING_A_DSA_KEY 129 +#define EVP_R_EXPECTING_A_ECDSA_KEY 141 +#define EVP_R_EXPECTING_A_EC_KEY 142 +#define EVP_R_INITIALIZATION_ERROR 134 +#define EVP_R_INPUT_NOT_INITIALIZED 111 +#define EVP_R_INVALID_DIGEST 152 +#define EVP_R_INVALID_KEY_LENGTH 130 +#define EVP_R_INVALID_OPERATION 148 +#define EVP_R_IV_TOO_LARGE 102 +#define EVP_R_KEYGEN_FAILURE 120 +#define EVP_R_MESSAGE_DIGEST_IS_NULL 159 +#define EVP_R_METHOD_NOT_SUPPORTED 144 +#define EVP_R_MISSING_PARAMETERS 103 +#define EVP_R_NO_CIPHER_SET 131 +#define EVP_R_NO_DEFAULT_DIGEST 158 +#define EVP_R_NO_DIGEST_SET 139 +#define EVP_R_NO_DSA_PARAMETERS 116 +#define EVP_R_NO_KEY_SET 154 +#define EVP_R_NO_OPERATION_SET 149 +#define EVP_R_NO_SIGN_FUNCTION_CONFIGURED 104 +#define EVP_R_NO_VERIFY_FUNCTION_CONFIGURED 105 +#define EVP_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE 150 +#define EVP_R_OPERATON_NOT_INITIALIZED 151 +#define EVP_R_PKCS8_UNKNOWN_BROKEN_TYPE 117 +#define EVP_R_PRIVATE_KEY_DECODE_ERROR 145 +#define EVP_R_PRIVATE_KEY_ENCODE_ERROR 146 +#define EVP_R_PUBLIC_KEY_NOT_RSA 106 +#define EVP_R_TOO_LARGE 164 +#define EVP_R_UNKNOWN_CIPHER 160 +#define EVP_R_UNKNOWN_DIGEST 161 +#define EVP_R_UNKNOWN_PBE_ALGORITHM 121 +#define EVP_R_UNSUPORTED_NUMBER_OF_ROUNDS 135 +#define EVP_R_UNSUPPORTED_ALGORITHM 156 +#define EVP_R_UNSUPPORTED_CIPHER 107 +#define EVP_R_UNSUPPORTED_KEYLENGTH 123 +#define EVP_R_UNSUPPORTED_KEY_DERIVATION_FUNCTION 124 +#define EVP_R_UNSUPPORTED_KEY_SIZE 108 +#define EVP_R_UNSUPPORTED_PRF 125 +#define EVP_R_UNSUPPORTED_PRIVATE_KEY_ALGORITHM 118 +#define EVP_R_UNSUPPORTED_SALT_TYPE 126 +#define EVP_R_WRONG_FINAL_BLOCK_LENGTH 109 +#define EVP_R_WRONG_PUBLIC_KEY_TYPE 110 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/hmac.h b/Source/Import/OpenSSL/Include/openssl/hmac.h new file mode 100644 index 0000000..1be0022 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/hmac.h @@ -0,0 +1,110 @@ +/* crypto/hmac/hmac.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ +#ifndef HEADER_HMAC_H +#define HEADER_HMAC_H + +#include + +#ifdef OPENSSL_NO_HMAC +#error HMAC is disabled. +#endif + +#include + +#define HMAC_MAX_MD_CBLOCK 128 /* largest known is SHA512 */ + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct hmac_ctx_st + { + const EVP_MD *md; + EVP_MD_CTX md_ctx; + EVP_MD_CTX i_ctx; + EVP_MD_CTX o_ctx; + unsigned int key_length; + unsigned char key[HMAC_MAX_MD_CBLOCK]; + } HMAC_CTX; + +#define HMAC_size(e) (EVP_MD_size((e)->md)) + + +void HMAC_CTX_init(HMAC_CTX *ctx); +void HMAC_CTX_cleanup(HMAC_CTX *ctx); + +#define HMAC_cleanup(ctx) HMAC_CTX_cleanup(ctx) /* deprecated */ + +int HMAC_Init(HMAC_CTX *ctx, const void *key, int len, + const EVP_MD *md); /* deprecated */ +int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int len, + const EVP_MD *md, ENGINE *impl); +int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, size_t len); +int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len); +unsigned char *HMAC(const EVP_MD *evp_md, const void *key, int key_len, + const unsigned char *d, size_t n, unsigned char *md, + unsigned int *md_len); +int HMAC_CTX_copy(HMAC_CTX *dctx, HMAC_CTX *sctx); + +void HMAC_CTX_set_flags(HMAC_CTX *ctx, unsigned long flags); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/idea.h b/Source/Import/OpenSSL/Include/openssl/idea.h new file mode 100644 index 0000000..e9a1e7f --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/idea.h @@ -0,0 +1,103 @@ +/* crypto/idea/idea.h */ +/* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_IDEA_H +#define HEADER_IDEA_H + +#include /* IDEA_INT, OPENSSL_NO_IDEA */ + +#ifdef OPENSSL_NO_IDEA +#error IDEA is disabled. +#endif + +#define IDEA_ENCRYPT 1 +#define IDEA_DECRYPT 0 + +#define IDEA_BLOCK 8 +#define IDEA_KEY_LENGTH 16 + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct idea_key_st + { + IDEA_INT data[9][6]; + } IDEA_KEY_SCHEDULE; + +const char *idea_options(void); +void idea_ecb_encrypt(const unsigned char *in, unsigned char *out, + IDEA_KEY_SCHEDULE *ks); +#ifdef OPENSSL_FIPS +void private_idea_set_encrypt_key(const unsigned char *key, IDEA_KEY_SCHEDULE *ks); +#endif +void idea_set_encrypt_key(const unsigned char *key, IDEA_KEY_SCHEDULE *ks); +void idea_set_decrypt_key(IDEA_KEY_SCHEDULE *ek, IDEA_KEY_SCHEDULE *dk); +void idea_cbc_encrypt(const unsigned char *in, unsigned char *out, + long length, IDEA_KEY_SCHEDULE *ks, unsigned char *iv,int enc); +void idea_cfb64_encrypt(const unsigned char *in, unsigned char *out, + long length, IDEA_KEY_SCHEDULE *ks, unsigned char *iv, + int *num,int enc); +void idea_ofb64_encrypt(const unsigned char *in, unsigned char *out, + long length, IDEA_KEY_SCHEDULE *ks, unsigned char *iv, int *num); +void idea_encrypt(unsigned long *in, IDEA_KEY_SCHEDULE *ks); +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/krb5_asn.h b/Source/Import/OpenSSL/Include/openssl/krb5_asn.h new file mode 100644 index 0000000..41725d0 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/krb5_asn.h @@ -0,0 +1,256 @@ +/* krb5_asn.h */ +/* Written by Vern Staats for the OpenSSL project, +** using ocsp/{*.h,*asn*.c} as a starting point +*/ + +/* ==================================================================== + * Copyright (c) 1998-2000 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_KRB5_ASN_H +#define HEADER_KRB5_ASN_H + +/* +#include +*/ +#include + +#ifdef __cplusplus +extern "C" { +#endif + + +/* ASN.1 from Kerberos RFC 1510 +*/ + +/* EncryptedData ::= SEQUENCE { +** etype[0] INTEGER, -- EncryptionType +** kvno[1] INTEGER OPTIONAL, +** cipher[2] OCTET STRING -- ciphertext +** } +*/ +typedef struct krb5_encdata_st + { + ASN1_INTEGER *etype; + ASN1_INTEGER *kvno; + ASN1_OCTET_STRING *cipher; + } KRB5_ENCDATA; + +DECLARE_STACK_OF(KRB5_ENCDATA) + +/* PrincipalName ::= SEQUENCE { +** name-type[0] INTEGER, +** name-string[1] SEQUENCE OF GeneralString +** } +*/ +typedef struct krb5_princname_st + { + ASN1_INTEGER *nametype; + STACK_OF(ASN1_GENERALSTRING) *namestring; + } KRB5_PRINCNAME; + +DECLARE_STACK_OF(KRB5_PRINCNAME) + + +/* Ticket ::= [APPLICATION 1] SEQUENCE { +** tkt-vno[0] INTEGER, +** realm[1] Realm, +** sname[2] PrincipalName, +** enc-part[3] EncryptedData +** } +*/ +typedef struct krb5_tktbody_st + { + ASN1_INTEGER *tktvno; + ASN1_GENERALSTRING *realm; + KRB5_PRINCNAME *sname; + KRB5_ENCDATA *encdata; + } KRB5_TKTBODY; + +typedef STACK_OF(KRB5_TKTBODY) KRB5_TICKET; +DECLARE_STACK_OF(KRB5_TKTBODY) + + +/* AP-REQ ::= [APPLICATION 14] SEQUENCE { +** pvno[0] INTEGER, +** msg-type[1] INTEGER, +** ap-options[2] APOptions, +** ticket[3] Ticket, +** authenticator[4] EncryptedData +** } +** +** APOptions ::= BIT STRING { +** reserved(0), use-session-key(1), mutual-required(2) } +*/ +typedef struct krb5_ap_req_st + { + ASN1_INTEGER *pvno; + ASN1_INTEGER *msgtype; + ASN1_BIT_STRING *apoptions; + KRB5_TICKET *ticket; + KRB5_ENCDATA *authenticator; + } KRB5_APREQBODY; + +typedef STACK_OF(KRB5_APREQBODY) KRB5_APREQ; +DECLARE_STACK_OF(KRB5_APREQBODY) + + +/* Authenticator Stuff */ + + +/* Checksum ::= SEQUENCE { +** cksumtype[0] INTEGER, +** checksum[1] OCTET STRING +** } +*/ +typedef struct krb5_checksum_st + { + ASN1_INTEGER *ctype; + ASN1_OCTET_STRING *checksum; + } KRB5_CHECKSUM; + +DECLARE_STACK_OF(KRB5_CHECKSUM) + + +/* EncryptionKey ::= SEQUENCE { +** keytype[0] INTEGER, +** keyvalue[1] OCTET STRING +** } +*/ +typedef struct krb5_encryptionkey_st + { + ASN1_INTEGER *ktype; + ASN1_OCTET_STRING *keyvalue; + } KRB5_ENCKEY; + +DECLARE_STACK_OF(KRB5_ENCKEY) + + +/* AuthorizationData ::= SEQUENCE OF SEQUENCE { +** ad-type[0] INTEGER, +** ad-data[1] OCTET STRING +** } +*/ +typedef struct krb5_authorization_st + { + ASN1_INTEGER *adtype; + ASN1_OCTET_STRING *addata; + } KRB5_AUTHDATA; + +DECLARE_STACK_OF(KRB5_AUTHDATA) + + +/* -- Unencrypted authenticator +** Authenticator ::= [APPLICATION 2] SEQUENCE { +** authenticator-vno[0] INTEGER, +** crealm[1] Realm, +** cname[2] PrincipalName, +** cksum[3] Checksum OPTIONAL, +** cusec[4] INTEGER, +** ctime[5] KerberosTime, +** subkey[6] EncryptionKey OPTIONAL, +** seq-number[7] INTEGER OPTIONAL, +** authorization-data[8] AuthorizationData OPTIONAL +** } +*/ +typedef struct krb5_authenticator_st + { + ASN1_INTEGER *avno; + ASN1_GENERALSTRING *crealm; + KRB5_PRINCNAME *cname; + KRB5_CHECKSUM *cksum; + ASN1_INTEGER *cusec; + ASN1_GENERALIZEDTIME *ctime; + KRB5_ENCKEY *subkey; + ASN1_INTEGER *seqnum; + KRB5_AUTHDATA *authorization; + } KRB5_AUTHENTBODY; + +typedef STACK_OF(KRB5_AUTHENTBODY) KRB5_AUTHENT; +DECLARE_STACK_OF(KRB5_AUTHENTBODY) + + +/* DECLARE_ASN1_FUNCTIONS(type) = DECLARE_ASN1_FUNCTIONS_name(type, type) = +** type *name##_new(void); +** void name##_free(type *a); +** DECLARE_ASN1_ENCODE_FUNCTIONS(type, name, name) = +** DECLARE_ASN1_ENCODE_FUNCTIONS(type, itname, name) = +** type *d2i_##name(type **a, const unsigned char **in, long len); +** int i2d_##name(type *a, unsigned char **out); +** DECLARE_ASN1_ITEM(itname) = OPENSSL_EXTERN const ASN1_ITEM itname##_it +*/ + +DECLARE_ASN1_FUNCTIONS(KRB5_ENCDATA) +DECLARE_ASN1_FUNCTIONS(KRB5_PRINCNAME) +DECLARE_ASN1_FUNCTIONS(KRB5_TKTBODY) +DECLARE_ASN1_FUNCTIONS(KRB5_APREQBODY) +DECLARE_ASN1_FUNCTIONS(KRB5_TICKET) +DECLARE_ASN1_FUNCTIONS(KRB5_APREQ) + +DECLARE_ASN1_FUNCTIONS(KRB5_CHECKSUM) +DECLARE_ASN1_FUNCTIONS(KRB5_ENCKEY) +DECLARE_ASN1_FUNCTIONS(KRB5_AUTHDATA) +DECLARE_ASN1_FUNCTIONS(KRB5_AUTHENTBODY) +DECLARE_ASN1_FUNCTIONS(KRB5_AUTHENT) + + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ + +#ifdef __cplusplus +} +#endif +#endif + diff --git a/Source/Import/OpenSSL/Include/openssl/kssl.h b/Source/Import/OpenSSL/Include/openssl/kssl.h new file mode 100644 index 0000000..8242fd5 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/kssl.h @@ -0,0 +1,183 @@ +/* ssl/kssl.h -*- mode: C; c-file-style: "eay" -*- */ +/* Written by Vern Staats for the OpenSSL project 2000. + * project 2000. + */ +/* ==================================================================== + * Copyright (c) 2000 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +/* +** 19990701 VRS Started. +*/ + +#ifndef KSSL_H +#define KSSL_H + +#include + +#ifndef OPENSSL_NO_KRB5 + +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* +** Depending on which KRB5 implementation used, some types from +** the other may be missing. Resolve that here and now +*/ +#ifdef KRB5_HEIMDAL +typedef unsigned char krb5_octet; +#define FAR +#else + +#ifndef FAR +#define FAR +#endif + +#endif + +/* Uncomment this to debug kssl problems or +** to trace usage of the Kerberos session key +** +** #define KSSL_DEBUG +*/ + +#ifndef KRB5SVC +#define KRB5SVC "host" +#endif + +#ifndef KRB5KEYTAB +#define KRB5KEYTAB "/etc/krb5.keytab" +#endif + +#ifndef KRB5SENDAUTH +#define KRB5SENDAUTH 1 +#endif + +#ifndef KRB5CHECKAUTH +#define KRB5CHECKAUTH 1 +#endif + +#ifndef KSSL_CLOCKSKEW +#define KSSL_CLOCKSKEW 300; +#endif + +#define KSSL_ERR_MAX 255 +typedef struct kssl_err_st { + int reason; + char text[KSSL_ERR_MAX+1]; + } KSSL_ERR; + + +/* Context for passing +** (1) Kerberos session key to SSL, and +** (2) Config data between application and SSL lib +*/ +typedef struct kssl_ctx_st + { + /* used by: disposition: */ + char *service_name; /* C,S default ok (kssl) */ + char *service_host; /* C input, REQUIRED */ + char *client_princ; /* S output from krb5 ticket */ + char *keytab_file; /* S NULL (/etc/krb5.keytab) */ + char *cred_cache; /* C NULL (default) */ + krb5_enctype enctype; + int length; + krb5_octet FAR *key; + } KSSL_CTX; + +#define KSSL_CLIENT 1 +#define KSSL_SERVER 2 +#define KSSL_SERVICE 3 +#define KSSL_KEYTAB 4 + +#define KSSL_CTX_OK 0 +#define KSSL_CTX_ERR 1 +#define KSSL_NOMEM 2 + +/* Public (for use by applications that use OpenSSL with Kerberos 5 support */ +krb5_error_code kssl_ctx_setstring(KSSL_CTX *kssl_ctx, int which, char *text); +KSSL_CTX *kssl_ctx_new(void); +KSSL_CTX *kssl_ctx_free(KSSL_CTX *kssl_ctx); +void kssl_ctx_show(KSSL_CTX *kssl_ctx); +krb5_error_code kssl_ctx_setprinc(KSSL_CTX *kssl_ctx, int which, + krb5_data *realm, krb5_data *entity, int nentities); +krb5_error_code kssl_cget_tkt(KSSL_CTX *kssl_ctx, krb5_data **enc_tktp, + krb5_data *authenp, KSSL_ERR *kssl_err); +krb5_error_code kssl_sget_tkt(KSSL_CTX *kssl_ctx, krb5_data *indata, + krb5_ticket_times *ttimes, KSSL_ERR *kssl_err); +krb5_error_code kssl_ctx_setkey(KSSL_CTX *kssl_ctx, krb5_keyblock *session); +void kssl_err_set(KSSL_ERR *kssl_err, int reason, char *text); +void kssl_krb5_free_data_contents(krb5_context context, krb5_data *data); +krb5_error_code kssl_build_principal_2(krb5_context context, + krb5_principal *princ, int rlen, const char *realm, + int slen, const char *svc, int hlen, const char *host); +krb5_error_code kssl_validate_times(krb5_timestamp atime, + krb5_ticket_times *ttimes); +krb5_error_code kssl_check_authent(KSSL_CTX *kssl_ctx, krb5_data *authentp, + krb5_timestamp *atimep, KSSL_ERR *kssl_err); +unsigned char *kssl_skip_confound(krb5_enctype enctype, unsigned char *authn); + +void SSL_set0_kssl_ctx(SSL *s, KSSL_CTX *kctx); +KSSL_CTX * SSL_get0_kssl_ctx(SSL *s); +char *kssl_ctx_get0_client_princ(KSSL_CTX *kctx); + +#ifdef __cplusplus +} +#endif +#endif /* OPENSSL_NO_KRB5 */ +#endif /* KSSL_H */ diff --git a/Source/Import/OpenSSL/Include/openssl/lhash.h b/Source/Import/OpenSSL/Include/openssl/lhash.h new file mode 100644 index 0000000..e7d8763 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/lhash.h @@ -0,0 +1,241 @@ +/* crypto/lhash/lhash.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +/* Header for dynamic hash table routines + * Author - Eric Young + */ + +#ifndef HEADER_LHASH_H +#define HEADER_LHASH_H + +#include +#ifndef OPENSSL_NO_FP_API +#include +#endif + +#ifndef OPENSSL_NO_BIO +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct lhash_node_st + { + void *data; + struct lhash_node_st *next; +#ifndef OPENSSL_NO_HASH_COMP + unsigned long hash; +#endif + } LHASH_NODE; + +typedef int (*LHASH_COMP_FN_TYPE)(const void *, const void *); +typedef unsigned long (*LHASH_HASH_FN_TYPE)(const void *); +typedef void (*LHASH_DOALL_FN_TYPE)(void *); +typedef void (*LHASH_DOALL_ARG_FN_TYPE)(void *, void *); + +/* Macros for declaring and implementing type-safe wrappers for LHASH callbacks. + * This way, callbacks can be provided to LHASH structures without function + * pointer casting and the macro-defined callbacks provide per-variable casting + * before deferring to the underlying type-specific callbacks. NB: It is + * possible to place a "static" in front of both the DECLARE and IMPLEMENT + * macros if the functions are strictly internal. */ + +/* First: "hash" functions */ +#define DECLARE_LHASH_HASH_FN(name, o_type) \ + unsigned long name##_LHASH_HASH(const void *); +#define IMPLEMENT_LHASH_HASH_FN(name, o_type) \ + unsigned long name##_LHASH_HASH(const void *arg) { \ + const o_type *a = arg; \ + return name##_hash(a); } +#define LHASH_HASH_FN(name) name##_LHASH_HASH + +/* Second: "compare" functions */ +#define DECLARE_LHASH_COMP_FN(name, o_type) \ + int name##_LHASH_COMP(const void *, const void *); +#define IMPLEMENT_LHASH_COMP_FN(name, o_type) \ + int name##_LHASH_COMP(const void *arg1, const void *arg2) { \ + const o_type *a = arg1; \ + const o_type *b = arg2; \ + return name##_cmp(a,b); } +#define LHASH_COMP_FN(name) name##_LHASH_COMP + +/* Third: "doall" functions */ +#define DECLARE_LHASH_DOALL_FN(name, o_type) \ + void name##_LHASH_DOALL(void *); +#define IMPLEMENT_LHASH_DOALL_FN(name, o_type) \ + void name##_LHASH_DOALL(void *arg) { \ + o_type *a = arg; \ + name##_doall(a); } +#define LHASH_DOALL_FN(name) name##_LHASH_DOALL + +/* Fourth: "doall_arg" functions */ +#define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \ + void name##_LHASH_DOALL_ARG(void *, void *); +#define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \ + void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \ + o_type *a = arg1; \ + a_type *b = arg2; \ + name##_doall_arg(a, b); } +#define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG + +typedef struct lhash_st + { + LHASH_NODE **b; + LHASH_COMP_FN_TYPE comp; + LHASH_HASH_FN_TYPE hash; + unsigned int num_nodes; + unsigned int num_alloc_nodes; + unsigned int p; + unsigned int pmax; + unsigned long up_load; /* load times 256 */ + unsigned long down_load; /* load times 256 */ + unsigned long num_items; + + unsigned long num_expands; + unsigned long num_expand_reallocs; + unsigned long num_contracts; + unsigned long num_contract_reallocs; + unsigned long num_hash_calls; + unsigned long num_comp_calls; + unsigned long num_insert; + unsigned long num_replace; + unsigned long num_delete; + unsigned long num_no_delete; + unsigned long num_retrieve; + unsigned long num_retrieve_miss; + unsigned long num_hash_comps; + + int error; + } _LHASH; /* Do not use _LHASH directly, use LHASH_OF + * and friends */ + +#define LH_LOAD_MULT 256 + +/* Indicates a malloc() error in the last call, this is only bad + * in lh_insert(). */ +#define lh_error(lh) ((lh)->error) + +_LHASH *lh_new(LHASH_HASH_FN_TYPE h, LHASH_COMP_FN_TYPE c); +void lh_free(_LHASH *lh); +void *lh_insert(_LHASH *lh, void *data); +void *lh_delete(_LHASH *lh, const void *data); +void *lh_retrieve(_LHASH *lh, const void *data); +void lh_doall(_LHASH *lh, LHASH_DOALL_FN_TYPE func); +void lh_doall_arg(_LHASH *lh, LHASH_DOALL_ARG_FN_TYPE func, void *arg); +unsigned long lh_strhash(const char *c); +unsigned long lh_num_items(const _LHASH *lh); + +#ifndef OPENSSL_NO_FP_API +void lh_stats(const _LHASH *lh, FILE *out); +void lh_node_stats(const _LHASH *lh, FILE *out); +void lh_node_usage_stats(const _LHASH *lh, FILE *out); +#endif + +#ifndef OPENSSL_NO_BIO +void lh_stats_bio(const _LHASH *lh, BIO *out); +void lh_node_stats_bio(const _LHASH *lh, BIO *out); +void lh_node_usage_stats_bio(const _LHASH *lh, BIO *out); +#endif + +/* Type checking... */ + +#define LHASH_OF(type) struct lhash_st_##type + +#define DECLARE_LHASH_OF(type) LHASH_OF(type) { int dummy; } + +#define CHECKED_LHASH_OF(type,lh) \ + ((_LHASH *)CHECKED_PTR_OF(LHASH_OF(type),lh)) + +/* Define wrapper functions. */ +#define LHM_lh_new(type, name) \ + ((LHASH_OF(type) *)lh_new(LHASH_HASH_FN(name), LHASH_COMP_FN(name))) +#define LHM_lh_error(type, lh) \ + lh_error(CHECKED_LHASH_OF(type,lh)) +#define LHM_lh_insert(type, lh, inst) \ + ((type *)lh_insert(CHECKED_LHASH_OF(type, lh), \ + CHECKED_PTR_OF(type, inst))) +#define LHM_lh_retrieve(type, lh, inst) \ + ((type *)lh_retrieve(CHECKED_LHASH_OF(type, lh), \ + CHECKED_PTR_OF(type, inst))) +#define LHM_lh_delete(type, lh, inst) \ + ((type *)lh_delete(CHECKED_LHASH_OF(type, lh), \ + CHECKED_PTR_OF(type, inst))) +#define LHM_lh_doall(type, lh,fn) lh_doall(CHECKED_LHASH_OF(type, lh), fn) +#define LHM_lh_doall_arg(type, lh, fn, arg_type, arg) \ + lh_doall_arg(CHECKED_LHASH_OF(type, lh), fn, CHECKED_PTR_OF(arg_type, arg)) +#define LHM_lh_num_items(type, lh) lh_num_items(CHECKED_LHASH_OF(type, lh)) +#define LHM_lh_down_load(type, lh) (CHECKED_LHASH_OF(type, lh)->down_load) +#define LHM_lh_node_stats_bio(type, lh, out) \ + lh_node_stats_bio(CHECKED_LHASH_OF(type, lh), out) +#define LHM_lh_node_usage_stats_bio(type, lh, out) \ + lh_node_usage_stats_bio(CHECKED_LHASH_OF(type, lh), out) +#define LHM_lh_stats_bio(type, lh, out) \ + lh_stats_bio(CHECKED_LHASH_OF(type, lh), out) +#define LHM_lh_free(type, lh) lh_free(CHECKED_LHASH_OF(type, lh)) + +DECLARE_LHASH_OF(OPENSSL_STRING); +DECLARE_LHASH_OF(OPENSSL_CSTRING); + +#ifdef __cplusplus +} +#endif + +#endif + diff --git a/Source/Import/OpenSSL/Include/openssl/md4.h b/Source/Import/OpenSSL/Include/openssl/md4.h new file mode 100644 index 0000000..a55368a --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/md4.h @@ -0,0 +1,120 @@ +/* crypto/md4/md4.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_MD4_H +#define HEADER_MD4_H + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef OPENSSL_NO_MD4 +#error MD4 is disabled. +#endif + +/* + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + * ! MD4_LONG has to be at least 32 bits wide. If it's wider, then ! + * ! MD4_LONG_LOG2 has to be defined along. ! + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + */ + +#if defined(__LP32__) +#define MD4_LONG unsigned long +#elif defined(OPENSSL_SYS_CRAY) || defined(__ILP64__) +#define MD4_LONG unsigned long +#define MD4_LONG_LOG2 3 +/* + * _CRAY note. I could declare short, but I have no idea what impact + * does it have on performance on none-T3E machines. I could declare + * int, but at least on C90 sizeof(int) can be chosen at compile time. + * So I've chosen long... + * + */ +#else +#define MD4_LONG unsigned int +#endif + +#define MD4_CBLOCK 64 +#define MD4_LBLOCK (MD4_CBLOCK/4) +#define MD4_DIGEST_LENGTH 16 + +typedef struct MD4state_st + { + MD4_LONG A,B,C,D; + MD4_LONG Nl,Nh; + MD4_LONG data[MD4_LBLOCK]; + unsigned int num; + } MD4_CTX; + +#ifdef OPENSSL_FIPS +int private_MD4_Init(MD4_CTX *c); +#endif +int MD4_Init(MD4_CTX *c); +int MD4_Update(MD4_CTX *c, const void *data, size_t len); +int MD4_Final(unsigned char *md, MD4_CTX *c); +unsigned char *MD4(const unsigned char *d, size_t n, unsigned char *md); +void MD4_Transform(MD4_CTX *c, const unsigned char *b); +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/md5.h b/Source/Import/OpenSSL/Include/openssl/md5.h new file mode 100644 index 0000000..541cc92 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/md5.h @@ -0,0 +1,120 @@ +/* crypto/md5/md5.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_MD5_H +#define HEADER_MD5_H + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef OPENSSL_NO_MD5 +#error MD5 is disabled. +#endif + +/* + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + * ! MD5_LONG has to be at least 32 bits wide. If it's wider, then ! + * ! MD5_LONG_LOG2 has to be defined along. ! + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + */ + +#if defined(__LP32__) +#define MD5_LONG unsigned long +#elif defined(OPENSSL_SYS_CRAY) || defined(__ILP64__) +#define MD5_LONG unsigned long +#define MD5_LONG_LOG2 3 +/* + * _CRAY note. I could declare short, but I have no idea what impact + * does it have on performance on none-T3E machines. I could declare + * int, but at least on C90 sizeof(int) can be chosen at compile time. + * So I've chosen long... + * + */ +#else +#define MD5_LONG unsigned int +#endif + +#define MD5_CBLOCK 64 +#define MD5_LBLOCK (MD5_CBLOCK/4) +#define MD5_DIGEST_LENGTH 16 + +typedef struct MD5state_st + { + MD5_LONG A,B,C,D; + MD5_LONG Nl,Nh; + MD5_LONG data[MD5_LBLOCK]; + unsigned int num; + } MD5_CTX; + +#ifdef OPENSSL_FIPS +int private_MD5_Init(MD5_CTX *c); +#endif +int MD5_Init(MD5_CTX *c); +int MD5_Update(MD5_CTX *c, const void *data, size_t len); +int MD5_Final(unsigned char *md, MD5_CTX *c); +unsigned char *MD5(const unsigned char *d, size_t n, unsigned char *md); +void MD5_Transform(MD5_CTX *c, const unsigned char *b); +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/mdc2.h b/Source/Import/OpenSSL/Include/openssl/mdc2.h new file mode 100644 index 0000000..f3e8e57 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/mdc2.h @@ -0,0 +1,98 @@ +/* crypto/mdc2/mdc2.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_MDC2_H +#define HEADER_MDC2_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef OPENSSL_NO_MDC2 +#error MDC2 is disabled. +#endif + +#define MDC2_BLOCK 8 +#define MDC2_DIGEST_LENGTH 16 + +typedef struct mdc2_ctx_st + { + unsigned int num; + unsigned char data[MDC2_BLOCK]; + DES_cblock h,hh; + int pad_type; /* either 1 or 2, default 1 */ + } MDC2_CTX; + + +#ifdef OPENSSL_FIPS +int private_MDC2_Init(MDC2_CTX *c); +#endif +int MDC2_Init(MDC2_CTX *c); +int MDC2_Update(MDC2_CTX *c, const unsigned char *data, size_t len); +int MDC2_Final(unsigned char *md, MDC2_CTX *c); +unsigned char *MDC2(const unsigned char *d, size_t n, + unsigned char *md); + +#ifdef __cplusplus +} +#endif + +#endif + diff --git a/Source/Import/OpenSSL/Include/openssl/modes.h b/Source/Import/OpenSSL/Include/openssl/modes.h new file mode 100644 index 0000000..f18215b --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/modes.h @@ -0,0 +1,135 @@ +/* ==================================================================== + * Copyright (c) 2008 The OpenSSL Project. All rights reserved. + * + * Rights for redistribution and usage in source and binary + * forms are granted according to the OpenSSL license. + */ + +#include + +typedef void (*block128_f)(const unsigned char in[16], + unsigned char out[16], + const void *key); + +typedef void (*cbc128_f)(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], int enc); + +typedef void (*ctr128_f)(const unsigned char *in, unsigned char *out, + size_t blocks, const void *key, + const unsigned char ivec[16]); + +typedef void (*ccm128_f)(const unsigned char *in, unsigned char *out, + size_t blocks, const void *key, + const unsigned char ivec[16],unsigned char cmac[16]); + +void CRYPTO_cbc128_encrypt(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], block128_f block); +void CRYPTO_cbc128_decrypt(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], block128_f block); + +void CRYPTO_ctr128_encrypt(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], unsigned char ecount_buf[16], + unsigned int *num, block128_f block); + +void CRYPTO_ctr128_encrypt_ctr32(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], unsigned char ecount_buf[16], + unsigned int *num, ctr128_f ctr); + +void CRYPTO_ofb128_encrypt(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], int *num, + block128_f block); + +void CRYPTO_cfb128_encrypt(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], int *num, + int enc, block128_f block); +void CRYPTO_cfb128_8_encrypt(const unsigned char *in, unsigned char *out, + size_t length, const void *key, + unsigned char ivec[16], int *num, + int enc, block128_f block); +void CRYPTO_cfb128_1_encrypt(const unsigned char *in, unsigned char *out, + size_t bits, const void *key, + unsigned char ivec[16], int *num, + int enc, block128_f block); + +size_t CRYPTO_cts128_encrypt_block(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], block128_f block); +size_t CRYPTO_cts128_encrypt(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], cbc128_f cbc); +size_t CRYPTO_cts128_decrypt_block(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], block128_f block); +size_t CRYPTO_cts128_decrypt(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], cbc128_f cbc); + +size_t CRYPTO_nistcts128_encrypt_block(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], block128_f block); +size_t CRYPTO_nistcts128_encrypt(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], cbc128_f cbc); +size_t CRYPTO_nistcts128_decrypt_block(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], block128_f block); +size_t CRYPTO_nistcts128_decrypt(const unsigned char *in, unsigned char *out, + size_t len, const void *key, + unsigned char ivec[16], cbc128_f cbc); + +typedef struct gcm128_context GCM128_CONTEXT; + +GCM128_CONTEXT *CRYPTO_gcm128_new(void *key, block128_f block); +void CRYPTO_gcm128_init(GCM128_CONTEXT *ctx,void *key,block128_f block); +void CRYPTO_gcm128_setiv(GCM128_CONTEXT *ctx, const unsigned char *iv, + size_t len); +int CRYPTO_gcm128_aad(GCM128_CONTEXT *ctx, const unsigned char *aad, + size_t len); +int CRYPTO_gcm128_encrypt(GCM128_CONTEXT *ctx, + const unsigned char *in, unsigned char *out, + size_t len); +int CRYPTO_gcm128_decrypt(GCM128_CONTEXT *ctx, + const unsigned char *in, unsigned char *out, + size_t len); +int CRYPTO_gcm128_encrypt_ctr32(GCM128_CONTEXT *ctx, + const unsigned char *in, unsigned char *out, + size_t len, ctr128_f stream); +int CRYPTO_gcm128_decrypt_ctr32(GCM128_CONTEXT *ctx, + const unsigned char *in, unsigned char *out, + size_t len, ctr128_f stream); +int CRYPTO_gcm128_finish(GCM128_CONTEXT *ctx,const unsigned char *tag, + size_t len); +void CRYPTO_gcm128_tag(GCM128_CONTEXT *ctx, unsigned char *tag, size_t len); +void CRYPTO_gcm128_release(GCM128_CONTEXT *ctx); + +typedef struct ccm128_context CCM128_CONTEXT; + +void CRYPTO_ccm128_init(CCM128_CONTEXT *ctx, + unsigned int M, unsigned int L, void *key,block128_f block); +int CRYPTO_ccm128_setiv(CCM128_CONTEXT *ctx, + const unsigned char *nonce, size_t nlen, size_t mlen); +void CRYPTO_ccm128_aad(CCM128_CONTEXT *ctx, + const unsigned char *aad, size_t alen); +int CRYPTO_ccm128_encrypt(CCM128_CONTEXT *ctx, + const unsigned char *inp, unsigned char *out, size_t len); +int CRYPTO_ccm128_decrypt(CCM128_CONTEXT *ctx, + const unsigned char *inp, unsigned char *out, size_t len); +int CRYPTO_ccm128_encrypt_ccm64(CCM128_CONTEXT *ctx, + const unsigned char *inp, unsigned char *out, size_t len, + ccm128_f stream); +int CRYPTO_ccm128_decrypt_ccm64(CCM128_CONTEXT *ctx, + const unsigned char *inp, unsigned char *out, size_t len, + ccm128_f stream); +size_t CRYPTO_ccm128_tag(CCM128_CONTEXT *ctx, unsigned char *tag, size_t len); + +typedef struct xts128_context XTS128_CONTEXT; + +int CRYPTO_xts128_encrypt(const XTS128_CONTEXT *ctx, const unsigned char iv[16], + const unsigned char *inp, unsigned char *out, size_t len, int enc); diff --git a/Source/Import/OpenSSL/Include/openssl/obj_mac.h b/Source/Import/OpenSSL/Include/openssl/obj_mac.h new file mode 100644 index 0000000..b5ea7cd --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/obj_mac.h @@ -0,0 +1,4032 @@ +/* crypto/objects/obj_mac.h */ + +/* THIS FILE IS GENERATED FROM objects.txt by objects.pl via the + * following command: + * perl objects.pl objects.txt obj_mac.num obj_mac.h + */ + +/* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#define SN_undef "UNDEF" +#define LN_undef "undefined" +#define NID_undef 0 +#define OBJ_undef 0L + +#define SN_itu_t "ITU-T" +#define LN_itu_t "itu-t" +#define NID_itu_t 645 +#define OBJ_itu_t 0L + +#define NID_ccitt 404 +#define OBJ_ccitt OBJ_itu_t + +#define SN_iso "ISO" +#define LN_iso "iso" +#define NID_iso 181 +#define OBJ_iso 1L + +#define SN_joint_iso_itu_t "JOINT-ISO-ITU-T" +#define LN_joint_iso_itu_t "joint-iso-itu-t" +#define NID_joint_iso_itu_t 646 +#define OBJ_joint_iso_itu_t 2L + +#define NID_joint_iso_ccitt 393 +#define OBJ_joint_iso_ccitt OBJ_joint_iso_itu_t + +#define SN_member_body "member-body" +#define LN_member_body "ISO Member Body" +#define NID_member_body 182 +#define OBJ_member_body OBJ_iso,2L + +#define SN_identified_organization "identified-organization" +#define NID_identified_organization 676 +#define OBJ_identified_organization OBJ_iso,3L + +#define SN_hmac_md5 "HMAC-MD5" +#define LN_hmac_md5 "hmac-md5" +#define NID_hmac_md5 780 +#define OBJ_hmac_md5 OBJ_identified_organization,6L,1L,5L,5L,8L,1L,1L + +#define SN_hmac_sha1 "HMAC-SHA1" +#define LN_hmac_sha1 "hmac-sha1" +#define NID_hmac_sha1 781 +#define OBJ_hmac_sha1 OBJ_identified_organization,6L,1L,5L,5L,8L,1L,2L + +#define SN_certicom_arc "certicom-arc" +#define NID_certicom_arc 677 +#define OBJ_certicom_arc OBJ_identified_organization,132L + +#define SN_international_organizations "international-organizations" +#define LN_international_organizations "International Organizations" +#define NID_international_organizations 647 +#define OBJ_international_organizations OBJ_joint_iso_itu_t,23L + +#define SN_wap "wap" +#define NID_wap 678 +#define OBJ_wap OBJ_international_organizations,43L + +#define SN_wap_wsg "wap-wsg" +#define NID_wap_wsg 679 +#define OBJ_wap_wsg OBJ_wap,1L + +#define SN_selected_attribute_types "selected-attribute-types" +#define LN_selected_attribute_types "Selected Attribute Types" +#define NID_selected_attribute_types 394 +#define OBJ_selected_attribute_types OBJ_joint_iso_itu_t,5L,1L,5L + +#define SN_clearance "clearance" +#define NID_clearance 395 +#define OBJ_clearance OBJ_selected_attribute_types,55L + +#define SN_ISO_US "ISO-US" +#define LN_ISO_US "ISO US Member Body" +#define NID_ISO_US 183 +#define OBJ_ISO_US OBJ_member_body,840L + +#define SN_X9_57 "X9-57" +#define LN_X9_57 "X9.57" +#define NID_X9_57 184 +#define OBJ_X9_57 OBJ_ISO_US,10040L + +#define SN_X9cm "X9cm" +#define LN_X9cm "X9.57 CM ?" +#define NID_X9cm 185 +#define OBJ_X9cm OBJ_X9_57,4L + +#define SN_dsa "DSA" +#define LN_dsa "dsaEncryption" +#define NID_dsa 116 +#define OBJ_dsa OBJ_X9cm,1L + +#define SN_dsaWithSHA1 "DSA-SHA1" +#define LN_dsaWithSHA1 "dsaWithSHA1" +#define NID_dsaWithSHA1 113 +#define OBJ_dsaWithSHA1 OBJ_X9cm,3L + +#define SN_ansi_X9_62 "ansi-X9-62" +#define LN_ansi_X9_62 "ANSI X9.62" +#define NID_ansi_X9_62 405 +#define OBJ_ansi_X9_62 OBJ_ISO_US,10045L + +#define OBJ_X9_62_id_fieldType OBJ_ansi_X9_62,1L + +#define SN_X9_62_prime_field "prime-field" +#define NID_X9_62_prime_field 406 +#define OBJ_X9_62_prime_field OBJ_X9_62_id_fieldType,1L + +#define SN_X9_62_characteristic_two_field "characteristic-two-field" +#define NID_X9_62_characteristic_two_field 407 +#define OBJ_X9_62_characteristic_two_field OBJ_X9_62_id_fieldType,2L + +#define SN_X9_62_id_characteristic_two_basis "id-characteristic-two-basis" +#define NID_X9_62_id_characteristic_two_basis 680 +#define OBJ_X9_62_id_characteristic_two_basis OBJ_X9_62_characteristic_two_field,3L + +#define SN_X9_62_onBasis "onBasis" +#define NID_X9_62_onBasis 681 +#define OBJ_X9_62_onBasis OBJ_X9_62_id_characteristic_two_basis,1L + +#define SN_X9_62_tpBasis "tpBasis" +#define NID_X9_62_tpBasis 682 +#define OBJ_X9_62_tpBasis OBJ_X9_62_id_characteristic_two_basis,2L + +#define SN_X9_62_ppBasis "ppBasis" +#define NID_X9_62_ppBasis 683 +#define OBJ_X9_62_ppBasis OBJ_X9_62_id_characteristic_two_basis,3L + +#define OBJ_X9_62_id_publicKeyType OBJ_ansi_X9_62,2L + +#define SN_X9_62_id_ecPublicKey "id-ecPublicKey" +#define NID_X9_62_id_ecPublicKey 408 +#define OBJ_X9_62_id_ecPublicKey OBJ_X9_62_id_publicKeyType,1L + +#define OBJ_X9_62_ellipticCurve OBJ_ansi_X9_62,3L + +#define OBJ_X9_62_c_TwoCurve OBJ_X9_62_ellipticCurve,0L + +#define SN_X9_62_c2pnb163v1 "c2pnb163v1" +#define NID_X9_62_c2pnb163v1 684 +#define OBJ_X9_62_c2pnb163v1 OBJ_X9_62_c_TwoCurve,1L + +#define SN_X9_62_c2pnb163v2 "c2pnb163v2" +#define NID_X9_62_c2pnb163v2 685 +#define OBJ_X9_62_c2pnb163v2 OBJ_X9_62_c_TwoCurve,2L + +#define SN_X9_62_c2pnb163v3 "c2pnb163v3" +#define NID_X9_62_c2pnb163v3 686 +#define OBJ_X9_62_c2pnb163v3 OBJ_X9_62_c_TwoCurve,3L + +#define SN_X9_62_c2pnb176v1 "c2pnb176v1" +#define NID_X9_62_c2pnb176v1 687 +#define OBJ_X9_62_c2pnb176v1 OBJ_X9_62_c_TwoCurve,4L + +#define SN_X9_62_c2tnb191v1 "c2tnb191v1" +#define NID_X9_62_c2tnb191v1 688 +#define OBJ_X9_62_c2tnb191v1 OBJ_X9_62_c_TwoCurve,5L + +#define SN_X9_62_c2tnb191v2 "c2tnb191v2" +#define NID_X9_62_c2tnb191v2 689 +#define OBJ_X9_62_c2tnb191v2 OBJ_X9_62_c_TwoCurve,6L + +#define SN_X9_62_c2tnb191v3 "c2tnb191v3" +#define NID_X9_62_c2tnb191v3 690 +#define OBJ_X9_62_c2tnb191v3 OBJ_X9_62_c_TwoCurve,7L + +#define SN_X9_62_c2onb191v4 "c2onb191v4" +#define NID_X9_62_c2onb191v4 691 +#define OBJ_X9_62_c2onb191v4 OBJ_X9_62_c_TwoCurve,8L + +#define SN_X9_62_c2onb191v5 "c2onb191v5" +#define NID_X9_62_c2onb191v5 692 +#define OBJ_X9_62_c2onb191v5 OBJ_X9_62_c_TwoCurve,9L + +#define SN_X9_62_c2pnb208w1 "c2pnb208w1" +#define NID_X9_62_c2pnb208w1 693 +#define OBJ_X9_62_c2pnb208w1 OBJ_X9_62_c_TwoCurve,10L + +#define SN_X9_62_c2tnb239v1 "c2tnb239v1" +#define NID_X9_62_c2tnb239v1 694 +#define OBJ_X9_62_c2tnb239v1 OBJ_X9_62_c_TwoCurve,11L + +#define SN_X9_62_c2tnb239v2 "c2tnb239v2" +#define NID_X9_62_c2tnb239v2 695 +#define OBJ_X9_62_c2tnb239v2 OBJ_X9_62_c_TwoCurve,12L + +#define SN_X9_62_c2tnb239v3 "c2tnb239v3" +#define NID_X9_62_c2tnb239v3 696 +#define OBJ_X9_62_c2tnb239v3 OBJ_X9_62_c_TwoCurve,13L + +#define SN_X9_62_c2onb239v4 "c2onb239v4" +#define NID_X9_62_c2onb239v4 697 +#define OBJ_X9_62_c2onb239v4 OBJ_X9_62_c_TwoCurve,14L + +#define SN_X9_62_c2onb239v5 "c2onb239v5" +#define NID_X9_62_c2onb239v5 698 +#define OBJ_X9_62_c2onb239v5 OBJ_X9_62_c_TwoCurve,15L + +#define SN_X9_62_c2pnb272w1 "c2pnb272w1" +#define NID_X9_62_c2pnb272w1 699 +#define OBJ_X9_62_c2pnb272w1 OBJ_X9_62_c_TwoCurve,16L + +#define SN_X9_62_c2pnb304w1 "c2pnb304w1" +#define NID_X9_62_c2pnb304w1 700 +#define OBJ_X9_62_c2pnb304w1 OBJ_X9_62_c_TwoCurve,17L + +#define SN_X9_62_c2tnb359v1 "c2tnb359v1" +#define NID_X9_62_c2tnb359v1 701 +#define OBJ_X9_62_c2tnb359v1 OBJ_X9_62_c_TwoCurve,18L + +#define SN_X9_62_c2pnb368w1 "c2pnb368w1" +#define NID_X9_62_c2pnb368w1 702 +#define OBJ_X9_62_c2pnb368w1 OBJ_X9_62_c_TwoCurve,19L + +#define SN_X9_62_c2tnb431r1 "c2tnb431r1" +#define NID_X9_62_c2tnb431r1 703 +#define OBJ_X9_62_c2tnb431r1 OBJ_X9_62_c_TwoCurve,20L + +#define OBJ_X9_62_primeCurve OBJ_X9_62_ellipticCurve,1L + +#define SN_X9_62_prime192v1 "prime192v1" +#define NID_X9_62_prime192v1 409 +#define OBJ_X9_62_prime192v1 OBJ_X9_62_primeCurve,1L + +#define SN_X9_62_prime192v2 "prime192v2" +#define NID_X9_62_prime192v2 410 +#define OBJ_X9_62_prime192v2 OBJ_X9_62_primeCurve,2L + +#define SN_X9_62_prime192v3 "prime192v3" +#define NID_X9_62_prime192v3 411 +#define OBJ_X9_62_prime192v3 OBJ_X9_62_primeCurve,3L + +#define SN_X9_62_prime239v1 "prime239v1" +#define NID_X9_62_prime239v1 412 +#define OBJ_X9_62_prime239v1 OBJ_X9_62_primeCurve,4L + +#define SN_X9_62_prime239v2 "prime239v2" +#define NID_X9_62_prime239v2 413 +#define OBJ_X9_62_prime239v2 OBJ_X9_62_primeCurve,5L + +#define SN_X9_62_prime239v3 "prime239v3" +#define NID_X9_62_prime239v3 414 +#define OBJ_X9_62_prime239v3 OBJ_X9_62_primeCurve,6L + +#define SN_X9_62_prime256v1 "prime256v1" +#define NID_X9_62_prime256v1 415 +#define OBJ_X9_62_prime256v1 OBJ_X9_62_primeCurve,7L + +#define OBJ_X9_62_id_ecSigType OBJ_ansi_X9_62,4L + +#define SN_ecdsa_with_SHA1 "ecdsa-with-SHA1" +#define NID_ecdsa_with_SHA1 416 +#define OBJ_ecdsa_with_SHA1 OBJ_X9_62_id_ecSigType,1L + +#define SN_ecdsa_with_Recommended "ecdsa-with-Recommended" +#define NID_ecdsa_with_Recommended 791 +#define OBJ_ecdsa_with_Recommended OBJ_X9_62_id_ecSigType,2L + +#define SN_ecdsa_with_Specified "ecdsa-with-Specified" +#define NID_ecdsa_with_Specified 792 +#define OBJ_ecdsa_with_Specified OBJ_X9_62_id_ecSigType,3L + +#define SN_ecdsa_with_SHA224 "ecdsa-with-SHA224" +#define NID_ecdsa_with_SHA224 793 +#define OBJ_ecdsa_with_SHA224 OBJ_ecdsa_with_Specified,1L + +#define SN_ecdsa_with_SHA256 "ecdsa-with-SHA256" +#define NID_ecdsa_with_SHA256 794 +#define OBJ_ecdsa_with_SHA256 OBJ_ecdsa_with_Specified,2L + +#define SN_ecdsa_with_SHA384 "ecdsa-with-SHA384" +#define NID_ecdsa_with_SHA384 795 +#define OBJ_ecdsa_with_SHA384 OBJ_ecdsa_with_Specified,3L + +#define SN_ecdsa_with_SHA512 "ecdsa-with-SHA512" +#define NID_ecdsa_with_SHA512 796 +#define OBJ_ecdsa_with_SHA512 OBJ_ecdsa_with_Specified,4L + +#define OBJ_secg_ellipticCurve OBJ_certicom_arc,0L + +#define SN_secp112r1 "secp112r1" +#define NID_secp112r1 704 +#define OBJ_secp112r1 OBJ_secg_ellipticCurve,6L + +#define SN_secp112r2 "secp112r2" +#define NID_secp112r2 705 +#define OBJ_secp112r2 OBJ_secg_ellipticCurve,7L + +#define SN_secp128r1 "secp128r1" +#define NID_secp128r1 706 +#define OBJ_secp128r1 OBJ_secg_ellipticCurve,28L + +#define SN_secp128r2 "secp128r2" +#define NID_secp128r2 707 +#define OBJ_secp128r2 OBJ_secg_ellipticCurve,29L + +#define SN_secp160k1 "secp160k1" +#define NID_secp160k1 708 +#define OBJ_secp160k1 OBJ_secg_ellipticCurve,9L + +#define SN_secp160r1 "secp160r1" +#define NID_secp160r1 709 +#define OBJ_secp160r1 OBJ_secg_ellipticCurve,8L + +#define SN_secp160r2 "secp160r2" +#define NID_secp160r2 710 +#define OBJ_secp160r2 OBJ_secg_ellipticCurve,30L + +#define SN_secp192k1 "secp192k1" +#define NID_secp192k1 711 +#define OBJ_secp192k1 OBJ_secg_ellipticCurve,31L + +#define SN_secp224k1 "secp224k1" +#define NID_secp224k1 712 +#define OBJ_secp224k1 OBJ_secg_ellipticCurve,32L + +#define SN_secp224r1 "secp224r1" +#define NID_secp224r1 713 +#define OBJ_secp224r1 OBJ_secg_ellipticCurve,33L + +#define SN_secp256k1 "secp256k1" +#define NID_secp256k1 714 +#define OBJ_secp256k1 OBJ_secg_ellipticCurve,10L + +#define SN_secp384r1 "secp384r1" +#define NID_secp384r1 715 +#define OBJ_secp384r1 OBJ_secg_ellipticCurve,34L + +#define SN_secp521r1 "secp521r1" +#define NID_secp521r1 716 +#define OBJ_secp521r1 OBJ_secg_ellipticCurve,35L + +#define SN_sect113r1 "sect113r1" +#define NID_sect113r1 717 +#define OBJ_sect113r1 OBJ_secg_ellipticCurve,4L + +#define SN_sect113r2 "sect113r2" +#define NID_sect113r2 718 +#define OBJ_sect113r2 OBJ_secg_ellipticCurve,5L + +#define SN_sect131r1 "sect131r1" +#define NID_sect131r1 719 +#define OBJ_sect131r1 OBJ_secg_ellipticCurve,22L + +#define SN_sect131r2 "sect131r2" +#define NID_sect131r2 720 +#define OBJ_sect131r2 OBJ_secg_ellipticCurve,23L + +#define SN_sect163k1 "sect163k1" +#define NID_sect163k1 721 +#define OBJ_sect163k1 OBJ_secg_ellipticCurve,1L + +#define SN_sect163r1 "sect163r1" +#define NID_sect163r1 722 +#define OBJ_sect163r1 OBJ_secg_ellipticCurve,2L + +#define SN_sect163r2 "sect163r2" +#define NID_sect163r2 723 +#define OBJ_sect163r2 OBJ_secg_ellipticCurve,15L + +#define SN_sect193r1 "sect193r1" +#define NID_sect193r1 724 +#define OBJ_sect193r1 OBJ_secg_ellipticCurve,24L + +#define SN_sect193r2 "sect193r2" +#define NID_sect193r2 725 +#define OBJ_sect193r2 OBJ_secg_ellipticCurve,25L + +#define SN_sect233k1 "sect233k1" +#define NID_sect233k1 726 +#define OBJ_sect233k1 OBJ_secg_ellipticCurve,26L + +#define SN_sect233r1 "sect233r1" +#define NID_sect233r1 727 +#define OBJ_sect233r1 OBJ_secg_ellipticCurve,27L + +#define SN_sect239k1 "sect239k1" +#define NID_sect239k1 728 +#define OBJ_sect239k1 OBJ_secg_ellipticCurve,3L + +#define SN_sect283k1 "sect283k1" +#define NID_sect283k1 729 +#define OBJ_sect283k1 OBJ_secg_ellipticCurve,16L + +#define SN_sect283r1 "sect283r1" +#define NID_sect283r1 730 +#define OBJ_sect283r1 OBJ_secg_ellipticCurve,17L + +#define SN_sect409k1 "sect409k1" +#define NID_sect409k1 731 +#define OBJ_sect409k1 OBJ_secg_ellipticCurve,36L + +#define SN_sect409r1 "sect409r1" +#define NID_sect409r1 732 +#define OBJ_sect409r1 OBJ_secg_ellipticCurve,37L + +#define SN_sect571k1 "sect571k1" +#define NID_sect571k1 733 +#define OBJ_sect571k1 OBJ_secg_ellipticCurve,38L + +#define SN_sect571r1 "sect571r1" +#define NID_sect571r1 734 +#define OBJ_sect571r1 OBJ_secg_ellipticCurve,39L + +#define OBJ_wap_wsg_idm_ecid OBJ_wap_wsg,4L + +#define SN_wap_wsg_idm_ecid_wtls1 "wap-wsg-idm-ecid-wtls1" +#define NID_wap_wsg_idm_ecid_wtls1 735 +#define OBJ_wap_wsg_idm_ecid_wtls1 OBJ_wap_wsg_idm_ecid,1L + +#define SN_wap_wsg_idm_ecid_wtls3 "wap-wsg-idm-ecid-wtls3" +#define NID_wap_wsg_idm_ecid_wtls3 736 +#define OBJ_wap_wsg_idm_ecid_wtls3 OBJ_wap_wsg_idm_ecid,3L + +#define SN_wap_wsg_idm_ecid_wtls4 "wap-wsg-idm-ecid-wtls4" +#define NID_wap_wsg_idm_ecid_wtls4 737 +#define OBJ_wap_wsg_idm_ecid_wtls4 OBJ_wap_wsg_idm_ecid,4L + +#define SN_wap_wsg_idm_ecid_wtls5 "wap-wsg-idm-ecid-wtls5" +#define NID_wap_wsg_idm_ecid_wtls5 738 +#define OBJ_wap_wsg_idm_ecid_wtls5 OBJ_wap_wsg_idm_ecid,5L + +#define SN_wap_wsg_idm_ecid_wtls6 "wap-wsg-idm-ecid-wtls6" +#define NID_wap_wsg_idm_ecid_wtls6 739 +#define OBJ_wap_wsg_idm_ecid_wtls6 OBJ_wap_wsg_idm_ecid,6L + +#define SN_wap_wsg_idm_ecid_wtls7 "wap-wsg-idm-ecid-wtls7" +#define NID_wap_wsg_idm_ecid_wtls7 740 +#define OBJ_wap_wsg_idm_ecid_wtls7 OBJ_wap_wsg_idm_ecid,7L + +#define SN_wap_wsg_idm_ecid_wtls8 "wap-wsg-idm-ecid-wtls8" +#define NID_wap_wsg_idm_ecid_wtls8 741 +#define OBJ_wap_wsg_idm_ecid_wtls8 OBJ_wap_wsg_idm_ecid,8L + +#define SN_wap_wsg_idm_ecid_wtls9 "wap-wsg-idm-ecid-wtls9" +#define NID_wap_wsg_idm_ecid_wtls9 742 +#define OBJ_wap_wsg_idm_ecid_wtls9 OBJ_wap_wsg_idm_ecid,9L + +#define SN_wap_wsg_idm_ecid_wtls10 "wap-wsg-idm-ecid-wtls10" +#define NID_wap_wsg_idm_ecid_wtls10 743 +#define OBJ_wap_wsg_idm_ecid_wtls10 OBJ_wap_wsg_idm_ecid,10L + +#define SN_wap_wsg_idm_ecid_wtls11 "wap-wsg-idm-ecid-wtls11" +#define NID_wap_wsg_idm_ecid_wtls11 744 +#define OBJ_wap_wsg_idm_ecid_wtls11 OBJ_wap_wsg_idm_ecid,11L + +#define SN_wap_wsg_idm_ecid_wtls12 "wap-wsg-idm-ecid-wtls12" +#define NID_wap_wsg_idm_ecid_wtls12 745 +#define OBJ_wap_wsg_idm_ecid_wtls12 OBJ_wap_wsg_idm_ecid,12L + +#define SN_cast5_cbc "CAST5-CBC" +#define LN_cast5_cbc "cast5-cbc" +#define NID_cast5_cbc 108 +#define OBJ_cast5_cbc OBJ_ISO_US,113533L,7L,66L,10L + +#define SN_cast5_ecb "CAST5-ECB" +#define LN_cast5_ecb "cast5-ecb" +#define NID_cast5_ecb 109 + +#define SN_cast5_cfb64 "CAST5-CFB" +#define LN_cast5_cfb64 "cast5-cfb" +#define NID_cast5_cfb64 110 + +#define SN_cast5_ofb64 "CAST5-OFB" +#define LN_cast5_ofb64 "cast5-ofb" +#define NID_cast5_ofb64 111 + +#define LN_pbeWithMD5AndCast5_CBC "pbeWithMD5AndCast5CBC" +#define NID_pbeWithMD5AndCast5_CBC 112 +#define OBJ_pbeWithMD5AndCast5_CBC OBJ_ISO_US,113533L,7L,66L,12L + +#define SN_id_PasswordBasedMAC "id-PasswordBasedMAC" +#define LN_id_PasswordBasedMAC "password based MAC" +#define NID_id_PasswordBasedMAC 782 +#define OBJ_id_PasswordBasedMAC OBJ_ISO_US,113533L,7L,66L,13L + +#define SN_id_DHBasedMac "id-DHBasedMac" +#define LN_id_DHBasedMac "Diffie-Hellman based MAC" +#define NID_id_DHBasedMac 783 +#define OBJ_id_DHBasedMac OBJ_ISO_US,113533L,7L,66L,30L + +#define SN_rsadsi "rsadsi" +#define LN_rsadsi "RSA Data Security, Inc." +#define NID_rsadsi 1 +#define OBJ_rsadsi OBJ_ISO_US,113549L + +#define SN_pkcs "pkcs" +#define LN_pkcs "RSA Data Security, Inc. PKCS" +#define NID_pkcs 2 +#define OBJ_pkcs OBJ_rsadsi,1L + +#define SN_pkcs1 "pkcs1" +#define NID_pkcs1 186 +#define OBJ_pkcs1 OBJ_pkcs,1L + +#define LN_rsaEncryption "rsaEncryption" +#define NID_rsaEncryption 6 +#define OBJ_rsaEncryption OBJ_pkcs1,1L + +#define SN_md2WithRSAEncryption "RSA-MD2" +#define LN_md2WithRSAEncryption "md2WithRSAEncryption" +#define NID_md2WithRSAEncryption 7 +#define OBJ_md2WithRSAEncryption OBJ_pkcs1,2L + +#define SN_md4WithRSAEncryption "RSA-MD4" +#define LN_md4WithRSAEncryption "md4WithRSAEncryption" +#define NID_md4WithRSAEncryption 396 +#define OBJ_md4WithRSAEncryption OBJ_pkcs1,3L + +#define SN_md5WithRSAEncryption "RSA-MD5" +#define LN_md5WithRSAEncryption "md5WithRSAEncryption" +#define NID_md5WithRSAEncryption 8 +#define OBJ_md5WithRSAEncryption OBJ_pkcs1,4L + +#define SN_sha1WithRSAEncryption "RSA-SHA1" +#define LN_sha1WithRSAEncryption "sha1WithRSAEncryption" +#define NID_sha1WithRSAEncryption 65 +#define OBJ_sha1WithRSAEncryption OBJ_pkcs1,5L + +#define SN_rsaesOaep "RSAES-OAEP" +#define LN_rsaesOaep "rsaesOaep" +#define NID_rsaesOaep 919 +#define OBJ_rsaesOaep OBJ_pkcs1,7L + +#define SN_mgf1 "MGF1" +#define LN_mgf1 "mgf1" +#define NID_mgf1 911 +#define OBJ_mgf1 OBJ_pkcs1,8L + +#define SN_rsassaPss "RSASSA-PSS" +#define LN_rsassaPss "rsassaPss" +#define NID_rsassaPss 912 +#define OBJ_rsassaPss OBJ_pkcs1,10L + +#define SN_sha256WithRSAEncryption "RSA-SHA256" +#define LN_sha256WithRSAEncryption "sha256WithRSAEncryption" +#define NID_sha256WithRSAEncryption 668 +#define OBJ_sha256WithRSAEncryption OBJ_pkcs1,11L + +#define SN_sha384WithRSAEncryption "RSA-SHA384" +#define LN_sha384WithRSAEncryption "sha384WithRSAEncryption" +#define NID_sha384WithRSAEncryption 669 +#define OBJ_sha384WithRSAEncryption OBJ_pkcs1,12L + +#define SN_sha512WithRSAEncryption "RSA-SHA512" +#define LN_sha512WithRSAEncryption "sha512WithRSAEncryption" +#define NID_sha512WithRSAEncryption 670 +#define OBJ_sha512WithRSAEncryption OBJ_pkcs1,13L + +#define SN_sha224WithRSAEncryption "RSA-SHA224" +#define LN_sha224WithRSAEncryption "sha224WithRSAEncryption" +#define NID_sha224WithRSAEncryption 671 +#define OBJ_sha224WithRSAEncryption OBJ_pkcs1,14L + +#define SN_pkcs3 "pkcs3" +#define NID_pkcs3 27 +#define OBJ_pkcs3 OBJ_pkcs,3L + +#define LN_dhKeyAgreement "dhKeyAgreement" +#define NID_dhKeyAgreement 28 +#define OBJ_dhKeyAgreement OBJ_pkcs3,1L + +#define SN_pkcs5 "pkcs5" +#define NID_pkcs5 187 +#define OBJ_pkcs5 OBJ_pkcs,5L + +#define SN_pbeWithMD2AndDES_CBC "PBE-MD2-DES" +#define LN_pbeWithMD2AndDES_CBC "pbeWithMD2AndDES-CBC" +#define NID_pbeWithMD2AndDES_CBC 9 +#define OBJ_pbeWithMD2AndDES_CBC OBJ_pkcs5,1L + +#define SN_pbeWithMD5AndDES_CBC "PBE-MD5-DES" +#define LN_pbeWithMD5AndDES_CBC "pbeWithMD5AndDES-CBC" +#define NID_pbeWithMD5AndDES_CBC 10 +#define OBJ_pbeWithMD5AndDES_CBC OBJ_pkcs5,3L + +#define SN_pbeWithMD2AndRC2_CBC "PBE-MD2-RC2-64" +#define LN_pbeWithMD2AndRC2_CBC "pbeWithMD2AndRC2-CBC" +#define NID_pbeWithMD2AndRC2_CBC 168 +#define OBJ_pbeWithMD2AndRC2_CBC OBJ_pkcs5,4L + +#define SN_pbeWithMD5AndRC2_CBC "PBE-MD5-RC2-64" +#define LN_pbeWithMD5AndRC2_CBC "pbeWithMD5AndRC2-CBC" +#define NID_pbeWithMD5AndRC2_CBC 169 +#define OBJ_pbeWithMD5AndRC2_CBC OBJ_pkcs5,6L + +#define SN_pbeWithSHA1AndDES_CBC "PBE-SHA1-DES" +#define LN_pbeWithSHA1AndDES_CBC "pbeWithSHA1AndDES-CBC" +#define NID_pbeWithSHA1AndDES_CBC 170 +#define OBJ_pbeWithSHA1AndDES_CBC OBJ_pkcs5,10L + +#define SN_pbeWithSHA1AndRC2_CBC "PBE-SHA1-RC2-64" +#define LN_pbeWithSHA1AndRC2_CBC "pbeWithSHA1AndRC2-CBC" +#define NID_pbeWithSHA1AndRC2_CBC 68 +#define OBJ_pbeWithSHA1AndRC2_CBC OBJ_pkcs5,11L + +#define LN_id_pbkdf2 "PBKDF2" +#define NID_id_pbkdf2 69 +#define OBJ_id_pbkdf2 OBJ_pkcs5,12L + +#define LN_pbes2 "PBES2" +#define NID_pbes2 161 +#define OBJ_pbes2 OBJ_pkcs5,13L + +#define LN_pbmac1 "PBMAC1" +#define NID_pbmac1 162 +#define OBJ_pbmac1 OBJ_pkcs5,14L + +#define SN_pkcs7 "pkcs7" +#define NID_pkcs7 20 +#define OBJ_pkcs7 OBJ_pkcs,7L + +#define LN_pkcs7_data "pkcs7-data" +#define NID_pkcs7_data 21 +#define OBJ_pkcs7_data OBJ_pkcs7,1L + +#define LN_pkcs7_signed "pkcs7-signedData" +#define NID_pkcs7_signed 22 +#define OBJ_pkcs7_signed OBJ_pkcs7,2L + +#define LN_pkcs7_enveloped "pkcs7-envelopedData" +#define NID_pkcs7_enveloped 23 +#define OBJ_pkcs7_enveloped OBJ_pkcs7,3L + +#define LN_pkcs7_signedAndEnveloped "pkcs7-signedAndEnvelopedData" +#define NID_pkcs7_signedAndEnveloped 24 +#define OBJ_pkcs7_signedAndEnveloped OBJ_pkcs7,4L + +#define LN_pkcs7_digest "pkcs7-digestData" +#define NID_pkcs7_digest 25 +#define OBJ_pkcs7_digest OBJ_pkcs7,5L + +#define LN_pkcs7_encrypted "pkcs7-encryptedData" +#define NID_pkcs7_encrypted 26 +#define OBJ_pkcs7_encrypted OBJ_pkcs7,6L + +#define SN_pkcs9 "pkcs9" +#define NID_pkcs9 47 +#define OBJ_pkcs9 OBJ_pkcs,9L + +#define LN_pkcs9_emailAddress "emailAddress" +#define NID_pkcs9_emailAddress 48 +#define OBJ_pkcs9_emailAddress OBJ_pkcs9,1L + +#define LN_pkcs9_unstructuredName "unstructuredName" +#define NID_pkcs9_unstructuredName 49 +#define OBJ_pkcs9_unstructuredName OBJ_pkcs9,2L + +#define LN_pkcs9_contentType "contentType" +#define NID_pkcs9_contentType 50 +#define OBJ_pkcs9_contentType OBJ_pkcs9,3L + +#define LN_pkcs9_messageDigest "messageDigest" +#define NID_pkcs9_messageDigest 51 +#define OBJ_pkcs9_messageDigest OBJ_pkcs9,4L + +#define LN_pkcs9_signingTime "signingTime" +#define NID_pkcs9_signingTime 52 +#define OBJ_pkcs9_signingTime OBJ_pkcs9,5L + +#define LN_pkcs9_countersignature "countersignature" +#define NID_pkcs9_countersignature 53 +#define OBJ_pkcs9_countersignature OBJ_pkcs9,6L + +#define LN_pkcs9_challengePassword "challengePassword" +#define NID_pkcs9_challengePassword 54 +#define OBJ_pkcs9_challengePassword OBJ_pkcs9,7L + +#define LN_pkcs9_unstructuredAddress "unstructuredAddress" +#define NID_pkcs9_unstructuredAddress 55 +#define OBJ_pkcs9_unstructuredAddress OBJ_pkcs9,8L + +#define LN_pkcs9_extCertAttributes "extendedCertificateAttributes" +#define NID_pkcs9_extCertAttributes 56 +#define OBJ_pkcs9_extCertAttributes OBJ_pkcs9,9L + +#define SN_ext_req "extReq" +#define LN_ext_req "Extension Request" +#define NID_ext_req 172 +#define OBJ_ext_req OBJ_pkcs9,14L + +#define SN_SMIMECapabilities "SMIME-CAPS" +#define LN_SMIMECapabilities "S/MIME Capabilities" +#define NID_SMIMECapabilities 167 +#define OBJ_SMIMECapabilities OBJ_pkcs9,15L + +#define SN_SMIME "SMIME" +#define LN_SMIME "S/MIME" +#define NID_SMIME 188 +#define OBJ_SMIME OBJ_pkcs9,16L + +#define SN_id_smime_mod "id-smime-mod" +#define NID_id_smime_mod 189 +#define OBJ_id_smime_mod OBJ_SMIME,0L + +#define SN_id_smime_ct "id-smime-ct" +#define NID_id_smime_ct 190 +#define OBJ_id_smime_ct OBJ_SMIME,1L + +#define SN_id_smime_aa "id-smime-aa" +#define NID_id_smime_aa 191 +#define OBJ_id_smime_aa OBJ_SMIME,2L + +#define SN_id_smime_alg "id-smime-alg" +#define NID_id_smime_alg 192 +#define OBJ_id_smime_alg OBJ_SMIME,3L + +#define SN_id_smime_cd "id-smime-cd" +#define NID_id_smime_cd 193 +#define OBJ_id_smime_cd OBJ_SMIME,4L + +#define SN_id_smime_spq "id-smime-spq" +#define NID_id_smime_spq 194 +#define OBJ_id_smime_spq OBJ_SMIME,5L + +#define SN_id_smime_cti "id-smime-cti" +#define NID_id_smime_cti 195 +#define OBJ_id_smime_cti OBJ_SMIME,6L + +#define SN_id_smime_mod_cms "id-smime-mod-cms" +#define NID_id_smime_mod_cms 196 +#define OBJ_id_smime_mod_cms OBJ_id_smime_mod,1L + +#define SN_id_smime_mod_ess "id-smime-mod-ess" +#define NID_id_smime_mod_ess 197 +#define OBJ_id_smime_mod_ess OBJ_id_smime_mod,2L + +#define SN_id_smime_mod_oid "id-smime-mod-oid" +#define NID_id_smime_mod_oid 198 +#define OBJ_id_smime_mod_oid OBJ_id_smime_mod,3L + +#define SN_id_smime_mod_msg_v3 "id-smime-mod-msg-v3" +#define NID_id_smime_mod_msg_v3 199 +#define OBJ_id_smime_mod_msg_v3 OBJ_id_smime_mod,4L + +#define SN_id_smime_mod_ets_eSignature_88 "id-smime-mod-ets-eSignature-88" +#define NID_id_smime_mod_ets_eSignature_88 200 +#define OBJ_id_smime_mod_ets_eSignature_88 OBJ_id_smime_mod,5L + +#define SN_id_smime_mod_ets_eSignature_97 "id-smime-mod-ets-eSignature-97" +#define NID_id_smime_mod_ets_eSignature_97 201 +#define OBJ_id_smime_mod_ets_eSignature_97 OBJ_id_smime_mod,6L + +#define SN_id_smime_mod_ets_eSigPolicy_88 "id-smime-mod-ets-eSigPolicy-88" +#define NID_id_smime_mod_ets_eSigPolicy_88 202 +#define OBJ_id_smime_mod_ets_eSigPolicy_88 OBJ_id_smime_mod,7L + +#define SN_id_smime_mod_ets_eSigPolicy_97 "id-smime-mod-ets-eSigPolicy-97" +#define NID_id_smime_mod_ets_eSigPolicy_97 203 +#define OBJ_id_smime_mod_ets_eSigPolicy_97 OBJ_id_smime_mod,8L + +#define SN_id_smime_ct_receipt "id-smime-ct-receipt" +#define NID_id_smime_ct_receipt 204 +#define OBJ_id_smime_ct_receipt OBJ_id_smime_ct,1L + +#define SN_id_smime_ct_authData "id-smime-ct-authData" +#define NID_id_smime_ct_authData 205 +#define OBJ_id_smime_ct_authData OBJ_id_smime_ct,2L + +#define SN_id_smime_ct_publishCert "id-smime-ct-publishCert" +#define NID_id_smime_ct_publishCert 206 +#define OBJ_id_smime_ct_publishCert OBJ_id_smime_ct,3L + +#define SN_id_smime_ct_TSTInfo "id-smime-ct-TSTInfo" +#define NID_id_smime_ct_TSTInfo 207 +#define OBJ_id_smime_ct_TSTInfo OBJ_id_smime_ct,4L + +#define SN_id_smime_ct_TDTInfo "id-smime-ct-TDTInfo" +#define NID_id_smime_ct_TDTInfo 208 +#define OBJ_id_smime_ct_TDTInfo OBJ_id_smime_ct,5L + +#define SN_id_smime_ct_contentInfo "id-smime-ct-contentInfo" +#define NID_id_smime_ct_contentInfo 209 +#define OBJ_id_smime_ct_contentInfo OBJ_id_smime_ct,6L + +#define SN_id_smime_ct_DVCSRequestData "id-smime-ct-DVCSRequestData" +#define NID_id_smime_ct_DVCSRequestData 210 +#define OBJ_id_smime_ct_DVCSRequestData OBJ_id_smime_ct,7L + +#define SN_id_smime_ct_DVCSResponseData "id-smime-ct-DVCSResponseData" +#define NID_id_smime_ct_DVCSResponseData 211 +#define OBJ_id_smime_ct_DVCSResponseData OBJ_id_smime_ct,8L + +#define SN_id_smime_ct_compressedData "id-smime-ct-compressedData" +#define NID_id_smime_ct_compressedData 786 +#define OBJ_id_smime_ct_compressedData OBJ_id_smime_ct,9L + +#define SN_id_ct_asciiTextWithCRLF "id-ct-asciiTextWithCRLF" +#define NID_id_ct_asciiTextWithCRLF 787 +#define OBJ_id_ct_asciiTextWithCRLF OBJ_id_smime_ct,27L + +#define SN_id_smime_aa_receiptRequest "id-smime-aa-receiptRequest" +#define NID_id_smime_aa_receiptRequest 212 +#define OBJ_id_smime_aa_receiptRequest OBJ_id_smime_aa,1L + +#define SN_id_smime_aa_securityLabel "id-smime-aa-securityLabel" +#define NID_id_smime_aa_securityLabel 213 +#define OBJ_id_smime_aa_securityLabel OBJ_id_smime_aa,2L + +#define SN_id_smime_aa_mlExpandHistory "id-smime-aa-mlExpandHistory" +#define NID_id_smime_aa_mlExpandHistory 214 +#define OBJ_id_smime_aa_mlExpandHistory OBJ_id_smime_aa,3L + +#define SN_id_smime_aa_contentHint "id-smime-aa-contentHint" +#define NID_id_smime_aa_contentHint 215 +#define OBJ_id_smime_aa_contentHint OBJ_id_smime_aa,4L + +#define SN_id_smime_aa_msgSigDigest "id-smime-aa-msgSigDigest" +#define NID_id_smime_aa_msgSigDigest 216 +#define OBJ_id_smime_aa_msgSigDigest OBJ_id_smime_aa,5L + +#define SN_id_smime_aa_encapContentType "id-smime-aa-encapContentType" +#define NID_id_smime_aa_encapContentType 217 +#define OBJ_id_smime_aa_encapContentType OBJ_id_smime_aa,6L + +#define SN_id_smime_aa_contentIdentifier "id-smime-aa-contentIdentifier" +#define NID_id_smime_aa_contentIdentifier 218 +#define OBJ_id_smime_aa_contentIdentifier OBJ_id_smime_aa,7L + +#define SN_id_smime_aa_macValue "id-smime-aa-macValue" +#define NID_id_smime_aa_macValue 219 +#define OBJ_id_smime_aa_macValue OBJ_id_smime_aa,8L + +#define SN_id_smime_aa_equivalentLabels "id-smime-aa-equivalentLabels" +#define NID_id_smime_aa_equivalentLabels 220 +#define OBJ_id_smime_aa_equivalentLabels OBJ_id_smime_aa,9L + +#define SN_id_smime_aa_contentReference "id-smime-aa-contentReference" +#define NID_id_smime_aa_contentReference 221 +#define OBJ_id_smime_aa_contentReference OBJ_id_smime_aa,10L + +#define SN_id_smime_aa_encrypKeyPref "id-smime-aa-encrypKeyPref" +#define NID_id_smime_aa_encrypKeyPref 222 +#define OBJ_id_smime_aa_encrypKeyPref OBJ_id_smime_aa,11L + +#define SN_id_smime_aa_signingCertificate "id-smime-aa-signingCertificate" +#define NID_id_smime_aa_signingCertificate 223 +#define OBJ_id_smime_aa_signingCertificate OBJ_id_smime_aa,12L + +#define SN_id_smime_aa_smimeEncryptCerts "id-smime-aa-smimeEncryptCerts" +#define NID_id_smime_aa_smimeEncryptCerts 224 +#define OBJ_id_smime_aa_smimeEncryptCerts OBJ_id_smime_aa,13L + +#define SN_id_smime_aa_timeStampToken "id-smime-aa-timeStampToken" +#define NID_id_smime_aa_timeStampToken 225 +#define OBJ_id_smime_aa_timeStampToken OBJ_id_smime_aa,14L + +#define SN_id_smime_aa_ets_sigPolicyId "id-smime-aa-ets-sigPolicyId" +#define NID_id_smime_aa_ets_sigPolicyId 226 +#define OBJ_id_smime_aa_ets_sigPolicyId OBJ_id_smime_aa,15L + +#define SN_id_smime_aa_ets_commitmentType "id-smime-aa-ets-commitmentType" +#define NID_id_smime_aa_ets_commitmentType 227 +#define OBJ_id_smime_aa_ets_commitmentType OBJ_id_smime_aa,16L + +#define SN_id_smime_aa_ets_signerLocation "id-smime-aa-ets-signerLocation" +#define NID_id_smime_aa_ets_signerLocation 228 +#define OBJ_id_smime_aa_ets_signerLocation OBJ_id_smime_aa,17L + +#define SN_id_smime_aa_ets_signerAttr "id-smime-aa-ets-signerAttr" +#define NID_id_smime_aa_ets_signerAttr 229 +#define OBJ_id_smime_aa_ets_signerAttr OBJ_id_smime_aa,18L + +#define SN_id_smime_aa_ets_otherSigCert "id-smime-aa-ets-otherSigCert" +#define NID_id_smime_aa_ets_otherSigCert 230 +#define OBJ_id_smime_aa_ets_otherSigCert OBJ_id_smime_aa,19L + +#define SN_id_smime_aa_ets_contentTimestamp "id-smime-aa-ets-contentTimestamp" +#define NID_id_smime_aa_ets_contentTimestamp 231 +#define OBJ_id_smime_aa_ets_contentTimestamp OBJ_id_smime_aa,20L + +#define SN_id_smime_aa_ets_CertificateRefs "id-smime-aa-ets-CertificateRefs" +#define NID_id_smime_aa_ets_CertificateRefs 232 +#define OBJ_id_smime_aa_ets_CertificateRefs OBJ_id_smime_aa,21L + +#define SN_id_smime_aa_ets_RevocationRefs "id-smime-aa-ets-RevocationRefs" +#define NID_id_smime_aa_ets_RevocationRefs 233 +#define OBJ_id_smime_aa_ets_RevocationRefs OBJ_id_smime_aa,22L + +#define SN_id_smime_aa_ets_certValues "id-smime-aa-ets-certValues" +#define NID_id_smime_aa_ets_certValues 234 +#define OBJ_id_smime_aa_ets_certValues OBJ_id_smime_aa,23L + +#define SN_id_smime_aa_ets_revocationValues "id-smime-aa-ets-revocationValues" +#define NID_id_smime_aa_ets_revocationValues 235 +#define OBJ_id_smime_aa_ets_revocationValues OBJ_id_smime_aa,24L + +#define SN_id_smime_aa_ets_escTimeStamp "id-smime-aa-ets-escTimeStamp" +#define NID_id_smime_aa_ets_escTimeStamp 236 +#define OBJ_id_smime_aa_ets_escTimeStamp OBJ_id_smime_aa,25L + +#define SN_id_smime_aa_ets_certCRLTimestamp "id-smime-aa-ets-certCRLTimestamp" +#define NID_id_smime_aa_ets_certCRLTimestamp 237 +#define OBJ_id_smime_aa_ets_certCRLTimestamp OBJ_id_smime_aa,26L + +#define SN_id_smime_aa_ets_archiveTimeStamp "id-smime-aa-ets-archiveTimeStamp" +#define NID_id_smime_aa_ets_archiveTimeStamp 238 +#define OBJ_id_smime_aa_ets_archiveTimeStamp OBJ_id_smime_aa,27L + +#define SN_id_smime_aa_signatureType "id-smime-aa-signatureType" +#define NID_id_smime_aa_signatureType 239 +#define OBJ_id_smime_aa_signatureType OBJ_id_smime_aa,28L + +#define SN_id_smime_aa_dvcs_dvc "id-smime-aa-dvcs-dvc" +#define NID_id_smime_aa_dvcs_dvc 240 +#define OBJ_id_smime_aa_dvcs_dvc OBJ_id_smime_aa,29L + +#define SN_id_smime_alg_ESDHwith3DES "id-smime-alg-ESDHwith3DES" +#define NID_id_smime_alg_ESDHwith3DES 241 +#define OBJ_id_smime_alg_ESDHwith3DES OBJ_id_smime_alg,1L + +#define SN_id_smime_alg_ESDHwithRC2 "id-smime-alg-ESDHwithRC2" +#define NID_id_smime_alg_ESDHwithRC2 242 +#define OBJ_id_smime_alg_ESDHwithRC2 OBJ_id_smime_alg,2L + +#define SN_id_smime_alg_3DESwrap "id-smime-alg-3DESwrap" +#define NID_id_smime_alg_3DESwrap 243 +#define OBJ_id_smime_alg_3DESwrap OBJ_id_smime_alg,3L + +#define SN_id_smime_alg_RC2wrap "id-smime-alg-RC2wrap" +#define NID_id_smime_alg_RC2wrap 244 +#define OBJ_id_smime_alg_RC2wrap OBJ_id_smime_alg,4L + +#define SN_id_smime_alg_ESDH "id-smime-alg-ESDH" +#define NID_id_smime_alg_ESDH 245 +#define OBJ_id_smime_alg_ESDH OBJ_id_smime_alg,5L + +#define SN_id_smime_alg_CMS3DESwrap "id-smime-alg-CMS3DESwrap" +#define NID_id_smime_alg_CMS3DESwrap 246 +#define OBJ_id_smime_alg_CMS3DESwrap OBJ_id_smime_alg,6L + +#define SN_id_smime_alg_CMSRC2wrap "id-smime-alg-CMSRC2wrap" +#define NID_id_smime_alg_CMSRC2wrap 247 +#define OBJ_id_smime_alg_CMSRC2wrap OBJ_id_smime_alg,7L + +#define SN_id_alg_PWRI_KEK "id-alg-PWRI-KEK" +#define NID_id_alg_PWRI_KEK 893 +#define OBJ_id_alg_PWRI_KEK OBJ_id_smime_alg,9L + +#define SN_id_smime_cd_ldap "id-smime-cd-ldap" +#define NID_id_smime_cd_ldap 248 +#define OBJ_id_smime_cd_ldap OBJ_id_smime_cd,1L + +#define SN_id_smime_spq_ets_sqt_uri "id-smime-spq-ets-sqt-uri" +#define NID_id_smime_spq_ets_sqt_uri 249 +#define OBJ_id_smime_spq_ets_sqt_uri OBJ_id_smime_spq,1L + +#define SN_id_smime_spq_ets_sqt_unotice "id-smime-spq-ets-sqt-unotice" +#define NID_id_smime_spq_ets_sqt_unotice 250 +#define OBJ_id_smime_spq_ets_sqt_unotice OBJ_id_smime_spq,2L + +#define SN_id_smime_cti_ets_proofOfOrigin "id-smime-cti-ets-proofOfOrigin" +#define NID_id_smime_cti_ets_proofOfOrigin 251 +#define OBJ_id_smime_cti_ets_proofOfOrigin OBJ_id_smime_cti,1L + +#define SN_id_smime_cti_ets_proofOfReceipt "id-smime-cti-ets-proofOfReceipt" +#define NID_id_smime_cti_ets_proofOfReceipt 252 +#define OBJ_id_smime_cti_ets_proofOfReceipt OBJ_id_smime_cti,2L + +#define SN_id_smime_cti_ets_proofOfDelivery "id-smime-cti-ets-proofOfDelivery" +#define NID_id_smime_cti_ets_proofOfDelivery 253 +#define OBJ_id_smime_cti_ets_proofOfDelivery OBJ_id_smime_cti,3L + +#define SN_id_smime_cti_ets_proofOfSender "id-smime-cti-ets-proofOfSender" +#define NID_id_smime_cti_ets_proofOfSender 254 +#define OBJ_id_smime_cti_ets_proofOfSender OBJ_id_smime_cti,4L + +#define SN_id_smime_cti_ets_proofOfApproval "id-smime-cti-ets-proofOfApproval" +#define NID_id_smime_cti_ets_proofOfApproval 255 +#define OBJ_id_smime_cti_ets_proofOfApproval OBJ_id_smime_cti,5L + +#define SN_id_smime_cti_ets_proofOfCreation "id-smime-cti-ets-proofOfCreation" +#define NID_id_smime_cti_ets_proofOfCreation 256 +#define OBJ_id_smime_cti_ets_proofOfCreation OBJ_id_smime_cti,6L + +#define LN_friendlyName "friendlyName" +#define NID_friendlyName 156 +#define OBJ_friendlyName OBJ_pkcs9,20L + +#define LN_localKeyID "localKeyID" +#define NID_localKeyID 157 +#define OBJ_localKeyID OBJ_pkcs9,21L + +#define SN_ms_csp_name "CSPName" +#define LN_ms_csp_name "Microsoft CSP Name" +#define NID_ms_csp_name 417 +#define OBJ_ms_csp_name 1L,3L,6L,1L,4L,1L,311L,17L,1L + +#define SN_LocalKeySet "LocalKeySet" +#define LN_LocalKeySet "Microsoft Local Key set" +#define NID_LocalKeySet 856 +#define OBJ_LocalKeySet 1L,3L,6L,1L,4L,1L,311L,17L,2L + +#define OBJ_certTypes OBJ_pkcs9,22L + +#define LN_x509Certificate "x509Certificate" +#define NID_x509Certificate 158 +#define OBJ_x509Certificate OBJ_certTypes,1L + +#define LN_sdsiCertificate "sdsiCertificate" +#define NID_sdsiCertificate 159 +#define OBJ_sdsiCertificate OBJ_certTypes,2L + +#define OBJ_crlTypes OBJ_pkcs9,23L + +#define LN_x509Crl "x509Crl" +#define NID_x509Crl 160 +#define OBJ_x509Crl OBJ_crlTypes,1L + +#define OBJ_pkcs12 OBJ_pkcs,12L + +#define OBJ_pkcs12_pbeids OBJ_pkcs12,1L + +#define SN_pbe_WithSHA1And128BitRC4 "PBE-SHA1-RC4-128" +#define LN_pbe_WithSHA1And128BitRC4 "pbeWithSHA1And128BitRC4" +#define NID_pbe_WithSHA1And128BitRC4 144 +#define OBJ_pbe_WithSHA1And128BitRC4 OBJ_pkcs12_pbeids,1L + +#define SN_pbe_WithSHA1And40BitRC4 "PBE-SHA1-RC4-40" +#define LN_pbe_WithSHA1And40BitRC4 "pbeWithSHA1And40BitRC4" +#define NID_pbe_WithSHA1And40BitRC4 145 +#define OBJ_pbe_WithSHA1And40BitRC4 OBJ_pkcs12_pbeids,2L + +#define SN_pbe_WithSHA1And3_Key_TripleDES_CBC "PBE-SHA1-3DES" +#define LN_pbe_WithSHA1And3_Key_TripleDES_CBC "pbeWithSHA1And3-KeyTripleDES-CBC" +#define NID_pbe_WithSHA1And3_Key_TripleDES_CBC 146 +#define OBJ_pbe_WithSHA1And3_Key_TripleDES_CBC OBJ_pkcs12_pbeids,3L + +#define SN_pbe_WithSHA1And2_Key_TripleDES_CBC "PBE-SHA1-2DES" +#define LN_pbe_WithSHA1And2_Key_TripleDES_CBC "pbeWithSHA1And2-KeyTripleDES-CBC" +#define NID_pbe_WithSHA1And2_Key_TripleDES_CBC 147 +#define OBJ_pbe_WithSHA1And2_Key_TripleDES_CBC OBJ_pkcs12_pbeids,4L + +#define SN_pbe_WithSHA1And128BitRC2_CBC "PBE-SHA1-RC2-128" +#define LN_pbe_WithSHA1And128BitRC2_CBC "pbeWithSHA1And128BitRC2-CBC" +#define NID_pbe_WithSHA1And128BitRC2_CBC 148 +#define OBJ_pbe_WithSHA1And128BitRC2_CBC OBJ_pkcs12_pbeids,5L + +#define SN_pbe_WithSHA1And40BitRC2_CBC "PBE-SHA1-RC2-40" +#define LN_pbe_WithSHA1And40BitRC2_CBC "pbeWithSHA1And40BitRC2-CBC" +#define NID_pbe_WithSHA1And40BitRC2_CBC 149 +#define OBJ_pbe_WithSHA1And40BitRC2_CBC OBJ_pkcs12_pbeids,6L + +#define OBJ_pkcs12_Version1 OBJ_pkcs12,10L + +#define OBJ_pkcs12_BagIds OBJ_pkcs12_Version1,1L + +#define LN_keyBag "keyBag" +#define NID_keyBag 150 +#define OBJ_keyBag OBJ_pkcs12_BagIds,1L + +#define LN_pkcs8ShroudedKeyBag "pkcs8ShroudedKeyBag" +#define NID_pkcs8ShroudedKeyBag 151 +#define OBJ_pkcs8ShroudedKeyBag OBJ_pkcs12_BagIds,2L + +#define LN_certBag "certBag" +#define NID_certBag 152 +#define OBJ_certBag OBJ_pkcs12_BagIds,3L + +#define LN_crlBag "crlBag" +#define NID_crlBag 153 +#define OBJ_crlBag OBJ_pkcs12_BagIds,4L + +#define LN_secretBag "secretBag" +#define NID_secretBag 154 +#define OBJ_secretBag OBJ_pkcs12_BagIds,5L + +#define LN_safeContentsBag "safeContentsBag" +#define NID_safeContentsBag 155 +#define OBJ_safeContentsBag OBJ_pkcs12_BagIds,6L + +#define SN_md2 "MD2" +#define LN_md2 "md2" +#define NID_md2 3 +#define OBJ_md2 OBJ_rsadsi,2L,2L + +#define SN_md4 "MD4" +#define LN_md4 "md4" +#define NID_md4 257 +#define OBJ_md4 OBJ_rsadsi,2L,4L + +#define SN_md5 "MD5" +#define LN_md5 "md5" +#define NID_md5 4 +#define OBJ_md5 OBJ_rsadsi,2L,5L + +#define SN_md5_sha1 "MD5-SHA1" +#define LN_md5_sha1 "md5-sha1" +#define NID_md5_sha1 114 + +#define LN_hmacWithMD5 "hmacWithMD5" +#define NID_hmacWithMD5 797 +#define OBJ_hmacWithMD5 OBJ_rsadsi,2L,6L + +#define LN_hmacWithSHA1 "hmacWithSHA1" +#define NID_hmacWithSHA1 163 +#define OBJ_hmacWithSHA1 OBJ_rsadsi,2L,7L + +#define LN_hmacWithSHA224 "hmacWithSHA224" +#define NID_hmacWithSHA224 798 +#define OBJ_hmacWithSHA224 OBJ_rsadsi,2L,8L + +#define LN_hmacWithSHA256 "hmacWithSHA256" +#define NID_hmacWithSHA256 799 +#define OBJ_hmacWithSHA256 OBJ_rsadsi,2L,9L + +#define LN_hmacWithSHA384 "hmacWithSHA384" +#define NID_hmacWithSHA384 800 +#define OBJ_hmacWithSHA384 OBJ_rsadsi,2L,10L + +#define LN_hmacWithSHA512 "hmacWithSHA512" +#define NID_hmacWithSHA512 801 +#define OBJ_hmacWithSHA512 OBJ_rsadsi,2L,11L + +#define SN_rc2_cbc "RC2-CBC" +#define LN_rc2_cbc "rc2-cbc" +#define NID_rc2_cbc 37 +#define OBJ_rc2_cbc OBJ_rsadsi,3L,2L + +#define SN_rc2_ecb "RC2-ECB" +#define LN_rc2_ecb "rc2-ecb" +#define NID_rc2_ecb 38 + +#define SN_rc2_cfb64 "RC2-CFB" +#define LN_rc2_cfb64 "rc2-cfb" +#define NID_rc2_cfb64 39 + +#define SN_rc2_ofb64 "RC2-OFB" +#define LN_rc2_ofb64 "rc2-ofb" +#define NID_rc2_ofb64 40 + +#define SN_rc2_40_cbc "RC2-40-CBC" +#define LN_rc2_40_cbc "rc2-40-cbc" +#define NID_rc2_40_cbc 98 + +#define SN_rc2_64_cbc "RC2-64-CBC" +#define LN_rc2_64_cbc "rc2-64-cbc" +#define NID_rc2_64_cbc 166 + +#define SN_rc4 "RC4" +#define LN_rc4 "rc4" +#define NID_rc4 5 +#define OBJ_rc4 OBJ_rsadsi,3L,4L + +#define SN_rc4_40 "RC4-40" +#define LN_rc4_40 "rc4-40" +#define NID_rc4_40 97 + +#define SN_des_ede3_cbc "DES-EDE3-CBC" +#define LN_des_ede3_cbc "des-ede3-cbc" +#define NID_des_ede3_cbc 44 +#define OBJ_des_ede3_cbc OBJ_rsadsi,3L,7L + +#define SN_rc5_cbc "RC5-CBC" +#define LN_rc5_cbc "rc5-cbc" +#define NID_rc5_cbc 120 +#define OBJ_rc5_cbc OBJ_rsadsi,3L,8L + +#define SN_rc5_ecb "RC5-ECB" +#define LN_rc5_ecb "rc5-ecb" +#define NID_rc5_ecb 121 + +#define SN_rc5_cfb64 "RC5-CFB" +#define LN_rc5_cfb64 "rc5-cfb" +#define NID_rc5_cfb64 122 + +#define SN_rc5_ofb64 "RC5-OFB" +#define LN_rc5_ofb64 "rc5-ofb" +#define NID_rc5_ofb64 123 + +#define SN_ms_ext_req "msExtReq" +#define LN_ms_ext_req "Microsoft Extension Request" +#define NID_ms_ext_req 171 +#define OBJ_ms_ext_req 1L,3L,6L,1L,4L,1L,311L,2L,1L,14L + +#define SN_ms_code_ind "msCodeInd" +#define LN_ms_code_ind "Microsoft Individual Code Signing" +#define NID_ms_code_ind 134 +#define OBJ_ms_code_ind 1L,3L,6L,1L,4L,1L,311L,2L,1L,21L + +#define SN_ms_code_com "msCodeCom" +#define LN_ms_code_com "Microsoft Commercial Code Signing" +#define NID_ms_code_com 135 +#define OBJ_ms_code_com 1L,3L,6L,1L,4L,1L,311L,2L,1L,22L + +#define SN_ms_ctl_sign "msCTLSign" +#define LN_ms_ctl_sign "Microsoft Trust List Signing" +#define NID_ms_ctl_sign 136 +#define OBJ_ms_ctl_sign 1L,3L,6L,1L,4L,1L,311L,10L,3L,1L + +#define SN_ms_sgc "msSGC" +#define LN_ms_sgc "Microsoft Server Gated Crypto" +#define NID_ms_sgc 137 +#define OBJ_ms_sgc 1L,3L,6L,1L,4L,1L,311L,10L,3L,3L + +#define SN_ms_efs "msEFS" +#define LN_ms_efs "Microsoft Encrypted File System" +#define NID_ms_efs 138 +#define OBJ_ms_efs 1L,3L,6L,1L,4L,1L,311L,10L,3L,4L + +#define SN_ms_smartcard_login "msSmartcardLogin" +#define LN_ms_smartcard_login "Microsoft Smartcardlogin" +#define NID_ms_smartcard_login 648 +#define OBJ_ms_smartcard_login 1L,3L,6L,1L,4L,1L,311L,20L,2L,2L + +#define SN_ms_upn "msUPN" +#define LN_ms_upn "Microsoft Universal Principal Name" +#define NID_ms_upn 649 +#define OBJ_ms_upn 1L,3L,6L,1L,4L,1L,311L,20L,2L,3L + +#define SN_idea_cbc "IDEA-CBC" +#define LN_idea_cbc "idea-cbc" +#define NID_idea_cbc 34 +#define OBJ_idea_cbc 1L,3L,6L,1L,4L,1L,188L,7L,1L,1L,2L + +#define SN_idea_ecb "IDEA-ECB" +#define LN_idea_ecb "idea-ecb" +#define NID_idea_ecb 36 + +#define SN_idea_cfb64 "IDEA-CFB" +#define LN_idea_cfb64 "idea-cfb" +#define NID_idea_cfb64 35 + +#define SN_idea_ofb64 "IDEA-OFB" +#define LN_idea_ofb64 "idea-ofb" +#define NID_idea_ofb64 46 + +#define SN_bf_cbc "BF-CBC" +#define LN_bf_cbc "bf-cbc" +#define NID_bf_cbc 91 +#define OBJ_bf_cbc 1L,3L,6L,1L,4L,1L,3029L,1L,2L + +#define SN_bf_ecb "BF-ECB" +#define LN_bf_ecb "bf-ecb" +#define NID_bf_ecb 92 + +#define SN_bf_cfb64 "BF-CFB" +#define LN_bf_cfb64 "bf-cfb" +#define NID_bf_cfb64 93 + +#define SN_bf_ofb64 "BF-OFB" +#define LN_bf_ofb64 "bf-ofb" +#define NID_bf_ofb64 94 + +#define SN_id_pkix "PKIX" +#define NID_id_pkix 127 +#define OBJ_id_pkix 1L,3L,6L,1L,5L,5L,7L + +#define SN_id_pkix_mod "id-pkix-mod" +#define NID_id_pkix_mod 258 +#define OBJ_id_pkix_mod OBJ_id_pkix,0L + +#define SN_id_pe "id-pe" +#define NID_id_pe 175 +#define OBJ_id_pe OBJ_id_pkix,1L + +#define SN_id_qt "id-qt" +#define NID_id_qt 259 +#define OBJ_id_qt OBJ_id_pkix,2L + +#define SN_id_kp "id-kp" +#define NID_id_kp 128 +#define OBJ_id_kp OBJ_id_pkix,3L + +#define SN_id_it "id-it" +#define NID_id_it 260 +#define OBJ_id_it OBJ_id_pkix,4L + +#define SN_id_pkip "id-pkip" +#define NID_id_pkip 261 +#define OBJ_id_pkip OBJ_id_pkix,5L + +#define SN_id_alg "id-alg" +#define NID_id_alg 262 +#define OBJ_id_alg OBJ_id_pkix,6L + +#define SN_id_cmc "id-cmc" +#define NID_id_cmc 263 +#define OBJ_id_cmc OBJ_id_pkix,7L + +#define SN_id_on "id-on" +#define NID_id_on 264 +#define OBJ_id_on OBJ_id_pkix,8L + +#define SN_id_pda "id-pda" +#define NID_id_pda 265 +#define OBJ_id_pda OBJ_id_pkix,9L + +#define SN_id_aca "id-aca" +#define NID_id_aca 266 +#define OBJ_id_aca OBJ_id_pkix,10L + +#define SN_id_qcs "id-qcs" +#define NID_id_qcs 267 +#define OBJ_id_qcs OBJ_id_pkix,11L + +#define SN_id_cct "id-cct" +#define NID_id_cct 268 +#define OBJ_id_cct OBJ_id_pkix,12L + +#define SN_id_ppl "id-ppl" +#define NID_id_ppl 662 +#define OBJ_id_ppl OBJ_id_pkix,21L + +#define SN_id_ad "id-ad" +#define NID_id_ad 176 +#define OBJ_id_ad OBJ_id_pkix,48L + +#define SN_id_pkix1_explicit_88 "id-pkix1-explicit-88" +#define NID_id_pkix1_explicit_88 269 +#define OBJ_id_pkix1_explicit_88 OBJ_id_pkix_mod,1L + +#define SN_id_pkix1_implicit_88 "id-pkix1-implicit-88" +#define NID_id_pkix1_implicit_88 270 +#define OBJ_id_pkix1_implicit_88 OBJ_id_pkix_mod,2L + +#define SN_id_pkix1_explicit_93 "id-pkix1-explicit-93" +#define NID_id_pkix1_explicit_93 271 +#define OBJ_id_pkix1_explicit_93 OBJ_id_pkix_mod,3L + +#define SN_id_pkix1_implicit_93 "id-pkix1-implicit-93" +#define NID_id_pkix1_implicit_93 272 +#define OBJ_id_pkix1_implicit_93 OBJ_id_pkix_mod,4L + +#define SN_id_mod_crmf "id-mod-crmf" +#define NID_id_mod_crmf 273 +#define OBJ_id_mod_crmf OBJ_id_pkix_mod,5L + +#define SN_id_mod_cmc "id-mod-cmc" +#define NID_id_mod_cmc 274 +#define OBJ_id_mod_cmc OBJ_id_pkix_mod,6L + +#define SN_id_mod_kea_profile_88 "id-mod-kea-profile-88" +#define NID_id_mod_kea_profile_88 275 +#define OBJ_id_mod_kea_profile_88 OBJ_id_pkix_mod,7L + +#define SN_id_mod_kea_profile_93 "id-mod-kea-profile-93" +#define NID_id_mod_kea_profile_93 276 +#define OBJ_id_mod_kea_profile_93 OBJ_id_pkix_mod,8L + +#define SN_id_mod_cmp "id-mod-cmp" +#define NID_id_mod_cmp 277 +#define OBJ_id_mod_cmp OBJ_id_pkix_mod,9L + +#define SN_id_mod_qualified_cert_88 "id-mod-qualified-cert-88" +#define NID_id_mod_qualified_cert_88 278 +#define OBJ_id_mod_qualified_cert_88 OBJ_id_pkix_mod,10L + +#define SN_id_mod_qualified_cert_93 "id-mod-qualified-cert-93" +#define NID_id_mod_qualified_cert_93 279 +#define OBJ_id_mod_qualified_cert_93 OBJ_id_pkix_mod,11L + +#define SN_id_mod_attribute_cert "id-mod-attribute-cert" +#define NID_id_mod_attribute_cert 280 +#define OBJ_id_mod_attribute_cert OBJ_id_pkix_mod,12L + +#define SN_id_mod_timestamp_protocol "id-mod-timestamp-protocol" +#define NID_id_mod_timestamp_protocol 281 +#define OBJ_id_mod_timestamp_protocol OBJ_id_pkix_mod,13L + +#define SN_id_mod_ocsp "id-mod-ocsp" +#define NID_id_mod_ocsp 282 +#define OBJ_id_mod_ocsp OBJ_id_pkix_mod,14L + +#define SN_id_mod_dvcs "id-mod-dvcs" +#define NID_id_mod_dvcs 283 +#define OBJ_id_mod_dvcs OBJ_id_pkix_mod,15L + +#define SN_id_mod_cmp2000 "id-mod-cmp2000" +#define NID_id_mod_cmp2000 284 +#define OBJ_id_mod_cmp2000 OBJ_id_pkix_mod,16L + +#define SN_info_access "authorityInfoAccess" +#define LN_info_access "Authority Information Access" +#define NID_info_access 177 +#define OBJ_info_access OBJ_id_pe,1L + +#define SN_biometricInfo "biometricInfo" +#define LN_biometricInfo "Biometric Info" +#define NID_biometricInfo 285 +#define OBJ_biometricInfo OBJ_id_pe,2L + +#define SN_qcStatements "qcStatements" +#define NID_qcStatements 286 +#define OBJ_qcStatements OBJ_id_pe,3L + +#define SN_ac_auditEntity "ac-auditEntity" +#define NID_ac_auditEntity 287 +#define OBJ_ac_auditEntity OBJ_id_pe,4L + +#define SN_ac_targeting "ac-targeting" +#define NID_ac_targeting 288 +#define OBJ_ac_targeting OBJ_id_pe,5L + +#define SN_aaControls "aaControls" +#define NID_aaControls 289 +#define OBJ_aaControls OBJ_id_pe,6L + +#define SN_sbgp_ipAddrBlock "sbgp-ipAddrBlock" +#define NID_sbgp_ipAddrBlock 290 +#define OBJ_sbgp_ipAddrBlock OBJ_id_pe,7L + +#define SN_sbgp_autonomousSysNum "sbgp-autonomousSysNum" +#define NID_sbgp_autonomousSysNum 291 +#define OBJ_sbgp_autonomousSysNum OBJ_id_pe,8L + +#define SN_sbgp_routerIdentifier "sbgp-routerIdentifier" +#define NID_sbgp_routerIdentifier 292 +#define OBJ_sbgp_routerIdentifier OBJ_id_pe,9L + +#define SN_ac_proxying "ac-proxying" +#define NID_ac_proxying 397 +#define OBJ_ac_proxying OBJ_id_pe,10L + +#define SN_sinfo_access "subjectInfoAccess" +#define LN_sinfo_access "Subject Information Access" +#define NID_sinfo_access 398 +#define OBJ_sinfo_access OBJ_id_pe,11L + +#define SN_proxyCertInfo "proxyCertInfo" +#define LN_proxyCertInfo "Proxy Certificate Information" +#define NID_proxyCertInfo 663 +#define OBJ_proxyCertInfo OBJ_id_pe,14L + +#define SN_id_qt_cps "id-qt-cps" +#define LN_id_qt_cps "Policy Qualifier CPS" +#define NID_id_qt_cps 164 +#define OBJ_id_qt_cps OBJ_id_qt,1L + +#define SN_id_qt_unotice "id-qt-unotice" +#define LN_id_qt_unotice "Policy Qualifier User Notice" +#define NID_id_qt_unotice 165 +#define OBJ_id_qt_unotice OBJ_id_qt,2L + +#define SN_textNotice "textNotice" +#define NID_textNotice 293 +#define OBJ_textNotice OBJ_id_qt,3L + +#define SN_server_auth "serverAuth" +#define LN_server_auth "TLS Web Server Authentication" +#define NID_server_auth 129 +#define OBJ_server_auth OBJ_id_kp,1L + +#define SN_client_auth "clientAuth" +#define LN_client_auth "TLS Web Client Authentication" +#define NID_client_auth 130 +#define OBJ_client_auth OBJ_id_kp,2L + +#define SN_code_sign "codeSigning" +#define LN_code_sign "Code Signing" +#define NID_code_sign 131 +#define OBJ_code_sign OBJ_id_kp,3L + +#define SN_email_protect "emailProtection" +#define LN_email_protect "E-mail Protection" +#define NID_email_protect 132 +#define OBJ_email_protect OBJ_id_kp,4L + +#define SN_ipsecEndSystem "ipsecEndSystem" +#define LN_ipsecEndSystem "IPSec End System" +#define NID_ipsecEndSystem 294 +#define OBJ_ipsecEndSystem OBJ_id_kp,5L + +#define SN_ipsecTunnel "ipsecTunnel" +#define LN_ipsecTunnel "IPSec Tunnel" +#define NID_ipsecTunnel 295 +#define OBJ_ipsecTunnel OBJ_id_kp,6L + +#define SN_ipsecUser "ipsecUser" +#define LN_ipsecUser "IPSec User" +#define NID_ipsecUser 296 +#define OBJ_ipsecUser OBJ_id_kp,7L + +#define SN_time_stamp "timeStamping" +#define LN_time_stamp "Time Stamping" +#define NID_time_stamp 133 +#define OBJ_time_stamp OBJ_id_kp,8L + +#define SN_OCSP_sign "OCSPSigning" +#define LN_OCSP_sign "OCSP Signing" +#define NID_OCSP_sign 180 +#define OBJ_OCSP_sign OBJ_id_kp,9L + +#define SN_dvcs "DVCS" +#define LN_dvcs "dvcs" +#define NID_dvcs 297 +#define OBJ_dvcs OBJ_id_kp,10L + +#define SN_id_it_caProtEncCert "id-it-caProtEncCert" +#define NID_id_it_caProtEncCert 298 +#define OBJ_id_it_caProtEncCert OBJ_id_it,1L + +#define SN_id_it_signKeyPairTypes "id-it-signKeyPairTypes" +#define NID_id_it_signKeyPairTypes 299 +#define OBJ_id_it_signKeyPairTypes OBJ_id_it,2L + +#define SN_id_it_encKeyPairTypes "id-it-encKeyPairTypes" +#define NID_id_it_encKeyPairTypes 300 +#define OBJ_id_it_encKeyPairTypes OBJ_id_it,3L + +#define SN_id_it_preferredSymmAlg "id-it-preferredSymmAlg" +#define NID_id_it_preferredSymmAlg 301 +#define OBJ_id_it_preferredSymmAlg OBJ_id_it,4L + +#define SN_id_it_caKeyUpdateInfo "id-it-caKeyUpdateInfo" +#define NID_id_it_caKeyUpdateInfo 302 +#define OBJ_id_it_caKeyUpdateInfo OBJ_id_it,5L + +#define SN_id_it_currentCRL "id-it-currentCRL" +#define NID_id_it_currentCRL 303 +#define OBJ_id_it_currentCRL OBJ_id_it,6L + +#define SN_id_it_unsupportedOIDs "id-it-unsupportedOIDs" +#define NID_id_it_unsupportedOIDs 304 +#define OBJ_id_it_unsupportedOIDs OBJ_id_it,7L + +#define SN_id_it_subscriptionRequest "id-it-subscriptionRequest" +#define NID_id_it_subscriptionRequest 305 +#define OBJ_id_it_subscriptionRequest OBJ_id_it,8L + +#define SN_id_it_subscriptionResponse "id-it-subscriptionResponse" +#define NID_id_it_subscriptionResponse 306 +#define OBJ_id_it_subscriptionResponse OBJ_id_it,9L + +#define SN_id_it_keyPairParamReq "id-it-keyPairParamReq" +#define NID_id_it_keyPairParamReq 307 +#define OBJ_id_it_keyPairParamReq OBJ_id_it,10L + +#define SN_id_it_keyPairParamRep "id-it-keyPairParamRep" +#define NID_id_it_keyPairParamRep 308 +#define OBJ_id_it_keyPairParamRep OBJ_id_it,11L + +#define SN_id_it_revPassphrase "id-it-revPassphrase" +#define NID_id_it_revPassphrase 309 +#define OBJ_id_it_revPassphrase OBJ_id_it,12L + +#define SN_id_it_implicitConfirm "id-it-implicitConfirm" +#define NID_id_it_implicitConfirm 310 +#define OBJ_id_it_implicitConfirm OBJ_id_it,13L + +#define SN_id_it_confirmWaitTime "id-it-confirmWaitTime" +#define NID_id_it_confirmWaitTime 311 +#define OBJ_id_it_confirmWaitTime OBJ_id_it,14L + +#define SN_id_it_origPKIMessage "id-it-origPKIMessage" +#define NID_id_it_origPKIMessage 312 +#define OBJ_id_it_origPKIMessage OBJ_id_it,15L + +#define SN_id_it_suppLangTags "id-it-suppLangTags" +#define NID_id_it_suppLangTags 784 +#define OBJ_id_it_suppLangTags OBJ_id_it,16L + +#define SN_id_regCtrl "id-regCtrl" +#define NID_id_regCtrl 313 +#define OBJ_id_regCtrl OBJ_id_pkip,1L + +#define SN_id_regInfo "id-regInfo" +#define NID_id_regInfo 314 +#define OBJ_id_regInfo OBJ_id_pkip,2L + +#define SN_id_regCtrl_regToken "id-regCtrl-regToken" +#define NID_id_regCtrl_regToken 315 +#define OBJ_id_regCtrl_regToken OBJ_id_regCtrl,1L + +#define SN_id_regCtrl_authenticator "id-regCtrl-authenticator" +#define NID_id_regCtrl_authenticator 316 +#define OBJ_id_regCtrl_authenticator OBJ_id_regCtrl,2L + +#define SN_id_regCtrl_pkiPublicationInfo "id-regCtrl-pkiPublicationInfo" +#define NID_id_regCtrl_pkiPublicationInfo 317 +#define OBJ_id_regCtrl_pkiPublicationInfo OBJ_id_regCtrl,3L + +#define SN_id_regCtrl_pkiArchiveOptions "id-regCtrl-pkiArchiveOptions" +#define NID_id_regCtrl_pkiArchiveOptions 318 +#define OBJ_id_regCtrl_pkiArchiveOptions OBJ_id_regCtrl,4L + +#define SN_id_regCtrl_oldCertID "id-regCtrl-oldCertID" +#define NID_id_regCtrl_oldCertID 319 +#define OBJ_id_regCtrl_oldCertID OBJ_id_regCtrl,5L + +#define SN_id_regCtrl_protocolEncrKey "id-regCtrl-protocolEncrKey" +#define NID_id_regCtrl_protocolEncrKey 320 +#define OBJ_id_regCtrl_protocolEncrKey OBJ_id_regCtrl,6L + +#define SN_id_regInfo_utf8Pairs "id-regInfo-utf8Pairs" +#define NID_id_regInfo_utf8Pairs 321 +#define OBJ_id_regInfo_utf8Pairs OBJ_id_regInfo,1L + +#define SN_id_regInfo_certReq "id-regInfo-certReq" +#define NID_id_regInfo_certReq 322 +#define OBJ_id_regInfo_certReq OBJ_id_regInfo,2L + +#define SN_id_alg_des40 "id-alg-des40" +#define NID_id_alg_des40 323 +#define OBJ_id_alg_des40 OBJ_id_alg,1L + +#define SN_id_alg_noSignature "id-alg-noSignature" +#define NID_id_alg_noSignature 324 +#define OBJ_id_alg_noSignature OBJ_id_alg,2L + +#define SN_id_alg_dh_sig_hmac_sha1 "id-alg-dh-sig-hmac-sha1" +#define NID_id_alg_dh_sig_hmac_sha1 325 +#define OBJ_id_alg_dh_sig_hmac_sha1 OBJ_id_alg,3L + +#define SN_id_alg_dh_pop "id-alg-dh-pop" +#define NID_id_alg_dh_pop 326 +#define OBJ_id_alg_dh_pop OBJ_id_alg,4L + +#define SN_id_cmc_statusInfo "id-cmc-statusInfo" +#define NID_id_cmc_statusInfo 327 +#define OBJ_id_cmc_statusInfo OBJ_id_cmc,1L + +#define SN_id_cmc_identification "id-cmc-identification" +#define NID_id_cmc_identification 328 +#define OBJ_id_cmc_identification OBJ_id_cmc,2L + +#define SN_id_cmc_identityProof "id-cmc-identityProof" +#define NID_id_cmc_identityProof 329 +#define OBJ_id_cmc_identityProof OBJ_id_cmc,3L + +#define SN_id_cmc_dataReturn "id-cmc-dataReturn" +#define NID_id_cmc_dataReturn 330 +#define OBJ_id_cmc_dataReturn OBJ_id_cmc,4L + +#define SN_id_cmc_transactionId "id-cmc-transactionId" +#define NID_id_cmc_transactionId 331 +#define OBJ_id_cmc_transactionId OBJ_id_cmc,5L + +#define SN_id_cmc_senderNonce "id-cmc-senderNonce" +#define NID_id_cmc_senderNonce 332 +#define OBJ_id_cmc_senderNonce OBJ_id_cmc,6L + +#define SN_id_cmc_recipientNonce "id-cmc-recipientNonce" +#define NID_id_cmc_recipientNonce 333 +#define OBJ_id_cmc_recipientNonce OBJ_id_cmc,7L + +#define SN_id_cmc_addExtensions "id-cmc-addExtensions" +#define NID_id_cmc_addExtensions 334 +#define OBJ_id_cmc_addExtensions OBJ_id_cmc,8L + +#define SN_id_cmc_encryptedPOP "id-cmc-encryptedPOP" +#define NID_id_cmc_encryptedPOP 335 +#define OBJ_id_cmc_encryptedPOP OBJ_id_cmc,9L + +#define SN_id_cmc_decryptedPOP "id-cmc-decryptedPOP" +#define NID_id_cmc_decryptedPOP 336 +#define OBJ_id_cmc_decryptedPOP OBJ_id_cmc,10L + +#define SN_id_cmc_lraPOPWitness "id-cmc-lraPOPWitness" +#define NID_id_cmc_lraPOPWitness 337 +#define OBJ_id_cmc_lraPOPWitness OBJ_id_cmc,11L + +#define SN_id_cmc_getCert "id-cmc-getCert" +#define NID_id_cmc_getCert 338 +#define OBJ_id_cmc_getCert OBJ_id_cmc,15L + +#define SN_id_cmc_getCRL "id-cmc-getCRL" +#define NID_id_cmc_getCRL 339 +#define OBJ_id_cmc_getCRL OBJ_id_cmc,16L + +#define SN_id_cmc_revokeRequest "id-cmc-revokeRequest" +#define NID_id_cmc_revokeRequest 340 +#define OBJ_id_cmc_revokeRequest OBJ_id_cmc,17L + +#define SN_id_cmc_regInfo "id-cmc-regInfo" +#define NID_id_cmc_regInfo 341 +#define OBJ_id_cmc_regInfo OBJ_id_cmc,18L + +#define SN_id_cmc_responseInfo "id-cmc-responseInfo" +#define NID_id_cmc_responseInfo 342 +#define OBJ_id_cmc_responseInfo OBJ_id_cmc,19L + +#define SN_id_cmc_queryPending "id-cmc-queryPending" +#define NID_id_cmc_queryPending 343 +#define OBJ_id_cmc_queryPending OBJ_id_cmc,21L + +#define SN_id_cmc_popLinkRandom "id-cmc-popLinkRandom" +#define NID_id_cmc_popLinkRandom 344 +#define OBJ_id_cmc_popLinkRandom OBJ_id_cmc,22L + +#define SN_id_cmc_popLinkWitness "id-cmc-popLinkWitness" +#define NID_id_cmc_popLinkWitness 345 +#define OBJ_id_cmc_popLinkWitness OBJ_id_cmc,23L + +#define SN_id_cmc_confirmCertAcceptance "id-cmc-confirmCertAcceptance" +#define NID_id_cmc_confirmCertAcceptance 346 +#define OBJ_id_cmc_confirmCertAcceptance OBJ_id_cmc,24L + +#define SN_id_on_personalData "id-on-personalData" +#define NID_id_on_personalData 347 +#define OBJ_id_on_personalData OBJ_id_on,1L + +#define SN_id_on_permanentIdentifier "id-on-permanentIdentifier" +#define LN_id_on_permanentIdentifier "Permanent Identifier" +#define NID_id_on_permanentIdentifier 858 +#define OBJ_id_on_permanentIdentifier OBJ_id_on,3L + +#define SN_id_pda_dateOfBirth "id-pda-dateOfBirth" +#define NID_id_pda_dateOfBirth 348 +#define OBJ_id_pda_dateOfBirth OBJ_id_pda,1L + +#define SN_id_pda_placeOfBirth "id-pda-placeOfBirth" +#define NID_id_pda_placeOfBirth 349 +#define OBJ_id_pda_placeOfBirth OBJ_id_pda,2L + +#define SN_id_pda_gender "id-pda-gender" +#define NID_id_pda_gender 351 +#define OBJ_id_pda_gender OBJ_id_pda,3L + +#define SN_id_pda_countryOfCitizenship "id-pda-countryOfCitizenship" +#define NID_id_pda_countryOfCitizenship 352 +#define OBJ_id_pda_countryOfCitizenship OBJ_id_pda,4L + +#define SN_id_pda_countryOfResidence "id-pda-countryOfResidence" +#define NID_id_pda_countryOfResidence 353 +#define OBJ_id_pda_countryOfResidence OBJ_id_pda,5L + +#define SN_id_aca_authenticationInfo "id-aca-authenticationInfo" +#define NID_id_aca_authenticationInfo 354 +#define OBJ_id_aca_authenticationInfo OBJ_id_aca,1L + +#define SN_id_aca_accessIdentity "id-aca-accessIdentity" +#define NID_id_aca_accessIdentity 355 +#define OBJ_id_aca_accessIdentity OBJ_id_aca,2L + +#define SN_id_aca_chargingIdentity "id-aca-chargingIdentity" +#define NID_id_aca_chargingIdentity 356 +#define OBJ_id_aca_chargingIdentity OBJ_id_aca,3L + +#define SN_id_aca_group "id-aca-group" +#define NID_id_aca_group 357 +#define OBJ_id_aca_group OBJ_id_aca,4L + +#define SN_id_aca_role "id-aca-role" +#define NID_id_aca_role 358 +#define OBJ_id_aca_role OBJ_id_aca,5L + +#define SN_id_aca_encAttrs "id-aca-encAttrs" +#define NID_id_aca_encAttrs 399 +#define OBJ_id_aca_encAttrs OBJ_id_aca,6L + +#define SN_id_qcs_pkixQCSyntax_v1 "id-qcs-pkixQCSyntax-v1" +#define NID_id_qcs_pkixQCSyntax_v1 359 +#define OBJ_id_qcs_pkixQCSyntax_v1 OBJ_id_qcs,1L + +#define SN_id_cct_crs "id-cct-crs" +#define NID_id_cct_crs 360 +#define OBJ_id_cct_crs OBJ_id_cct,1L + +#define SN_id_cct_PKIData "id-cct-PKIData" +#define NID_id_cct_PKIData 361 +#define OBJ_id_cct_PKIData OBJ_id_cct,2L + +#define SN_id_cct_PKIResponse "id-cct-PKIResponse" +#define NID_id_cct_PKIResponse 362 +#define OBJ_id_cct_PKIResponse OBJ_id_cct,3L + +#define SN_id_ppl_anyLanguage "id-ppl-anyLanguage" +#define LN_id_ppl_anyLanguage "Any language" +#define NID_id_ppl_anyLanguage 664 +#define OBJ_id_ppl_anyLanguage OBJ_id_ppl,0L + +#define SN_id_ppl_inheritAll "id-ppl-inheritAll" +#define LN_id_ppl_inheritAll "Inherit all" +#define NID_id_ppl_inheritAll 665 +#define OBJ_id_ppl_inheritAll OBJ_id_ppl,1L + +#define SN_Independent "id-ppl-independent" +#define LN_Independent "Independent" +#define NID_Independent 667 +#define OBJ_Independent OBJ_id_ppl,2L + +#define SN_ad_OCSP "OCSP" +#define LN_ad_OCSP "OCSP" +#define NID_ad_OCSP 178 +#define OBJ_ad_OCSP OBJ_id_ad,1L + +#define SN_ad_ca_issuers "caIssuers" +#define LN_ad_ca_issuers "CA Issuers" +#define NID_ad_ca_issuers 179 +#define OBJ_ad_ca_issuers OBJ_id_ad,2L + +#define SN_ad_timeStamping "ad_timestamping" +#define LN_ad_timeStamping "AD Time Stamping" +#define NID_ad_timeStamping 363 +#define OBJ_ad_timeStamping OBJ_id_ad,3L + +#define SN_ad_dvcs "AD_DVCS" +#define LN_ad_dvcs "ad dvcs" +#define NID_ad_dvcs 364 +#define OBJ_ad_dvcs OBJ_id_ad,4L + +#define SN_caRepository "caRepository" +#define LN_caRepository "CA Repository" +#define NID_caRepository 785 +#define OBJ_caRepository OBJ_id_ad,5L + +#define OBJ_id_pkix_OCSP OBJ_ad_OCSP + +#define SN_id_pkix_OCSP_basic "basicOCSPResponse" +#define LN_id_pkix_OCSP_basic "Basic OCSP Response" +#define NID_id_pkix_OCSP_basic 365 +#define OBJ_id_pkix_OCSP_basic OBJ_id_pkix_OCSP,1L + +#define SN_id_pkix_OCSP_Nonce "Nonce" +#define LN_id_pkix_OCSP_Nonce "OCSP Nonce" +#define NID_id_pkix_OCSP_Nonce 366 +#define OBJ_id_pkix_OCSP_Nonce OBJ_id_pkix_OCSP,2L + +#define SN_id_pkix_OCSP_CrlID "CrlID" +#define LN_id_pkix_OCSP_CrlID "OCSP CRL ID" +#define NID_id_pkix_OCSP_CrlID 367 +#define OBJ_id_pkix_OCSP_CrlID OBJ_id_pkix_OCSP,3L + +#define SN_id_pkix_OCSP_acceptableResponses "acceptableResponses" +#define LN_id_pkix_OCSP_acceptableResponses "Acceptable OCSP Responses" +#define NID_id_pkix_OCSP_acceptableResponses 368 +#define OBJ_id_pkix_OCSP_acceptableResponses OBJ_id_pkix_OCSP,4L + +#define SN_id_pkix_OCSP_noCheck "noCheck" +#define LN_id_pkix_OCSP_noCheck "OCSP No Check" +#define NID_id_pkix_OCSP_noCheck 369 +#define OBJ_id_pkix_OCSP_noCheck OBJ_id_pkix_OCSP,5L + +#define SN_id_pkix_OCSP_archiveCutoff "archiveCutoff" +#define LN_id_pkix_OCSP_archiveCutoff "OCSP Archive Cutoff" +#define NID_id_pkix_OCSP_archiveCutoff 370 +#define OBJ_id_pkix_OCSP_archiveCutoff OBJ_id_pkix_OCSP,6L + +#define SN_id_pkix_OCSP_serviceLocator "serviceLocator" +#define LN_id_pkix_OCSP_serviceLocator "OCSP Service Locator" +#define NID_id_pkix_OCSP_serviceLocator 371 +#define OBJ_id_pkix_OCSP_serviceLocator OBJ_id_pkix_OCSP,7L + +#define SN_id_pkix_OCSP_extendedStatus "extendedStatus" +#define LN_id_pkix_OCSP_extendedStatus "Extended OCSP Status" +#define NID_id_pkix_OCSP_extendedStatus 372 +#define OBJ_id_pkix_OCSP_extendedStatus OBJ_id_pkix_OCSP,8L + +#define SN_id_pkix_OCSP_valid "valid" +#define NID_id_pkix_OCSP_valid 373 +#define OBJ_id_pkix_OCSP_valid OBJ_id_pkix_OCSP,9L + +#define SN_id_pkix_OCSP_path "path" +#define NID_id_pkix_OCSP_path 374 +#define OBJ_id_pkix_OCSP_path OBJ_id_pkix_OCSP,10L + +#define SN_id_pkix_OCSP_trustRoot "trustRoot" +#define LN_id_pkix_OCSP_trustRoot "Trust Root" +#define NID_id_pkix_OCSP_trustRoot 375 +#define OBJ_id_pkix_OCSP_trustRoot OBJ_id_pkix_OCSP,11L + +#define SN_algorithm "algorithm" +#define LN_algorithm "algorithm" +#define NID_algorithm 376 +#define OBJ_algorithm 1L,3L,14L,3L,2L + +#define SN_md5WithRSA "RSA-NP-MD5" +#define LN_md5WithRSA "md5WithRSA" +#define NID_md5WithRSA 104 +#define OBJ_md5WithRSA OBJ_algorithm,3L + +#define SN_des_ecb "DES-ECB" +#define LN_des_ecb "des-ecb" +#define NID_des_ecb 29 +#define OBJ_des_ecb OBJ_algorithm,6L + +#define SN_des_cbc "DES-CBC" +#define LN_des_cbc "des-cbc" +#define NID_des_cbc 31 +#define OBJ_des_cbc OBJ_algorithm,7L + +#define SN_des_ofb64 "DES-OFB" +#define LN_des_ofb64 "des-ofb" +#define NID_des_ofb64 45 +#define OBJ_des_ofb64 OBJ_algorithm,8L + +#define SN_des_cfb64 "DES-CFB" +#define LN_des_cfb64 "des-cfb" +#define NID_des_cfb64 30 +#define OBJ_des_cfb64 OBJ_algorithm,9L + +#define SN_rsaSignature "rsaSignature" +#define NID_rsaSignature 377 +#define OBJ_rsaSignature OBJ_algorithm,11L + +#define SN_dsa_2 "DSA-old" +#define LN_dsa_2 "dsaEncryption-old" +#define NID_dsa_2 67 +#define OBJ_dsa_2 OBJ_algorithm,12L + +#define SN_dsaWithSHA "DSA-SHA" +#define LN_dsaWithSHA "dsaWithSHA" +#define NID_dsaWithSHA 66 +#define OBJ_dsaWithSHA OBJ_algorithm,13L + +#define SN_shaWithRSAEncryption "RSA-SHA" +#define LN_shaWithRSAEncryption "shaWithRSAEncryption" +#define NID_shaWithRSAEncryption 42 +#define OBJ_shaWithRSAEncryption OBJ_algorithm,15L + +#define SN_des_ede_ecb "DES-EDE" +#define LN_des_ede_ecb "des-ede" +#define NID_des_ede_ecb 32 +#define OBJ_des_ede_ecb OBJ_algorithm,17L + +#define SN_des_ede3_ecb "DES-EDE3" +#define LN_des_ede3_ecb "des-ede3" +#define NID_des_ede3_ecb 33 + +#define SN_des_ede_cbc "DES-EDE-CBC" +#define LN_des_ede_cbc "des-ede-cbc" +#define NID_des_ede_cbc 43 + +#define SN_des_ede_cfb64 "DES-EDE-CFB" +#define LN_des_ede_cfb64 "des-ede-cfb" +#define NID_des_ede_cfb64 60 + +#define SN_des_ede3_cfb64 "DES-EDE3-CFB" +#define LN_des_ede3_cfb64 "des-ede3-cfb" +#define NID_des_ede3_cfb64 61 + +#define SN_des_ede_ofb64 "DES-EDE-OFB" +#define LN_des_ede_ofb64 "des-ede-ofb" +#define NID_des_ede_ofb64 62 + +#define SN_des_ede3_ofb64 "DES-EDE3-OFB" +#define LN_des_ede3_ofb64 "des-ede3-ofb" +#define NID_des_ede3_ofb64 63 + +#define SN_desx_cbc "DESX-CBC" +#define LN_desx_cbc "desx-cbc" +#define NID_desx_cbc 80 + +#define SN_sha "SHA" +#define LN_sha "sha" +#define NID_sha 41 +#define OBJ_sha OBJ_algorithm,18L + +#define SN_sha1 "SHA1" +#define LN_sha1 "sha1" +#define NID_sha1 64 +#define OBJ_sha1 OBJ_algorithm,26L + +#define SN_dsaWithSHA1_2 "DSA-SHA1-old" +#define LN_dsaWithSHA1_2 "dsaWithSHA1-old" +#define NID_dsaWithSHA1_2 70 +#define OBJ_dsaWithSHA1_2 OBJ_algorithm,27L + +#define SN_sha1WithRSA "RSA-SHA1-2" +#define LN_sha1WithRSA "sha1WithRSA" +#define NID_sha1WithRSA 115 +#define OBJ_sha1WithRSA OBJ_algorithm,29L + +#define SN_ripemd160 "RIPEMD160" +#define LN_ripemd160 "ripemd160" +#define NID_ripemd160 117 +#define OBJ_ripemd160 1L,3L,36L,3L,2L,1L + +#define SN_ripemd160WithRSA "RSA-RIPEMD160" +#define LN_ripemd160WithRSA "ripemd160WithRSA" +#define NID_ripemd160WithRSA 119 +#define OBJ_ripemd160WithRSA 1L,3L,36L,3L,3L,1L,2L + +#define SN_sxnet "SXNetID" +#define LN_sxnet "Strong Extranet ID" +#define NID_sxnet 143 +#define OBJ_sxnet 1L,3L,101L,1L,4L,1L + +#define SN_X500 "X500" +#define LN_X500 "directory services (X.500)" +#define NID_X500 11 +#define OBJ_X500 2L,5L + +#define SN_X509 "X509" +#define NID_X509 12 +#define OBJ_X509 OBJ_X500,4L + +#define SN_commonName "CN" +#define LN_commonName "commonName" +#define NID_commonName 13 +#define OBJ_commonName OBJ_X509,3L + +#define SN_surname "SN" +#define LN_surname "surname" +#define NID_surname 100 +#define OBJ_surname OBJ_X509,4L + +#define LN_serialNumber "serialNumber" +#define NID_serialNumber 105 +#define OBJ_serialNumber OBJ_X509,5L + +#define SN_countryName "C" +#define LN_countryName "countryName" +#define NID_countryName 14 +#define OBJ_countryName OBJ_X509,6L + +#define SN_localityName "L" +#define LN_localityName "localityName" +#define NID_localityName 15 +#define OBJ_localityName OBJ_X509,7L + +#define SN_stateOrProvinceName "ST" +#define LN_stateOrProvinceName "stateOrProvinceName" +#define NID_stateOrProvinceName 16 +#define OBJ_stateOrProvinceName OBJ_X509,8L + +#define SN_streetAddress "street" +#define LN_streetAddress "streetAddress" +#define NID_streetAddress 660 +#define OBJ_streetAddress OBJ_X509,9L + +#define SN_organizationName "O" +#define LN_organizationName "organizationName" +#define NID_organizationName 17 +#define OBJ_organizationName OBJ_X509,10L + +#define SN_organizationalUnitName "OU" +#define LN_organizationalUnitName "organizationalUnitName" +#define NID_organizationalUnitName 18 +#define OBJ_organizationalUnitName OBJ_X509,11L + +#define SN_title "title" +#define LN_title "title" +#define NID_title 106 +#define OBJ_title OBJ_X509,12L + +#define LN_description "description" +#define NID_description 107 +#define OBJ_description OBJ_X509,13L + +#define LN_searchGuide "searchGuide" +#define NID_searchGuide 859 +#define OBJ_searchGuide OBJ_X509,14L + +#define LN_businessCategory "businessCategory" +#define NID_businessCategory 860 +#define OBJ_businessCategory OBJ_X509,15L + +#define LN_postalAddress "postalAddress" +#define NID_postalAddress 861 +#define OBJ_postalAddress OBJ_X509,16L + +#define LN_postalCode "postalCode" +#define NID_postalCode 661 +#define OBJ_postalCode OBJ_X509,17L + +#define LN_postOfficeBox "postOfficeBox" +#define NID_postOfficeBox 862 +#define OBJ_postOfficeBox OBJ_X509,18L + +#define LN_physicalDeliveryOfficeName "physicalDeliveryOfficeName" +#define NID_physicalDeliveryOfficeName 863 +#define OBJ_physicalDeliveryOfficeName OBJ_X509,19L + +#define LN_telephoneNumber "telephoneNumber" +#define NID_telephoneNumber 864 +#define OBJ_telephoneNumber OBJ_X509,20L + +#define LN_telexNumber "telexNumber" +#define NID_telexNumber 865 +#define OBJ_telexNumber OBJ_X509,21L + +#define LN_teletexTerminalIdentifier "teletexTerminalIdentifier" +#define NID_teletexTerminalIdentifier 866 +#define OBJ_teletexTerminalIdentifier OBJ_X509,22L + +#define LN_facsimileTelephoneNumber "facsimileTelephoneNumber" +#define NID_facsimileTelephoneNumber 867 +#define OBJ_facsimileTelephoneNumber OBJ_X509,23L + +#define LN_x121Address "x121Address" +#define NID_x121Address 868 +#define OBJ_x121Address OBJ_X509,24L + +#define LN_internationaliSDNNumber "internationaliSDNNumber" +#define NID_internationaliSDNNumber 869 +#define OBJ_internationaliSDNNumber OBJ_X509,25L + +#define LN_registeredAddress "registeredAddress" +#define NID_registeredAddress 870 +#define OBJ_registeredAddress OBJ_X509,26L + +#define LN_destinationIndicator "destinationIndicator" +#define NID_destinationIndicator 871 +#define OBJ_destinationIndicator OBJ_X509,27L + +#define LN_preferredDeliveryMethod "preferredDeliveryMethod" +#define NID_preferredDeliveryMethod 872 +#define OBJ_preferredDeliveryMethod OBJ_X509,28L + +#define LN_presentationAddress "presentationAddress" +#define NID_presentationAddress 873 +#define OBJ_presentationAddress OBJ_X509,29L + +#define LN_supportedApplicationContext "supportedApplicationContext" +#define NID_supportedApplicationContext 874 +#define OBJ_supportedApplicationContext OBJ_X509,30L + +#define SN_member "member" +#define NID_member 875 +#define OBJ_member OBJ_X509,31L + +#define SN_owner "owner" +#define NID_owner 876 +#define OBJ_owner OBJ_X509,32L + +#define LN_roleOccupant "roleOccupant" +#define NID_roleOccupant 877 +#define OBJ_roleOccupant OBJ_X509,33L + +#define SN_seeAlso "seeAlso" +#define NID_seeAlso 878 +#define OBJ_seeAlso OBJ_X509,34L + +#define LN_userPassword "userPassword" +#define NID_userPassword 879 +#define OBJ_userPassword OBJ_X509,35L + +#define LN_userCertificate "userCertificate" +#define NID_userCertificate 880 +#define OBJ_userCertificate OBJ_X509,36L + +#define LN_cACertificate "cACertificate" +#define NID_cACertificate 881 +#define OBJ_cACertificate OBJ_X509,37L + +#define LN_authorityRevocationList "authorityRevocationList" +#define NID_authorityRevocationList 882 +#define OBJ_authorityRevocationList OBJ_X509,38L + +#define LN_certificateRevocationList "certificateRevocationList" +#define NID_certificateRevocationList 883 +#define OBJ_certificateRevocationList OBJ_X509,39L + +#define LN_crossCertificatePair "crossCertificatePair" +#define NID_crossCertificatePair 884 +#define OBJ_crossCertificatePair OBJ_X509,40L + +#define SN_name "name" +#define LN_name "name" +#define NID_name 173 +#define OBJ_name OBJ_X509,41L + +#define SN_givenName "GN" +#define LN_givenName "givenName" +#define NID_givenName 99 +#define OBJ_givenName OBJ_X509,42L + +#define SN_initials "initials" +#define LN_initials "initials" +#define NID_initials 101 +#define OBJ_initials OBJ_X509,43L + +#define LN_generationQualifier "generationQualifier" +#define NID_generationQualifier 509 +#define OBJ_generationQualifier OBJ_X509,44L + +#define LN_x500UniqueIdentifier "x500UniqueIdentifier" +#define NID_x500UniqueIdentifier 503 +#define OBJ_x500UniqueIdentifier OBJ_X509,45L + +#define SN_dnQualifier "dnQualifier" +#define LN_dnQualifier "dnQualifier" +#define NID_dnQualifier 174 +#define OBJ_dnQualifier OBJ_X509,46L + +#define LN_enhancedSearchGuide "enhancedSearchGuide" +#define NID_enhancedSearchGuide 885 +#define OBJ_enhancedSearchGuide OBJ_X509,47L + +#define LN_protocolInformation "protocolInformation" +#define NID_protocolInformation 886 +#define OBJ_protocolInformation OBJ_X509,48L + +#define LN_distinguishedName "distinguishedName" +#define NID_distinguishedName 887 +#define OBJ_distinguishedName OBJ_X509,49L + +#define LN_uniqueMember "uniqueMember" +#define NID_uniqueMember 888 +#define OBJ_uniqueMember OBJ_X509,50L + +#define LN_houseIdentifier "houseIdentifier" +#define NID_houseIdentifier 889 +#define OBJ_houseIdentifier OBJ_X509,51L + +#define LN_supportedAlgorithms "supportedAlgorithms" +#define NID_supportedAlgorithms 890 +#define OBJ_supportedAlgorithms OBJ_X509,52L + +#define LN_deltaRevocationList "deltaRevocationList" +#define NID_deltaRevocationList 891 +#define OBJ_deltaRevocationList OBJ_X509,53L + +#define SN_dmdName "dmdName" +#define NID_dmdName 892 +#define OBJ_dmdName OBJ_X509,54L + +#define LN_pseudonym "pseudonym" +#define NID_pseudonym 510 +#define OBJ_pseudonym OBJ_X509,65L + +#define SN_role "role" +#define LN_role "role" +#define NID_role 400 +#define OBJ_role OBJ_X509,72L + +#define SN_X500algorithms "X500algorithms" +#define LN_X500algorithms "directory services - algorithms" +#define NID_X500algorithms 378 +#define OBJ_X500algorithms OBJ_X500,8L + +#define SN_rsa "RSA" +#define LN_rsa "rsa" +#define NID_rsa 19 +#define OBJ_rsa OBJ_X500algorithms,1L,1L + +#define SN_mdc2WithRSA "RSA-MDC2" +#define LN_mdc2WithRSA "mdc2WithRSA" +#define NID_mdc2WithRSA 96 +#define OBJ_mdc2WithRSA OBJ_X500algorithms,3L,100L + +#define SN_mdc2 "MDC2" +#define LN_mdc2 "mdc2" +#define NID_mdc2 95 +#define OBJ_mdc2 OBJ_X500algorithms,3L,101L + +#define SN_id_ce "id-ce" +#define NID_id_ce 81 +#define OBJ_id_ce OBJ_X500,29L + +#define SN_subject_directory_attributes "subjectDirectoryAttributes" +#define LN_subject_directory_attributes "X509v3 Subject Directory Attributes" +#define NID_subject_directory_attributes 769 +#define OBJ_subject_directory_attributes OBJ_id_ce,9L + +#define SN_subject_key_identifier "subjectKeyIdentifier" +#define LN_subject_key_identifier "X509v3 Subject Key Identifier" +#define NID_subject_key_identifier 82 +#define OBJ_subject_key_identifier OBJ_id_ce,14L + +#define SN_key_usage "keyUsage" +#define LN_key_usage "X509v3 Key Usage" +#define NID_key_usage 83 +#define OBJ_key_usage OBJ_id_ce,15L + +#define SN_private_key_usage_period "privateKeyUsagePeriod" +#define LN_private_key_usage_period "X509v3 Private Key Usage Period" +#define NID_private_key_usage_period 84 +#define OBJ_private_key_usage_period OBJ_id_ce,16L + +#define SN_subject_alt_name "subjectAltName" +#define LN_subject_alt_name "X509v3 Subject Alternative Name" +#define NID_subject_alt_name 85 +#define OBJ_subject_alt_name OBJ_id_ce,17L + +#define SN_issuer_alt_name "issuerAltName" +#define LN_issuer_alt_name "X509v3 Issuer Alternative Name" +#define NID_issuer_alt_name 86 +#define OBJ_issuer_alt_name OBJ_id_ce,18L + +#define SN_basic_constraints "basicConstraints" +#define LN_basic_constraints "X509v3 Basic Constraints" +#define NID_basic_constraints 87 +#define OBJ_basic_constraints OBJ_id_ce,19L + +#define SN_crl_number "crlNumber" +#define LN_crl_number "X509v3 CRL Number" +#define NID_crl_number 88 +#define OBJ_crl_number OBJ_id_ce,20L + +#define SN_crl_reason "CRLReason" +#define LN_crl_reason "X509v3 CRL Reason Code" +#define NID_crl_reason 141 +#define OBJ_crl_reason OBJ_id_ce,21L + +#define SN_invalidity_date "invalidityDate" +#define LN_invalidity_date "Invalidity Date" +#define NID_invalidity_date 142 +#define OBJ_invalidity_date OBJ_id_ce,24L + +#define SN_delta_crl "deltaCRL" +#define LN_delta_crl "X509v3 Delta CRL Indicator" +#define NID_delta_crl 140 +#define OBJ_delta_crl OBJ_id_ce,27L + +#define SN_issuing_distribution_point "issuingDistributionPoint" +#define LN_issuing_distribution_point "X509v3 Issuing Distrubution Point" +#define NID_issuing_distribution_point 770 +#define OBJ_issuing_distribution_point OBJ_id_ce,28L + +#define SN_certificate_issuer "certificateIssuer" +#define LN_certificate_issuer "X509v3 Certificate Issuer" +#define NID_certificate_issuer 771 +#define OBJ_certificate_issuer OBJ_id_ce,29L + +#define SN_name_constraints "nameConstraints" +#define LN_name_constraints "X509v3 Name Constraints" +#define NID_name_constraints 666 +#define OBJ_name_constraints OBJ_id_ce,30L + +#define SN_crl_distribution_points "crlDistributionPoints" +#define LN_crl_distribution_points "X509v3 CRL Distribution Points" +#define NID_crl_distribution_points 103 +#define OBJ_crl_distribution_points OBJ_id_ce,31L + +#define SN_certificate_policies "certificatePolicies" +#define LN_certificate_policies "X509v3 Certificate Policies" +#define NID_certificate_policies 89 +#define OBJ_certificate_policies OBJ_id_ce,32L + +#define SN_any_policy "anyPolicy" +#define LN_any_policy "X509v3 Any Policy" +#define NID_any_policy 746 +#define OBJ_any_policy OBJ_certificate_policies,0L + +#define SN_policy_mappings "policyMappings" +#define LN_policy_mappings "X509v3 Policy Mappings" +#define NID_policy_mappings 747 +#define OBJ_policy_mappings OBJ_id_ce,33L + +#define SN_authority_key_identifier "authorityKeyIdentifier" +#define LN_authority_key_identifier "X509v3 Authority Key Identifier" +#define NID_authority_key_identifier 90 +#define OBJ_authority_key_identifier OBJ_id_ce,35L + +#define SN_policy_constraints "policyConstraints" +#define LN_policy_constraints "X509v3 Policy Constraints" +#define NID_policy_constraints 401 +#define OBJ_policy_constraints OBJ_id_ce,36L + +#define SN_ext_key_usage "extendedKeyUsage" +#define LN_ext_key_usage "X509v3 Extended Key Usage" +#define NID_ext_key_usage 126 +#define OBJ_ext_key_usage OBJ_id_ce,37L + +#define SN_freshest_crl "freshestCRL" +#define LN_freshest_crl "X509v3 Freshest CRL" +#define NID_freshest_crl 857 +#define OBJ_freshest_crl OBJ_id_ce,46L + +#define SN_inhibit_any_policy "inhibitAnyPolicy" +#define LN_inhibit_any_policy "X509v3 Inhibit Any Policy" +#define NID_inhibit_any_policy 748 +#define OBJ_inhibit_any_policy OBJ_id_ce,54L + +#define SN_target_information "targetInformation" +#define LN_target_information "X509v3 AC Targeting" +#define NID_target_information 402 +#define OBJ_target_information OBJ_id_ce,55L + +#define SN_no_rev_avail "noRevAvail" +#define LN_no_rev_avail "X509v3 No Revocation Available" +#define NID_no_rev_avail 403 +#define OBJ_no_rev_avail OBJ_id_ce,56L + +#define SN_anyExtendedKeyUsage "anyExtendedKeyUsage" +#define LN_anyExtendedKeyUsage "Any Extended Key Usage" +#define NID_anyExtendedKeyUsage 910 +#define OBJ_anyExtendedKeyUsage OBJ_ext_key_usage,0L + +#define SN_netscape "Netscape" +#define LN_netscape "Netscape Communications Corp." +#define NID_netscape 57 +#define OBJ_netscape 2L,16L,840L,1L,113730L + +#define SN_netscape_cert_extension "nsCertExt" +#define LN_netscape_cert_extension "Netscape Certificate Extension" +#define NID_netscape_cert_extension 58 +#define OBJ_netscape_cert_extension OBJ_netscape,1L + +#define SN_netscape_data_type "nsDataType" +#define LN_netscape_data_type "Netscape Data Type" +#define NID_netscape_data_type 59 +#define OBJ_netscape_data_type OBJ_netscape,2L + +#define SN_netscape_cert_type "nsCertType" +#define LN_netscape_cert_type "Netscape Cert Type" +#define NID_netscape_cert_type 71 +#define OBJ_netscape_cert_type OBJ_netscape_cert_extension,1L + +#define SN_netscape_base_url "nsBaseUrl" +#define LN_netscape_base_url "Netscape Base Url" +#define NID_netscape_base_url 72 +#define OBJ_netscape_base_url OBJ_netscape_cert_extension,2L + +#define SN_netscape_revocation_url "nsRevocationUrl" +#define LN_netscape_revocation_url "Netscape Revocation Url" +#define NID_netscape_revocation_url 73 +#define OBJ_netscape_revocation_url OBJ_netscape_cert_extension,3L + +#define SN_netscape_ca_revocation_url "nsCaRevocationUrl" +#define LN_netscape_ca_revocation_url "Netscape CA Revocation Url" +#define NID_netscape_ca_revocation_url 74 +#define OBJ_netscape_ca_revocation_url OBJ_netscape_cert_extension,4L + +#define SN_netscape_renewal_url "nsRenewalUrl" +#define LN_netscape_renewal_url "Netscape Renewal Url" +#define NID_netscape_renewal_url 75 +#define OBJ_netscape_renewal_url OBJ_netscape_cert_extension,7L + +#define SN_netscape_ca_policy_url "nsCaPolicyUrl" +#define LN_netscape_ca_policy_url "Netscape CA Policy Url" +#define NID_netscape_ca_policy_url 76 +#define OBJ_netscape_ca_policy_url OBJ_netscape_cert_extension,8L + +#define SN_netscape_ssl_server_name "nsSslServerName" +#define LN_netscape_ssl_server_name "Netscape SSL Server Name" +#define NID_netscape_ssl_server_name 77 +#define OBJ_netscape_ssl_server_name OBJ_netscape_cert_extension,12L + +#define SN_netscape_comment "nsComment" +#define LN_netscape_comment "Netscape Comment" +#define NID_netscape_comment 78 +#define OBJ_netscape_comment OBJ_netscape_cert_extension,13L + +#define SN_netscape_cert_sequence "nsCertSequence" +#define LN_netscape_cert_sequence "Netscape Certificate Sequence" +#define NID_netscape_cert_sequence 79 +#define OBJ_netscape_cert_sequence OBJ_netscape_data_type,5L + +#define SN_ns_sgc "nsSGC" +#define LN_ns_sgc "Netscape Server Gated Crypto" +#define NID_ns_sgc 139 +#define OBJ_ns_sgc OBJ_netscape,4L,1L + +#define SN_org "ORG" +#define LN_org "org" +#define NID_org 379 +#define OBJ_org OBJ_iso,3L + +#define SN_dod "DOD" +#define LN_dod "dod" +#define NID_dod 380 +#define OBJ_dod OBJ_org,6L + +#define SN_iana "IANA" +#define LN_iana "iana" +#define NID_iana 381 +#define OBJ_iana OBJ_dod,1L + +#define OBJ_internet OBJ_iana + +#define SN_Directory "directory" +#define LN_Directory "Directory" +#define NID_Directory 382 +#define OBJ_Directory OBJ_internet,1L + +#define SN_Management "mgmt" +#define LN_Management "Management" +#define NID_Management 383 +#define OBJ_Management OBJ_internet,2L + +#define SN_Experimental "experimental" +#define LN_Experimental "Experimental" +#define NID_Experimental 384 +#define OBJ_Experimental OBJ_internet,3L + +#define SN_Private "private" +#define LN_Private "Private" +#define NID_Private 385 +#define OBJ_Private OBJ_internet,4L + +#define SN_Security "security" +#define LN_Security "Security" +#define NID_Security 386 +#define OBJ_Security OBJ_internet,5L + +#define SN_SNMPv2 "snmpv2" +#define LN_SNMPv2 "SNMPv2" +#define NID_SNMPv2 387 +#define OBJ_SNMPv2 OBJ_internet,6L + +#define LN_Mail "Mail" +#define NID_Mail 388 +#define OBJ_Mail OBJ_internet,7L + +#define SN_Enterprises "enterprises" +#define LN_Enterprises "Enterprises" +#define NID_Enterprises 389 +#define OBJ_Enterprises OBJ_Private,1L + +#define SN_dcObject "dcobject" +#define LN_dcObject "dcObject" +#define NID_dcObject 390 +#define OBJ_dcObject OBJ_Enterprises,1466L,344L + +#define SN_mime_mhs "mime-mhs" +#define LN_mime_mhs "MIME MHS" +#define NID_mime_mhs 504 +#define OBJ_mime_mhs OBJ_Mail,1L + +#define SN_mime_mhs_headings "mime-mhs-headings" +#define LN_mime_mhs_headings "mime-mhs-headings" +#define NID_mime_mhs_headings 505 +#define OBJ_mime_mhs_headings OBJ_mime_mhs,1L + +#define SN_mime_mhs_bodies "mime-mhs-bodies" +#define LN_mime_mhs_bodies "mime-mhs-bodies" +#define NID_mime_mhs_bodies 506 +#define OBJ_mime_mhs_bodies OBJ_mime_mhs,2L + +#define SN_id_hex_partial_message "id-hex-partial-message" +#define LN_id_hex_partial_message "id-hex-partial-message" +#define NID_id_hex_partial_message 507 +#define OBJ_id_hex_partial_message OBJ_mime_mhs_headings,1L + +#define SN_id_hex_multipart_message "id-hex-multipart-message" +#define LN_id_hex_multipart_message "id-hex-multipart-message" +#define NID_id_hex_multipart_message 508 +#define OBJ_id_hex_multipart_message OBJ_mime_mhs_headings,2L + +#define SN_rle_compression "RLE" +#define LN_rle_compression "run length compression" +#define NID_rle_compression 124 +#define OBJ_rle_compression 1L,1L,1L,1L,666L,1L + +#define SN_zlib_compression "ZLIB" +#define LN_zlib_compression "zlib compression" +#define NID_zlib_compression 125 +#define OBJ_zlib_compression OBJ_id_smime_alg,8L + +#define OBJ_csor 2L,16L,840L,1L,101L,3L + +#define OBJ_nistAlgorithms OBJ_csor,4L + +#define OBJ_aes OBJ_nistAlgorithms,1L + +#define SN_aes_128_ecb "AES-128-ECB" +#define LN_aes_128_ecb "aes-128-ecb" +#define NID_aes_128_ecb 418 +#define OBJ_aes_128_ecb OBJ_aes,1L + +#define SN_aes_128_cbc "AES-128-CBC" +#define LN_aes_128_cbc "aes-128-cbc" +#define NID_aes_128_cbc 419 +#define OBJ_aes_128_cbc OBJ_aes,2L + +#define SN_aes_128_ofb128 "AES-128-OFB" +#define LN_aes_128_ofb128 "aes-128-ofb" +#define NID_aes_128_ofb128 420 +#define OBJ_aes_128_ofb128 OBJ_aes,3L + +#define SN_aes_128_cfb128 "AES-128-CFB" +#define LN_aes_128_cfb128 "aes-128-cfb" +#define NID_aes_128_cfb128 421 +#define OBJ_aes_128_cfb128 OBJ_aes,4L + +#define SN_id_aes128_wrap "id-aes128-wrap" +#define NID_id_aes128_wrap 788 +#define OBJ_id_aes128_wrap OBJ_aes,5L + +#define SN_aes_128_gcm "id-aes128-GCM" +#define LN_aes_128_gcm "aes-128-gcm" +#define NID_aes_128_gcm 895 +#define OBJ_aes_128_gcm OBJ_aes,6L + +#define SN_aes_128_ccm "id-aes128-CCM" +#define LN_aes_128_ccm "aes-128-ccm" +#define NID_aes_128_ccm 896 +#define OBJ_aes_128_ccm OBJ_aes,7L + +#define SN_id_aes128_wrap_pad "id-aes128-wrap-pad" +#define NID_id_aes128_wrap_pad 897 +#define OBJ_id_aes128_wrap_pad OBJ_aes,8L + +#define SN_aes_192_ecb "AES-192-ECB" +#define LN_aes_192_ecb "aes-192-ecb" +#define NID_aes_192_ecb 422 +#define OBJ_aes_192_ecb OBJ_aes,21L + +#define SN_aes_192_cbc "AES-192-CBC" +#define LN_aes_192_cbc "aes-192-cbc" +#define NID_aes_192_cbc 423 +#define OBJ_aes_192_cbc OBJ_aes,22L + +#define SN_aes_192_ofb128 "AES-192-OFB" +#define LN_aes_192_ofb128 "aes-192-ofb" +#define NID_aes_192_ofb128 424 +#define OBJ_aes_192_ofb128 OBJ_aes,23L + +#define SN_aes_192_cfb128 "AES-192-CFB" +#define LN_aes_192_cfb128 "aes-192-cfb" +#define NID_aes_192_cfb128 425 +#define OBJ_aes_192_cfb128 OBJ_aes,24L + +#define SN_id_aes192_wrap "id-aes192-wrap" +#define NID_id_aes192_wrap 789 +#define OBJ_id_aes192_wrap OBJ_aes,25L + +#define SN_aes_192_gcm "id-aes192-GCM" +#define LN_aes_192_gcm "aes-192-gcm" +#define NID_aes_192_gcm 898 +#define OBJ_aes_192_gcm OBJ_aes,26L + +#define SN_aes_192_ccm "id-aes192-CCM" +#define LN_aes_192_ccm "aes-192-ccm" +#define NID_aes_192_ccm 899 +#define OBJ_aes_192_ccm OBJ_aes,27L + +#define SN_id_aes192_wrap_pad "id-aes192-wrap-pad" +#define NID_id_aes192_wrap_pad 900 +#define OBJ_id_aes192_wrap_pad OBJ_aes,28L + +#define SN_aes_256_ecb "AES-256-ECB" +#define LN_aes_256_ecb "aes-256-ecb" +#define NID_aes_256_ecb 426 +#define OBJ_aes_256_ecb OBJ_aes,41L + +#define SN_aes_256_cbc "AES-256-CBC" +#define LN_aes_256_cbc "aes-256-cbc" +#define NID_aes_256_cbc 427 +#define OBJ_aes_256_cbc OBJ_aes,42L + +#define SN_aes_256_ofb128 "AES-256-OFB" +#define LN_aes_256_ofb128 "aes-256-ofb" +#define NID_aes_256_ofb128 428 +#define OBJ_aes_256_ofb128 OBJ_aes,43L + +#define SN_aes_256_cfb128 "AES-256-CFB" +#define LN_aes_256_cfb128 "aes-256-cfb" +#define NID_aes_256_cfb128 429 +#define OBJ_aes_256_cfb128 OBJ_aes,44L + +#define SN_id_aes256_wrap "id-aes256-wrap" +#define NID_id_aes256_wrap 790 +#define OBJ_id_aes256_wrap OBJ_aes,45L + +#define SN_aes_256_gcm "id-aes256-GCM" +#define LN_aes_256_gcm "aes-256-gcm" +#define NID_aes_256_gcm 901 +#define OBJ_aes_256_gcm OBJ_aes,46L + +#define SN_aes_256_ccm "id-aes256-CCM" +#define LN_aes_256_ccm "aes-256-ccm" +#define NID_aes_256_ccm 902 +#define OBJ_aes_256_ccm OBJ_aes,47L + +#define SN_id_aes256_wrap_pad "id-aes256-wrap-pad" +#define NID_id_aes256_wrap_pad 903 +#define OBJ_id_aes256_wrap_pad OBJ_aes,48L + +#define SN_aes_128_cfb1 "AES-128-CFB1" +#define LN_aes_128_cfb1 "aes-128-cfb1" +#define NID_aes_128_cfb1 650 + +#define SN_aes_192_cfb1 "AES-192-CFB1" +#define LN_aes_192_cfb1 "aes-192-cfb1" +#define NID_aes_192_cfb1 651 + +#define SN_aes_256_cfb1 "AES-256-CFB1" +#define LN_aes_256_cfb1 "aes-256-cfb1" +#define NID_aes_256_cfb1 652 + +#define SN_aes_128_cfb8 "AES-128-CFB8" +#define LN_aes_128_cfb8 "aes-128-cfb8" +#define NID_aes_128_cfb8 653 + +#define SN_aes_192_cfb8 "AES-192-CFB8" +#define LN_aes_192_cfb8 "aes-192-cfb8" +#define NID_aes_192_cfb8 654 + +#define SN_aes_256_cfb8 "AES-256-CFB8" +#define LN_aes_256_cfb8 "aes-256-cfb8" +#define NID_aes_256_cfb8 655 + +#define SN_aes_128_ctr "AES-128-CTR" +#define LN_aes_128_ctr "aes-128-ctr" +#define NID_aes_128_ctr 904 + +#define SN_aes_192_ctr "AES-192-CTR" +#define LN_aes_192_ctr "aes-192-ctr" +#define NID_aes_192_ctr 905 + +#define SN_aes_256_ctr "AES-256-CTR" +#define LN_aes_256_ctr "aes-256-ctr" +#define NID_aes_256_ctr 906 + +#define SN_aes_128_xts "AES-128-XTS" +#define LN_aes_128_xts "aes-128-xts" +#define NID_aes_128_xts 913 + +#define SN_aes_256_xts "AES-256-XTS" +#define LN_aes_256_xts "aes-256-xts" +#define NID_aes_256_xts 914 + +#define SN_des_cfb1 "DES-CFB1" +#define LN_des_cfb1 "des-cfb1" +#define NID_des_cfb1 656 + +#define SN_des_cfb8 "DES-CFB8" +#define LN_des_cfb8 "des-cfb8" +#define NID_des_cfb8 657 + +#define SN_des_ede3_cfb1 "DES-EDE3-CFB1" +#define LN_des_ede3_cfb1 "des-ede3-cfb1" +#define NID_des_ede3_cfb1 658 + +#define SN_des_ede3_cfb8 "DES-EDE3-CFB8" +#define LN_des_ede3_cfb8 "des-ede3-cfb8" +#define NID_des_ede3_cfb8 659 + +#define OBJ_nist_hashalgs OBJ_nistAlgorithms,2L + +#define SN_sha256 "SHA256" +#define LN_sha256 "sha256" +#define NID_sha256 672 +#define OBJ_sha256 OBJ_nist_hashalgs,1L + +#define SN_sha384 "SHA384" +#define LN_sha384 "sha384" +#define NID_sha384 673 +#define OBJ_sha384 OBJ_nist_hashalgs,2L + +#define SN_sha512 "SHA512" +#define LN_sha512 "sha512" +#define NID_sha512 674 +#define OBJ_sha512 OBJ_nist_hashalgs,3L + +#define SN_sha224 "SHA224" +#define LN_sha224 "sha224" +#define NID_sha224 675 +#define OBJ_sha224 OBJ_nist_hashalgs,4L + +#define OBJ_dsa_with_sha2 OBJ_nistAlgorithms,3L + +#define SN_dsa_with_SHA224 "dsa_with_SHA224" +#define NID_dsa_with_SHA224 802 +#define OBJ_dsa_with_SHA224 OBJ_dsa_with_sha2,1L + +#define SN_dsa_with_SHA256 "dsa_with_SHA256" +#define NID_dsa_with_SHA256 803 +#define OBJ_dsa_with_SHA256 OBJ_dsa_with_sha2,2L + +#define SN_hold_instruction_code "holdInstructionCode" +#define LN_hold_instruction_code "Hold Instruction Code" +#define NID_hold_instruction_code 430 +#define OBJ_hold_instruction_code OBJ_id_ce,23L + +#define OBJ_holdInstruction OBJ_X9_57,2L + +#define SN_hold_instruction_none "holdInstructionNone" +#define LN_hold_instruction_none "Hold Instruction None" +#define NID_hold_instruction_none 431 +#define OBJ_hold_instruction_none OBJ_holdInstruction,1L + +#define SN_hold_instruction_call_issuer "holdInstructionCallIssuer" +#define LN_hold_instruction_call_issuer "Hold Instruction Call Issuer" +#define NID_hold_instruction_call_issuer 432 +#define OBJ_hold_instruction_call_issuer OBJ_holdInstruction,2L + +#define SN_hold_instruction_reject "holdInstructionReject" +#define LN_hold_instruction_reject "Hold Instruction Reject" +#define NID_hold_instruction_reject 433 +#define OBJ_hold_instruction_reject OBJ_holdInstruction,3L + +#define SN_data "data" +#define NID_data 434 +#define OBJ_data OBJ_itu_t,9L + +#define SN_pss "pss" +#define NID_pss 435 +#define OBJ_pss OBJ_data,2342L + +#define SN_ucl "ucl" +#define NID_ucl 436 +#define OBJ_ucl OBJ_pss,19200300L + +#define SN_pilot "pilot" +#define NID_pilot 437 +#define OBJ_pilot OBJ_ucl,100L + +#define LN_pilotAttributeType "pilotAttributeType" +#define NID_pilotAttributeType 438 +#define OBJ_pilotAttributeType OBJ_pilot,1L + +#define LN_pilotAttributeSyntax "pilotAttributeSyntax" +#define NID_pilotAttributeSyntax 439 +#define OBJ_pilotAttributeSyntax OBJ_pilot,3L + +#define LN_pilotObjectClass "pilotObjectClass" +#define NID_pilotObjectClass 440 +#define OBJ_pilotObjectClass OBJ_pilot,4L + +#define LN_pilotGroups "pilotGroups" +#define NID_pilotGroups 441 +#define OBJ_pilotGroups OBJ_pilot,10L + +#define LN_iA5StringSyntax "iA5StringSyntax" +#define NID_iA5StringSyntax 442 +#define OBJ_iA5StringSyntax OBJ_pilotAttributeSyntax,4L + +#define LN_caseIgnoreIA5StringSyntax "caseIgnoreIA5StringSyntax" +#define NID_caseIgnoreIA5StringSyntax 443 +#define OBJ_caseIgnoreIA5StringSyntax OBJ_pilotAttributeSyntax,5L + +#define LN_pilotObject "pilotObject" +#define NID_pilotObject 444 +#define OBJ_pilotObject OBJ_pilotObjectClass,3L + +#define LN_pilotPerson "pilotPerson" +#define NID_pilotPerson 445 +#define OBJ_pilotPerson OBJ_pilotObjectClass,4L + +#define SN_account "account" +#define NID_account 446 +#define OBJ_account OBJ_pilotObjectClass,5L + +#define SN_document "document" +#define NID_document 447 +#define OBJ_document OBJ_pilotObjectClass,6L + +#define SN_room "room" +#define NID_room 448 +#define OBJ_room OBJ_pilotObjectClass,7L + +#define LN_documentSeries "documentSeries" +#define NID_documentSeries 449 +#define OBJ_documentSeries OBJ_pilotObjectClass,9L + +#define SN_Domain "domain" +#define LN_Domain "Domain" +#define NID_Domain 392 +#define OBJ_Domain OBJ_pilotObjectClass,13L + +#define LN_rFC822localPart "rFC822localPart" +#define NID_rFC822localPart 450 +#define OBJ_rFC822localPart OBJ_pilotObjectClass,14L + +#define LN_dNSDomain "dNSDomain" +#define NID_dNSDomain 451 +#define OBJ_dNSDomain OBJ_pilotObjectClass,15L + +#define LN_domainRelatedObject "domainRelatedObject" +#define NID_domainRelatedObject 452 +#define OBJ_domainRelatedObject OBJ_pilotObjectClass,17L + +#define LN_friendlyCountry "friendlyCountry" +#define NID_friendlyCountry 453 +#define OBJ_friendlyCountry OBJ_pilotObjectClass,18L + +#define LN_simpleSecurityObject "simpleSecurityObject" +#define NID_simpleSecurityObject 454 +#define OBJ_simpleSecurityObject OBJ_pilotObjectClass,19L + +#define LN_pilotOrganization "pilotOrganization" +#define NID_pilotOrganization 455 +#define OBJ_pilotOrganization OBJ_pilotObjectClass,20L + +#define LN_pilotDSA "pilotDSA" +#define NID_pilotDSA 456 +#define OBJ_pilotDSA OBJ_pilotObjectClass,21L + +#define LN_qualityLabelledData "qualityLabelledData" +#define NID_qualityLabelledData 457 +#define OBJ_qualityLabelledData OBJ_pilotObjectClass,22L + +#define SN_userId "UID" +#define LN_userId "userId" +#define NID_userId 458 +#define OBJ_userId OBJ_pilotAttributeType,1L + +#define LN_textEncodedORAddress "textEncodedORAddress" +#define NID_textEncodedORAddress 459 +#define OBJ_textEncodedORAddress OBJ_pilotAttributeType,2L + +#define SN_rfc822Mailbox "mail" +#define LN_rfc822Mailbox "rfc822Mailbox" +#define NID_rfc822Mailbox 460 +#define OBJ_rfc822Mailbox OBJ_pilotAttributeType,3L + +#define SN_info "info" +#define NID_info 461 +#define OBJ_info OBJ_pilotAttributeType,4L + +#define LN_favouriteDrink "favouriteDrink" +#define NID_favouriteDrink 462 +#define OBJ_favouriteDrink OBJ_pilotAttributeType,5L + +#define LN_roomNumber "roomNumber" +#define NID_roomNumber 463 +#define OBJ_roomNumber OBJ_pilotAttributeType,6L + +#define SN_photo "photo" +#define NID_photo 464 +#define OBJ_photo OBJ_pilotAttributeType,7L + +#define LN_userClass "userClass" +#define NID_userClass 465 +#define OBJ_userClass OBJ_pilotAttributeType,8L + +#define SN_host "host" +#define NID_host 466 +#define OBJ_host OBJ_pilotAttributeType,9L + +#define SN_manager "manager" +#define NID_manager 467 +#define OBJ_manager OBJ_pilotAttributeType,10L + +#define LN_documentIdentifier "documentIdentifier" +#define NID_documentIdentifier 468 +#define OBJ_documentIdentifier OBJ_pilotAttributeType,11L + +#define LN_documentTitle "documentTitle" +#define NID_documentTitle 469 +#define OBJ_documentTitle OBJ_pilotAttributeType,12L + +#define LN_documentVersion "documentVersion" +#define NID_documentVersion 470 +#define OBJ_documentVersion OBJ_pilotAttributeType,13L + +#define LN_documentAuthor "documentAuthor" +#define NID_documentAuthor 471 +#define OBJ_documentAuthor OBJ_pilotAttributeType,14L + +#define LN_documentLocation "documentLocation" +#define NID_documentLocation 472 +#define OBJ_documentLocation OBJ_pilotAttributeType,15L + +#define LN_homeTelephoneNumber "homeTelephoneNumber" +#define NID_homeTelephoneNumber 473 +#define OBJ_homeTelephoneNumber OBJ_pilotAttributeType,20L + +#define SN_secretary "secretary" +#define NID_secretary 474 +#define OBJ_secretary OBJ_pilotAttributeType,21L + +#define LN_otherMailbox "otherMailbox" +#define NID_otherMailbox 475 +#define OBJ_otherMailbox OBJ_pilotAttributeType,22L + +#define LN_lastModifiedTime "lastModifiedTime" +#define NID_lastModifiedTime 476 +#define OBJ_lastModifiedTime OBJ_pilotAttributeType,23L + +#define LN_lastModifiedBy "lastModifiedBy" +#define NID_lastModifiedBy 477 +#define OBJ_lastModifiedBy OBJ_pilotAttributeType,24L + +#define SN_domainComponent "DC" +#define LN_domainComponent "domainComponent" +#define NID_domainComponent 391 +#define OBJ_domainComponent OBJ_pilotAttributeType,25L + +#define LN_aRecord "aRecord" +#define NID_aRecord 478 +#define OBJ_aRecord OBJ_pilotAttributeType,26L + +#define LN_pilotAttributeType27 "pilotAttributeType27" +#define NID_pilotAttributeType27 479 +#define OBJ_pilotAttributeType27 OBJ_pilotAttributeType,27L + +#define LN_mXRecord "mXRecord" +#define NID_mXRecord 480 +#define OBJ_mXRecord OBJ_pilotAttributeType,28L + +#define LN_nSRecord "nSRecord" +#define NID_nSRecord 481 +#define OBJ_nSRecord OBJ_pilotAttributeType,29L + +#define LN_sOARecord "sOARecord" +#define NID_sOARecord 482 +#define OBJ_sOARecord OBJ_pilotAttributeType,30L + +#define LN_cNAMERecord "cNAMERecord" +#define NID_cNAMERecord 483 +#define OBJ_cNAMERecord OBJ_pilotAttributeType,31L + +#define LN_associatedDomain "associatedDomain" +#define NID_associatedDomain 484 +#define OBJ_associatedDomain OBJ_pilotAttributeType,37L + +#define LN_associatedName "associatedName" +#define NID_associatedName 485 +#define OBJ_associatedName OBJ_pilotAttributeType,38L + +#define LN_homePostalAddress "homePostalAddress" +#define NID_homePostalAddress 486 +#define OBJ_homePostalAddress OBJ_pilotAttributeType,39L + +#define LN_personalTitle "personalTitle" +#define NID_personalTitle 487 +#define OBJ_personalTitle OBJ_pilotAttributeType,40L + +#define LN_mobileTelephoneNumber "mobileTelephoneNumber" +#define NID_mobileTelephoneNumber 488 +#define OBJ_mobileTelephoneNumber OBJ_pilotAttributeType,41L + +#define LN_pagerTelephoneNumber "pagerTelephoneNumber" +#define NID_pagerTelephoneNumber 489 +#define OBJ_pagerTelephoneNumber OBJ_pilotAttributeType,42L + +#define LN_friendlyCountryName "friendlyCountryName" +#define NID_friendlyCountryName 490 +#define OBJ_friendlyCountryName OBJ_pilotAttributeType,43L + +#define LN_organizationalStatus "organizationalStatus" +#define NID_organizationalStatus 491 +#define OBJ_organizationalStatus OBJ_pilotAttributeType,45L + +#define LN_janetMailbox "janetMailbox" +#define NID_janetMailbox 492 +#define OBJ_janetMailbox OBJ_pilotAttributeType,46L + +#define LN_mailPreferenceOption "mailPreferenceOption" +#define NID_mailPreferenceOption 493 +#define OBJ_mailPreferenceOption OBJ_pilotAttributeType,47L + +#define LN_buildingName "buildingName" +#define NID_buildingName 494 +#define OBJ_buildingName OBJ_pilotAttributeType,48L + +#define LN_dSAQuality "dSAQuality" +#define NID_dSAQuality 495 +#define OBJ_dSAQuality OBJ_pilotAttributeType,49L + +#define LN_singleLevelQuality "singleLevelQuality" +#define NID_singleLevelQuality 496 +#define OBJ_singleLevelQuality OBJ_pilotAttributeType,50L + +#define LN_subtreeMinimumQuality "subtreeMinimumQuality" +#define NID_subtreeMinimumQuality 497 +#define OBJ_subtreeMinimumQuality OBJ_pilotAttributeType,51L + +#define LN_subtreeMaximumQuality "subtreeMaximumQuality" +#define NID_subtreeMaximumQuality 498 +#define OBJ_subtreeMaximumQuality OBJ_pilotAttributeType,52L + +#define LN_personalSignature "personalSignature" +#define NID_personalSignature 499 +#define OBJ_personalSignature OBJ_pilotAttributeType,53L + +#define LN_dITRedirect "dITRedirect" +#define NID_dITRedirect 500 +#define OBJ_dITRedirect OBJ_pilotAttributeType,54L + +#define SN_audio "audio" +#define NID_audio 501 +#define OBJ_audio OBJ_pilotAttributeType,55L + +#define LN_documentPublisher "documentPublisher" +#define NID_documentPublisher 502 +#define OBJ_documentPublisher OBJ_pilotAttributeType,56L + +#define SN_id_set "id-set" +#define LN_id_set "Secure Electronic Transactions" +#define NID_id_set 512 +#define OBJ_id_set OBJ_international_organizations,42L + +#define SN_set_ctype "set-ctype" +#define LN_set_ctype "content types" +#define NID_set_ctype 513 +#define OBJ_set_ctype OBJ_id_set,0L + +#define SN_set_msgExt "set-msgExt" +#define LN_set_msgExt "message extensions" +#define NID_set_msgExt 514 +#define OBJ_set_msgExt OBJ_id_set,1L + +#define SN_set_attr "set-attr" +#define NID_set_attr 515 +#define OBJ_set_attr OBJ_id_set,3L + +#define SN_set_policy "set-policy" +#define NID_set_policy 516 +#define OBJ_set_policy OBJ_id_set,5L + +#define SN_set_certExt "set-certExt" +#define LN_set_certExt "certificate extensions" +#define NID_set_certExt 517 +#define OBJ_set_certExt OBJ_id_set,7L + +#define SN_set_brand "set-brand" +#define NID_set_brand 518 +#define OBJ_set_brand OBJ_id_set,8L + +#define SN_setct_PANData "setct-PANData" +#define NID_setct_PANData 519 +#define OBJ_setct_PANData OBJ_set_ctype,0L + +#define SN_setct_PANToken "setct-PANToken" +#define NID_setct_PANToken 520 +#define OBJ_setct_PANToken OBJ_set_ctype,1L + +#define SN_setct_PANOnly "setct-PANOnly" +#define NID_setct_PANOnly 521 +#define OBJ_setct_PANOnly OBJ_set_ctype,2L + +#define SN_setct_OIData "setct-OIData" +#define NID_setct_OIData 522 +#define OBJ_setct_OIData OBJ_set_ctype,3L + +#define SN_setct_PI "setct-PI" +#define NID_setct_PI 523 +#define OBJ_setct_PI OBJ_set_ctype,4L + +#define SN_setct_PIData "setct-PIData" +#define NID_setct_PIData 524 +#define OBJ_setct_PIData OBJ_set_ctype,5L + +#define SN_setct_PIDataUnsigned "setct-PIDataUnsigned" +#define NID_setct_PIDataUnsigned 525 +#define OBJ_setct_PIDataUnsigned OBJ_set_ctype,6L + +#define SN_setct_HODInput "setct-HODInput" +#define NID_setct_HODInput 526 +#define OBJ_setct_HODInput OBJ_set_ctype,7L + +#define SN_setct_AuthResBaggage "setct-AuthResBaggage" +#define NID_setct_AuthResBaggage 527 +#define OBJ_setct_AuthResBaggage OBJ_set_ctype,8L + +#define SN_setct_AuthRevReqBaggage "setct-AuthRevReqBaggage" +#define NID_setct_AuthRevReqBaggage 528 +#define OBJ_setct_AuthRevReqBaggage OBJ_set_ctype,9L + +#define SN_setct_AuthRevResBaggage "setct-AuthRevResBaggage" +#define NID_setct_AuthRevResBaggage 529 +#define OBJ_setct_AuthRevResBaggage OBJ_set_ctype,10L + +#define SN_setct_CapTokenSeq "setct-CapTokenSeq" +#define NID_setct_CapTokenSeq 530 +#define OBJ_setct_CapTokenSeq OBJ_set_ctype,11L + +#define SN_setct_PInitResData "setct-PInitResData" +#define NID_setct_PInitResData 531 +#define OBJ_setct_PInitResData OBJ_set_ctype,12L + +#define SN_setct_PI_TBS "setct-PI-TBS" +#define NID_setct_PI_TBS 532 +#define OBJ_setct_PI_TBS OBJ_set_ctype,13L + +#define SN_setct_PResData "setct-PResData" +#define NID_setct_PResData 533 +#define OBJ_setct_PResData OBJ_set_ctype,14L + +#define SN_setct_AuthReqTBS "setct-AuthReqTBS" +#define NID_setct_AuthReqTBS 534 +#define OBJ_setct_AuthReqTBS OBJ_set_ctype,16L + +#define SN_setct_AuthResTBS "setct-AuthResTBS" +#define NID_setct_AuthResTBS 535 +#define OBJ_setct_AuthResTBS OBJ_set_ctype,17L + +#define SN_setct_AuthResTBSX "setct-AuthResTBSX" +#define NID_setct_AuthResTBSX 536 +#define OBJ_setct_AuthResTBSX OBJ_set_ctype,18L + +#define SN_setct_AuthTokenTBS "setct-AuthTokenTBS" +#define NID_setct_AuthTokenTBS 537 +#define OBJ_setct_AuthTokenTBS OBJ_set_ctype,19L + +#define SN_setct_CapTokenData "setct-CapTokenData" +#define NID_setct_CapTokenData 538 +#define OBJ_setct_CapTokenData OBJ_set_ctype,20L + +#define SN_setct_CapTokenTBS "setct-CapTokenTBS" +#define NID_setct_CapTokenTBS 539 +#define OBJ_setct_CapTokenTBS OBJ_set_ctype,21L + +#define SN_setct_AcqCardCodeMsg "setct-AcqCardCodeMsg" +#define NID_setct_AcqCardCodeMsg 540 +#define OBJ_setct_AcqCardCodeMsg OBJ_set_ctype,22L + +#define SN_setct_AuthRevReqTBS "setct-AuthRevReqTBS" +#define NID_setct_AuthRevReqTBS 541 +#define OBJ_setct_AuthRevReqTBS OBJ_set_ctype,23L + +#define SN_setct_AuthRevResData "setct-AuthRevResData" +#define NID_setct_AuthRevResData 542 +#define OBJ_setct_AuthRevResData OBJ_set_ctype,24L + +#define SN_setct_AuthRevResTBS "setct-AuthRevResTBS" +#define NID_setct_AuthRevResTBS 543 +#define OBJ_setct_AuthRevResTBS OBJ_set_ctype,25L + +#define SN_setct_CapReqTBS "setct-CapReqTBS" +#define NID_setct_CapReqTBS 544 +#define OBJ_setct_CapReqTBS OBJ_set_ctype,26L + +#define SN_setct_CapReqTBSX "setct-CapReqTBSX" +#define NID_setct_CapReqTBSX 545 +#define OBJ_setct_CapReqTBSX OBJ_set_ctype,27L + +#define SN_setct_CapResData "setct-CapResData" +#define NID_setct_CapResData 546 +#define OBJ_setct_CapResData OBJ_set_ctype,28L + +#define SN_setct_CapRevReqTBS "setct-CapRevReqTBS" +#define NID_setct_CapRevReqTBS 547 +#define OBJ_setct_CapRevReqTBS OBJ_set_ctype,29L + +#define SN_setct_CapRevReqTBSX "setct-CapRevReqTBSX" +#define NID_setct_CapRevReqTBSX 548 +#define OBJ_setct_CapRevReqTBSX OBJ_set_ctype,30L + +#define SN_setct_CapRevResData "setct-CapRevResData" +#define NID_setct_CapRevResData 549 +#define OBJ_setct_CapRevResData OBJ_set_ctype,31L + +#define SN_setct_CredReqTBS "setct-CredReqTBS" +#define NID_setct_CredReqTBS 550 +#define OBJ_setct_CredReqTBS OBJ_set_ctype,32L + +#define SN_setct_CredReqTBSX "setct-CredReqTBSX" +#define NID_setct_CredReqTBSX 551 +#define OBJ_setct_CredReqTBSX OBJ_set_ctype,33L + +#define SN_setct_CredResData "setct-CredResData" +#define NID_setct_CredResData 552 +#define OBJ_setct_CredResData OBJ_set_ctype,34L + +#define SN_setct_CredRevReqTBS "setct-CredRevReqTBS" +#define NID_setct_CredRevReqTBS 553 +#define OBJ_setct_CredRevReqTBS OBJ_set_ctype,35L + +#define SN_setct_CredRevReqTBSX "setct-CredRevReqTBSX" +#define NID_setct_CredRevReqTBSX 554 +#define OBJ_setct_CredRevReqTBSX OBJ_set_ctype,36L + +#define SN_setct_CredRevResData "setct-CredRevResData" +#define NID_setct_CredRevResData 555 +#define OBJ_setct_CredRevResData OBJ_set_ctype,37L + +#define SN_setct_PCertReqData "setct-PCertReqData" +#define NID_setct_PCertReqData 556 +#define OBJ_setct_PCertReqData OBJ_set_ctype,38L + +#define SN_setct_PCertResTBS "setct-PCertResTBS" +#define NID_setct_PCertResTBS 557 +#define OBJ_setct_PCertResTBS OBJ_set_ctype,39L + +#define SN_setct_BatchAdminReqData "setct-BatchAdminReqData" +#define NID_setct_BatchAdminReqData 558 +#define OBJ_setct_BatchAdminReqData OBJ_set_ctype,40L + +#define SN_setct_BatchAdminResData "setct-BatchAdminResData" +#define NID_setct_BatchAdminResData 559 +#define OBJ_setct_BatchAdminResData OBJ_set_ctype,41L + +#define SN_setct_CardCInitResTBS "setct-CardCInitResTBS" +#define NID_setct_CardCInitResTBS 560 +#define OBJ_setct_CardCInitResTBS OBJ_set_ctype,42L + +#define SN_setct_MeAqCInitResTBS "setct-MeAqCInitResTBS" +#define NID_setct_MeAqCInitResTBS 561 +#define OBJ_setct_MeAqCInitResTBS OBJ_set_ctype,43L + +#define SN_setct_RegFormResTBS "setct-RegFormResTBS" +#define NID_setct_RegFormResTBS 562 +#define OBJ_setct_RegFormResTBS OBJ_set_ctype,44L + +#define SN_setct_CertReqData "setct-CertReqData" +#define NID_setct_CertReqData 563 +#define OBJ_setct_CertReqData OBJ_set_ctype,45L + +#define SN_setct_CertReqTBS "setct-CertReqTBS" +#define NID_setct_CertReqTBS 564 +#define OBJ_setct_CertReqTBS OBJ_set_ctype,46L + +#define SN_setct_CertResData "setct-CertResData" +#define NID_setct_CertResData 565 +#define OBJ_setct_CertResData OBJ_set_ctype,47L + +#define SN_setct_CertInqReqTBS "setct-CertInqReqTBS" +#define NID_setct_CertInqReqTBS 566 +#define OBJ_setct_CertInqReqTBS OBJ_set_ctype,48L + +#define SN_setct_ErrorTBS "setct-ErrorTBS" +#define NID_setct_ErrorTBS 567 +#define OBJ_setct_ErrorTBS OBJ_set_ctype,49L + +#define SN_setct_PIDualSignedTBE "setct-PIDualSignedTBE" +#define NID_setct_PIDualSignedTBE 568 +#define OBJ_setct_PIDualSignedTBE OBJ_set_ctype,50L + +#define SN_setct_PIUnsignedTBE "setct-PIUnsignedTBE" +#define NID_setct_PIUnsignedTBE 569 +#define OBJ_setct_PIUnsignedTBE OBJ_set_ctype,51L + +#define SN_setct_AuthReqTBE "setct-AuthReqTBE" +#define NID_setct_AuthReqTBE 570 +#define OBJ_setct_AuthReqTBE OBJ_set_ctype,52L + +#define SN_setct_AuthResTBE "setct-AuthResTBE" +#define NID_setct_AuthResTBE 571 +#define OBJ_setct_AuthResTBE OBJ_set_ctype,53L + +#define SN_setct_AuthResTBEX "setct-AuthResTBEX" +#define NID_setct_AuthResTBEX 572 +#define OBJ_setct_AuthResTBEX OBJ_set_ctype,54L + +#define SN_setct_AuthTokenTBE "setct-AuthTokenTBE" +#define NID_setct_AuthTokenTBE 573 +#define OBJ_setct_AuthTokenTBE OBJ_set_ctype,55L + +#define SN_setct_CapTokenTBE "setct-CapTokenTBE" +#define NID_setct_CapTokenTBE 574 +#define OBJ_setct_CapTokenTBE OBJ_set_ctype,56L + +#define SN_setct_CapTokenTBEX "setct-CapTokenTBEX" +#define NID_setct_CapTokenTBEX 575 +#define OBJ_setct_CapTokenTBEX OBJ_set_ctype,57L + +#define SN_setct_AcqCardCodeMsgTBE "setct-AcqCardCodeMsgTBE" +#define NID_setct_AcqCardCodeMsgTBE 576 +#define OBJ_setct_AcqCardCodeMsgTBE OBJ_set_ctype,58L + +#define SN_setct_AuthRevReqTBE "setct-AuthRevReqTBE" +#define NID_setct_AuthRevReqTBE 577 +#define OBJ_setct_AuthRevReqTBE OBJ_set_ctype,59L + +#define SN_setct_AuthRevResTBE "setct-AuthRevResTBE" +#define NID_setct_AuthRevResTBE 578 +#define OBJ_setct_AuthRevResTBE OBJ_set_ctype,60L + +#define SN_setct_AuthRevResTBEB "setct-AuthRevResTBEB" +#define NID_setct_AuthRevResTBEB 579 +#define OBJ_setct_AuthRevResTBEB OBJ_set_ctype,61L + +#define SN_setct_CapReqTBE "setct-CapReqTBE" +#define NID_setct_CapReqTBE 580 +#define OBJ_setct_CapReqTBE OBJ_set_ctype,62L + +#define SN_setct_CapReqTBEX "setct-CapReqTBEX" +#define NID_setct_CapReqTBEX 581 +#define OBJ_setct_CapReqTBEX OBJ_set_ctype,63L + +#define SN_setct_CapResTBE "setct-CapResTBE" +#define NID_setct_CapResTBE 582 +#define OBJ_setct_CapResTBE OBJ_set_ctype,64L + +#define SN_setct_CapRevReqTBE "setct-CapRevReqTBE" +#define NID_setct_CapRevReqTBE 583 +#define OBJ_setct_CapRevReqTBE OBJ_set_ctype,65L + +#define SN_setct_CapRevReqTBEX "setct-CapRevReqTBEX" +#define NID_setct_CapRevReqTBEX 584 +#define OBJ_setct_CapRevReqTBEX OBJ_set_ctype,66L + +#define SN_setct_CapRevResTBE "setct-CapRevResTBE" +#define NID_setct_CapRevResTBE 585 +#define OBJ_setct_CapRevResTBE OBJ_set_ctype,67L + +#define SN_setct_CredReqTBE "setct-CredReqTBE" +#define NID_setct_CredReqTBE 586 +#define OBJ_setct_CredReqTBE OBJ_set_ctype,68L + +#define SN_setct_CredReqTBEX "setct-CredReqTBEX" +#define NID_setct_CredReqTBEX 587 +#define OBJ_setct_CredReqTBEX OBJ_set_ctype,69L + +#define SN_setct_CredResTBE "setct-CredResTBE" +#define NID_setct_CredResTBE 588 +#define OBJ_setct_CredResTBE OBJ_set_ctype,70L + +#define SN_setct_CredRevReqTBE "setct-CredRevReqTBE" +#define NID_setct_CredRevReqTBE 589 +#define OBJ_setct_CredRevReqTBE OBJ_set_ctype,71L + +#define SN_setct_CredRevReqTBEX "setct-CredRevReqTBEX" +#define NID_setct_CredRevReqTBEX 590 +#define OBJ_setct_CredRevReqTBEX OBJ_set_ctype,72L + +#define SN_setct_CredRevResTBE "setct-CredRevResTBE" +#define NID_setct_CredRevResTBE 591 +#define OBJ_setct_CredRevResTBE OBJ_set_ctype,73L + +#define SN_setct_BatchAdminReqTBE "setct-BatchAdminReqTBE" +#define NID_setct_BatchAdminReqTBE 592 +#define OBJ_setct_BatchAdminReqTBE OBJ_set_ctype,74L + +#define SN_setct_BatchAdminResTBE "setct-BatchAdminResTBE" +#define NID_setct_BatchAdminResTBE 593 +#define OBJ_setct_BatchAdminResTBE OBJ_set_ctype,75L + +#define SN_setct_RegFormReqTBE "setct-RegFormReqTBE" +#define NID_setct_RegFormReqTBE 594 +#define OBJ_setct_RegFormReqTBE OBJ_set_ctype,76L + +#define SN_setct_CertReqTBE "setct-CertReqTBE" +#define NID_setct_CertReqTBE 595 +#define OBJ_setct_CertReqTBE OBJ_set_ctype,77L + +#define SN_setct_CertReqTBEX "setct-CertReqTBEX" +#define NID_setct_CertReqTBEX 596 +#define OBJ_setct_CertReqTBEX OBJ_set_ctype,78L + +#define SN_setct_CertResTBE "setct-CertResTBE" +#define NID_setct_CertResTBE 597 +#define OBJ_setct_CertResTBE OBJ_set_ctype,79L + +#define SN_setct_CRLNotificationTBS "setct-CRLNotificationTBS" +#define NID_setct_CRLNotificationTBS 598 +#define OBJ_setct_CRLNotificationTBS OBJ_set_ctype,80L + +#define SN_setct_CRLNotificationResTBS "setct-CRLNotificationResTBS" +#define NID_setct_CRLNotificationResTBS 599 +#define OBJ_setct_CRLNotificationResTBS OBJ_set_ctype,81L + +#define SN_setct_BCIDistributionTBS "setct-BCIDistributionTBS" +#define NID_setct_BCIDistributionTBS 600 +#define OBJ_setct_BCIDistributionTBS OBJ_set_ctype,82L + +#define SN_setext_genCrypt "setext-genCrypt" +#define LN_setext_genCrypt "generic cryptogram" +#define NID_setext_genCrypt 601 +#define OBJ_setext_genCrypt OBJ_set_msgExt,1L + +#define SN_setext_miAuth "setext-miAuth" +#define LN_setext_miAuth "merchant initiated auth" +#define NID_setext_miAuth 602 +#define OBJ_setext_miAuth OBJ_set_msgExt,3L + +#define SN_setext_pinSecure "setext-pinSecure" +#define NID_setext_pinSecure 603 +#define OBJ_setext_pinSecure OBJ_set_msgExt,4L + +#define SN_setext_pinAny "setext-pinAny" +#define NID_setext_pinAny 604 +#define OBJ_setext_pinAny OBJ_set_msgExt,5L + +#define SN_setext_track2 "setext-track2" +#define NID_setext_track2 605 +#define OBJ_setext_track2 OBJ_set_msgExt,7L + +#define SN_setext_cv "setext-cv" +#define LN_setext_cv "additional verification" +#define NID_setext_cv 606 +#define OBJ_setext_cv OBJ_set_msgExt,8L + +#define SN_set_policy_root "set-policy-root" +#define NID_set_policy_root 607 +#define OBJ_set_policy_root OBJ_set_policy,0L + +#define SN_setCext_hashedRoot "setCext-hashedRoot" +#define NID_setCext_hashedRoot 608 +#define OBJ_setCext_hashedRoot OBJ_set_certExt,0L + +#define SN_setCext_certType "setCext-certType" +#define NID_setCext_certType 609 +#define OBJ_setCext_certType OBJ_set_certExt,1L + +#define SN_setCext_merchData "setCext-merchData" +#define NID_setCext_merchData 610 +#define OBJ_setCext_merchData OBJ_set_certExt,2L + +#define SN_setCext_cCertRequired "setCext-cCertRequired" +#define NID_setCext_cCertRequired 611 +#define OBJ_setCext_cCertRequired OBJ_set_certExt,3L + +#define SN_setCext_tunneling "setCext-tunneling" +#define NID_setCext_tunneling 612 +#define OBJ_setCext_tunneling OBJ_set_certExt,4L + +#define SN_setCext_setExt "setCext-setExt" +#define NID_setCext_setExt 613 +#define OBJ_setCext_setExt OBJ_set_certExt,5L + +#define SN_setCext_setQualf "setCext-setQualf" +#define NID_setCext_setQualf 614 +#define OBJ_setCext_setQualf OBJ_set_certExt,6L + +#define SN_setCext_PGWYcapabilities "setCext-PGWYcapabilities" +#define NID_setCext_PGWYcapabilities 615 +#define OBJ_setCext_PGWYcapabilities OBJ_set_certExt,7L + +#define SN_setCext_TokenIdentifier "setCext-TokenIdentifier" +#define NID_setCext_TokenIdentifier 616 +#define OBJ_setCext_TokenIdentifier OBJ_set_certExt,8L + +#define SN_setCext_Track2Data "setCext-Track2Data" +#define NID_setCext_Track2Data 617 +#define OBJ_setCext_Track2Data OBJ_set_certExt,9L + +#define SN_setCext_TokenType "setCext-TokenType" +#define NID_setCext_TokenType 618 +#define OBJ_setCext_TokenType OBJ_set_certExt,10L + +#define SN_setCext_IssuerCapabilities "setCext-IssuerCapabilities" +#define NID_setCext_IssuerCapabilities 619 +#define OBJ_setCext_IssuerCapabilities OBJ_set_certExt,11L + +#define SN_setAttr_Cert "setAttr-Cert" +#define NID_setAttr_Cert 620 +#define OBJ_setAttr_Cert OBJ_set_attr,0L + +#define SN_setAttr_PGWYcap "setAttr-PGWYcap" +#define LN_setAttr_PGWYcap "payment gateway capabilities" +#define NID_setAttr_PGWYcap 621 +#define OBJ_setAttr_PGWYcap OBJ_set_attr,1L + +#define SN_setAttr_TokenType "setAttr-TokenType" +#define NID_setAttr_TokenType 622 +#define OBJ_setAttr_TokenType OBJ_set_attr,2L + +#define SN_setAttr_IssCap "setAttr-IssCap" +#define LN_setAttr_IssCap "issuer capabilities" +#define NID_setAttr_IssCap 623 +#define OBJ_setAttr_IssCap OBJ_set_attr,3L + +#define SN_set_rootKeyThumb "set-rootKeyThumb" +#define NID_set_rootKeyThumb 624 +#define OBJ_set_rootKeyThumb OBJ_setAttr_Cert,0L + +#define SN_set_addPolicy "set-addPolicy" +#define NID_set_addPolicy 625 +#define OBJ_set_addPolicy OBJ_setAttr_Cert,1L + +#define SN_setAttr_Token_EMV "setAttr-Token-EMV" +#define NID_setAttr_Token_EMV 626 +#define OBJ_setAttr_Token_EMV OBJ_setAttr_TokenType,1L + +#define SN_setAttr_Token_B0Prime "setAttr-Token-B0Prime" +#define NID_setAttr_Token_B0Prime 627 +#define OBJ_setAttr_Token_B0Prime OBJ_setAttr_TokenType,2L + +#define SN_setAttr_IssCap_CVM "setAttr-IssCap-CVM" +#define NID_setAttr_IssCap_CVM 628 +#define OBJ_setAttr_IssCap_CVM OBJ_setAttr_IssCap,3L + +#define SN_setAttr_IssCap_T2 "setAttr-IssCap-T2" +#define NID_setAttr_IssCap_T2 629 +#define OBJ_setAttr_IssCap_T2 OBJ_setAttr_IssCap,4L + +#define SN_setAttr_IssCap_Sig "setAttr-IssCap-Sig" +#define NID_setAttr_IssCap_Sig 630 +#define OBJ_setAttr_IssCap_Sig OBJ_setAttr_IssCap,5L + +#define SN_setAttr_GenCryptgrm "setAttr-GenCryptgrm" +#define LN_setAttr_GenCryptgrm "generate cryptogram" +#define NID_setAttr_GenCryptgrm 631 +#define OBJ_setAttr_GenCryptgrm OBJ_setAttr_IssCap_CVM,1L + +#define SN_setAttr_T2Enc "setAttr-T2Enc" +#define LN_setAttr_T2Enc "encrypted track 2" +#define NID_setAttr_T2Enc 632 +#define OBJ_setAttr_T2Enc OBJ_setAttr_IssCap_T2,1L + +#define SN_setAttr_T2cleartxt "setAttr-T2cleartxt" +#define LN_setAttr_T2cleartxt "cleartext track 2" +#define NID_setAttr_T2cleartxt 633 +#define OBJ_setAttr_T2cleartxt OBJ_setAttr_IssCap_T2,2L + +#define SN_setAttr_TokICCsig "setAttr-TokICCsig" +#define LN_setAttr_TokICCsig "ICC or token signature" +#define NID_setAttr_TokICCsig 634 +#define OBJ_setAttr_TokICCsig OBJ_setAttr_IssCap_Sig,1L + +#define SN_setAttr_SecDevSig "setAttr-SecDevSig" +#define LN_setAttr_SecDevSig "secure device signature" +#define NID_setAttr_SecDevSig 635 +#define OBJ_setAttr_SecDevSig OBJ_setAttr_IssCap_Sig,2L + +#define SN_set_brand_IATA_ATA "set-brand-IATA-ATA" +#define NID_set_brand_IATA_ATA 636 +#define OBJ_set_brand_IATA_ATA OBJ_set_brand,1L + +#define SN_set_brand_Diners "set-brand-Diners" +#define NID_set_brand_Diners 637 +#define OBJ_set_brand_Diners OBJ_set_brand,30L + +#define SN_set_brand_AmericanExpress "set-brand-AmericanExpress" +#define NID_set_brand_AmericanExpress 638 +#define OBJ_set_brand_AmericanExpress OBJ_set_brand,34L + +#define SN_set_brand_JCB "set-brand-JCB" +#define NID_set_brand_JCB 639 +#define OBJ_set_brand_JCB OBJ_set_brand,35L + +#define SN_set_brand_Visa "set-brand-Visa" +#define NID_set_brand_Visa 640 +#define OBJ_set_brand_Visa OBJ_set_brand,4L + +#define SN_set_brand_MasterCard "set-brand-MasterCard" +#define NID_set_brand_MasterCard 641 +#define OBJ_set_brand_MasterCard OBJ_set_brand,5L + +#define SN_set_brand_Novus "set-brand-Novus" +#define NID_set_brand_Novus 642 +#define OBJ_set_brand_Novus OBJ_set_brand,6011L + +#define SN_des_cdmf "DES-CDMF" +#define LN_des_cdmf "des-cdmf" +#define NID_des_cdmf 643 +#define OBJ_des_cdmf OBJ_rsadsi,3L,10L + +#define SN_rsaOAEPEncryptionSET "rsaOAEPEncryptionSET" +#define NID_rsaOAEPEncryptionSET 644 +#define OBJ_rsaOAEPEncryptionSET OBJ_rsadsi,1L,1L,6L + +#define SN_ipsec3 "Oakley-EC2N-3" +#define LN_ipsec3 "ipsec3" +#define NID_ipsec3 749 + +#define SN_ipsec4 "Oakley-EC2N-4" +#define LN_ipsec4 "ipsec4" +#define NID_ipsec4 750 + +#define SN_whirlpool "whirlpool" +#define NID_whirlpool 804 +#define OBJ_whirlpool OBJ_iso,0L,10118L,3L,0L,55L + +#define SN_cryptopro "cryptopro" +#define NID_cryptopro 805 +#define OBJ_cryptopro OBJ_member_body,643L,2L,2L + +#define SN_cryptocom "cryptocom" +#define NID_cryptocom 806 +#define OBJ_cryptocom OBJ_member_body,643L,2L,9L + +#define SN_id_GostR3411_94_with_GostR3410_2001 "id-GostR3411-94-with-GostR3410-2001" +#define LN_id_GostR3411_94_with_GostR3410_2001 "GOST R 34.11-94 with GOST R 34.10-2001" +#define NID_id_GostR3411_94_with_GostR3410_2001 807 +#define OBJ_id_GostR3411_94_with_GostR3410_2001 OBJ_cryptopro,3L + +#define SN_id_GostR3411_94_with_GostR3410_94 "id-GostR3411-94-with-GostR3410-94" +#define LN_id_GostR3411_94_with_GostR3410_94 "GOST R 34.11-94 with GOST R 34.10-94" +#define NID_id_GostR3411_94_with_GostR3410_94 808 +#define OBJ_id_GostR3411_94_with_GostR3410_94 OBJ_cryptopro,4L + +#define SN_id_GostR3411_94 "md_gost94" +#define LN_id_GostR3411_94 "GOST R 34.11-94" +#define NID_id_GostR3411_94 809 +#define OBJ_id_GostR3411_94 OBJ_cryptopro,9L + +#define SN_id_HMACGostR3411_94 "id-HMACGostR3411-94" +#define LN_id_HMACGostR3411_94 "HMAC GOST 34.11-94" +#define NID_id_HMACGostR3411_94 810 +#define OBJ_id_HMACGostR3411_94 OBJ_cryptopro,10L + +#define SN_id_GostR3410_2001 "gost2001" +#define LN_id_GostR3410_2001 "GOST R 34.10-2001" +#define NID_id_GostR3410_2001 811 +#define OBJ_id_GostR3410_2001 OBJ_cryptopro,19L + +#define SN_id_GostR3410_94 "gost94" +#define LN_id_GostR3410_94 "GOST R 34.10-94" +#define NID_id_GostR3410_94 812 +#define OBJ_id_GostR3410_94 OBJ_cryptopro,20L + +#define SN_id_Gost28147_89 "gost89" +#define LN_id_Gost28147_89 "GOST 28147-89" +#define NID_id_Gost28147_89 813 +#define OBJ_id_Gost28147_89 OBJ_cryptopro,21L + +#define SN_gost89_cnt "gost89-cnt" +#define NID_gost89_cnt 814 + +#define SN_id_Gost28147_89_MAC "gost-mac" +#define LN_id_Gost28147_89_MAC "GOST 28147-89 MAC" +#define NID_id_Gost28147_89_MAC 815 +#define OBJ_id_Gost28147_89_MAC OBJ_cryptopro,22L + +#define SN_id_GostR3411_94_prf "prf-gostr3411-94" +#define LN_id_GostR3411_94_prf "GOST R 34.11-94 PRF" +#define NID_id_GostR3411_94_prf 816 +#define OBJ_id_GostR3411_94_prf OBJ_cryptopro,23L + +#define SN_id_GostR3410_2001DH "id-GostR3410-2001DH" +#define LN_id_GostR3410_2001DH "GOST R 34.10-2001 DH" +#define NID_id_GostR3410_2001DH 817 +#define OBJ_id_GostR3410_2001DH OBJ_cryptopro,98L + +#define SN_id_GostR3410_94DH "id-GostR3410-94DH" +#define LN_id_GostR3410_94DH "GOST R 34.10-94 DH" +#define NID_id_GostR3410_94DH 818 +#define OBJ_id_GostR3410_94DH OBJ_cryptopro,99L + +#define SN_id_Gost28147_89_CryptoPro_KeyMeshing "id-Gost28147-89-CryptoPro-KeyMeshing" +#define NID_id_Gost28147_89_CryptoPro_KeyMeshing 819 +#define OBJ_id_Gost28147_89_CryptoPro_KeyMeshing OBJ_cryptopro,14L,1L + +#define SN_id_Gost28147_89_None_KeyMeshing "id-Gost28147-89-None-KeyMeshing" +#define NID_id_Gost28147_89_None_KeyMeshing 820 +#define OBJ_id_Gost28147_89_None_KeyMeshing OBJ_cryptopro,14L,0L + +#define SN_id_GostR3411_94_TestParamSet "id-GostR3411-94-TestParamSet" +#define NID_id_GostR3411_94_TestParamSet 821 +#define OBJ_id_GostR3411_94_TestParamSet OBJ_cryptopro,30L,0L + +#define SN_id_GostR3411_94_CryptoProParamSet "id-GostR3411-94-CryptoProParamSet" +#define NID_id_GostR3411_94_CryptoProParamSet 822 +#define OBJ_id_GostR3411_94_CryptoProParamSet OBJ_cryptopro,30L,1L + +#define SN_id_Gost28147_89_TestParamSet "id-Gost28147-89-TestParamSet" +#define NID_id_Gost28147_89_TestParamSet 823 +#define OBJ_id_Gost28147_89_TestParamSet OBJ_cryptopro,31L,0L + +#define SN_id_Gost28147_89_CryptoPro_A_ParamSet "id-Gost28147-89-CryptoPro-A-ParamSet" +#define NID_id_Gost28147_89_CryptoPro_A_ParamSet 824 +#define OBJ_id_Gost28147_89_CryptoPro_A_ParamSet OBJ_cryptopro,31L,1L + +#define SN_id_Gost28147_89_CryptoPro_B_ParamSet "id-Gost28147-89-CryptoPro-B-ParamSet" +#define NID_id_Gost28147_89_CryptoPro_B_ParamSet 825 +#define OBJ_id_Gost28147_89_CryptoPro_B_ParamSet OBJ_cryptopro,31L,2L + +#define SN_id_Gost28147_89_CryptoPro_C_ParamSet "id-Gost28147-89-CryptoPro-C-ParamSet" +#define NID_id_Gost28147_89_CryptoPro_C_ParamSet 826 +#define OBJ_id_Gost28147_89_CryptoPro_C_ParamSet OBJ_cryptopro,31L,3L + +#define SN_id_Gost28147_89_CryptoPro_D_ParamSet "id-Gost28147-89-CryptoPro-D-ParamSet" +#define NID_id_Gost28147_89_CryptoPro_D_ParamSet 827 +#define OBJ_id_Gost28147_89_CryptoPro_D_ParamSet OBJ_cryptopro,31L,4L + +#define SN_id_Gost28147_89_CryptoPro_Oscar_1_1_ParamSet "id-Gost28147-89-CryptoPro-Oscar-1-1-ParamSet" +#define NID_id_Gost28147_89_CryptoPro_Oscar_1_1_ParamSet 828 +#define OBJ_id_Gost28147_89_CryptoPro_Oscar_1_1_ParamSet OBJ_cryptopro,31L,5L + +#define SN_id_Gost28147_89_CryptoPro_Oscar_1_0_ParamSet "id-Gost28147-89-CryptoPro-Oscar-1-0-ParamSet" +#define NID_id_Gost28147_89_CryptoPro_Oscar_1_0_ParamSet 829 +#define OBJ_id_Gost28147_89_CryptoPro_Oscar_1_0_ParamSet OBJ_cryptopro,31L,6L + +#define SN_id_Gost28147_89_CryptoPro_RIC_1_ParamSet "id-Gost28147-89-CryptoPro-RIC-1-ParamSet" +#define NID_id_Gost28147_89_CryptoPro_RIC_1_ParamSet 830 +#define OBJ_id_Gost28147_89_CryptoPro_RIC_1_ParamSet OBJ_cryptopro,31L,7L + +#define SN_id_GostR3410_94_TestParamSet "id-GostR3410-94-TestParamSet" +#define NID_id_GostR3410_94_TestParamSet 831 +#define OBJ_id_GostR3410_94_TestParamSet OBJ_cryptopro,32L,0L + +#define SN_id_GostR3410_94_CryptoPro_A_ParamSet "id-GostR3410-94-CryptoPro-A-ParamSet" +#define NID_id_GostR3410_94_CryptoPro_A_ParamSet 832 +#define OBJ_id_GostR3410_94_CryptoPro_A_ParamSet OBJ_cryptopro,32L,2L + +#define SN_id_GostR3410_94_CryptoPro_B_ParamSet "id-GostR3410-94-CryptoPro-B-ParamSet" +#define NID_id_GostR3410_94_CryptoPro_B_ParamSet 833 +#define OBJ_id_GostR3410_94_CryptoPro_B_ParamSet OBJ_cryptopro,32L,3L + +#define SN_id_GostR3410_94_CryptoPro_C_ParamSet "id-GostR3410-94-CryptoPro-C-ParamSet" +#define NID_id_GostR3410_94_CryptoPro_C_ParamSet 834 +#define OBJ_id_GostR3410_94_CryptoPro_C_ParamSet OBJ_cryptopro,32L,4L + +#define SN_id_GostR3410_94_CryptoPro_D_ParamSet "id-GostR3410-94-CryptoPro-D-ParamSet" +#define NID_id_GostR3410_94_CryptoPro_D_ParamSet 835 +#define OBJ_id_GostR3410_94_CryptoPro_D_ParamSet OBJ_cryptopro,32L,5L + +#define SN_id_GostR3410_94_CryptoPro_XchA_ParamSet "id-GostR3410-94-CryptoPro-XchA-ParamSet" +#define NID_id_GostR3410_94_CryptoPro_XchA_ParamSet 836 +#define OBJ_id_GostR3410_94_CryptoPro_XchA_ParamSet OBJ_cryptopro,33L,1L + +#define SN_id_GostR3410_94_CryptoPro_XchB_ParamSet "id-GostR3410-94-CryptoPro-XchB-ParamSet" +#define NID_id_GostR3410_94_CryptoPro_XchB_ParamSet 837 +#define OBJ_id_GostR3410_94_CryptoPro_XchB_ParamSet OBJ_cryptopro,33L,2L + +#define SN_id_GostR3410_94_CryptoPro_XchC_ParamSet "id-GostR3410-94-CryptoPro-XchC-ParamSet" +#define NID_id_GostR3410_94_CryptoPro_XchC_ParamSet 838 +#define OBJ_id_GostR3410_94_CryptoPro_XchC_ParamSet OBJ_cryptopro,33L,3L + +#define SN_id_GostR3410_2001_TestParamSet "id-GostR3410-2001-TestParamSet" +#define NID_id_GostR3410_2001_TestParamSet 839 +#define OBJ_id_GostR3410_2001_TestParamSet OBJ_cryptopro,35L,0L + +#define SN_id_GostR3410_2001_CryptoPro_A_ParamSet "id-GostR3410-2001-CryptoPro-A-ParamSet" +#define NID_id_GostR3410_2001_CryptoPro_A_ParamSet 840 +#define OBJ_id_GostR3410_2001_CryptoPro_A_ParamSet OBJ_cryptopro,35L,1L + +#define SN_id_GostR3410_2001_CryptoPro_B_ParamSet "id-GostR3410-2001-CryptoPro-B-ParamSet" +#define NID_id_GostR3410_2001_CryptoPro_B_ParamSet 841 +#define OBJ_id_GostR3410_2001_CryptoPro_B_ParamSet OBJ_cryptopro,35L,2L + +#define SN_id_GostR3410_2001_CryptoPro_C_ParamSet "id-GostR3410-2001-CryptoPro-C-ParamSet" +#define NID_id_GostR3410_2001_CryptoPro_C_ParamSet 842 +#define OBJ_id_GostR3410_2001_CryptoPro_C_ParamSet OBJ_cryptopro,35L,3L + +#define SN_id_GostR3410_2001_CryptoPro_XchA_ParamSet "id-GostR3410-2001-CryptoPro-XchA-ParamSet" +#define NID_id_GostR3410_2001_CryptoPro_XchA_ParamSet 843 +#define OBJ_id_GostR3410_2001_CryptoPro_XchA_ParamSet OBJ_cryptopro,36L,0L + +#define SN_id_GostR3410_2001_CryptoPro_XchB_ParamSet "id-GostR3410-2001-CryptoPro-XchB-ParamSet" +#define NID_id_GostR3410_2001_CryptoPro_XchB_ParamSet 844 +#define OBJ_id_GostR3410_2001_CryptoPro_XchB_ParamSet OBJ_cryptopro,36L,1L + +#define SN_id_GostR3410_94_a "id-GostR3410-94-a" +#define NID_id_GostR3410_94_a 845 +#define OBJ_id_GostR3410_94_a OBJ_id_GostR3410_94,1L + +#define SN_id_GostR3410_94_aBis "id-GostR3410-94-aBis" +#define NID_id_GostR3410_94_aBis 846 +#define OBJ_id_GostR3410_94_aBis OBJ_id_GostR3410_94,2L + +#define SN_id_GostR3410_94_b "id-GostR3410-94-b" +#define NID_id_GostR3410_94_b 847 +#define OBJ_id_GostR3410_94_b OBJ_id_GostR3410_94,3L + +#define SN_id_GostR3410_94_bBis "id-GostR3410-94-bBis" +#define NID_id_GostR3410_94_bBis 848 +#define OBJ_id_GostR3410_94_bBis OBJ_id_GostR3410_94,4L + +#define SN_id_Gost28147_89_cc "id-Gost28147-89-cc" +#define LN_id_Gost28147_89_cc "GOST 28147-89 Cryptocom ParamSet" +#define NID_id_Gost28147_89_cc 849 +#define OBJ_id_Gost28147_89_cc OBJ_cryptocom,1L,6L,1L + +#define SN_id_GostR3410_94_cc "gost94cc" +#define LN_id_GostR3410_94_cc "GOST 34.10-94 Cryptocom" +#define NID_id_GostR3410_94_cc 850 +#define OBJ_id_GostR3410_94_cc OBJ_cryptocom,1L,5L,3L + +#define SN_id_GostR3410_2001_cc "gost2001cc" +#define LN_id_GostR3410_2001_cc "GOST 34.10-2001 Cryptocom" +#define NID_id_GostR3410_2001_cc 851 +#define OBJ_id_GostR3410_2001_cc OBJ_cryptocom,1L,5L,4L + +#define SN_id_GostR3411_94_with_GostR3410_94_cc "id-GostR3411-94-with-GostR3410-94-cc" +#define LN_id_GostR3411_94_with_GostR3410_94_cc "GOST R 34.11-94 with GOST R 34.10-94 Cryptocom" +#define NID_id_GostR3411_94_with_GostR3410_94_cc 852 +#define OBJ_id_GostR3411_94_with_GostR3410_94_cc OBJ_cryptocom,1L,3L,3L + +#define SN_id_GostR3411_94_with_GostR3410_2001_cc "id-GostR3411-94-with-GostR3410-2001-cc" +#define LN_id_GostR3411_94_with_GostR3410_2001_cc "GOST R 34.11-94 with GOST R 34.10-2001 Cryptocom" +#define NID_id_GostR3411_94_with_GostR3410_2001_cc 853 +#define OBJ_id_GostR3411_94_with_GostR3410_2001_cc OBJ_cryptocom,1L,3L,4L + +#define SN_id_GostR3410_2001_ParamSet_cc "id-GostR3410-2001-ParamSet-cc" +#define LN_id_GostR3410_2001_ParamSet_cc "GOST R 3410-2001 Parameter Set Cryptocom" +#define NID_id_GostR3410_2001_ParamSet_cc 854 +#define OBJ_id_GostR3410_2001_ParamSet_cc OBJ_cryptocom,1L,8L,1L + +#define SN_camellia_128_cbc "CAMELLIA-128-CBC" +#define LN_camellia_128_cbc "camellia-128-cbc" +#define NID_camellia_128_cbc 751 +#define OBJ_camellia_128_cbc 1L,2L,392L,200011L,61L,1L,1L,1L,2L + +#define SN_camellia_192_cbc "CAMELLIA-192-CBC" +#define LN_camellia_192_cbc "camellia-192-cbc" +#define NID_camellia_192_cbc 752 +#define OBJ_camellia_192_cbc 1L,2L,392L,200011L,61L,1L,1L,1L,3L + +#define SN_camellia_256_cbc "CAMELLIA-256-CBC" +#define LN_camellia_256_cbc "camellia-256-cbc" +#define NID_camellia_256_cbc 753 +#define OBJ_camellia_256_cbc 1L,2L,392L,200011L,61L,1L,1L,1L,4L + +#define SN_id_camellia128_wrap "id-camellia128-wrap" +#define NID_id_camellia128_wrap 907 +#define OBJ_id_camellia128_wrap 1L,2L,392L,200011L,61L,1L,1L,3L,2L + +#define SN_id_camellia192_wrap "id-camellia192-wrap" +#define NID_id_camellia192_wrap 908 +#define OBJ_id_camellia192_wrap 1L,2L,392L,200011L,61L,1L,1L,3L,3L + +#define SN_id_camellia256_wrap "id-camellia256-wrap" +#define NID_id_camellia256_wrap 909 +#define OBJ_id_camellia256_wrap 1L,2L,392L,200011L,61L,1L,1L,3L,4L + +#define OBJ_ntt_ds 0L,3L,4401L,5L + +#define OBJ_camellia OBJ_ntt_ds,3L,1L,9L + +#define SN_camellia_128_ecb "CAMELLIA-128-ECB" +#define LN_camellia_128_ecb "camellia-128-ecb" +#define NID_camellia_128_ecb 754 +#define OBJ_camellia_128_ecb OBJ_camellia,1L + +#define SN_camellia_128_ofb128 "CAMELLIA-128-OFB" +#define LN_camellia_128_ofb128 "camellia-128-ofb" +#define NID_camellia_128_ofb128 766 +#define OBJ_camellia_128_ofb128 OBJ_camellia,3L + +#define SN_camellia_128_cfb128 "CAMELLIA-128-CFB" +#define LN_camellia_128_cfb128 "camellia-128-cfb" +#define NID_camellia_128_cfb128 757 +#define OBJ_camellia_128_cfb128 OBJ_camellia,4L + +#define SN_camellia_192_ecb "CAMELLIA-192-ECB" +#define LN_camellia_192_ecb "camellia-192-ecb" +#define NID_camellia_192_ecb 755 +#define OBJ_camellia_192_ecb OBJ_camellia,21L + +#define SN_camellia_192_ofb128 "CAMELLIA-192-OFB" +#define LN_camellia_192_ofb128 "camellia-192-ofb" +#define NID_camellia_192_ofb128 767 +#define OBJ_camellia_192_ofb128 OBJ_camellia,23L + +#define SN_camellia_192_cfb128 "CAMELLIA-192-CFB" +#define LN_camellia_192_cfb128 "camellia-192-cfb" +#define NID_camellia_192_cfb128 758 +#define OBJ_camellia_192_cfb128 OBJ_camellia,24L + +#define SN_camellia_256_ecb "CAMELLIA-256-ECB" +#define LN_camellia_256_ecb "camellia-256-ecb" +#define NID_camellia_256_ecb 756 +#define OBJ_camellia_256_ecb OBJ_camellia,41L + +#define SN_camellia_256_ofb128 "CAMELLIA-256-OFB" +#define LN_camellia_256_ofb128 "camellia-256-ofb" +#define NID_camellia_256_ofb128 768 +#define OBJ_camellia_256_ofb128 OBJ_camellia,43L + +#define SN_camellia_256_cfb128 "CAMELLIA-256-CFB" +#define LN_camellia_256_cfb128 "camellia-256-cfb" +#define NID_camellia_256_cfb128 759 +#define OBJ_camellia_256_cfb128 OBJ_camellia,44L + +#define SN_camellia_128_cfb1 "CAMELLIA-128-CFB1" +#define LN_camellia_128_cfb1 "camellia-128-cfb1" +#define NID_camellia_128_cfb1 760 + +#define SN_camellia_192_cfb1 "CAMELLIA-192-CFB1" +#define LN_camellia_192_cfb1 "camellia-192-cfb1" +#define NID_camellia_192_cfb1 761 + +#define SN_camellia_256_cfb1 "CAMELLIA-256-CFB1" +#define LN_camellia_256_cfb1 "camellia-256-cfb1" +#define NID_camellia_256_cfb1 762 + +#define SN_camellia_128_cfb8 "CAMELLIA-128-CFB8" +#define LN_camellia_128_cfb8 "camellia-128-cfb8" +#define NID_camellia_128_cfb8 763 + +#define SN_camellia_192_cfb8 "CAMELLIA-192-CFB8" +#define LN_camellia_192_cfb8 "camellia-192-cfb8" +#define NID_camellia_192_cfb8 764 + +#define SN_camellia_256_cfb8 "CAMELLIA-256-CFB8" +#define LN_camellia_256_cfb8 "camellia-256-cfb8" +#define NID_camellia_256_cfb8 765 + +#define SN_kisa "KISA" +#define LN_kisa "kisa" +#define NID_kisa 773 +#define OBJ_kisa OBJ_member_body,410L,200004L + +#define SN_seed_ecb "SEED-ECB" +#define LN_seed_ecb "seed-ecb" +#define NID_seed_ecb 776 +#define OBJ_seed_ecb OBJ_kisa,1L,3L + +#define SN_seed_cbc "SEED-CBC" +#define LN_seed_cbc "seed-cbc" +#define NID_seed_cbc 777 +#define OBJ_seed_cbc OBJ_kisa,1L,4L + +#define SN_seed_cfb128 "SEED-CFB" +#define LN_seed_cfb128 "seed-cfb" +#define NID_seed_cfb128 779 +#define OBJ_seed_cfb128 OBJ_kisa,1L,5L + +#define SN_seed_ofb128 "SEED-OFB" +#define LN_seed_ofb128 "seed-ofb" +#define NID_seed_ofb128 778 +#define OBJ_seed_ofb128 OBJ_kisa,1L,6L + +#define SN_hmac "HMAC" +#define LN_hmac "hmac" +#define NID_hmac 855 + +#define SN_cmac "CMAC" +#define LN_cmac "cmac" +#define NID_cmac 894 + +#define SN_rc4_hmac_md5 "RC4-HMAC-MD5" +#define LN_rc4_hmac_md5 "rc4-hmac-md5" +#define NID_rc4_hmac_md5 915 + +#define SN_aes_128_cbc_hmac_sha1 "AES-128-CBC-HMAC-SHA1" +#define LN_aes_128_cbc_hmac_sha1 "aes-128-cbc-hmac-sha1" +#define NID_aes_128_cbc_hmac_sha1 916 + +#define SN_aes_192_cbc_hmac_sha1 "AES-192-CBC-HMAC-SHA1" +#define LN_aes_192_cbc_hmac_sha1 "aes-192-cbc-hmac-sha1" +#define NID_aes_192_cbc_hmac_sha1 917 + +#define SN_aes_256_cbc_hmac_sha1 "AES-256-CBC-HMAC-SHA1" +#define LN_aes_256_cbc_hmac_sha1 "aes-256-cbc-hmac-sha1" +#define NID_aes_256_cbc_hmac_sha1 918 + diff --git a/Source/Import/OpenSSL/Include/openssl/objects.h b/Source/Import/OpenSSL/Include/openssl/objects.h new file mode 100644 index 0000000..bd0ee52 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/objects.h @@ -0,0 +1,1138 @@ +/* crypto/objects/objects.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_OBJECTS_H +#define HEADER_OBJECTS_H + +#define USE_OBJ_MAC + +#ifdef USE_OBJ_MAC +#include +#else +#define SN_undef "UNDEF" +#define LN_undef "undefined" +#define NID_undef 0 +#define OBJ_undef 0L + +#define SN_Algorithm "Algorithm" +#define LN_algorithm "algorithm" +#define NID_algorithm 38 +#define OBJ_algorithm 1L,3L,14L,3L,2L + +#define LN_rsadsi "rsadsi" +#define NID_rsadsi 1 +#define OBJ_rsadsi 1L,2L,840L,113549L + +#define LN_pkcs "pkcs" +#define NID_pkcs 2 +#define OBJ_pkcs OBJ_rsadsi,1L + +#define SN_md2 "MD2" +#define LN_md2 "md2" +#define NID_md2 3 +#define OBJ_md2 OBJ_rsadsi,2L,2L + +#define SN_md5 "MD5" +#define LN_md5 "md5" +#define NID_md5 4 +#define OBJ_md5 OBJ_rsadsi,2L,5L + +#define SN_rc4 "RC4" +#define LN_rc4 "rc4" +#define NID_rc4 5 +#define OBJ_rc4 OBJ_rsadsi,3L,4L + +#define LN_rsaEncryption "rsaEncryption" +#define NID_rsaEncryption 6 +#define OBJ_rsaEncryption OBJ_pkcs,1L,1L + +#define SN_md2WithRSAEncryption "RSA-MD2" +#define LN_md2WithRSAEncryption "md2WithRSAEncryption" +#define NID_md2WithRSAEncryption 7 +#define OBJ_md2WithRSAEncryption OBJ_pkcs,1L,2L + +#define SN_md5WithRSAEncryption "RSA-MD5" +#define LN_md5WithRSAEncryption "md5WithRSAEncryption" +#define NID_md5WithRSAEncryption 8 +#define OBJ_md5WithRSAEncryption OBJ_pkcs,1L,4L + +#define SN_pbeWithMD2AndDES_CBC "PBE-MD2-DES" +#define LN_pbeWithMD2AndDES_CBC "pbeWithMD2AndDES-CBC" +#define NID_pbeWithMD2AndDES_CBC 9 +#define OBJ_pbeWithMD2AndDES_CBC OBJ_pkcs,5L,1L + +#define SN_pbeWithMD5AndDES_CBC "PBE-MD5-DES" +#define LN_pbeWithMD5AndDES_CBC "pbeWithMD5AndDES-CBC" +#define NID_pbeWithMD5AndDES_CBC 10 +#define OBJ_pbeWithMD5AndDES_CBC OBJ_pkcs,5L,3L + +#define LN_X500 "X500" +#define NID_X500 11 +#define OBJ_X500 2L,5L + +#define LN_X509 "X509" +#define NID_X509 12 +#define OBJ_X509 OBJ_X500,4L + +#define SN_commonName "CN" +#define LN_commonName "commonName" +#define NID_commonName 13 +#define OBJ_commonName OBJ_X509,3L + +#define SN_countryName "C" +#define LN_countryName "countryName" +#define NID_countryName 14 +#define OBJ_countryName OBJ_X509,6L + +#define SN_localityName "L" +#define LN_localityName "localityName" +#define NID_localityName 15 +#define OBJ_localityName OBJ_X509,7L + +/* Postal Address? PA */ + +/* should be "ST" (rfc1327) but MS uses 'S' */ +#define SN_stateOrProvinceName "ST" +#define LN_stateOrProvinceName "stateOrProvinceName" +#define NID_stateOrProvinceName 16 +#define OBJ_stateOrProvinceName OBJ_X509,8L + +#define SN_organizationName "O" +#define LN_organizationName "organizationName" +#define NID_organizationName 17 +#define OBJ_organizationName OBJ_X509,10L + +#define SN_organizationalUnitName "OU" +#define LN_organizationalUnitName "organizationalUnitName" +#define NID_organizationalUnitName 18 +#define OBJ_organizationalUnitName OBJ_X509,11L + +#define SN_rsa "RSA" +#define LN_rsa "rsa" +#define NID_rsa 19 +#define OBJ_rsa OBJ_X500,8L,1L,1L + +#define LN_pkcs7 "pkcs7" +#define NID_pkcs7 20 +#define OBJ_pkcs7 OBJ_pkcs,7L + +#define LN_pkcs7_data "pkcs7-data" +#define NID_pkcs7_data 21 +#define OBJ_pkcs7_data OBJ_pkcs7,1L + +#define LN_pkcs7_signed "pkcs7-signedData" +#define NID_pkcs7_signed 22 +#define OBJ_pkcs7_signed OBJ_pkcs7,2L + +#define LN_pkcs7_enveloped "pkcs7-envelopedData" +#define NID_pkcs7_enveloped 23 +#define OBJ_pkcs7_enveloped OBJ_pkcs7,3L + +#define LN_pkcs7_signedAndEnveloped "pkcs7-signedAndEnvelopedData" +#define NID_pkcs7_signedAndEnveloped 24 +#define OBJ_pkcs7_signedAndEnveloped OBJ_pkcs7,4L + +#define LN_pkcs7_digest "pkcs7-digestData" +#define NID_pkcs7_digest 25 +#define OBJ_pkcs7_digest OBJ_pkcs7,5L + +#define LN_pkcs7_encrypted "pkcs7-encryptedData" +#define NID_pkcs7_encrypted 26 +#define OBJ_pkcs7_encrypted OBJ_pkcs7,6L + +#define LN_pkcs3 "pkcs3" +#define NID_pkcs3 27 +#define OBJ_pkcs3 OBJ_pkcs,3L + +#define LN_dhKeyAgreement "dhKeyAgreement" +#define NID_dhKeyAgreement 28 +#define OBJ_dhKeyAgreement OBJ_pkcs3,1L + +#define SN_des_ecb "DES-ECB" +#define LN_des_ecb "des-ecb" +#define NID_des_ecb 29 +#define OBJ_des_ecb OBJ_algorithm,6L + +#define SN_des_cfb64 "DES-CFB" +#define LN_des_cfb64 "des-cfb" +#define NID_des_cfb64 30 +/* IV + num */ +#define OBJ_des_cfb64 OBJ_algorithm,9L + +#define SN_des_cbc "DES-CBC" +#define LN_des_cbc "des-cbc" +#define NID_des_cbc 31 +/* IV */ +#define OBJ_des_cbc OBJ_algorithm,7L + +#define SN_des_ede "DES-EDE" +#define LN_des_ede "des-ede" +#define NID_des_ede 32 +/* ?? */ +#define OBJ_des_ede OBJ_algorithm,17L + +#define SN_des_ede3 "DES-EDE3" +#define LN_des_ede3 "des-ede3" +#define NID_des_ede3 33 + +#define SN_idea_cbc "IDEA-CBC" +#define LN_idea_cbc "idea-cbc" +#define NID_idea_cbc 34 +#define OBJ_idea_cbc 1L,3L,6L,1L,4L,1L,188L,7L,1L,1L,2L + +#define SN_idea_cfb64 "IDEA-CFB" +#define LN_idea_cfb64 "idea-cfb" +#define NID_idea_cfb64 35 + +#define SN_idea_ecb "IDEA-ECB" +#define LN_idea_ecb "idea-ecb" +#define NID_idea_ecb 36 + +#define SN_rc2_cbc "RC2-CBC" +#define LN_rc2_cbc "rc2-cbc" +#define NID_rc2_cbc 37 +#define OBJ_rc2_cbc OBJ_rsadsi,3L,2L + +#define SN_rc2_ecb "RC2-ECB" +#define LN_rc2_ecb "rc2-ecb" +#define NID_rc2_ecb 38 + +#define SN_rc2_cfb64 "RC2-CFB" +#define LN_rc2_cfb64 "rc2-cfb" +#define NID_rc2_cfb64 39 + +#define SN_rc2_ofb64 "RC2-OFB" +#define LN_rc2_ofb64 "rc2-ofb" +#define NID_rc2_ofb64 40 + +#define SN_sha "SHA" +#define LN_sha "sha" +#define NID_sha 41 +#define OBJ_sha OBJ_algorithm,18L + +#define SN_shaWithRSAEncryption "RSA-SHA" +#define LN_shaWithRSAEncryption "shaWithRSAEncryption" +#define NID_shaWithRSAEncryption 42 +#define OBJ_shaWithRSAEncryption OBJ_algorithm,15L + +#define SN_des_ede_cbc "DES-EDE-CBC" +#define LN_des_ede_cbc "des-ede-cbc" +#define NID_des_ede_cbc 43 + +#define SN_des_ede3_cbc "DES-EDE3-CBC" +#define LN_des_ede3_cbc "des-ede3-cbc" +#define NID_des_ede3_cbc 44 +#define OBJ_des_ede3_cbc OBJ_rsadsi,3L,7L + +#define SN_des_ofb64 "DES-OFB" +#define LN_des_ofb64 "des-ofb" +#define NID_des_ofb64 45 +#define OBJ_des_ofb64 OBJ_algorithm,8L + +#define SN_idea_ofb64 "IDEA-OFB" +#define LN_idea_ofb64 "idea-ofb" +#define NID_idea_ofb64 46 + +#define LN_pkcs9 "pkcs9" +#define NID_pkcs9 47 +#define OBJ_pkcs9 OBJ_pkcs,9L + +#define SN_pkcs9_emailAddress "Email" +#define LN_pkcs9_emailAddress "emailAddress" +#define NID_pkcs9_emailAddress 48 +#define OBJ_pkcs9_emailAddress OBJ_pkcs9,1L + +#define LN_pkcs9_unstructuredName "unstructuredName" +#define NID_pkcs9_unstructuredName 49 +#define OBJ_pkcs9_unstructuredName OBJ_pkcs9,2L + +#define LN_pkcs9_contentType "contentType" +#define NID_pkcs9_contentType 50 +#define OBJ_pkcs9_contentType OBJ_pkcs9,3L + +#define LN_pkcs9_messageDigest "messageDigest" +#define NID_pkcs9_messageDigest 51 +#define OBJ_pkcs9_messageDigest OBJ_pkcs9,4L + +#define LN_pkcs9_signingTime "signingTime" +#define NID_pkcs9_signingTime 52 +#define OBJ_pkcs9_signingTime OBJ_pkcs9,5L + +#define LN_pkcs9_countersignature "countersignature" +#define NID_pkcs9_countersignature 53 +#define OBJ_pkcs9_countersignature OBJ_pkcs9,6L + +#define LN_pkcs9_challengePassword "challengePassword" +#define NID_pkcs9_challengePassword 54 +#define OBJ_pkcs9_challengePassword OBJ_pkcs9,7L + +#define LN_pkcs9_unstructuredAddress "unstructuredAddress" +#define NID_pkcs9_unstructuredAddress 55 +#define OBJ_pkcs9_unstructuredAddress OBJ_pkcs9,8L + +#define LN_pkcs9_extCertAttributes "extendedCertificateAttributes" +#define NID_pkcs9_extCertAttributes 56 +#define OBJ_pkcs9_extCertAttributes OBJ_pkcs9,9L + +#define SN_netscape "Netscape" +#define LN_netscape "Netscape Communications Corp." +#define NID_netscape 57 +#define OBJ_netscape 2L,16L,840L,1L,113730L + +#define SN_netscape_cert_extension "nsCertExt" +#define LN_netscape_cert_extension "Netscape Certificate Extension" +#define NID_netscape_cert_extension 58 +#define OBJ_netscape_cert_extension OBJ_netscape,1L + +#define SN_netscape_data_type "nsDataType" +#define LN_netscape_data_type "Netscape Data Type" +#define NID_netscape_data_type 59 +#define OBJ_netscape_data_type OBJ_netscape,2L + +#define SN_des_ede_cfb64 "DES-EDE-CFB" +#define LN_des_ede_cfb64 "des-ede-cfb" +#define NID_des_ede_cfb64 60 + +#define SN_des_ede3_cfb64 "DES-EDE3-CFB" +#define LN_des_ede3_cfb64 "des-ede3-cfb" +#define NID_des_ede3_cfb64 61 + +#define SN_des_ede_ofb64 "DES-EDE-OFB" +#define LN_des_ede_ofb64 "des-ede-ofb" +#define NID_des_ede_ofb64 62 + +#define SN_des_ede3_ofb64 "DES-EDE3-OFB" +#define LN_des_ede3_ofb64 "des-ede3-ofb" +#define NID_des_ede3_ofb64 63 + +/* I'm not sure about the object ID */ +#define SN_sha1 "SHA1" +#define LN_sha1 "sha1" +#define NID_sha1 64 +#define OBJ_sha1 OBJ_algorithm,26L +/* 28 Jun 1996 - eay */ +/* #define OBJ_sha1 1L,3L,14L,2L,26L,05L <- wrong */ + +#define SN_sha1WithRSAEncryption "RSA-SHA1" +#define LN_sha1WithRSAEncryption "sha1WithRSAEncryption" +#define NID_sha1WithRSAEncryption 65 +#define OBJ_sha1WithRSAEncryption OBJ_pkcs,1L,5L + +#define SN_dsaWithSHA "DSA-SHA" +#define LN_dsaWithSHA "dsaWithSHA" +#define NID_dsaWithSHA 66 +#define OBJ_dsaWithSHA OBJ_algorithm,13L + +#define SN_dsa_2 "DSA-old" +#define LN_dsa_2 "dsaEncryption-old" +#define NID_dsa_2 67 +#define OBJ_dsa_2 OBJ_algorithm,12L + +/* proposed by microsoft to RSA */ +#define SN_pbeWithSHA1AndRC2_CBC "PBE-SHA1-RC2-64" +#define LN_pbeWithSHA1AndRC2_CBC "pbeWithSHA1AndRC2-CBC" +#define NID_pbeWithSHA1AndRC2_CBC 68 +#define OBJ_pbeWithSHA1AndRC2_CBC OBJ_pkcs,5L,11L + +/* proposed by microsoft to RSA as pbeWithSHA1AndRC4: it is now + * defined explicitly in PKCS#5 v2.0 as id-PBKDF2 which is something + * completely different. + */ +#define LN_id_pbkdf2 "PBKDF2" +#define NID_id_pbkdf2 69 +#define OBJ_id_pbkdf2 OBJ_pkcs,5L,12L + +#define SN_dsaWithSHA1_2 "DSA-SHA1-old" +#define LN_dsaWithSHA1_2 "dsaWithSHA1-old" +#define NID_dsaWithSHA1_2 70 +/* Got this one from 'sdn706r20.pdf' which is actually an NSA document :-) */ +#define OBJ_dsaWithSHA1_2 OBJ_algorithm,27L + +#define SN_netscape_cert_type "nsCertType" +#define LN_netscape_cert_type "Netscape Cert Type" +#define NID_netscape_cert_type 71 +#define OBJ_netscape_cert_type OBJ_netscape_cert_extension,1L + +#define SN_netscape_base_url "nsBaseUrl" +#define LN_netscape_base_url "Netscape Base Url" +#define NID_netscape_base_url 72 +#define OBJ_netscape_base_url OBJ_netscape_cert_extension,2L + +#define SN_netscape_revocation_url "nsRevocationUrl" +#define LN_netscape_revocation_url "Netscape Revocation Url" +#define NID_netscape_revocation_url 73 +#define OBJ_netscape_revocation_url OBJ_netscape_cert_extension,3L + +#define SN_netscape_ca_revocation_url "nsCaRevocationUrl" +#define LN_netscape_ca_revocation_url "Netscape CA Revocation Url" +#define NID_netscape_ca_revocation_url 74 +#define OBJ_netscape_ca_revocation_url OBJ_netscape_cert_extension,4L + +#define SN_netscape_renewal_url "nsRenewalUrl" +#define LN_netscape_renewal_url "Netscape Renewal Url" +#define NID_netscape_renewal_url 75 +#define OBJ_netscape_renewal_url OBJ_netscape_cert_extension,7L + +#define SN_netscape_ca_policy_url "nsCaPolicyUrl" +#define LN_netscape_ca_policy_url "Netscape CA Policy Url" +#define NID_netscape_ca_policy_url 76 +#define OBJ_netscape_ca_policy_url OBJ_netscape_cert_extension,8L + +#define SN_netscape_ssl_server_name "nsSslServerName" +#define LN_netscape_ssl_server_name "Netscape SSL Server Name" +#define NID_netscape_ssl_server_name 77 +#define OBJ_netscape_ssl_server_name OBJ_netscape_cert_extension,12L + +#define SN_netscape_comment "nsComment" +#define LN_netscape_comment "Netscape Comment" +#define NID_netscape_comment 78 +#define OBJ_netscape_comment OBJ_netscape_cert_extension,13L + +#define SN_netscape_cert_sequence "nsCertSequence" +#define LN_netscape_cert_sequence "Netscape Certificate Sequence" +#define NID_netscape_cert_sequence 79 +#define OBJ_netscape_cert_sequence OBJ_netscape_data_type,5L + +#define SN_desx_cbc "DESX-CBC" +#define LN_desx_cbc "desx-cbc" +#define NID_desx_cbc 80 + +#define SN_id_ce "id-ce" +#define NID_id_ce 81 +#define OBJ_id_ce 2L,5L,29L + +#define SN_subject_key_identifier "subjectKeyIdentifier" +#define LN_subject_key_identifier "X509v3 Subject Key Identifier" +#define NID_subject_key_identifier 82 +#define OBJ_subject_key_identifier OBJ_id_ce,14L + +#define SN_key_usage "keyUsage" +#define LN_key_usage "X509v3 Key Usage" +#define NID_key_usage 83 +#define OBJ_key_usage OBJ_id_ce,15L + +#define SN_private_key_usage_period "privateKeyUsagePeriod" +#define LN_private_key_usage_period "X509v3 Private Key Usage Period" +#define NID_private_key_usage_period 84 +#define OBJ_private_key_usage_period OBJ_id_ce,16L + +#define SN_subject_alt_name "subjectAltName" +#define LN_subject_alt_name "X509v3 Subject Alternative Name" +#define NID_subject_alt_name 85 +#define OBJ_subject_alt_name OBJ_id_ce,17L + +#define SN_issuer_alt_name "issuerAltName" +#define LN_issuer_alt_name "X509v3 Issuer Alternative Name" +#define NID_issuer_alt_name 86 +#define OBJ_issuer_alt_name OBJ_id_ce,18L + +#define SN_basic_constraints "basicConstraints" +#define LN_basic_constraints "X509v3 Basic Constraints" +#define NID_basic_constraints 87 +#define OBJ_basic_constraints OBJ_id_ce,19L + +#define SN_crl_number "crlNumber" +#define LN_crl_number "X509v3 CRL Number" +#define NID_crl_number 88 +#define OBJ_crl_number OBJ_id_ce,20L + +#define SN_certificate_policies "certificatePolicies" +#define LN_certificate_policies "X509v3 Certificate Policies" +#define NID_certificate_policies 89 +#define OBJ_certificate_policies OBJ_id_ce,32L + +#define SN_authority_key_identifier "authorityKeyIdentifier" +#define LN_authority_key_identifier "X509v3 Authority Key Identifier" +#define NID_authority_key_identifier 90 +#define OBJ_authority_key_identifier OBJ_id_ce,35L + +#define SN_bf_cbc "BF-CBC" +#define LN_bf_cbc "bf-cbc" +#define NID_bf_cbc 91 +#define OBJ_bf_cbc 1L,3L,6L,1L,4L,1L,3029L,1L,2L + +#define SN_bf_ecb "BF-ECB" +#define LN_bf_ecb "bf-ecb" +#define NID_bf_ecb 92 + +#define SN_bf_cfb64 "BF-CFB" +#define LN_bf_cfb64 "bf-cfb" +#define NID_bf_cfb64 93 + +#define SN_bf_ofb64 "BF-OFB" +#define LN_bf_ofb64 "bf-ofb" +#define NID_bf_ofb64 94 + +#define SN_mdc2 "MDC2" +#define LN_mdc2 "mdc2" +#define NID_mdc2 95 +#define OBJ_mdc2 2L,5L,8L,3L,101L +/* An alternative? 1L,3L,14L,3L,2L,19L */ + +#define SN_mdc2WithRSA "RSA-MDC2" +#define LN_mdc2WithRSA "mdc2withRSA" +#define NID_mdc2WithRSA 96 +#define OBJ_mdc2WithRSA 2L,5L,8L,3L,100L + +#define SN_rc4_40 "RC4-40" +#define LN_rc4_40 "rc4-40" +#define NID_rc4_40 97 + +#define SN_rc2_40_cbc "RC2-40-CBC" +#define LN_rc2_40_cbc "rc2-40-cbc" +#define NID_rc2_40_cbc 98 + +#define SN_givenName "G" +#define LN_givenName "givenName" +#define NID_givenName 99 +#define OBJ_givenName OBJ_X509,42L + +#define SN_surname "S" +#define LN_surname "surname" +#define NID_surname 100 +#define OBJ_surname OBJ_X509,4L + +#define SN_initials "I" +#define LN_initials "initials" +#define NID_initials 101 +#define OBJ_initials OBJ_X509,43L + +#define SN_uniqueIdentifier "UID" +#define LN_uniqueIdentifier "uniqueIdentifier" +#define NID_uniqueIdentifier 102 +#define OBJ_uniqueIdentifier OBJ_X509,45L + +#define SN_crl_distribution_points "crlDistributionPoints" +#define LN_crl_distribution_points "X509v3 CRL Distribution Points" +#define NID_crl_distribution_points 103 +#define OBJ_crl_distribution_points OBJ_id_ce,31L + +#define SN_md5WithRSA "RSA-NP-MD5" +#define LN_md5WithRSA "md5WithRSA" +#define NID_md5WithRSA 104 +#define OBJ_md5WithRSA OBJ_algorithm,3L + +#define SN_serialNumber "SN" +#define LN_serialNumber "serialNumber" +#define NID_serialNumber 105 +#define OBJ_serialNumber OBJ_X509,5L + +#define SN_title "T" +#define LN_title "title" +#define NID_title 106 +#define OBJ_title OBJ_X509,12L + +#define SN_description "D" +#define LN_description "description" +#define NID_description 107 +#define OBJ_description OBJ_X509,13L + +/* CAST5 is CAST-128, I'm just sticking with the documentation */ +#define SN_cast5_cbc "CAST5-CBC" +#define LN_cast5_cbc "cast5-cbc" +#define NID_cast5_cbc 108 +#define OBJ_cast5_cbc 1L,2L,840L,113533L,7L,66L,10L + +#define SN_cast5_ecb "CAST5-ECB" +#define LN_cast5_ecb "cast5-ecb" +#define NID_cast5_ecb 109 + +#define SN_cast5_cfb64 "CAST5-CFB" +#define LN_cast5_cfb64 "cast5-cfb" +#define NID_cast5_cfb64 110 + +#define SN_cast5_ofb64 "CAST5-OFB" +#define LN_cast5_ofb64 "cast5-ofb" +#define NID_cast5_ofb64 111 + +#define LN_pbeWithMD5AndCast5_CBC "pbeWithMD5AndCast5CBC" +#define NID_pbeWithMD5AndCast5_CBC 112 +#define OBJ_pbeWithMD5AndCast5_CBC 1L,2L,840L,113533L,7L,66L,12L + +/* This is one sun will soon be using :-( + * id-dsa-with-sha1 ID ::= { + * iso(1) member-body(2) us(840) x9-57 (10040) x9cm(4) 3 } + */ +#define SN_dsaWithSHA1 "DSA-SHA1" +#define LN_dsaWithSHA1 "dsaWithSHA1" +#define NID_dsaWithSHA1 113 +#define OBJ_dsaWithSHA1 1L,2L,840L,10040L,4L,3L + +#define NID_md5_sha1 114 +#define SN_md5_sha1 "MD5-SHA1" +#define LN_md5_sha1 "md5-sha1" + +#define SN_sha1WithRSA "RSA-SHA1-2" +#define LN_sha1WithRSA "sha1WithRSA" +#define NID_sha1WithRSA 115 +#define OBJ_sha1WithRSA OBJ_algorithm,29L + +#define SN_dsa "DSA" +#define LN_dsa "dsaEncryption" +#define NID_dsa 116 +#define OBJ_dsa 1L,2L,840L,10040L,4L,1L + +#define SN_ripemd160 "RIPEMD160" +#define LN_ripemd160 "ripemd160" +#define NID_ripemd160 117 +#define OBJ_ripemd160 1L,3L,36L,3L,2L,1L + +/* The name should actually be rsaSignatureWithripemd160, but I'm going + * to continue using the convention I'm using with the other ciphers */ +#define SN_ripemd160WithRSA "RSA-RIPEMD160" +#define LN_ripemd160WithRSA "ripemd160WithRSA" +#define NID_ripemd160WithRSA 119 +#define OBJ_ripemd160WithRSA 1L,3L,36L,3L,3L,1L,2L + +/* Taken from rfc2040 + * RC5_CBC_Parameters ::= SEQUENCE { + * version INTEGER (v1_0(16)), + * rounds INTEGER (8..127), + * blockSizeInBits INTEGER (64, 128), + * iv OCTET STRING OPTIONAL + * } + */ +#define SN_rc5_cbc "RC5-CBC" +#define LN_rc5_cbc "rc5-cbc" +#define NID_rc5_cbc 120 +#define OBJ_rc5_cbc OBJ_rsadsi,3L,8L + +#define SN_rc5_ecb "RC5-ECB" +#define LN_rc5_ecb "rc5-ecb" +#define NID_rc5_ecb 121 + +#define SN_rc5_cfb64 "RC5-CFB" +#define LN_rc5_cfb64 "rc5-cfb" +#define NID_rc5_cfb64 122 + +#define SN_rc5_ofb64 "RC5-OFB" +#define LN_rc5_ofb64 "rc5-ofb" +#define NID_rc5_ofb64 123 + +#define SN_rle_compression "RLE" +#define LN_rle_compression "run length compression" +#define NID_rle_compression 124 +#define OBJ_rle_compression 1L,1L,1L,1L,666L,1L + +#define SN_zlib_compression "ZLIB" +#define LN_zlib_compression "zlib compression" +#define NID_zlib_compression 125 +#define OBJ_zlib_compression 1L,1L,1L,1L,666L,2L + +#define SN_ext_key_usage "extendedKeyUsage" +#define LN_ext_key_usage "X509v3 Extended Key Usage" +#define NID_ext_key_usage 126 +#define OBJ_ext_key_usage OBJ_id_ce,37 + +#define SN_id_pkix "PKIX" +#define NID_id_pkix 127 +#define OBJ_id_pkix 1L,3L,6L,1L,5L,5L,7L + +#define SN_id_kp "id-kp" +#define NID_id_kp 128 +#define OBJ_id_kp OBJ_id_pkix,3L + +/* PKIX extended key usage OIDs */ + +#define SN_server_auth "serverAuth" +#define LN_server_auth "TLS Web Server Authentication" +#define NID_server_auth 129 +#define OBJ_server_auth OBJ_id_kp,1L + +#define SN_client_auth "clientAuth" +#define LN_client_auth "TLS Web Client Authentication" +#define NID_client_auth 130 +#define OBJ_client_auth OBJ_id_kp,2L + +#define SN_code_sign "codeSigning" +#define LN_code_sign "Code Signing" +#define NID_code_sign 131 +#define OBJ_code_sign OBJ_id_kp,3L + +#define SN_email_protect "emailProtection" +#define LN_email_protect "E-mail Protection" +#define NID_email_protect 132 +#define OBJ_email_protect OBJ_id_kp,4L + +#define SN_time_stamp "timeStamping" +#define LN_time_stamp "Time Stamping" +#define NID_time_stamp 133 +#define OBJ_time_stamp OBJ_id_kp,8L + +/* Additional extended key usage OIDs: Microsoft */ + +#define SN_ms_code_ind "msCodeInd" +#define LN_ms_code_ind "Microsoft Individual Code Signing" +#define NID_ms_code_ind 134 +#define OBJ_ms_code_ind 1L,3L,6L,1L,4L,1L,311L,2L,1L,21L + +#define SN_ms_code_com "msCodeCom" +#define LN_ms_code_com "Microsoft Commercial Code Signing" +#define NID_ms_code_com 135 +#define OBJ_ms_code_com 1L,3L,6L,1L,4L,1L,311L,2L,1L,22L + +#define SN_ms_ctl_sign "msCTLSign" +#define LN_ms_ctl_sign "Microsoft Trust List Signing" +#define NID_ms_ctl_sign 136 +#define OBJ_ms_ctl_sign 1L,3L,6L,1L,4L,1L,311L,10L,3L,1L + +#define SN_ms_sgc "msSGC" +#define LN_ms_sgc "Microsoft Server Gated Crypto" +#define NID_ms_sgc 137 +#define OBJ_ms_sgc 1L,3L,6L,1L,4L,1L,311L,10L,3L,3L + +#define SN_ms_efs "msEFS" +#define LN_ms_efs "Microsoft Encrypted File System" +#define NID_ms_efs 138 +#define OBJ_ms_efs 1L,3L,6L,1L,4L,1L,311L,10L,3L,4L + +/* Additional usage: Netscape */ + +#define SN_ns_sgc "nsSGC" +#define LN_ns_sgc "Netscape Server Gated Crypto" +#define NID_ns_sgc 139 +#define OBJ_ns_sgc OBJ_netscape,4L,1L + +#define SN_delta_crl "deltaCRL" +#define LN_delta_crl "X509v3 Delta CRL Indicator" +#define NID_delta_crl 140 +#define OBJ_delta_crl OBJ_id_ce,27L + +#define SN_crl_reason "CRLReason" +#define LN_crl_reason "CRL Reason Code" +#define NID_crl_reason 141 +#define OBJ_crl_reason OBJ_id_ce,21L + +#define SN_invalidity_date "invalidityDate" +#define LN_invalidity_date "Invalidity Date" +#define NID_invalidity_date 142 +#define OBJ_invalidity_date OBJ_id_ce,24L + +#define SN_sxnet "SXNetID" +#define LN_sxnet "Strong Extranet ID" +#define NID_sxnet 143 +#define OBJ_sxnet 1L,3L,101L,1L,4L,1L + +/* PKCS12 and related OBJECT IDENTIFIERS */ + +#define OBJ_pkcs12 OBJ_pkcs,12L +#define OBJ_pkcs12_pbeids OBJ_pkcs12, 1 + +#define SN_pbe_WithSHA1And128BitRC4 "PBE-SHA1-RC4-128" +#define LN_pbe_WithSHA1And128BitRC4 "pbeWithSHA1And128BitRC4" +#define NID_pbe_WithSHA1And128BitRC4 144 +#define OBJ_pbe_WithSHA1And128BitRC4 OBJ_pkcs12_pbeids, 1L + +#define SN_pbe_WithSHA1And40BitRC4 "PBE-SHA1-RC4-40" +#define LN_pbe_WithSHA1And40BitRC4 "pbeWithSHA1And40BitRC4" +#define NID_pbe_WithSHA1And40BitRC4 145 +#define OBJ_pbe_WithSHA1And40BitRC4 OBJ_pkcs12_pbeids, 2L + +#define SN_pbe_WithSHA1And3_Key_TripleDES_CBC "PBE-SHA1-3DES" +#define LN_pbe_WithSHA1And3_Key_TripleDES_CBC "pbeWithSHA1And3-KeyTripleDES-CBC" +#define NID_pbe_WithSHA1And3_Key_TripleDES_CBC 146 +#define OBJ_pbe_WithSHA1And3_Key_TripleDES_CBC OBJ_pkcs12_pbeids, 3L + +#define SN_pbe_WithSHA1And2_Key_TripleDES_CBC "PBE-SHA1-2DES" +#define LN_pbe_WithSHA1And2_Key_TripleDES_CBC "pbeWithSHA1And2-KeyTripleDES-CBC" +#define NID_pbe_WithSHA1And2_Key_TripleDES_CBC 147 +#define OBJ_pbe_WithSHA1And2_Key_TripleDES_CBC OBJ_pkcs12_pbeids, 4L + +#define SN_pbe_WithSHA1And128BitRC2_CBC "PBE-SHA1-RC2-128" +#define LN_pbe_WithSHA1And128BitRC2_CBC "pbeWithSHA1And128BitRC2-CBC" +#define NID_pbe_WithSHA1And128BitRC2_CBC 148 +#define OBJ_pbe_WithSHA1And128BitRC2_CBC OBJ_pkcs12_pbeids, 5L + +#define SN_pbe_WithSHA1And40BitRC2_CBC "PBE-SHA1-RC2-40" +#define LN_pbe_WithSHA1And40BitRC2_CBC "pbeWithSHA1And40BitRC2-CBC" +#define NID_pbe_WithSHA1And40BitRC2_CBC 149 +#define OBJ_pbe_WithSHA1And40BitRC2_CBC OBJ_pkcs12_pbeids, 6L + +#define OBJ_pkcs12_Version1 OBJ_pkcs12, 10L + +#define OBJ_pkcs12_BagIds OBJ_pkcs12_Version1, 1L + +#define LN_keyBag "keyBag" +#define NID_keyBag 150 +#define OBJ_keyBag OBJ_pkcs12_BagIds, 1L + +#define LN_pkcs8ShroudedKeyBag "pkcs8ShroudedKeyBag" +#define NID_pkcs8ShroudedKeyBag 151 +#define OBJ_pkcs8ShroudedKeyBag OBJ_pkcs12_BagIds, 2L + +#define LN_certBag "certBag" +#define NID_certBag 152 +#define OBJ_certBag OBJ_pkcs12_BagIds, 3L + +#define LN_crlBag "crlBag" +#define NID_crlBag 153 +#define OBJ_crlBag OBJ_pkcs12_BagIds, 4L + +#define LN_secretBag "secretBag" +#define NID_secretBag 154 +#define OBJ_secretBag OBJ_pkcs12_BagIds, 5L + +#define LN_safeContentsBag "safeContentsBag" +#define NID_safeContentsBag 155 +#define OBJ_safeContentsBag OBJ_pkcs12_BagIds, 6L + +#define LN_friendlyName "friendlyName" +#define NID_friendlyName 156 +#define OBJ_friendlyName OBJ_pkcs9, 20L + +#define LN_localKeyID "localKeyID" +#define NID_localKeyID 157 +#define OBJ_localKeyID OBJ_pkcs9, 21L + +#define OBJ_certTypes OBJ_pkcs9, 22L + +#define LN_x509Certificate "x509Certificate" +#define NID_x509Certificate 158 +#define OBJ_x509Certificate OBJ_certTypes, 1L + +#define LN_sdsiCertificate "sdsiCertificate" +#define NID_sdsiCertificate 159 +#define OBJ_sdsiCertificate OBJ_certTypes, 2L + +#define OBJ_crlTypes OBJ_pkcs9, 23L + +#define LN_x509Crl "x509Crl" +#define NID_x509Crl 160 +#define OBJ_x509Crl OBJ_crlTypes, 1L + +/* PKCS#5 v2 OIDs */ + +#define LN_pbes2 "PBES2" +#define NID_pbes2 161 +#define OBJ_pbes2 OBJ_pkcs,5L,13L + +#define LN_pbmac1 "PBMAC1" +#define NID_pbmac1 162 +#define OBJ_pbmac1 OBJ_pkcs,5L,14L + +#define LN_hmacWithSHA1 "hmacWithSHA1" +#define NID_hmacWithSHA1 163 +#define OBJ_hmacWithSHA1 OBJ_rsadsi,2L,7L + +/* Policy Qualifier Ids */ + +#define LN_id_qt_cps "Policy Qualifier CPS" +#define SN_id_qt_cps "id-qt-cps" +#define NID_id_qt_cps 164 +#define OBJ_id_qt_cps OBJ_id_pkix,2L,1L + +#define LN_id_qt_unotice "Policy Qualifier User Notice" +#define SN_id_qt_unotice "id-qt-unotice" +#define NID_id_qt_unotice 165 +#define OBJ_id_qt_unotice OBJ_id_pkix,2L,2L + +#define SN_rc2_64_cbc "RC2-64-CBC" +#define LN_rc2_64_cbc "rc2-64-cbc" +#define NID_rc2_64_cbc 166 + +#define SN_SMIMECapabilities "SMIME-CAPS" +#define LN_SMIMECapabilities "S/MIME Capabilities" +#define NID_SMIMECapabilities 167 +#define OBJ_SMIMECapabilities OBJ_pkcs9,15L + +#define SN_pbeWithMD2AndRC2_CBC "PBE-MD2-RC2-64" +#define LN_pbeWithMD2AndRC2_CBC "pbeWithMD2AndRC2-CBC" +#define NID_pbeWithMD2AndRC2_CBC 168 +#define OBJ_pbeWithMD2AndRC2_CBC OBJ_pkcs,5L,4L + +#define SN_pbeWithMD5AndRC2_CBC "PBE-MD5-RC2-64" +#define LN_pbeWithMD5AndRC2_CBC "pbeWithMD5AndRC2-CBC" +#define NID_pbeWithMD5AndRC2_CBC 169 +#define OBJ_pbeWithMD5AndRC2_CBC OBJ_pkcs,5L,6L + +#define SN_pbeWithSHA1AndDES_CBC "PBE-SHA1-DES" +#define LN_pbeWithSHA1AndDES_CBC "pbeWithSHA1AndDES-CBC" +#define NID_pbeWithSHA1AndDES_CBC 170 +#define OBJ_pbeWithSHA1AndDES_CBC OBJ_pkcs,5L,10L + +/* Extension request OIDs */ + +#define LN_ms_ext_req "Microsoft Extension Request" +#define SN_ms_ext_req "msExtReq" +#define NID_ms_ext_req 171 +#define OBJ_ms_ext_req 1L,3L,6L,1L,4L,1L,311L,2L,1L,14L + +#define LN_ext_req "Extension Request" +#define SN_ext_req "extReq" +#define NID_ext_req 172 +#define OBJ_ext_req OBJ_pkcs9,14L + +#define SN_name "name" +#define LN_name "name" +#define NID_name 173 +#define OBJ_name OBJ_X509,41L + +#define SN_dnQualifier "dnQualifier" +#define LN_dnQualifier "dnQualifier" +#define NID_dnQualifier 174 +#define OBJ_dnQualifier OBJ_X509,46L + +#define SN_id_pe "id-pe" +#define NID_id_pe 175 +#define OBJ_id_pe OBJ_id_pkix,1L + +#define SN_id_ad "id-ad" +#define NID_id_ad 176 +#define OBJ_id_ad OBJ_id_pkix,48L + +#define SN_info_access "authorityInfoAccess" +#define LN_info_access "Authority Information Access" +#define NID_info_access 177 +#define OBJ_info_access OBJ_id_pe,1L + +#define SN_ad_OCSP "OCSP" +#define LN_ad_OCSP "OCSP" +#define NID_ad_OCSP 178 +#define OBJ_ad_OCSP OBJ_id_ad,1L + +#define SN_ad_ca_issuers "caIssuers" +#define LN_ad_ca_issuers "CA Issuers" +#define NID_ad_ca_issuers 179 +#define OBJ_ad_ca_issuers OBJ_id_ad,2L + +#define SN_OCSP_sign "OCSPSigning" +#define LN_OCSP_sign "OCSP Signing" +#define NID_OCSP_sign 180 +#define OBJ_OCSP_sign OBJ_id_kp,9L +#endif /* USE_OBJ_MAC */ + +#include +#include + +#define OBJ_NAME_TYPE_UNDEF 0x00 +#define OBJ_NAME_TYPE_MD_METH 0x01 +#define OBJ_NAME_TYPE_CIPHER_METH 0x02 +#define OBJ_NAME_TYPE_PKEY_METH 0x03 +#define OBJ_NAME_TYPE_COMP_METH 0x04 +#define OBJ_NAME_TYPE_NUM 0x05 + +#define OBJ_NAME_ALIAS 0x8000 + +#define OBJ_BSEARCH_VALUE_ON_NOMATCH 0x01 +#define OBJ_BSEARCH_FIRST_VALUE_ON_MATCH 0x02 + + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct obj_name_st + { + int type; + int alias; + const char *name; + const char *data; + } OBJ_NAME; + +#define OBJ_create_and_add_object(a,b,c) OBJ_create(a,b,c) + + +int OBJ_NAME_init(void); +int OBJ_NAME_new_index(unsigned long (*hash_func)(const char *), + int (*cmp_func)(const char *, const char *), + void (*free_func)(const char *, int, const char *)); +const char *OBJ_NAME_get(const char *name,int type); +int OBJ_NAME_add(const char *name,int type,const char *data); +int OBJ_NAME_remove(const char *name,int type); +void OBJ_NAME_cleanup(int type); /* -1 for everything */ +void OBJ_NAME_do_all(int type,void (*fn)(const OBJ_NAME *,void *arg), + void *arg); +void OBJ_NAME_do_all_sorted(int type,void (*fn)(const OBJ_NAME *,void *arg), + void *arg); + +ASN1_OBJECT * OBJ_dup(const ASN1_OBJECT *o); +ASN1_OBJECT * OBJ_nid2obj(int n); +const char * OBJ_nid2ln(int n); +const char * OBJ_nid2sn(int n); +int OBJ_obj2nid(const ASN1_OBJECT *o); +ASN1_OBJECT * OBJ_txt2obj(const char *s, int no_name); +int OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *a, int no_name); +int OBJ_txt2nid(const char *s); +int OBJ_ln2nid(const char *s); +int OBJ_sn2nid(const char *s); +int OBJ_cmp(const ASN1_OBJECT *a,const ASN1_OBJECT *b); +const void * OBJ_bsearch_(const void *key,const void *base,int num,int size, + int (*cmp)(const void *, const void *)); +const void * OBJ_bsearch_ex_(const void *key,const void *base,int num, + int size, + int (*cmp)(const void *, const void *), + int flags); + +#define _DECLARE_OBJ_BSEARCH_CMP_FN(scope, type1, type2, nm) \ + static int nm##_cmp_BSEARCH_CMP_FN(const void *, const void *); \ + static int nm##_cmp(type1 const *, type2 const *); \ + scope type2 * OBJ_bsearch_##nm(type1 *key, type2 const *base, int num) + +#define DECLARE_OBJ_BSEARCH_CMP_FN(type1, type2, cmp) \ + _DECLARE_OBJ_BSEARCH_CMP_FN(static, type1, type2, cmp) +#define DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(type1, type2, nm) \ + type2 * OBJ_bsearch_##nm(type1 *key, type2 const *base, int num) + +/* + * Unsolved problem: if a type is actually a pointer type, like + * nid_triple is, then its impossible to get a const where you need + * it. Consider: + * + * typedef int nid_triple[3]; + * const void *a_; + * const nid_triple const *a = a_; + * + * The assignement discards a const because what you really want is: + * + * const int const * const *a = a_; + * + * But if you do that, you lose the fact that a is an array of 3 ints, + * which breaks comparison functions. + * + * Thus we end up having to cast, sadly, or unpack the + * declarations. Or, as I finally did in this case, delcare nid_triple + * to be a struct, which it should have been in the first place. + * + * Ben, August 2008. + * + * Also, strictly speaking not all types need be const, but handling + * the non-constness means a lot of complication, and in practice + * comparison routines do always not touch their arguments. + */ + +#define IMPLEMENT_OBJ_BSEARCH_CMP_FN(type1, type2, nm) \ + static int nm##_cmp_BSEARCH_CMP_FN(const void *a_, const void *b_) \ + { \ + type1 const *a = a_; \ + type2 const *b = b_; \ + return nm##_cmp(a,b); \ + } \ + static type2 *OBJ_bsearch_##nm(type1 *key, type2 const *base, int num) \ + { \ + return (type2 *)OBJ_bsearch_(key, base, num, sizeof(type2), \ + nm##_cmp_BSEARCH_CMP_FN); \ + } \ + extern void dummy_prototype(void) + +#define IMPLEMENT_OBJ_BSEARCH_GLOBAL_CMP_FN(type1, type2, nm) \ + static int nm##_cmp_BSEARCH_CMP_FN(const void *a_, const void *b_) \ + { \ + type1 const *a = a_; \ + type2 const *b = b_; \ + return nm##_cmp(a,b); \ + } \ + type2 *OBJ_bsearch_##nm(type1 *key, type2 const *base, int num) \ + { \ + return (type2 *)OBJ_bsearch_(key, base, num, sizeof(type2), \ + nm##_cmp_BSEARCH_CMP_FN); \ + } \ + extern void dummy_prototype(void) + +#define OBJ_bsearch(type1,key,type2,base,num,cmp) \ + ((type2 *)OBJ_bsearch_(CHECKED_PTR_OF(type1,key),CHECKED_PTR_OF(type2,base), \ + num,sizeof(type2), \ + ((void)CHECKED_PTR_OF(type1,cmp##_type_1), \ + (void)CHECKED_PTR_OF(type2,cmp##_type_2), \ + cmp##_BSEARCH_CMP_FN))) + +#define OBJ_bsearch_ex(type1,key,type2,base,num,cmp,flags) \ + ((type2 *)OBJ_bsearch_ex_(CHECKED_PTR_OF(type1,key),CHECKED_PTR_OF(type2,base), \ + num,sizeof(type2), \ + ((void)CHECKED_PTR_OF(type1,cmp##_type_1), \ + (void)type_2=CHECKED_PTR_OF(type2,cmp##_type_2), \ + cmp##_BSEARCH_CMP_FN)),flags) + +int OBJ_new_nid(int num); +int OBJ_add_object(const ASN1_OBJECT *obj); +int OBJ_create(const char *oid,const char *sn,const char *ln); +void OBJ_cleanup(void ); +int OBJ_create_objects(BIO *in); + +int OBJ_find_sigid_algs(int signid, int *pdig_nid, int *ppkey_nid); +int OBJ_find_sigid_by_algs(int *psignid, int dig_nid, int pkey_nid); +int OBJ_add_sigid(int signid, int dig_id, int pkey_id); +void OBJ_sigid_free(void); + +extern int obj_cleanup_defer; +void check_defer(int nid); + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_OBJ_strings(void); + +/* Error codes for the OBJ functions. */ + +/* Function codes. */ +#define OBJ_F_OBJ_ADD_OBJECT 105 +#define OBJ_F_OBJ_CREATE 100 +#define OBJ_F_OBJ_DUP 101 +#define OBJ_F_OBJ_NAME_NEW_INDEX 106 +#define OBJ_F_OBJ_NID2LN 102 +#define OBJ_F_OBJ_NID2OBJ 103 +#define OBJ_F_OBJ_NID2SN 104 + +/* Reason codes. */ +#define OBJ_R_MALLOC_FAILURE 100 +#define OBJ_R_UNKNOWN_NID 101 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/ocsp.h b/Source/Import/OpenSSL/Include/openssl/ocsp.h new file mode 100644 index 0000000..31e4574 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ocsp.h @@ -0,0 +1,623 @@ +/* ocsp.h */ +/* Written by Tom Titchener for the OpenSSL + * project. */ + +/* History: + This file was transfered to Richard Levitte from CertCo by Kathy + Weinhold in mid-spring 2000 to be included in OpenSSL or released + as a patch kit. */ + +/* ==================================================================== + * Copyright (c) 1998-2000 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_OCSP_H +#define HEADER_OCSP_H + +#include +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Various flags and values */ + +#define OCSP_DEFAULT_NONCE_LENGTH 16 + +#define OCSP_NOCERTS 0x1 +#define OCSP_NOINTERN 0x2 +#define OCSP_NOSIGS 0x4 +#define OCSP_NOCHAIN 0x8 +#define OCSP_NOVERIFY 0x10 +#define OCSP_NOEXPLICIT 0x20 +#define OCSP_NOCASIGN 0x40 +#define OCSP_NODELEGATED 0x80 +#define OCSP_NOCHECKS 0x100 +#define OCSP_TRUSTOTHER 0x200 +#define OCSP_RESPID_KEY 0x400 +#define OCSP_NOTIME 0x800 + +/* CertID ::= SEQUENCE { + * hashAlgorithm AlgorithmIdentifier, + * issuerNameHash OCTET STRING, -- Hash of Issuer's DN + * issuerKeyHash OCTET STRING, -- Hash of Issuers public key (excluding the tag & length fields) + * serialNumber CertificateSerialNumber } + */ +typedef struct ocsp_cert_id_st + { + X509_ALGOR *hashAlgorithm; + ASN1_OCTET_STRING *issuerNameHash; + ASN1_OCTET_STRING *issuerKeyHash; + ASN1_INTEGER *serialNumber; + } OCSP_CERTID; + +DECLARE_STACK_OF(OCSP_CERTID) + +/* Request ::= SEQUENCE { + * reqCert CertID, + * singleRequestExtensions [0] EXPLICIT Extensions OPTIONAL } + */ +typedef struct ocsp_one_request_st + { + OCSP_CERTID *reqCert; + STACK_OF(X509_EXTENSION) *singleRequestExtensions; + } OCSP_ONEREQ; + +DECLARE_STACK_OF(OCSP_ONEREQ) +DECLARE_ASN1_SET_OF(OCSP_ONEREQ) + + +/* TBSRequest ::= SEQUENCE { + * version [0] EXPLICIT Version DEFAULT v1, + * requestorName [1] EXPLICIT GeneralName OPTIONAL, + * requestList SEQUENCE OF Request, + * requestExtensions [2] EXPLICIT Extensions OPTIONAL } + */ +typedef struct ocsp_req_info_st + { + ASN1_INTEGER *version; + GENERAL_NAME *requestorName; + STACK_OF(OCSP_ONEREQ) *requestList; + STACK_OF(X509_EXTENSION) *requestExtensions; + } OCSP_REQINFO; + +/* Signature ::= SEQUENCE { + * signatureAlgorithm AlgorithmIdentifier, + * signature BIT STRING, + * certs [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL } + */ +typedef struct ocsp_signature_st + { + X509_ALGOR *signatureAlgorithm; + ASN1_BIT_STRING *signature; + STACK_OF(X509) *certs; + } OCSP_SIGNATURE; + +/* OCSPRequest ::= SEQUENCE { + * tbsRequest TBSRequest, + * optionalSignature [0] EXPLICIT Signature OPTIONAL } + */ +typedef struct ocsp_request_st + { + OCSP_REQINFO *tbsRequest; + OCSP_SIGNATURE *optionalSignature; /* OPTIONAL */ + } OCSP_REQUEST; + +/* OCSPResponseStatus ::= ENUMERATED { + * successful (0), --Response has valid confirmations + * malformedRequest (1), --Illegal confirmation request + * internalError (2), --Internal error in issuer + * tryLater (3), --Try again later + * --(4) is not used + * sigRequired (5), --Must sign the request + * unauthorized (6) --Request unauthorized + * } + */ +#define OCSP_RESPONSE_STATUS_SUCCESSFUL 0 +#define OCSP_RESPONSE_STATUS_MALFORMEDREQUEST 1 +#define OCSP_RESPONSE_STATUS_INTERNALERROR 2 +#define OCSP_RESPONSE_STATUS_TRYLATER 3 +#define OCSP_RESPONSE_STATUS_SIGREQUIRED 5 +#define OCSP_RESPONSE_STATUS_UNAUTHORIZED 6 + +/* ResponseBytes ::= SEQUENCE { + * responseType OBJECT IDENTIFIER, + * response OCTET STRING } + */ +typedef struct ocsp_resp_bytes_st + { + ASN1_OBJECT *responseType; + ASN1_OCTET_STRING *response; + } OCSP_RESPBYTES; + +/* OCSPResponse ::= SEQUENCE { + * responseStatus OCSPResponseStatus, + * responseBytes [0] EXPLICIT ResponseBytes OPTIONAL } + */ +struct ocsp_response_st + { + ASN1_ENUMERATED *responseStatus; + OCSP_RESPBYTES *responseBytes; + }; + +/* ResponderID ::= CHOICE { + * byName [1] Name, + * byKey [2] KeyHash } + */ +#define V_OCSP_RESPID_NAME 0 +#define V_OCSP_RESPID_KEY 1 +struct ocsp_responder_id_st + { + int type; + union { + X509_NAME* byName; + ASN1_OCTET_STRING *byKey; + } value; + }; + +DECLARE_STACK_OF(OCSP_RESPID) +DECLARE_ASN1_FUNCTIONS(OCSP_RESPID) + +/* KeyHash ::= OCTET STRING --SHA-1 hash of responder's public key + * --(excluding the tag and length fields) + */ + +/* RevokedInfo ::= SEQUENCE { + * revocationTime GeneralizedTime, + * revocationReason [0] EXPLICIT CRLReason OPTIONAL } + */ +typedef struct ocsp_revoked_info_st + { + ASN1_GENERALIZEDTIME *revocationTime; + ASN1_ENUMERATED *revocationReason; + } OCSP_REVOKEDINFO; + +/* CertStatus ::= CHOICE { + * good [0] IMPLICIT NULL, + * revoked [1] IMPLICIT RevokedInfo, + * unknown [2] IMPLICIT UnknownInfo } + */ +#define V_OCSP_CERTSTATUS_GOOD 0 +#define V_OCSP_CERTSTATUS_REVOKED 1 +#define V_OCSP_CERTSTATUS_UNKNOWN 2 +typedef struct ocsp_cert_status_st + { + int type; + union { + ASN1_NULL *good; + OCSP_REVOKEDINFO *revoked; + ASN1_NULL *unknown; + } value; + } OCSP_CERTSTATUS; + +/* SingleResponse ::= SEQUENCE { + * certID CertID, + * certStatus CertStatus, + * thisUpdate GeneralizedTime, + * nextUpdate [0] EXPLICIT GeneralizedTime OPTIONAL, + * singleExtensions [1] EXPLICIT Extensions OPTIONAL } + */ +typedef struct ocsp_single_response_st + { + OCSP_CERTID *certId; + OCSP_CERTSTATUS *certStatus; + ASN1_GENERALIZEDTIME *thisUpdate; + ASN1_GENERALIZEDTIME *nextUpdate; + STACK_OF(X509_EXTENSION) *singleExtensions; + } OCSP_SINGLERESP; + +DECLARE_STACK_OF(OCSP_SINGLERESP) +DECLARE_ASN1_SET_OF(OCSP_SINGLERESP) + +/* ResponseData ::= SEQUENCE { + * version [0] EXPLICIT Version DEFAULT v1, + * responderID ResponderID, + * producedAt GeneralizedTime, + * responses SEQUENCE OF SingleResponse, + * responseExtensions [1] EXPLICIT Extensions OPTIONAL } + */ +typedef struct ocsp_response_data_st + { + ASN1_INTEGER *version; + OCSP_RESPID *responderId; + ASN1_GENERALIZEDTIME *producedAt; + STACK_OF(OCSP_SINGLERESP) *responses; + STACK_OF(X509_EXTENSION) *responseExtensions; + } OCSP_RESPDATA; + +/* BasicOCSPResponse ::= SEQUENCE { + * tbsResponseData ResponseData, + * signatureAlgorithm AlgorithmIdentifier, + * signature BIT STRING, + * certs [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL } + */ + /* Note 1: + The value for "signature" is specified in the OCSP rfc2560 as follows: + "The value for the signature SHALL be computed on the hash of the DER + encoding ResponseData." This means that you must hash the DER-encoded + tbsResponseData, and then run it through a crypto-signing function, which + will (at least w/RSA) do a hash-'n'-private-encrypt operation. This seems + a bit odd, but that's the spec. Also note that the data structures do not + leave anywhere to independently specify the algorithm used for the initial + hash. So, we look at the signature-specification algorithm, and try to do + something intelligent. -- Kathy Weinhold, CertCo */ + /* Note 2: + It seems that the mentioned passage from RFC 2560 (section 4.2.1) is open + for interpretation. I've done tests against another responder, and found + that it doesn't do the double hashing that the RFC seems to say one + should. Therefore, all relevant functions take a flag saying which + variant should be used. -- Richard Levitte, OpenSSL team and CeloCom */ +typedef struct ocsp_basic_response_st + { + OCSP_RESPDATA *tbsResponseData; + X509_ALGOR *signatureAlgorithm; + ASN1_BIT_STRING *signature; + STACK_OF(X509) *certs; + } OCSP_BASICRESP; + +/* + * CRLReason ::= ENUMERATED { + * unspecified (0), + * keyCompromise (1), + * cACompromise (2), + * affiliationChanged (3), + * superseded (4), + * cessationOfOperation (5), + * certificateHold (6), + * removeFromCRL (8) } + */ +#define OCSP_REVOKED_STATUS_NOSTATUS -1 +#define OCSP_REVOKED_STATUS_UNSPECIFIED 0 +#define OCSP_REVOKED_STATUS_KEYCOMPROMISE 1 +#define OCSP_REVOKED_STATUS_CACOMPROMISE 2 +#define OCSP_REVOKED_STATUS_AFFILIATIONCHANGED 3 +#define OCSP_REVOKED_STATUS_SUPERSEDED 4 +#define OCSP_REVOKED_STATUS_CESSATIONOFOPERATION 5 +#define OCSP_REVOKED_STATUS_CERTIFICATEHOLD 6 +#define OCSP_REVOKED_STATUS_REMOVEFROMCRL 8 + +/* CrlID ::= SEQUENCE { + * crlUrl [0] EXPLICIT IA5String OPTIONAL, + * crlNum [1] EXPLICIT INTEGER OPTIONAL, + * crlTime [2] EXPLICIT GeneralizedTime OPTIONAL } + */ +typedef struct ocsp_crl_id_st + { + ASN1_IA5STRING *crlUrl; + ASN1_INTEGER *crlNum; + ASN1_GENERALIZEDTIME *crlTime; + } OCSP_CRLID; + +/* ServiceLocator ::= SEQUENCE { + * issuer Name, + * locator AuthorityInfoAccessSyntax OPTIONAL } + */ +typedef struct ocsp_service_locator_st + { + X509_NAME* issuer; + STACK_OF(ACCESS_DESCRIPTION) *locator; + } OCSP_SERVICELOC; + +#define PEM_STRING_OCSP_REQUEST "OCSP REQUEST" +#define PEM_STRING_OCSP_RESPONSE "OCSP RESPONSE" + +#define d2i_OCSP_REQUEST_bio(bp,p) ASN1_d2i_bio_of(OCSP_REQUEST,OCSP_REQUEST_new,d2i_OCSP_REQUEST,bp,p) + +#define d2i_OCSP_RESPONSE_bio(bp,p) ASN1_d2i_bio_of(OCSP_RESPONSE,OCSP_RESPONSE_new,d2i_OCSP_RESPONSE,bp,p) + +#define PEM_read_bio_OCSP_REQUEST(bp,x,cb) (OCSP_REQUEST *)PEM_ASN1_read_bio( \ + (char *(*)())d2i_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST,bp,(char **)x,cb,NULL) + +#define PEM_read_bio_OCSP_RESPONSE(bp,x,cb)(OCSP_RESPONSE *)PEM_ASN1_read_bio(\ + (char *(*)())d2i_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE,bp,(char **)x,cb,NULL) + +#define PEM_write_bio_OCSP_REQUEST(bp,o) \ + PEM_ASN1_write_bio((int (*)())i2d_OCSP_REQUEST,PEM_STRING_OCSP_REQUEST,\ + bp,(char *)o, NULL,NULL,0,NULL,NULL) + +#define PEM_write_bio_OCSP_RESPONSE(bp,o) \ + PEM_ASN1_write_bio((int (*)())i2d_OCSP_RESPONSE,PEM_STRING_OCSP_RESPONSE,\ + bp,(char *)o, NULL,NULL,0,NULL,NULL) + +#define i2d_OCSP_RESPONSE_bio(bp,o) ASN1_i2d_bio_of(OCSP_RESPONSE,i2d_OCSP_RESPONSE,bp,o) + +#define i2d_OCSP_REQUEST_bio(bp,o) ASN1_i2d_bio_of(OCSP_REQUEST,i2d_OCSP_REQUEST,bp,o) + +#define OCSP_REQUEST_sign(o,pkey,md) \ + ASN1_item_sign(ASN1_ITEM_rptr(OCSP_REQINFO),\ + o->optionalSignature->signatureAlgorithm,NULL,\ + o->optionalSignature->signature,o->tbsRequest,pkey,md) + +#define OCSP_BASICRESP_sign(o,pkey,md,d) \ + ASN1_item_sign(ASN1_ITEM_rptr(OCSP_RESPDATA),o->signatureAlgorithm,NULL,\ + o->signature,o->tbsResponseData,pkey,md) + +#define OCSP_REQUEST_verify(a,r) ASN1_item_verify(ASN1_ITEM_rptr(OCSP_REQINFO),\ + a->optionalSignature->signatureAlgorithm,\ + a->optionalSignature->signature,a->tbsRequest,r) + +#define OCSP_BASICRESP_verify(a,r,d) ASN1_item_verify(ASN1_ITEM_rptr(OCSP_RESPDATA),\ + a->signatureAlgorithm,a->signature,a->tbsResponseData,r) + +#define ASN1_BIT_STRING_digest(data,type,md,len) \ + ASN1_item_digest(ASN1_ITEM_rptr(ASN1_BIT_STRING),type,data,md,len) + +#define OCSP_CERTSTATUS_dup(cs)\ + (OCSP_CERTSTATUS*)ASN1_dup((int(*)())i2d_OCSP_CERTSTATUS,\ + (char *(*)())d2i_OCSP_CERTSTATUS,(char *)(cs)) + +OCSP_CERTID *OCSP_CERTID_dup(OCSP_CERTID *id); + +OCSP_RESPONSE *OCSP_sendreq_bio(BIO *b, char *path, OCSP_REQUEST *req); +OCSP_REQ_CTX *OCSP_sendreq_new(BIO *io, char *path, OCSP_REQUEST *req, + int maxline); +int OCSP_sendreq_nbio(OCSP_RESPONSE **presp, OCSP_REQ_CTX *rctx); +void OCSP_REQ_CTX_free(OCSP_REQ_CTX *rctx); +int OCSP_REQ_CTX_set1_req(OCSP_REQ_CTX *rctx, OCSP_REQUEST *req); +int OCSP_REQ_CTX_add1_header(OCSP_REQ_CTX *rctx, + const char *name, const char *value); + +OCSP_CERTID *OCSP_cert_to_id(const EVP_MD *dgst, X509 *subject, X509 *issuer); + +OCSP_CERTID *OCSP_cert_id_new(const EVP_MD *dgst, + X509_NAME *issuerName, + ASN1_BIT_STRING* issuerKey, + ASN1_INTEGER *serialNumber); + +OCSP_ONEREQ *OCSP_request_add0_id(OCSP_REQUEST *req, OCSP_CERTID *cid); + +int OCSP_request_add1_nonce(OCSP_REQUEST *req, unsigned char *val, int len); +int OCSP_basic_add1_nonce(OCSP_BASICRESP *resp, unsigned char *val, int len); +int OCSP_check_nonce(OCSP_REQUEST *req, OCSP_BASICRESP *bs); +int OCSP_copy_nonce(OCSP_BASICRESP *resp, OCSP_REQUEST *req); + +int OCSP_request_set1_name(OCSP_REQUEST *req, X509_NAME *nm); +int OCSP_request_add1_cert(OCSP_REQUEST *req, X509 *cert); + +int OCSP_request_sign(OCSP_REQUEST *req, + X509 *signer, + EVP_PKEY *key, + const EVP_MD *dgst, + STACK_OF(X509) *certs, + unsigned long flags); + +int OCSP_response_status(OCSP_RESPONSE *resp); +OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp); + +int OCSP_resp_count(OCSP_BASICRESP *bs); +OCSP_SINGLERESP *OCSP_resp_get0(OCSP_BASICRESP *bs, int idx); +int OCSP_resp_find(OCSP_BASICRESP *bs, OCSP_CERTID *id, int last); +int OCSP_single_get0_status(OCSP_SINGLERESP *single, int *reason, + ASN1_GENERALIZEDTIME **revtime, + ASN1_GENERALIZEDTIME **thisupd, + ASN1_GENERALIZEDTIME **nextupd); +int OCSP_resp_find_status(OCSP_BASICRESP *bs, OCSP_CERTID *id, int *status, + int *reason, + ASN1_GENERALIZEDTIME **revtime, + ASN1_GENERALIZEDTIME **thisupd, + ASN1_GENERALIZEDTIME **nextupd); +int OCSP_check_validity(ASN1_GENERALIZEDTIME *thisupd, + ASN1_GENERALIZEDTIME *nextupd, + long sec, long maxsec); + +int OCSP_request_verify(OCSP_REQUEST *req, STACK_OF(X509) *certs, X509_STORE *store, unsigned long flags); + +int OCSP_parse_url(char *url, char **phost, char **pport, char **ppath, int *pssl); + +int OCSP_id_issuer_cmp(OCSP_CERTID *a, OCSP_CERTID *b); +int OCSP_id_cmp(OCSP_CERTID *a, OCSP_CERTID *b); + +int OCSP_request_onereq_count(OCSP_REQUEST *req); +OCSP_ONEREQ *OCSP_request_onereq_get0(OCSP_REQUEST *req, int i); +OCSP_CERTID *OCSP_onereq_get0_id(OCSP_ONEREQ *one); +int OCSP_id_get0_info(ASN1_OCTET_STRING **piNameHash, ASN1_OBJECT **pmd, + ASN1_OCTET_STRING **pikeyHash, + ASN1_INTEGER **pserial, OCSP_CERTID *cid); +int OCSP_request_is_signed(OCSP_REQUEST *req); +OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs); +OCSP_SINGLERESP *OCSP_basic_add1_status(OCSP_BASICRESP *rsp, + OCSP_CERTID *cid, + int status, int reason, + ASN1_TIME *revtime, + ASN1_TIME *thisupd, ASN1_TIME *nextupd); +int OCSP_basic_add1_cert(OCSP_BASICRESP *resp, X509 *cert); +int OCSP_basic_sign(OCSP_BASICRESP *brsp, + X509 *signer, EVP_PKEY *key, const EVP_MD *dgst, + STACK_OF(X509) *certs, unsigned long flags); + +X509_EXTENSION *OCSP_crlID_new(char *url, long *n, char *tim); + +X509_EXTENSION *OCSP_accept_responses_new(char **oids); + +X509_EXTENSION *OCSP_archive_cutoff_new(char* tim); + +X509_EXTENSION *OCSP_url_svcloc_new(X509_NAME* issuer, char **urls); + +int OCSP_REQUEST_get_ext_count(OCSP_REQUEST *x); +int OCSP_REQUEST_get_ext_by_NID(OCSP_REQUEST *x, int nid, int lastpos); +int OCSP_REQUEST_get_ext_by_OBJ(OCSP_REQUEST *x, ASN1_OBJECT *obj, int lastpos); +int OCSP_REQUEST_get_ext_by_critical(OCSP_REQUEST *x, int crit, int lastpos); +X509_EXTENSION *OCSP_REQUEST_get_ext(OCSP_REQUEST *x, int loc); +X509_EXTENSION *OCSP_REQUEST_delete_ext(OCSP_REQUEST *x, int loc); +void *OCSP_REQUEST_get1_ext_d2i(OCSP_REQUEST *x, int nid, int *crit, int *idx); +int OCSP_REQUEST_add1_ext_i2d(OCSP_REQUEST *x, int nid, void *value, int crit, + unsigned long flags); +int OCSP_REQUEST_add_ext(OCSP_REQUEST *x, X509_EXTENSION *ex, int loc); + +int OCSP_ONEREQ_get_ext_count(OCSP_ONEREQ *x); +int OCSP_ONEREQ_get_ext_by_NID(OCSP_ONEREQ *x, int nid, int lastpos); +int OCSP_ONEREQ_get_ext_by_OBJ(OCSP_ONEREQ *x, ASN1_OBJECT *obj, int lastpos); +int OCSP_ONEREQ_get_ext_by_critical(OCSP_ONEREQ *x, int crit, int lastpos); +X509_EXTENSION *OCSP_ONEREQ_get_ext(OCSP_ONEREQ *x, int loc); +X509_EXTENSION *OCSP_ONEREQ_delete_ext(OCSP_ONEREQ *x, int loc); +void *OCSP_ONEREQ_get1_ext_d2i(OCSP_ONEREQ *x, int nid, int *crit, int *idx); +int OCSP_ONEREQ_add1_ext_i2d(OCSP_ONEREQ *x, int nid, void *value, int crit, + unsigned long flags); +int OCSP_ONEREQ_add_ext(OCSP_ONEREQ *x, X509_EXTENSION *ex, int loc); + +int OCSP_BASICRESP_get_ext_count(OCSP_BASICRESP *x); +int OCSP_BASICRESP_get_ext_by_NID(OCSP_BASICRESP *x, int nid, int lastpos); +int OCSP_BASICRESP_get_ext_by_OBJ(OCSP_BASICRESP *x, ASN1_OBJECT *obj, int lastpos); +int OCSP_BASICRESP_get_ext_by_critical(OCSP_BASICRESP *x, int crit, int lastpos); +X509_EXTENSION *OCSP_BASICRESP_get_ext(OCSP_BASICRESP *x, int loc); +X509_EXTENSION *OCSP_BASICRESP_delete_ext(OCSP_BASICRESP *x, int loc); +void *OCSP_BASICRESP_get1_ext_d2i(OCSP_BASICRESP *x, int nid, int *crit, int *idx); +int OCSP_BASICRESP_add1_ext_i2d(OCSP_BASICRESP *x, int nid, void *value, int crit, + unsigned long flags); +int OCSP_BASICRESP_add_ext(OCSP_BASICRESP *x, X509_EXTENSION *ex, int loc); + +int OCSP_SINGLERESP_get_ext_count(OCSP_SINGLERESP *x); +int OCSP_SINGLERESP_get_ext_by_NID(OCSP_SINGLERESP *x, int nid, int lastpos); +int OCSP_SINGLERESP_get_ext_by_OBJ(OCSP_SINGLERESP *x, ASN1_OBJECT *obj, int lastpos); +int OCSP_SINGLERESP_get_ext_by_critical(OCSP_SINGLERESP *x, int crit, int lastpos); +X509_EXTENSION *OCSP_SINGLERESP_get_ext(OCSP_SINGLERESP *x, int loc); +X509_EXTENSION *OCSP_SINGLERESP_delete_ext(OCSP_SINGLERESP *x, int loc); +void *OCSP_SINGLERESP_get1_ext_d2i(OCSP_SINGLERESP *x, int nid, int *crit, int *idx); +int OCSP_SINGLERESP_add1_ext_i2d(OCSP_SINGLERESP *x, int nid, void *value, int crit, + unsigned long flags); +int OCSP_SINGLERESP_add_ext(OCSP_SINGLERESP *x, X509_EXTENSION *ex, int loc); + +DECLARE_ASN1_FUNCTIONS(OCSP_SINGLERESP) +DECLARE_ASN1_FUNCTIONS(OCSP_CERTSTATUS) +DECLARE_ASN1_FUNCTIONS(OCSP_REVOKEDINFO) +DECLARE_ASN1_FUNCTIONS(OCSP_BASICRESP) +DECLARE_ASN1_FUNCTIONS(OCSP_RESPDATA) +DECLARE_ASN1_FUNCTIONS(OCSP_RESPID) +DECLARE_ASN1_FUNCTIONS(OCSP_RESPONSE) +DECLARE_ASN1_FUNCTIONS(OCSP_RESPBYTES) +DECLARE_ASN1_FUNCTIONS(OCSP_ONEREQ) +DECLARE_ASN1_FUNCTIONS(OCSP_CERTID) +DECLARE_ASN1_FUNCTIONS(OCSP_REQUEST) +DECLARE_ASN1_FUNCTIONS(OCSP_SIGNATURE) +DECLARE_ASN1_FUNCTIONS(OCSP_REQINFO) +DECLARE_ASN1_FUNCTIONS(OCSP_CRLID) +DECLARE_ASN1_FUNCTIONS(OCSP_SERVICELOC) + +const char *OCSP_response_status_str(long s); +const char *OCSP_cert_status_str(long s); +const char *OCSP_crl_reason_str(long s); + +int OCSP_REQUEST_print(BIO *bp, OCSP_REQUEST* a, unsigned long flags); +int OCSP_RESPONSE_print(BIO *bp, OCSP_RESPONSE* o, unsigned long flags); + +int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs, + X509_STORE *st, unsigned long flags); + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_OCSP_strings(void); + +/* Error codes for the OCSP functions. */ + +/* Function codes. */ +#define OCSP_F_ASN1_STRING_ENCODE 100 +#define OCSP_F_D2I_OCSP_NONCE 102 +#define OCSP_F_OCSP_BASIC_ADD1_STATUS 103 +#define OCSP_F_OCSP_BASIC_SIGN 104 +#define OCSP_F_OCSP_BASIC_VERIFY 105 +#define OCSP_F_OCSP_CERT_ID_NEW 101 +#define OCSP_F_OCSP_CHECK_DELEGATED 106 +#define OCSP_F_OCSP_CHECK_IDS 107 +#define OCSP_F_OCSP_CHECK_ISSUER 108 +#define OCSP_F_OCSP_CHECK_VALIDITY 115 +#define OCSP_F_OCSP_MATCH_ISSUERID 109 +#define OCSP_F_OCSP_PARSE_URL 114 +#define OCSP_F_OCSP_REQUEST_SIGN 110 +#define OCSP_F_OCSP_REQUEST_VERIFY 116 +#define OCSP_F_OCSP_RESPONSE_GET1_BASIC 111 +#define OCSP_F_OCSP_SENDREQ_BIO 112 +#define OCSP_F_OCSP_SENDREQ_NBIO 117 +#define OCSP_F_PARSE_HTTP_LINE1 118 +#define OCSP_F_REQUEST_VERIFY 113 + +/* Reason codes. */ +#define OCSP_R_BAD_DATA 100 +#define OCSP_R_CERTIFICATE_VERIFY_ERROR 101 +#define OCSP_R_DIGEST_ERR 102 +#define OCSP_R_ERROR_IN_NEXTUPDATE_FIELD 122 +#define OCSP_R_ERROR_IN_THISUPDATE_FIELD 123 +#define OCSP_R_ERROR_PARSING_URL 121 +#define OCSP_R_MISSING_OCSPSIGNING_USAGE 103 +#define OCSP_R_NEXTUPDATE_BEFORE_THISUPDATE 124 +#define OCSP_R_NOT_BASIC_RESPONSE 104 +#define OCSP_R_NO_CERTIFICATES_IN_CHAIN 105 +#define OCSP_R_NO_CONTENT 106 +#define OCSP_R_NO_PUBLIC_KEY 107 +#define OCSP_R_NO_RESPONSE_DATA 108 +#define OCSP_R_NO_REVOKED_TIME 109 +#define OCSP_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 110 +#define OCSP_R_REQUEST_NOT_SIGNED 128 +#define OCSP_R_RESPONSE_CONTAINS_NO_REVOCATION_DATA 111 +#define OCSP_R_ROOT_CA_NOT_TRUSTED 112 +#define OCSP_R_SERVER_READ_ERROR 113 +#define OCSP_R_SERVER_RESPONSE_ERROR 114 +#define OCSP_R_SERVER_RESPONSE_PARSE_ERROR 115 +#define OCSP_R_SERVER_WRITE_ERROR 116 +#define OCSP_R_SIGNATURE_FAILURE 117 +#define OCSP_R_SIGNER_CERTIFICATE_NOT_FOUND 118 +#define OCSP_R_STATUS_EXPIRED 125 +#define OCSP_R_STATUS_NOT_YET_VALID 126 +#define OCSP_R_STATUS_TOO_OLD 127 +#define OCSP_R_UNKNOWN_MESSAGE_DIGEST 119 +#define OCSP_R_UNKNOWN_NID 120 +#define OCSP_R_UNSUPPORTED_REQUESTORNAME_TYPE 129 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/opensslconf.h b/Source/Import/OpenSSL/Include/openssl/opensslconf.h new file mode 100644 index 0000000..0ea617f --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/opensslconf.h @@ -0,0 +1,238 @@ +/* opensslconf.h */ +/* WARNING: Generated automatically from opensslconf.h.in by Configure. */ + +/* OpenSSL was configured with the following options: */ +#ifndef OPENSSL_SYSNAME_MINGW32 +# define OPENSSL_SYSNAME_MINGW32 +#endif +#ifndef OPENSSL_DOING_MAKEDEPEND + + +#ifndef OPENSSL_NO_EC_NISTP_64_GCC_128 +# define OPENSSL_NO_EC_NISTP_64_GCC_128 +#endif +#ifndef OPENSSL_NO_GMP +# define OPENSSL_NO_GMP +#endif +#ifndef OPENSSL_NO_JPAKE +# define OPENSSL_NO_JPAKE +#endif +#ifndef OPENSSL_NO_KRB5 +# define OPENSSL_NO_KRB5 +#endif +#ifndef OPENSSL_NO_MD2 +# define OPENSSL_NO_MD2 +#endif +#ifndef OPENSSL_NO_RC5 +# define OPENSSL_NO_RC5 +#endif +#ifndef OPENSSL_NO_RFC3779 +# define OPENSSL_NO_RFC3779 +#endif +#ifndef OPENSSL_NO_SCTP +# define OPENSSL_NO_SCTP +#endif +#ifndef OPENSSL_NO_STORE +# define OPENSSL_NO_STORE +#endif + +#endif /* OPENSSL_DOING_MAKEDEPEND */ + +#ifndef OPENSSL_THREADS +# define OPENSSL_THREADS +#endif +#ifndef OPENSSL_NO_DYNAMIC_ENGINE +# define OPENSSL_NO_DYNAMIC_ENGINE +#endif + +/* The OPENSSL_NO_* macros are also defined as NO_* if the application + asks for it. This is a transient feature that is provided for those + who haven't had the time to do the appropriate changes in their + applications. */ +#ifdef OPENSSL_ALGORITHM_DEFINES +# if defined(OPENSSL_NO_EC_NISTP_64_GCC_128) && !defined(NO_EC_NISTP_64_GCC_128) +# define NO_EC_NISTP_64_GCC_128 +# endif +# if defined(OPENSSL_NO_GMP) && !defined(NO_GMP) +# define NO_GMP +# endif +# if defined(OPENSSL_NO_JPAKE) && !defined(NO_JPAKE) +# define NO_JPAKE +# endif +# if defined(OPENSSL_NO_KRB5) && !defined(NO_KRB5) +# define NO_KRB5 +# endif +# if defined(OPENSSL_NO_MD2) && !defined(NO_MD2) +# define NO_MD2 +# endif +# if defined(OPENSSL_NO_RC5) && !defined(NO_RC5) +# define NO_RC5 +# endif +# if defined(OPENSSL_NO_RFC3779) && !defined(NO_RFC3779) +# define NO_RFC3779 +# endif +# if defined(OPENSSL_NO_SCTP) && !defined(NO_SCTP) +# define NO_SCTP +# endif +# if defined(OPENSSL_NO_STORE) && !defined(NO_STORE) +# define NO_STORE +# endif +#endif + +#define OPENSSL_CPUID_OBJ + +/* crypto/opensslconf.h.in */ + +/* Generate 80386 code? */ +#undef I386_ONLY + +#if !(defined(VMS) || defined(__VMS)) /* VMS uses logical names instead */ +#if defined(HEADER_CRYPTLIB_H) && !defined(OPENSSLDIR) +#define ENGINESDIR "/usr/local/ssl/lib/engines" +#define OPENSSLDIR "/usr/local/ssl" +#endif +#endif + +#undef OPENSSL_UNISTD +#define OPENSSL_UNISTD + +#undef OPENSSL_EXPORT_VAR_AS_FUNCTION +#define OPENSSL_EXPORT_VAR_AS_FUNCTION + +#if defined(HEADER_IDEA_H) && !defined(IDEA_INT) +#define IDEA_INT unsigned int +#endif + +#if defined(HEADER_MD2_H) && !defined(MD2_INT) +#define MD2_INT unsigned int +#endif + +#if defined(HEADER_RC2_H) && !defined(RC2_INT) +/* I need to put in a mod for the alpha - eay */ +#define RC2_INT unsigned int +#endif + +#if defined(HEADER_RC4_H) +#if !defined(RC4_INT) +/* using int types make the structure larger but make the code faster + * on most boxes I have tested - up to %20 faster. */ +/* + * I don't know what does "most" mean, but declaring "int" is a must on: + * - Intel P6 because partial register stalls are very expensive; + * - elder Alpha because it lacks byte load/store instructions; + */ +#define RC4_INT unsigned int +#endif +#if !defined(RC4_CHUNK) +/* + * This enables code handling data aligned at natural CPU word + * boundary. See crypto/rc4/rc4_enc.c for further details. + */ +#undef RC4_CHUNK +#endif +#endif + +#if (defined(HEADER_NEW_DES_H) || defined(HEADER_DES_H)) && !defined(DES_LONG) +/* If this is set to 'unsigned int' on a DEC Alpha, this gives about a + * %20 speed up (longs are 8 bytes, int's are 4). */ +#ifndef DES_LONG +#define DES_LONG unsigned long +#endif +#endif + +#if defined(HEADER_BN_H) && !defined(CONFIG_HEADER_BN_H) +#define CONFIG_HEADER_BN_H +#define BN_LLONG + +/* Should we define BN_DIV2W here? */ + +/* Only one for the following should be defined */ +#undef SIXTY_FOUR_BIT_LONG +#undef SIXTY_FOUR_BIT +#define THIRTY_TWO_BIT +#endif + +#if defined(HEADER_RC4_LOCL_H) && !defined(CONFIG_HEADER_RC4_LOCL_H) +#define CONFIG_HEADER_RC4_LOCL_H +/* if this is defined data[i] is used instead of *data, this is a %20 + * speedup on x86 */ +#define RC4_INDEX +#endif + +#if defined(HEADER_BF_LOCL_H) && !defined(CONFIG_HEADER_BF_LOCL_H) +#define CONFIG_HEADER_BF_LOCL_H +#undef BF_PTR +#endif /* HEADER_BF_LOCL_H */ + +#if defined(HEADER_DES_LOCL_H) && !defined(CONFIG_HEADER_DES_LOCL_H) +#define CONFIG_HEADER_DES_LOCL_H +#ifndef DES_DEFAULT_OPTIONS +/* the following is tweaked from a config script, that is why it is a + * protected undef/define */ +#ifndef DES_PTR +#define DES_PTR +#endif + +/* This helps C compiler generate the correct code for multiple functional + * units. It reduces register dependancies at the expense of 2 more + * registers */ +#ifndef DES_RISC1 +#define DES_RISC1 +#endif + +#ifndef DES_RISC2 +#undef DES_RISC2 +#endif + +#if defined(DES_RISC1) && defined(DES_RISC2) +YOU SHOULD NOT HAVE BOTH DES_RISC1 AND DES_RISC2 DEFINED!!!!! +#endif + +/* Unroll the inner loop, this sometimes helps, sometimes hinders. + * Very mucy CPU dependant */ +#ifndef DES_UNROLL +#define DES_UNROLL +#endif + +/* These default values were supplied by + * Peter Gutman + * They are only used if nothing else has been defined */ +#if !defined(DES_PTR) && !defined(DES_RISC1) && !defined(DES_RISC2) && !defined(DES_UNROLL) +/* Special defines which change the way the code is built depending on the + CPU and OS. For SGI machines you can use _MIPS_SZLONG (32 or 64) to find + even newer MIPS CPU's, but at the moment one size fits all for + optimization options. Older Sparc's work better with only UNROLL, but + there's no way to tell at compile time what it is you're running on */ + +#if defined( sun ) /* Newer Sparc's */ +# define DES_PTR +# define DES_RISC1 +# define DES_UNROLL +#elif defined( __ultrix ) /* Older MIPS */ +# define DES_PTR +# define DES_RISC2 +# define DES_UNROLL +#elif defined( __osf1__ ) /* Alpha */ +# define DES_PTR +# define DES_RISC2 +#elif defined ( _AIX ) /* RS6000 */ + /* Unknown */ +#elif defined( __hpux ) /* HP-PA */ + /* Unknown */ +#elif defined( __aux ) /* 68K */ + /* Unknown */ +#elif defined( __dgux ) /* 88K (but P6 in latest boxes) */ +# define DES_UNROLL +#elif defined( __sgi ) /* Newer MIPS */ +# define DES_PTR +# define DES_RISC2 +# define DES_UNROLL +#elif defined(i386) || defined(__i386__) /* x86 boxes, should be gcc */ +# define DES_PTR +# define DES_RISC1 +# define DES_UNROLL +#endif /* Systems-specific speed defines */ +#endif + +#endif /* DES_DEFAULT_OPTIONS */ +#endif /* HEADER_DES_LOCL_H */ diff --git a/Source/Import/OpenSSL/Include/openssl/opensslv.h b/Source/Import/OpenSSL/Include/openssl/opensslv.h new file mode 100644 index 0000000..71be359 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/opensslv.h @@ -0,0 +1,89 @@ +#ifndef HEADER_OPENSSLV_H +#define HEADER_OPENSSLV_H + +/* Numeric release version identifier: + * MNNFFPPS: major minor fix patch status + * The status nibble has one of the values 0 for development, 1 to e for betas + * 1 to 14, and f for release. The patch level is exactly that. + * For example: + * 0.9.3-dev 0x00903000 + * 0.9.3-beta1 0x00903001 + * 0.9.3-beta2-dev 0x00903002 + * 0.9.3-beta2 0x00903002 (same as ...beta2-dev) + * 0.9.3 0x0090300f + * 0.9.3a 0x0090301f + * 0.9.4 0x0090400f + * 1.2.3z 0x102031af + * + * For continuity reasons (because 0.9.5 is already out, and is coded + * 0x00905100), between 0.9.5 and 0.9.6 the coding of the patch level + * part is slightly different, by setting the highest bit. This means + * that 0.9.5a looks like this: 0x0090581f. At 0.9.6, we can start + * with 0x0090600S... + * + * (Prior to 0.9.3-dev a different scheme was used: 0.9.2b is 0x0922.) + * (Prior to 0.9.5a beta1, a different scheme was used: MMNNFFRBB for + * major minor fix final patch/beta) + */ +#define OPENSSL_VERSION_NUMBER 0x1000103fL +#ifdef OPENSSL_FIPS +#define OPENSSL_VERSION_TEXT "OpenSSL 1.0.1c-fips 10 May 2012" +#else +#define OPENSSL_VERSION_TEXT "OpenSSL 1.0.1c 10 May 2012" +#endif +#define OPENSSL_VERSION_PTEXT " part of " OPENSSL_VERSION_TEXT + + +/* The macros below are to be used for shared library (.so, .dll, ...) + * versioning. That kind of versioning works a bit differently between + * operating systems. The most usual scheme is to set a major and a minor + * number, and have the runtime loader check that the major number is equal + * to what it was at application link time, while the minor number has to + * be greater or equal to what it was at application link time. With this + * scheme, the version number is usually part of the file name, like this: + * + * libcrypto.so.0.9 + * + * Some unixen also make a softlink with the major verson number only: + * + * libcrypto.so.0 + * + * On Tru64 and IRIX 6.x it works a little bit differently. There, the + * shared library version is stored in the file, and is actually a series + * of versions, separated by colons. The rightmost version present in the + * library when linking an application is stored in the application to be + * matched at run time. When the application is run, a check is done to + * see if the library version stored in the application matches any of the + * versions in the version string of the library itself. + * This version string can be constructed in any way, depending on what + * kind of matching is desired. However, to implement the same scheme as + * the one used in the other unixen, all compatible versions, from lowest + * to highest, should be part of the string. Consecutive builds would + * give the following versions strings: + * + * 3.0 + * 3.0:3.1 + * 3.0:3.1:3.2 + * 4.0 + * 4.0:4.1 + * + * Notice how version 4 is completely incompatible with version, and + * therefore give the breach you can see. + * + * There may be other schemes as well that I haven't yet discovered. + * + * So, here's the way it works here: first of all, the library version + * number doesn't need at all to match the overall OpenSSL version. + * However, it's nice and more understandable if it actually does. + * The current library version is stored in the macro SHLIB_VERSION_NUMBER, + * which is just a piece of text in the format "M.m.e" (Major, minor, edit). + * For the sake of Tru64, IRIX, and any other OS that behaves in similar ways, + * we need to keep a history of version numbers, which is done in the + * macro SHLIB_VERSION_HISTORY. The numbers are separated by colons and + * should only keep the versions that are binary compatible with the current. + */ +#define SHLIB_VERSION_HISTORY "" +#define SHLIB_VERSION_NUMBER "1.0.0" + + +#endif /* HEADER_OPENSSLV_H */ diff --git a/Source/Import/OpenSSL/Include/openssl/ossl_typ.h b/Source/Import/OpenSSL/Include/openssl/ossl_typ.h new file mode 100644 index 0000000..ea9227f --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ossl_typ.h @@ -0,0 +1,202 @@ +/* ==================================================================== + * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_OPENSSL_TYPES_H +#define HEADER_OPENSSL_TYPES_H + +#include + +#ifdef NO_ASN1_TYPEDEFS +#define ASN1_INTEGER ASN1_STRING +#define ASN1_ENUMERATED ASN1_STRING +#define ASN1_BIT_STRING ASN1_STRING +#define ASN1_OCTET_STRING ASN1_STRING +#define ASN1_PRINTABLESTRING ASN1_STRING +#define ASN1_T61STRING ASN1_STRING +#define ASN1_IA5STRING ASN1_STRING +#define ASN1_UTCTIME ASN1_STRING +#define ASN1_GENERALIZEDTIME ASN1_STRING +#define ASN1_TIME ASN1_STRING +#define ASN1_GENERALSTRING ASN1_STRING +#define ASN1_UNIVERSALSTRING ASN1_STRING +#define ASN1_BMPSTRING ASN1_STRING +#define ASN1_VISIBLESTRING ASN1_STRING +#define ASN1_UTF8STRING ASN1_STRING +#define ASN1_BOOLEAN int +#define ASN1_NULL int +#else +typedef struct asn1_string_st ASN1_INTEGER; +typedef struct asn1_string_st ASN1_ENUMERATED; +typedef struct asn1_string_st ASN1_BIT_STRING; +typedef struct asn1_string_st ASN1_OCTET_STRING; +typedef struct asn1_string_st ASN1_PRINTABLESTRING; +typedef struct asn1_string_st ASN1_T61STRING; +typedef struct asn1_string_st ASN1_IA5STRING; +typedef struct asn1_string_st ASN1_GENERALSTRING; +typedef struct asn1_string_st ASN1_UNIVERSALSTRING; +typedef struct asn1_string_st ASN1_BMPSTRING; +typedef struct asn1_string_st ASN1_UTCTIME; +typedef struct asn1_string_st ASN1_TIME; +typedef struct asn1_string_st ASN1_GENERALIZEDTIME; +typedef struct asn1_string_st ASN1_VISIBLESTRING; +typedef struct asn1_string_st ASN1_UTF8STRING; +typedef struct asn1_string_st ASN1_STRING; +typedef int ASN1_BOOLEAN; +typedef int ASN1_NULL; +#endif + +typedef struct ASN1_ITEM_st ASN1_ITEM; +typedef struct asn1_pctx_st ASN1_PCTX; + +#ifdef OPENSSL_SYS_WIN32 +#undef X509_NAME +#undef X509_EXTENSIONS +#undef X509_CERT_PAIR +#undef PKCS7_ISSUER_AND_SERIAL +#undef OCSP_REQUEST +#undef OCSP_RESPONSE +#endif + +#ifdef BIGNUM +#undef BIGNUM +#endif +typedef struct bignum_st BIGNUM; +typedef struct bignum_ctx BN_CTX; +typedef struct bn_blinding_st BN_BLINDING; +typedef struct bn_mont_ctx_st BN_MONT_CTX; +typedef struct bn_recp_ctx_st BN_RECP_CTX; +typedef struct bn_gencb_st BN_GENCB; + +typedef struct buf_mem_st BUF_MEM; + +typedef struct evp_cipher_st EVP_CIPHER; +typedef struct evp_cipher_ctx_st EVP_CIPHER_CTX; +typedef struct env_md_st EVP_MD; +typedef struct env_md_ctx_st EVP_MD_CTX; +typedef struct evp_pkey_st EVP_PKEY; + +typedef struct evp_pkey_asn1_method_st EVP_PKEY_ASN1_METHOD; + +typedef struct evp_pkey_method_st EVP_PKEY_METHOD; +typedef struct evp_pkey_ctx_st EVP_PKEY_CTX; + +typedef struct dh_st DH; +typedef struct dh_method DH_METHOD; + +typedef struct dsa_st DSA; +typedef struct dsa_method DSA_METHOD; + +typedef struct rsa_st RSA; +typedef struct rsa_meth_st RSA_METHOD; + +typedef struct rand_meth_st RAND_METHOD; + +typedef struct ecdh_method ECDH_METHOD; +typedef struct ecdsa_method ECDSA_METHOD; + +typedef struct x509_st X509; +typedef struct X509_algor_st X509_ALGOR; +typedef struct X509_crl_st X509_CRL; +typedef struct x509_crl_method_st X509_CRL_METHOD; +typedef struct x509_revoked_st X509_REVOKED; +typedef struct X509_name_st X509_NAME; +typedef struct X509_pubkey_st X509_PUBKEY; +typedef struct x509_store_st X509_STORE; +typedef struct x509_store_ctx_st X509_STORE_CTX; + +typedef struct pkcs8_priv_key_info_st PKCS8_PRIV_KEY_INFO; + +typedef struct v3_ext_ctx X509V3_CTX; +typedef struct conf_st CONF; + +typedef struct store_st STORE; +typedef struct store_method_st STORE_METHOD; + +typedef struct ui_st UI; +typedef struct ui_method_st UI_METHOD; + +typedef struct st_ERR_FNS ERR_FNS; + +typedef struct engine_st ENGINE; +typedef struct ssl_st SSL; +typedef struct ssl_ctx_st SSL_CTX; + +typedef struct X509_POLICY_NODE_st X509_POLICY_NODE; +typedef struct X509_POLICY_LEVEL_st X509_POLICY_LEVEL; +typedef struct X509_POLICY_TREE_st X509_POLICY_TREE; +typedef struct X509_POLICY_CACHE_st X509_POLICY_CACHE; + +typedef struct AUTHORITY_KEYID_st AUTHORITY_KEYID; +typedef struct DIST_POINT_st DIST_POINT; +typedef struct ISSUING_DIST_POINT_st ISSUING_DIST_POINT; +typedef struct NAME_CONSTRAINTS_st NAME_CONSTRAINTS; + + /* If placed in pkcs12.h, we end up with a circular depency with pkcs7.h */ +#define DECLARE_PKCS12_STACK_OF(type) /* Nothing */ +#define IMPLEMENT_PKCS12_STACK_OF(type) /* Nothing */ + +typedef struct crypto_ex_data_st CRYPTO_EX_DATA; +/* Callback types for crypto.h */ +typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad, + int idx, long argl, void *argp); +typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad, + int idx, long argl, void *argp); +typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, + int idx, long argl, void *argp); + +typedef struct ocsp_req_ctx_st OCSP_REQ_CTX; +typedef struct ocsp_response_st OCSP_RESPONSE; +typedef struct ocsp_responder_id_st OCSP_RESPID; + +#endif /* def HEADER_OPENSSL_TYPES_H */ diff --git a/Source/Import/OpenSSL/Include/openssl/pem.h b/Source/Import/OpenSSL/Include/openssl/pem.h new file mode 100644 index 0000000..8a6abab --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/pem.h @@ -0,0 +1,641 @@ +/* crypto/pem/pem.h */ +/* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_PEM_H +#define HEADER_PEM_H + +#include +#ifndef OPENSSL_NO_BIO +#include +#endif +#ifndef OPENSSL_NO_STACK +#include +#endif +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#define PEM_BUFSIZE 1024 + +#define PEM_OBJ_UNDEF 0 +#define PEM_OBJ_X509 1 +#define PEM_OBJ_X509_REQ 2 +#define PEM_OBJ_CRL 3 +#define PEM_OBJ_SSL_SESSION 4 +#define PEM_OBJ_PRIV_KEY 10 +#define PEM_OBJ_PRIV_RSA 11 +#define PEM_OBJ_PRIV_DSA 12 +#define PEM_OBJ_PRIV_DH 13 +#define PEM_OBJ_PUB_RSA 14 +#define PEM_OBJ_PUB_DSA 15 +#define PEM_OBJ_PUB_DH 16 +#define PEM_OBJ_DHPARAMS 17 +#define PEM_OBJ_DSAPARAMS 18 +#define PEM_OBJ_PRIV_RSA_PUBLIC 19 +#define PEM_OBJ_PRIV_ECDSA 20 +#define PEM_OBJ_PUB_ECDSA 21 +#define PEM_OBJ_ECPARAMETERS 22 + +#define PEM_ERROR 30 +#define PEM_DEK_DES_CBC 40 +#define PEM_DEK_IDEA_CBC 45 +#define PEM_DEK_DES_EDE 50 +#define PEM_DEK_DES_ECB 60 +#define PEM_DEK_RSA 70 +#define PEM_DEK_RSA_MD2 80 +#define PEM_DEK_RSA_MD5 90 + +#define PEM_MD_MD2 NID_md2 +#define PEM_MD_MD5 NID_md5 +#define PEM_MD_SHA NID_sha +#define PEM_MD_MD2_RSA NID_md2WithRSAEncryption +#define PEM_MD_MD5_RSA NID_md5WithRSAEncryption +#define PEM_MD_SHA_RSA NID_sha1WithRSAEncryption + +#define PEM_STRING_X509_OLD "X509 CERTIFICATE" +#define PEM_STRING_X509 "CERTIFICATE" +#define PEM_STRING_X509_PAIR "CERTIFICATE PAIR" +#define PEM_STRING_X509_TRUSTED "TRUSTED CERTIFICATE" +#define PEM_STRING_X509_REQ_OLD "NEW CERTIFICATE REQUEST" +#define PEM_STRING_X509_REQ "CERTIFICATE REQUEST" +#define PEM_STRING_X509_CRL "X509 CRL" +#define PEM_STRING_EVP_PKEY "ANY PRIVATE KEY" +#define PEM_STRING_PUBLIC "PUBLIC KEY" +#define PEM_STRING_RSA "RSA PRIVATE KEY" +#define PEM_STRING_RSA_PUBLIC "RSA PUBLIC KEY" +#define PEM_STRING_DSA "DSA PRIVATE KEY" +#define PEM_STRING_DSA_PUBLIC "DSA PUBLIC KEY" +#define PEM_STRING_PKCS7 "PKCS7" +#define PEM_STRING_PKCS7_SIGNED "PKCS #7 SIGNED DATA" +#define PEM_STRING_PKCS8 "ENCRYPTED PRIVATE KEY" +#define PEM_STRING_PKCS8INF "PRIVATE KEY" +#define PEM_STRING_DHPARAMS "DH PARAMETERS" +#define PEM_STRING_SSL_SESSION "SSL SESSION PARAMETERS" +#define PEM_STRING_DSAPARAMS "DSA PARAMETERS" +#define PEM_STRING_ECDSA_PUBLIC "ECDSA PUBLIC KEY" +#define PEM_STRING_ECPARAMETERS "EC PARAMETERS" +#define PEM_STRING_ECPRIVATEKEY "EC PRIVATE KEY" +#define PEM_STRING_PARAMETERS "PARAMETERS" +#define PEM_STRING_CMS "CMS" + + /* Note that this structure is initialised by PEM_SealInit and cleaned up + by PEM_SealFinal (at least for now) */ +typedef struct PEM_Encode_Seal_st + { + EVP_ENCODE_CTX encode; + EVP_MD_CTX md; + EVP_CIPHER_CTX cipher; + } PEM_ENCODE_SEAL_CTX; + +/* enc_type is one off */ +#define PEM_TYPE_ENCRYPTED 10 +#define PEM_TYPE_MIC_ONLY 20 +#define PEM_TYPE_MIC_CLEAR 30 +#define PEM_TYPE_CLEAR 40 + +typedef struct pem_recip_st + { + char *name; + X509_NAME *dn; + + int cipher; + int key_enc; + /* char iv[8]; unused and wrong size */ + } PEM_USER; + +typedef struct pem_ctx_st + { + int type; /* what type of object */ + + struct { + int version; + int mode; + } proc_type; + + char *domain; + + struct { + int cipher; + /* unused, and wrong size + unsigned char iv[8]; */ + } DEK_info; + + PEM_USER *originator; + + int num_recipient; + PEM_USER **recipient; + + /* XXX(ben): don#t think this is used! + STACK *x509_chain; / * certificate chain */ + EVP_MD *md; /* signature type */ + + int md_enc; /* is the md encrypted or not? */ + int md_len; /* length of md_data */ + char *md_data; /* message digest, could be pkey encrypted */ + + EVP_CIPHER *dec; /* date encryption cipher */ + int key_len; /* key length */ + unsigned char *key; /* key */ + /* unused, and wrong size + unsigned char iv[8]; */ + + + int data_enc; /* is the data encrypted */ + int data_len; + unsigned char *data; + } PEM_CTX; + +/* These macros make the PEM_read/PEM_write functions easier to maintain and + * write. Now they are all implemented with either: + * IMPLEMENT_PEM_rw(...) or IMPLEMENT_PEM_rw_cb(...) + */ + +#ifdef OPENSSL_NO_FP_API + +#define IMPLEMENT_PEM_read_fp(name, type, str, asn1) /**/ +#define IMPLEMENT_PEM_write_fp(name, type, str, asn1) /**/ +#define IMPLEMENT_PEM_write_fp_const(name, type, str, asn1) /**/ +#define IMPLEMENT_PEM_write_cb_fp(name, type, str, asn1) /**/ +#define IMPLEMENT_PEM_write_cb_fp_const(name, type, str, asn1) /**/ + +#else + +#define IMPLEMENT_PEM_read_fp(name, type, str, asn1) \ +type *PEM_read_##name(FILE *fp, type **x, pem_password_cb *cb, void *u)\ +{ \ +return PEM_ASN1_read((d2i_of_void *)d2i_##asn1, str,fp,(void **)x,cb,u); \ +} + +#define IMPLEMENT_PEM_write_fp(name, type, str, asn1) \ +int PEM_write_##name(FILE *fp, type *x) \ +{ \ +return PEM_ASN1_write((i2d_of_void *)i2d_##asn1,str,fp,x,NULL,NULL,0,NULL,NULL); \ +} + +#define IMPLEMENT_PEM_write_fp_const(name, type, str, asn1) \ +int PEM_write_##name(FILE *fp, const type *x) \ +{ \ +return PEM_ASN1_write((i2d_of_void *)i2d_##asn1,str,fp,(void *)x,NULL,NULL,0,NULL,NULL); \ +} + +#define IMPLEMENT_PEM_write_cb_fp(name, type, str, asn1) \ +int PEM_write_##name(FILE *fp, type *x, const EVP_CIPHER *enc, \ + unsigned char *kstr, int klen, pem_password_cb *cb, \ + void *u) \ + { \ + return PEM_ASN1_write((i2d_of_void *)i2d_##asn1,str,fp,x,enc,kstr,klen,cb,u); \ + } + +#define IMPLEMENT_PEM_write_cb_fp_const(name, type, str, asn1) \ +int PEM_write_##name(FILE *fp, type *x, const EVP_CIPHER *enc, \ + unsigned char *kstr, int klen, pem_password_cb *cb, \ + void *u) \ + { \ + return PEM_ASN1_write((i2d_of_void *)i2d_##asn1,str,fp,x,enc,kstr,klen,cb,u); \ + } + +#endif + +#define IMPLEMENT_PEM_read_bio(name, type, str, asn1) \ +type *PEM_read_bio_##name(BIO *bp, type **x, pem_password_cb *cb, void *u)\ +{ \ +return PEM_ASN1_read_bio((d2i_of_void *)d2i_##asn1, str,bp,(void **)x,cb,u); \ +} + +#define IMPLEMENT_PEM_write_bio(name, type, str, asn1) \ +int PEM_write_bio_##name(BIO *bp, type *x) \ +{ \ +return PEM_ASN1_write_bio((i2d_of_void *)i2d_##asn1,str,bp,x,NULL,NULL,0,NULL,NULL); \ +} + +#define IMPLEMENT_PEM_write_bio_const(name, type, str, asn1) \ +int PEM_write_bio_##name(BIO *bp, const type *x) \ +{ \ +return PEM_ASN1_write_bio((i2d_of_void *)i2d_##asn1,str,bp,(void *)x,NULL,NULL,0,NULL,NULL); \ +} + +#define IMPLEMENT_PEM_write_cb_bio(name, type, str, asn1) \ +int PEM_write_bio_##name(BIO *bp, type *x, const EVP_CIPHER *enc, \ + unsigned char *kstr, int klen, pem_password_cb *cb, void *u) \ + { \ + return PEM_ASN1_write_bio((i2d_of_void *)i2d_##asn1,str,bp,x,enc,kstr,klen,cb,u); \ + } + +#define IMPLEMENT_PEM_write_cb_bio_const(name, type, str, asn1) \ +int PEM_write_bio_##name(BIO *bp, type *x, const EVP_CIPHER *enc, \ + unsigned char *kstr, int klen, pem_password_cb *cb, void *u) \ + { \ + return PEM_ASN1_write_bio((i2d_of_void *)i2d_##asn1,str,bp,(void *)x,enc,kstr,klen,cb,u); \ + } + +#define IMPLEMENT_PEM_write(name, type, str, asn1) \ + IMPLEMENT_PEM_write_bio(name, type, str, asn1) \ + IMPLEMENT_PEM_write_fp(name, type, str, asn1) + +#define IMPLEMENT_PEM_write_const(name, type, str, asn1) \ + IMPLEMENT_PEM_write_bio_const(name, type, str, asn1) \ + IMPLEMENT_PEM_write_fp_const(name, type, str, asn1) + +#define IMPLEMENT_PEM_write_cb(name, type, str, asn1) \ + IMPLEMENT_PEM_write_cb_bio(name, type, str, asn1) \ + IMPLEMENT_PEM_write_cb_fp(name, type, str, asn1) + +#define IMPLEMENT_PEM_write_cb_const(name, type, str, asn1) \ + IMPLEMENT_PEM_write_cb_bio_const(name, type, str, asn1) \ + IMPLEMENT_PEM_write_cb_fp_const(name, type, str, asn1) + +#define IMPLEMENT_PEM_read(name, type, str, asn1) \ + IMPLEMENT_PEM_read_bio(name, type, str, asn1) \ + IMPLEMENT_PEM_read_fp(name, type, str, asn1) + +#define IMPLEMENT_PEM_rw(name, type, str, asn1) \ + IMPLEMENT_PEM_read(name, type, str, asn1) \ + IMPLEMENT_PEM_write(name, type, str, asn1) + +#define IMPLEMENT_PEM_rw_const(name, type, str, asn1) \ + IMPLEMENT_PEM_read(name, type, str, asn1) \ + IMPLEMENT_PEM_write_const(name, type, str, asn1) + +#define IMPLEMENT_PEM_rw_cb(name, type, str, asn1) \ + IMPLEMENT_PEM_read(name, type, str, asn1) \ + IMPLEMENT_PEM_write_cb(name, type, str, asn1) + +/* These are the same except they are for the declarations */ + +#if defined(OPENSSL_NO_FP_API) + +#define DECLARE_PEM_read_fp(name, type) /**/ +#define DECLARE_PEM_write_fp(name, type) /**/ +#define DECLARE_PEM_write_cb_fp(name, type) /**/ + +#else + +#define DECLARE_PEM_read_fp(name, type) \ + type *PEM_read_##name(FILE *fp, type **x, pem_password_cb *cb, void *u); + +#define DECLARE_PEM_write_fp(name, type) \ + int PEM_write_##name(FILE *fp, type *x); + +#define DECLARE_PEM_write_fp_const(name, type) \ + int PEM_write_##name(FILE *fp, const type *x); + +#define DECLARE_PEM_write_cb_fp(name, type) \ + int PEM_write_##name(FILE *fp, type *x, const EVP_CIPHER *enc, \ + unsigned char *kstr, int klen, pem_password_cb *cb, void *u); + +#endif + +#ifndef OPENSSL_NO_BIO +#define DECLARE_PEM_read_bio(name, type) \ + type *PEM_read_bio_##name(BIO *bp, type **x, pem_password_cb *cb, void *u); + +#define DECLARE_PEM_write_bio(name, type) \ + int PEM_write_bio_##name(BIO *bp, type *x); + +#define DECLARE_PEM_write_bio_const(name, type) \ + int PEM_write_bio_##name(BIO *bp, const type *x); + +#define DECLARE_PEM_write_cb_bio(name, type) \ + int PEM_write_bio_##name(BIO *bp, type *x, const EVP_CIPHER *enc, \ + unsigned char *kstr, int klen, pem_password_cb *cb, void *u); + +#else + +#define DECLARE_PEM_read_bio(name, type) /**/ +#define DECLARE_PEM_write_bio(name, type) /**/ +#define DECLARE_PEM_write_bio_const(name, type) /**/ +#define DECLARE_PEM_write_cb_bio(name, type) /**/ + +#endif + +#define DECLARE_PEM_write(name, type) \ + DECLARE_PEM_write_bio(name, type) \ + DECLARE_PEM_write_fp(name, type) + +#define DECLARE_PEM_write_const(name, type) \ + DECLARE_PEM_write_bio_const(name, type) \ + DECLARE_PEM_write_fp_const(name, type) + +#define DECLARE_PEM_write_cb(name, type) \ + DECLARE_PEM_write_cb_bio(name, type) \ + DECLARE_PEM_write_cb_fp(name, type) + +#define DECLARE_PEM_read(name, type) \ + DECLARE_PEM_read_bio(name, type) \ + DECLARE_PEM_read_fp(name, type) + +#define DECLARE_PEM_rw(name, type) \ + DECLARE_PEM_read(name, type) \ + DECLARE_PEM_write(name, type) + +#define DECLARE_PEM_rw_const(name, type) \ + DECLARE_PEM_read(name, type) \ + DECLARE_PEM_write_const(name, type) + +#define DECLARE_PEM_rw_cb(name, type) \ + DECLARE_PEM_read(name, type) \ + DECLARE_PEM_write_cb(name, type) + +#if 1 +/* "userdata": new with OpenSSL 0.9.4 */ +typedef int pem_password_cb(char *buf, int size, int rwflag, void *userdata); +#else +/* OpenSSL 0.9.3, 0.9.3a */ +typedef int pem_password_cb(char *buf, int size, int rwflag); +#endif + +int PEM_get_EVP_CIPHER_INFO(char *header, EVP_CIPHER_INFO *cipher); +int PEM_do_header (EVP_CIPHER_INFO *cipher, unsigned char *data,long *len, + pem_password_cb *callback,void *u); + +#ifndef OPENSSL_NO_BIO +int PEM_read_bio(BIO *bp, char **name, char **header, + unsigned char **data,long *len); +int PEM_write_bio(BIO *bp,const char *name,char *hdr,unsigned char *data, + long len); +int PEM_bytes_read_bio(unsigned char **pdata, long *plen, char **pnm, const char *name, BIO *bp, + pem_password_cb *cb, void *u); +void * PEM_ASN1_read_bio(d2i_of_void *d2i, const char *name, BIO *bp, + void **x, pem_password_cb *cb, void *u); +int PEM_ASN1_write_bio(i2d_of_void *i2d,const char *name,BIO *bp, void *x, + const EVP_CIPHER *enc,unsigned char *kstr,int klen, + pem_password_cb *cb, void *u); + +STACK_OF(X509_INFO) * PEM_X509_INFO_read_bio(BIO *bp, STACK_OF(X509_INFO) *sk, pem_password_cb *cb, void *u); +int PEM_X509_INFO_write_bio(BIO *bp,X509_INFO *xi, EVP_CIPHER *enc, + unsigned char *kstr, int klen, pem_password_cb *cd, void *u); +#endif + +int PEM_read(FILE *fp, char **name, char **header, + unsigned char **data,long *len); +int PEM_write(FILE *fp,char *name,char *hdr,unsigned char *data,long len); +void * PEM_ASN1_read(d2i_of_void *d2i, const char *name, FILE *fp, void **x, + pem_password_cb *cb, void *u); +int PEM_ASN1_write(i2d_of_void *i2d,const char *name,FILE *fp, + void *x,const EVP_CIPHER *enc,unsigned char *kstr, + int klen,pem_password_cb *callback, void *u); +STACK_OF(X509_INFO) * PEM_X509_INFO_read(FILE *fp, STACK_OF(X509_INFO) *sk, + pem_password_cb *cb, void *u); + +int PEM_SealInit(PEM_ENCODE_SEAL_CTX *ctx, EVP_CIPHER *type, + EVP_MD *md_type, unsigned char **ek, int *ekl, + unsigned char *iv, EVP_PKEY **pubk, int npubk); +void PEM_SealUpdate(PEM_ENCODE_SEAL_CTX *ctx, unsigned char *out, int *outl, + unsigned char *in, int inl); +int PEM_SealFinal(PEM_ENCODE_SEAL_CTX *ctx, unsigned char *sig,int *sigl, + unsigned char *out, int *outl, EVP_PKEY *priv); + +void PEM_SignInit(EVP_MD_CTX *ctx, EVP_MD *type); +void PEM_SignUpdate(EVP_MD_CTX *ctx,unsigned char *d,unsigned int cnt); +int PEM_SignFinal(EVP_MD_CTX *ctx, unsigned char *sigret, + unsigned int *siglen, EVP_PKEY *pkey); + +int PEM_def_callback(char *buf, int num, int w, void *key); +void PEM_proc_type(char *buf, int type); +void PEM_dek_info(char *buf, const char *type, int len, char *str); + + +#include + +DECLARE_PEM_rw(X509, X509) + +DECLARE_PEM_rw(X509_AUX, X509) + +DECLARE_PEM_rw(X509_CERT_PAIR, X509_CERT_PAIR) + +DECLARE_PEM_rw(X509_REQ, X509_REQ) +DECLARE_PEM_write(X509_REQ_NEW, X509_REQ) + +DECLARE_PEM_rw(X509_CRL, X509_CRL) + +DECLARE_PEM_rw(PKCS7, PKCS7) + +DECLARE_PEM_rw(NETSCAPE_CERT_SEQUENCE, NETSCAPE_CERT_SEQUENCE) + +DECLARE_PEM_rw(PKCS8, X509_SIG) + +DECLARE_PEM_rw(PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO) + +#ifndef OPENSSL_NO_RSA + +DECLARE_PEM_rw_cb(RSAPrivateKey, RSA) + +DECLARE_PEM_rw_const(RSAPublicKey, RSA) +DECLARE_PEM_rw(RSA_PUBKEY, RSA) + +#endif + +#ifndef OPENSSL_NO_DSA + +DECLARE_PEM_rw_cb(DSAPrivateKey, DSA) + +DECLARE_PEM_rw(DSA_PUBKEY, DSA) + +DECLARE_PEM_rw_const(DSAparams, DSA) + +#endif + +#ifndef OPENSSL_NO_EC +DECLARE_PEM_rw_const(ECPKParameters, EC_GROUP) +DECLARE_PEM_rw_cb(ECPrivateKey, EC_KEY) +DECLARE_PEM_rw(EC_PUBKEY, EC_KEY) +#endif + +#ifndef OPENSSL_NO_DH + +DECLARE_PEM_rw_const(DHparams, DH) + +#endif + +DECLARE_PEM_rw_cb(PrivateKey, EVP_PKEY) + +DECLARE_PEM_rw(PUBKEY, EVP_PKEY) + +int PEM_write_bio_PKCS8PrivateKey_nid(BIO *bp, EVP_PKEY *x, int nid, + char *kstr, int klen, + pem_password_cb *cb, void *u); +int PEM_write_bio_PKCS8PrivateKey(BIO *, EVP_PKEY *, const EVP_CIPHER *, + char *, int, pem_password_cb *, void *); +int i2d_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc, + char *kstr, int klen, + pem_password_cb *cb, void *u); +int i2d_PKCS8PrivateKey_nid_bio(BIO *bp, EVP_PKEY *x, int nid, + char *kstr, int klen, + pem_password_cb *cb, void *u); +EVP_PKEY *d2i_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY **x, pem_password_cb *cb, void *u); + +int i2d_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc, + char *kstr, int klen, + pem_password_cb *cb, void *u); +int i2d_PKCS8PrivateKey_nid_fp(FILE *fp, EVP_PKEY *x, int nid, + char *kstr, int klen, + pem_password_cb *cb, void *u); +int PEM_write_PKCS8PrivateKey_nid(FILE *fp, EVP_PKEY *x, int nid, + char *kstr, int klen, + pem_password_cb *cb, void *u); + +EVP_PKEY *d2i_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY **x, pem_password_cb *cb, void *u); + +int PEM_write_PKCS8PrivateKey(FILE *fp,EVP_PKEY *x,const EVP_CIPHER *enc, + char *kstr,int klen, pem_password_cb *cd, void *u); + +EVP_PKEY *PEM_read_bio_Parameters(BIO *bp, EVP_PKEY **x); +int PEM_write_bio_Parameters(BIO *bp, EVP_PKEY *x); + + +EVP_PKEY *b2i_PrivateKey(const unsigned char **in, long length); +EVP_PKEY *b2i_PublicKey(const unsigned char **in, long length); +EVP_PKEY *b2i_PrivateKey_bio(BIO *in); +EVP_PKEY *b2i_PublicKey_bio(BIO *in); +int i2b_PrivateKey_bio(BIO *out, EVP_PKEY *pk); +int i2b_PublicKey_bio(BIO *out, EVP_PKEY *pk); +#ifndef OPENSSL_NO_RC4 +EVP_PKEY *b2i_PVK_bio(BIO *in, pem_password_cb *cb, void *u); +int i2b_PVK_bio(BIO *out, EVP_PKEY *pk, int enclevel, + pem_password_cb *cb, void *u); +#endif + + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_PEM_strings(void); + +/* Error codes for the PEM functions. */ + +/* Function codes. */ +#define PEM_F_B2I_DSS 127 +#define PEM_F_B2I_PVK_BIO 128 +#define PEM_F_B2I_RSA 129 +#define PEM_F_CHECK_BITLEN_DSA 130 +#define PEM_F_CHECK_BITLEN_RSA 131 +#define PEM_F_D2I_PKCS8PRIVATEKEY_BIO 120 +#define PEM_F_D2I_PKCS8PRIVATEKEY_FP 121 +#define PEM_F_DO_B2I 132 +#define PEM_F_DO_B2I_BIO 133 +#define PEM_F_DO_BLOB_HEADER 134 +#define PEM_F_DO_PK8PKEY 126 +#define PEM_F_DO_PK8PKEY_FP 125 +#define PEM_F_DO_PVK_BODY 135 +#define PEM_F_DO_PVK_HEADER 136 +#define PEM_F_I2B_PVK 137 +#define PEM_F_I2B_PVK_BIO 138 +#define PEM_F_LOAD_IV 101 +#define PEM_F_PEM_ASN1_READ 102 +#define PEM_F_PEM_ASN1_READ_BIO 103 +#define PEM_F_PEM_ASN1_WRITE 104 +#define PEM_F_PEM_ASN1_WRITE_BIO 105 +#define PEM_F_PEM_DEF_CALLBACK 100 +#define PEM_F_PEM_DO_HEADER 106 +#define PEM_F_PEM_F_PEM_WRITE_PKCS8PRIVATEKEY 118 +#define PEM_F_PEM_GET_EVP_CIPHER_INFO 107 +#define PEM_F_PEM_PK8PKEY 119 +#define PEM_F_PEM_READ 108 +#define PEM_F_PEM_READ_BIO 109 +#define PEM_F_PEM_READ_BIO_PARAMETERS 140 +#define PEM_F_PEM_READ_BIO_PRIVATEKEY 123 +#define PEM_F_PEM_READ_PRIVATEKEY 124 +#define PEM_F_PEM_SEALFINAL 110 +#define PEM_F_PEM_SEALINIT 111 +#define PEM_F_PEM_SIGNFINAL 112 +#define PEM_F_PEM_WRITE 113 +#define PEM_F_PEM_WRITE_BIO 114 +#define PEM_F_PEM_WRITE_PRIVATEKEY 139 +#define PEM_F_PEM_X509_INFO_READ 115 +#define PEM_F_PEM_X509_INFO_READ_BIO 116 +#define PEM_F_PEM_X509_INFO_WRITE_BIO 117 + +/* Reason codes. */ +#define PEM_R_BAD_BASE64_DECODE 100 +#define PEM_R_BAD_DECRYPT 101 +#define PEM_R_BAD_END_LINE 102 +#define PEM_R_BAD_IV_CHARS 103 +#define PEM_R_BAD_MAGIC_NUMBER 116 +#define PEM_R_BAD_PASSWORD_READ 104 +#define PEM_R_BAD_VERSION_NUMBER 117 +#define PEM_R_BIO_WRITE_FAILURE 118 +#define PEM_R_CIPHER_IS_NULL 127 +#define PEM_R_ERROR_CONVERTING_PRIVATE_KEY 115 +#define PEM_R_EXPECTING_PRIVATE_KEY_BLOB 119 +#define PEM_R_EXPECTING_PUBLIC_KEY_BLOB 120 +#define PEM_R_INCONSISTENT_HEADER 121 +#define PEM_R_KEYBLOB_HEADER_PARSE_ERROR 122 +#define PEM_R_KEYBLOB_TOO_SHORT 123 +#define PEM_R_NOT_DEK_INFO 105 +#define PEM_R_NOT_ENCRYPTED 106 +#define PEM_R_NOT_PROC_TYPE 107 +#define PEM_R_NO_START_LINE 108 +#define PEM_R_PROBLEMS_GETTING_PASSWORD 109 +#define PEM_R_PUBLIC_KEY_NO_RSA 110 +#define PEM_R_PVK_DATA_TOO_SHORT 124 +#define PEM_R_PVK_TOO_SHORT 125 +#define PEM_R_READ_KEY 111 +#define PEM_R_SHORT_HEADER 112 +#define PEM_R_UNSUPPORTED_CIPHER 113 +#define PEM_R_UNSUPPORTED_ENCRYPTION 114 +#define PEM_R_UNSUPPORTED_KEY_COMPONENTS 126 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/pem2.h b/Source/Import/OpenSSL/Include/openssl/pem2.h new file mode 100644 index 0000000..f31790d --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/pem2.h @@ -0,0 +1,70 @@ +/* ==================================================================== + * Copyright (c) 1999 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +/* + * This header only exists to break a circular dependency between pem and err + * Ben 30 Jan 1999. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef HEADER_PEM_H +void ERR_load_PEM_strings(void); +#endif + +#ifdef __cplusplus +} +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/pkcs12.h b/Source/Import/OpenSSL/Include/openssl/pkcs12.h new file mode 100644 index 0000000..b17eb9f --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/pkcs12.h @@ -0,0 +1,331 @@ +/* pkcs12.h */ +/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL + * project 1999. + */ +/* ==================================================================== + * Copyright (c) 1999 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_PKCS12_H +#define HEADER_PKCS12_H + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#define PKCS12_KEY_ID 1 +#define PKCS12_IV_ID 2 +#define PKCS12_MAC_ID 3 + +/* Default iteration count */ +#ifndef PKCS12_DEFAULT_ITER +#define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER +#endif + +#define PKCS12_MAC_KEY_LENGTH 20 + +#define PKCS12_SALT_LEN 8 + +/* Uncomment out next line for unicode password and names, otherwise ASCII */ + +/*#define PBE_UNICODE*/ + +#ifdef PBE_UNICODE +#define PKCS12_key_gen PKCS12_key_gen_uni +#define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni +#else +#define PKCS12_key_gen PKCS12_key_gen_asc +#define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc +#endif + +/* MS key usage constants */ + +#define KEY_EX 0x10 +#define KEY_SIG 0x80 + +typedef struct { +X509_SIG *dinfo; +ASN1_OCTET_STRING *salt; +ASN1_INTEGER *iter; /* defaults to 1 */ +} PKCS12_MAC_DATA; + +typedef struct { +ASN1_INTEGER *version; +PKCS12_MAC_DATA *mac; +PKCS7 *authsafes; +} PKCS12; + +typedef struct { +ASN1_OBJECT *type; +union { + struct pkcs12_bag_st *bag; /* secret, crl and certbag */ + struct pkcs8_priv_key_info_st *keybag; /* keybag */ + X509_SIG *shkeybag; /* shrouded key bag */ + STACK_OF(PKCS12_SAFEBAG) *safes; + ASN1_TYPE *other; +}value; +STACK_OF(X509_ATTRIBUTE) *attrib; +} PKCS12_SAFEBAG; + +DECLARE_STACK_OF(PKCS12_SAFEBAG) +DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG) +DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG) + +typedef struct pkcs12_bag_st { +ASN1_OBJECT *type; +union { + ASN1_OCTET_STRING *x509cert; + ASN1_OCTET_STRING *x509crl; + ASN1_OCTET_STRING *octet; + ASN1_IA5STRING *sdsicert; + ASN1_TYPE *other; /* Secret or other bag */ +}value; +} PKCS12_BAGS; + +#define PKCS12_ERROR 0 +#define PKCS12_OK 1 + +/* Compatibility macros */ + +#define M_PKCS12_x5092certbag PKCS12_x5092certbag +#define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag + +#define M_PKCS12_certbag2x509 PKCS12_certbag2x509 +#define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl + +#define M_PKCS12_unpack_p7data PKCS12_unpack_p7data +#define M_PKCS12_pack_authsafes PKCS12_pack_authsafes +#define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes +#define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata + +#define M_PKCS12_decrypt_skey PKCS12_decrypt_skey +#define M_PKCS8_decrypt PKCS8_decrypt + +#define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type) +#define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type) +#define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type + +#define PKCS12_get_attr(bag, attr_nid) \ + PKCS12_get_attr_gen(bag->attrib, attr_nid) + +#define PKCS8_get_attr(p8, attr_nid) \ + PKCS12_get_attr_gen(p8->attributes, attr_nid) + +#define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0) + + +PKCS12_SAFEBAG *PKCS12_x5092certbag(X509 *x509); +PKCS12_SAFEBAG *PKCS12_x509crl2certbag(X509_CRL *crl); +X509 *PKCS12_certbag2x509(PKCS12_SAFEBAG *bag); +X509_CRL *PKCS12_certbag2x509crl(PKCS12_SAFEBAG *bag); + +PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it, int nid1, + int nid2); +PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8); +PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *p8, const char *pass, int passlen); +PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag, const char *pass, + int passlen); +X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, + const char *pass, int passlen, + unsigned char *salt, int saltlen, int iter, + PKCS8_PRIV_KEY_INFO *p8); +PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass, + int passlen, unsigned char *salt, + int saltlen, int iter, + PKCS8_PRIV_KEY_INFO *p8); +PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk); +STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7); +PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen, + unsigned char *salt, int saltlen, int iter, + STACK_OF(PKCS12_SAFEBAG) *bags); +STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass, int passlen); + +int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes); +STACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12); + +int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen); +int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name, + int namelen); +int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name, + int namelen); +int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name, + int namelen); +int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage); +ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid); +char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag); +unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass, + int passlen, unsigned char *in, int inlen, + unsigned char **data, int *datalen, int en_de); +void * PKCS12_item_decrypt_d2i(X509_ALGOR *algor, const ASN1_ITEM *it, + const char *pass, int passlen, ASN1_OCTET_STRING *oct, int zbuf); +ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor, const ASN1_ITEM *it, + const char *pass, int passlen, + void *obj, int zbuf); +PKCS12 *PKCS12_init(int mode); +int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt, + int saltlen, int id, int iter, int n, + unsigned char *out, const EVP_MD *md_type); +int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int id, int iter, int n, unsigned char *out, const EVP_MD *md_type); +int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, + ASN1_TYPE *param, const EVP_CIPHER *cipher, const EVP_MD *md_type, + int en_de); +int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen, + unsigned char *mac, unsigned int *maclen); +int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen); +int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen, + unsigned char *salt, int saltlen, int iter, + const EVP_MD *md_type); +int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, + int saltlen, const EVP_MD *md_type); +unsigned char *OPENSSL_asc2uni(const char *asc, int asclen, unsigned char **uni, int *unilen); +char *OPENSSL_uni2asc(unsigned char *uni, int unilen); + +DECLARE_ASN1_FUNCTIONS(PKCS12) +DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA) +DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG) +DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS) + +DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS) +DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES) + +void PKCS12_PBE_add(void); +int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert, + STACK_OF(X509) **ca); +PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert, + STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter, + int mac_iter, int keytype); + +PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert); +PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags, EVP_PKEY *key, + int key_usage, int iter, + int key_nid, char *pass); +int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags, + int safe_nid, int iter, char *pass); +PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid); + +int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12); +int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12); +PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12); +PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12); +int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass); + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_PKCS12_strings(void); + +/* Error codes for the PKCS12 functions. */ + +/* Function codes. */ +#define PKCS12_F_PARSE_BAG 129 +#define PKCS12_F_PARSE_BAGS 103 +#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME 100 +#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC 127 +#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI 102 +#define PKCS12_F_PKCS12_ADD_LOCALKEYID 104 +#define PKCS12_F_PKCS12_CREATE 105 +#define PKCS12_F_PKCS12_GEN_MAC 107 +#define PKCS12_F_PKCS12_INIT 109 +#define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I 106 +#define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT 108 +#define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG 117 +#define PKCS12_F_PKCS12_KEY_GEN_ASC 110 +#define PKCS12_F_PKCS12_KEY_GEN_UNI 111 +#define PKCS12_F_PKCS12_MAKE_KEYBAG 112 +#define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113 +#define PKCS12_F_PKCS12_NEWPASS 128 +#define PKCS12_F_PKCS12_PACK_P7DATA 114 +#define PKCS12_F_PKCS12_PACK_P7ENCDATA 115 +#define PKCS12_F_PKCS12_PARSE 118 +#define PKCS12_F_PKCS12_PBE_CRYPT 119 +#define PKCS12_F_PKCS12_PBE_KEYIVGEN 120 +#define PKCS12_F_PKCS12_SETUP_MAC 122 +#define PKCS12_F_PKCS12_SET_MAC 123 +#define PKCS12_F_PKCS12_UNPACK_AUTHSAFES 130 +#define PKCS12_F_PKCS12_UNPACK_P7DATA 131 +#define PKCS12_F_PKCS12_VERIFY_MAC 126 +#define PKCS12_F_PKCS8_ADD_KEYUSAGE 124 +#define PKCS12_F_PKCS8_ENCRYPT 125 + +/* Reason codes. */ +#define PKCS12_R_CANT_PACK_STRUCTURE 100 +#define PKCS12_R_CONTENT_TYPE_NOT_DATA 121 +#define PKCS12_R_DECODE_ERROR 101 +#define PKCS12_R_ENCODE_ERROR 102 +#define PKCS12_R_ENCRYPT_ERROR 103 +#define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120 +#define PKCS12_R_INVALID_NULL_ARGUMENT 104 +#define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105 +#define PKCS12_R_IV_GEN_ERROR 106 +#define PKCS12_R_KEY_GEN_ERROR 107 +#define PKCS12_R_MAC_ABSENT 108 +#define PKCS12_R_MAC_GENERATION_ERROR 109 +#define PKCS12_R_MAC_SETUP_ERROR 110 +#define PKCS12_R_MAC_STRING_SET_ERROR 111 +#define PKCS12_R_MAC_VERIFY_ERROR 112 +#define PKCS12_R_MAC_VERIFY_FAILURE 113 +#define PKCS12_R_PARSE_ERROR 114 +#define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115 +#define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116 +#define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117 +#define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118 +#define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/pkcs7.h b/Source/Import/OpenSSL/Include/openssl/pkcs7.h new file mode 100644 index 0000000..e4d4431 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/pkcs7.h @@ -0,0 +1,499 @@ +/* crypto/pkcs7/pkcs7.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_PKCS7_H +#define HEADER_PKCS7_H + +#include +#include +#include + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef OPENSSL_SYS_WIN32 +/* Under Win32 thes are defined in wincrypt.h */ +#undef PKCS7_ISSUER_AND_SERIAL +#undef PKCS7_SIGNER_INFO +#endif + +/* +Encryption_ID DES-CBC +Digest_ID MD5 +Digest_Encryption_ID rsaEncryption +Key_Encryption_ID rsaEncryption +*/ + +typedef struct pkcs7_issuer_and_serial_st + { + X509_NAME *issuer; + ASN1_INTEGER *serial; + } PKCS7_ISSUER_AND_SERIAL; + +typedef struct pkcs7_signer_info_st + { + ASN1_INTEGER *version; /* version 1 */ + PKCS7_ISSUER_AND_SERIAL *issuer_and_serial; + X509_ALGOR *digest_alg; + STACK_OF(X509_ATTRIBUTE) *auth_attr; /* [ 0 ] */ + X509_ALGOR *digest_enc_alg; + ASN1_OCTET_STRING *enc_digest; + STACK_OF(X509_ATTRIBUTE) *unauth_attr; /* [ 1 ] */ + + /* The private key to sign with */ + EVP_PKEY *pkey; + } PKCS7_SIGNER_INFO; + +DECLARE_STACK_OF(PKCS7_SIGNER_INFO) +DECLARE_ASN1_SET_OF(PKCS7_SIGNER_INFO) + +typedef struct pkcs7_recip_info_st + { + ASN1_INTEGER *version; /* version 0 */ + PKCS7_ISSUER_AND_SERIAL *issuer_and_serial; + X509_ALGOR *key_enc_algor; + ASN1_OCTET_STRING *enc_key; + X509 *cert; /* get the pub-key from this */ + } PKCS7_RECIP_INFO; + +DECLARE_STACK_OF(PKCS7_RECIP_INFO) +DECLARE_ASN1_SET_OF(PKCS7_RECIP_INFO) + +typedef struct pkcs7_signed_st + { + ASN1_INTEGER *version; /* version 1 */ + STACK_OF(X509_ALGOR) *md_algs; /* md used */ + STACK_OF(X509) *cert; /* [ 0 ] */ + STACK_OF(X509_CRL) *crl; /* [ 1 ] */ + STACK_OF(PKCS7_SIGNER_INFO) *signer_info; + + struct pkcs7_st *contents; + } PKCS7_SIGNED; +/* The above structure is very very similar to PKCS7_SIGN_ENVELOPE. + * How about merging the two */ + +typedef struct pkcs7_enc_content_st + { + ASN1_OBJECT *content_type; + X509_ALGOR *algorithm; + ASN1_OCTET_STRING *enc_data; /* [ 0 ] */ + const EVP_CIPHER *cipher; + } PKCS7_ENC_CONTENT; + +typedef struct pkcs7_enveloped_st + { + ASN1_INTEGER *version; /* version 0 */ + STACK_OF(PKCS7_RECIP_INFO) *recipientinfo; + PKCS7_ENC_CONTENT *enc_data; + } PKCS7_ENVELOPE; + +typedef struct pkcs7_signedandenveloped_st + { + ASN1_INTEGER *version; /* version 1 */ + STACK_OF(X509_ALGOR) *md_algs; /* md used */ + STACK_OF(X509) *cert; /* [ 0 ] */ + STACK_OF(X509_CRL) *crl; /* [ 1 ] */ + STACK_OF(PKCS7_SIGNER_INFO) *signer_info; + + PKCS7_ENC_CONTENT *enc_data; + STACK_OF(PKCS7_RECIP_INFO) *recipientinfo; + } PKCS7_SIGN_ENVELOPE; + +typedef struct pkcs7_digest_st + { + ASN1_INTEGER *version; /* version 0 */ + X509_ALGOR *md; /* md used */ + struct pkcs7_st *contents; + ASN1_OCTET_STRING *digest; + } PKCS7_DIGEST; + +typedef struct pkcs7_encrypted_st + { + ASN1_INTEGER *version; /* version 0 */ + PKCS7_ENC_CONTENT *enc_data; + } PKCS7_ENCRYPT; + +typedef struct pkcs7_st + { + /* The following is non NULL if it contains ASN1 encoding of + * this structure */ + unsigned char *asn1; + long length; + +#define PKCS7_S_HEADER 0 +#define PKCS7_S_BODY 1 +#define PKCS7_S_TAIL 2 + int state; /* used during processing */ + + int detached; + + ASN1_OBJECT *type; + /* content as defined by the type */ + /* all encryption/message digests are applied to the 'contents', + * leaving out the 'type' field. */ + union { + char *ptr; + + /* NID_pkcs7_data */ + ASN1_OCTET_STRING *data; + + /* NID_pkcs7_signed */ + PKCS7_SIGNED *sign; + + /* NID_pkcs7_enveloped */ + PKCS7_ENVELOPE *enveloped; + + /* NID_pkcs7_signedAndEnveloped */ + PKCS7_SIGN_ENVELOPE *signed_and_enveloped; + + /* NID_pkcs7_digest */ + PKCS7_DIGEST *digest; + + /* NID_pkcs7_encrypted */ + PKCS7_ENCRYPT *encrypted; + + /* Anything else */ + ASN1_TYPE *other; + } d; + } PKCS7; + +DECLARE_STACK_OF(PKCS7) +DECLARE_ASN1_SET_OF(PKCS7) +DECLARE_PKCS12_STACK_OF(PKCS7) + +#define PKCS7_OP_SET_DETACHED_SIGNATURE 1 +#define PKCS7_OP_GET_DETACHED_SIGNATURE 2 + +#define PKCS7_get_signed_attributes(si) ((si)->auth_attr) +#define PKCS7_get_attributes(si) ((si)->unauth_attr) + +#define PKCS7_type_is_signed(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_signed) +#define PKCS7_type_is_encrypted(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_encrypted) +#define PKCS7_type_is_enveloped(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_enveloped) +#define PKCS7_type_is_signedAndEnveloped(a) \ + (OBJ_obj2nid((a)->type) == NID_pkcs7_signedAndEnveloped) +#define PKCS7_type_is_data(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_data) +#define PKCS7_type_is_digest(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_digest) +#define PKCS7_type_is_encrypted(a) \ + (OBJ_obj2nid((a)->type) == NID_pkcs7_encrypted) + +#define PKCS7_type_is_digest(a) (OBJ_obj2nid((a)->type) == NID_pkcs7_digest) + +#define PKCS7_set_detached(p,v) \ + PKCS7_ctrl(p,PKCS7_OP_SET_DETACHED_SIGNATURE,v,NULL) +#define PKCS7_get_detached(p) \ + PKCS7_ctrl(p,PKCS7_OP_GET_DETACHED_SIGNATURE,0,NULL) + +#define PKCS7_is_detached(p7) (PKCS7_type_is_signed(p7) && PKCS7_get_detached(p7)) + +/* S/MIME related flags */ + +#define PKCS7_TEXT 0x1 +#define PKCS7_NOCERTS 0x2 +#define PKCS7_NOSIGS 0x4 +#define PKCS7_NOCHAIN 0x8 +#define PKCS7_NOINTERN 0x10 +#define PKCS7_NOVERIFY 0x20 +#define PKCS7_DETACHED 0x40 +#define PKCS7_BINARY 0x80 +#define PKCS7_NOATTR 0x100 +#define PKCS7_NOSMIMECAP 0x200 +#define PKCS7_NOOLDMIMETYPE 0x400 +#define PKCS7_CRLFEOL 0x800 +#define PKCS7_STREAM 0x1000 +#define PKCS7_NOCRL 0x2000 +#define PKCS7_PARTIAL 0x4000 +#define PKCS7_REUSE_DIGEST 0x8000 + +/* Flags: for compatibility with older code */ + +#define SMIME_TEXT PKCS7_TEXT +#define SMIME_NOCERTS PKCS7_NOCERTS +#define SMIME_NOSIGS PKCS7_NOSIGS +#define SMIME_NOCHAIN PKCS7_NOCHAIN +#define SMIME_NOINTERN PKCS7_NOINTERN +#define SMIME_NOVERIFY PKCS7_NOVERIFY +#define SMIME_DETACHED PKCS7_DETACHED +#define SMIME_BINARY PKCS7_BINARY +#define SMIME_NOATTR PKCS7_NOATTR + +DECLARE_ASN1_FUNCTIONS(PKCS7_ISSUER_AND_SERIAL) + +int PKCS7_ISSUER_AND_SERIAL_digest(PKCS7_ISSUER_AND_SERIAL *data,const EVP_MD *type, + unsigned char *md,unsigned int *len); +#ifndef OPENSSL_NO_FP_API +PKCS7 *d2i_PKCS7_fp(FILE *fp,PKCS7 **p7); +int i2d_PKCS7_fp(FILE *fp,PKCS7 *p7); +#endif +PKCS7 *PKCS7_dup(PKCS7 *p7); +PKCS7 *d2i_PKCS7_bio(BIO *bp,PKCS7 **p7); +int i2d_PKCS7_bio(BIO *bp,PKCS7 *p7); +int i2d_PKCS7_bio_stream(BIO *out, PKCS7 *p7, BIO *in, int flags); +int PEM_write_bio_PKCS7_stream(BIO *out, PKCS7 *p7, BIO *in, int flags); + +DECLARE_ASN1_FUNCTIONS(PKCS7_SIGNER_INFO) +DECLARE_ASN1_FUNCTIONS(PKCS7_RECIP_INFO) +DECLARE_ASN1_FUNCTIONS(PKCS7_SIGNED) +DECLARE_ASN1_FUNCTIONS(PKCS7_ENC_CONTENT) +DECLARE_ASN1_FUNCTIONS(PKCS7_ENVELOPE) +DECLARE_ASN1_FUNCTIONS(PKCS7_SIGN_ENVELOPE) +DECLARE_ASN1_FUNCTIONS(PKCS7_DIGEST) +DECLARE_ASN1_FUNCTIONS(PKCS7_ENCRYPT) +DECLARE_ASN1_FUNCTIONS(PKCS7) + +DECLARE_ASN1_ITEM(PKCS7_ATTR_SIGN) +DECLARE_ASN1_ITEM(PKCS7_ATTR_VERIFY) + +DECLARE_ASN1_NDEF_FUNCTION(PKCS7) +DECLARE_ASN1_PRINT_FUNCTION(PKCS7) + +long PKCS7_ctrl(PKCS7 *p7, int cmd, long larg, char *parg); + +int PKCS7_set_type(PKCS7 *p7, int type); +int PKCS7_set0_type_other(PKCS7 *p7, int type, ASN1_TYPE *other); +int PKCS7_set_content(PKCS7 *p7, PKCS7 *p7_data); +int PKCS7_SIGNER_INFO_set(PKCS7_SIGNER_INFO *p7i, X509 *x509, EVP_PKEY *pkey, + const EVP_MD *dgst); +int PKCS7_SIGNER_INFO_sign(PKCS7_SIGNER_INFO *si); +int PKCS7_add_signer(PKCS7 *p7, PKCS7_SIGNER_INFO *p7i); +int PKCS7_add_certificate(PKCS7 *p7, X509 *x509); +int PKCS7_add_crl(PKCS7 *p7, X509_CRL *x509); +int PKCS7_content_new(PKCS7 *p7, int nid); +int PKCS7_dataVerify(X509_STORE *cert_store, X509_STORE_CTX *ctx, + BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si); +int PKCS7_signatureVerify(BIO *bio, PKCS7 *p7, PKCS7_SIGNER_INFO *si, + X509 *x509); + +BIO *PKCS7_dataInit(PKCS7 *p7, BIO *bio); +int PKCS7_dataFinal(PKCS7 *p7, BIO *bio); +BIO *PKCS7_dataDecode(PKCS7 *p7, EVP_PKEY *pkey, BIO *in_bio, X509 *pcert); + + +PKCS7_SIGNER_INFO *PKCS7_add_signature(PKCS7 *p7, X509 *x509, + EVP_PKEY *pkey, const EVP_MD *dgst); +X509 *PKCS7_cert_from_signer_info(PKCS7 *p7, PKCS7_SIGNER_INFO *si); +int PKCS7_set_digest(PKCS7 *p7, const EVP_MD *md); +STACK_OF(PKCS7_SIGNER_INFO) *PKCS7_get_signer_info(PKCS7 *p7); + +PKCS7_RECIP_INFO *PKCS7_add_recipient(PKCS7 *p7, X509 *x509); +void PKCS7_SIGNER_INFO_get0_algs(PKCS7_SIGNER_INFO *si, EVP_PKEY **pk, + X509_ALGOR **pdig, X509_ALGOR **psig); +void PKCS7_RECIP_INFO_get0_alg(PKCS7_RECIP_INFO *ri, X509_ALGOR **penc); +int PKCS7_add_recipient_info(PKCS7 *p7, PKCS7_RECIP_INFO *ri); +int PKCS7_RECIP_INFO_set(PKCS7_RECIP_INFO *p7i, X509 *x509); +int PKCS7_set_cipher(PKCS7 *p7, const EVP_CIPHER *cipher); +int PKCS7_stream(unsigned char ***boundary, PKCS7 *p7); + +PKCS7_ISSUER_AND_SERIAL *PKCS7_get_issuer_and_serial(PKCS7 *p7, int idx); +ASN1_OCTET_STRING *PKCS7_digest_from_attributes(STACK_OF(X509_ATTRIBUTE) *sk); +int PKCS7_add_signed_attribute(PKCS7_SIGNER_INFO *p7si,int nid,int type, + void *data); +int PKCS7_add_attribute (PKCS7_SIGNER_INFO *p7si, int nid, int atrtype, + void *value); +ASN1_TYPE *PKCS7_get_attribute(PKCS7_SIGNER_INFO *si, int nid); +ASN1_TYPE *PKCS7_get_signed_attribute(PKCS7_SIGNER_INFO *si, int nid); +int PKCS7_set_signed_attributes(PKCS7_SIGNER_INFO *p7si, + STACK_OF(X509_ATTRIBUTE) *sk); +int PKCS7_set_attributes(PKCS7_SIGNER_INFO *p7si,STACK_OF(X509_ATTRIBUTE) *sk); + + +PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, + BIO *data, int flags); + +PKCS7_SIGNER_INFO *PKCS7_sign_add_signer(PKCS7 *p7, + X509 *signcert, EVP_PKEY *pkey, const EVP_MD *md, + int flags); + +int PKCS7_final(PKCS7 *p7, BIO *data, int flags); +int PKCS7_verify(PKCS7 *p7, STACK_OF(X509) *certs, X509_STORE *store, + BIO *indata, BIO *out, int flags); +STACK_OF(X509) *PKCS7_get0_signers(PKCS7 *p7, STACK_OF(X509) *certs, int flags); +PKCS7 *PKCS7_encrypt(STACK_OF(X509) *certs, BIO *in, const EVP_CIPHER *cipher, + int flags); +int PKCS7_decrypt(PKCS7 *p7, EVP_PKEY *pkey, X509 *cert, BIO *data, int flags); + +int PKCS7_add_attrib_smimecap(PKCS7_SIGNER_INFO *si, + STACK_OF(X509_ALGOR) *cap); +STACK_OF(X509_ALGOR) *PKCS7_get_smimecap(PKCS7_SIGNER_INFO *si); +int PKCS7_simple_smimecap(STACK_OF(X509_ALGOR) *sk, int nid, int arg); + +int PKCS7_add_attrib_content_type(PKCS7_SIGNER_INFO *si, ASN1_OBJECT *coid); +int PKCS7_add0_attrib_signing_time(PKCS7_SIGNER_INFO *si, ASN1_TIME *t); +int PKCS7_add1_attrib_digest(PKCS7_SIGNER_INFO *si, + const unsigned char *md, int mdlen); + +int SMIME_write_PKCS7(BIO *bio, PKCS7 *p7, BIO *data, int flags); +PKCS7 *SMIME_read_PKCS7(BIO *bio, BIO **bcont); + +BIO *BIO_new_PKCS7(BIO *out, PKCS7 *p7); + + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_PKCS7_strings(void); + +/* Error codes for the PKCS7 functions. */ + +/* Function codes. */ +#define PKCS7_F_B64_READ_PKCS7 120 +#define PKCS7_F_B64_WRITE_PKCS7 121 +#define PKCS7_F_DO_PKCS7_SIGNED_ATTRIB 136 +#define PKCS7_F_I2D_PKCS7_BIO_STREAM 140 +#define PKCS7_F_PKCS7_ADD0_ATTRIB_SIGNING_TIME 135 +#define PKCS7_F_PKCS7_ADD_ATTRIB_SMIMECAP 118 +#define PKCS7_F_PKCS7_ADD_CERTIFICATE 100 +#define PKCS7_F_PKCS7_ADD_CRL 101 +#define PKCS7_F_PKCS7_ADD_RECIPIENT_INFO 102 +#define PKCS7_F_PKCS7_ADD_SIGNATURE 131 +#define PKCS7_F_PKCS7_ADD_SIGNER 103 +#define PKCS7_F_PKCS7_BIO_ADD_DIGEST 125 +#define PKCS7_F_PKCS7_COPY_EXISTING_DIGEST 138 +#define PKCS7_F_PKCS7_CTRL 104 +#define PKCS7_F_PKCS7_DATADECODE 112 +#define PKCS7_F_PKCS7_DATAFINAL 128 +#define PKCS7_F_PKCS7_DATAINIT 105 +#define PKCS7_F_PKCS7_DATASIGN 106 +#define PKCS7_F_PKCS7_DATAVERIFY 107 +#define PKCS7_F_PKCS7_DECRYPT 114 +#define PKCS7_F_PKCS7_DECRYPT_RINFO 133 +#define PKCS7_F_PKCS7_ENCODE_RINFO 132 +#define PKCS7_F_PKCS7_ENCRYPT 115 +#define PKCS7_F_PKCS7_FINAL 134 +#define PKCS7_F_PKCS7_FIND_DIGEST 127 +#define PKCS7_F_PKCS7_GET0_SIGNERS 124 +#define PKCS7_F_PKCS7_RECIP_INFO_SET 130 +#define PKCS7_F_PKCS7_SET_CIPHER 108 +#define PKCS7_F_PKCS7_SET_CONTENT 109 +#define PKCS7_F_PKCS7_SET_DIGEST 126 +#define PKCS7_F_PKCS7_SET_TYPE 110 +#define PKCS7_F_PKCS7_SIGN 116 +#define PKCS7_F_PKCS7_SIGNATUREVERIFY 113 +#define PKCS7_F_PKCS7_SIGNER_INFO_SET 129 +#define PKCS7_F_PKCS7_SIGNER_INFO_SIGN 139 +#define PKCS7_F_PKCS7_SIGN_ADD_SIGNER 137 +#define PKCS7_F_PKCS7_SIMPLE_SMIMECAP 119 +#define PKCS7_F_PKCS7_VERIFY 117 +#define PKCS7_F_SMIME_READ_PKCS7 122 +#define PKCS7_F_SMIME_TEXT 123 + +/* Reason codes. */ +#define PKCS7_R_CERTIFICATE_VERIFY_ERROR 117 +#define PKCS7_R_CIPHER_HAS_NO_OBJECT_IDENTIFIER 144 +#define PKCS7_R_CIPHER_NOT_INITIALIZED 116 +#define PKCS7_R_CONTENT_AND_DATA_PRESENT 118 +#define PKCS7_R_CTRL_ERROR 152 +#define PKCS7_R_DECODE_ERROR 130 +#define PKCS7_R_DECRYPTED_KEY_IS_WRONG_LENGTH 100 +#define PKCS7_R_DECRYPT_ERROR 119 +#define PKCS7_R_DIGEST_FAILURE 101 +#define PKCS7_R_ENCRYPTION_CTRL_FAILURE 149 +#define PKCS7_R_ENCRYPTION_NOT_SUPPORTED_FOR_THIS_KEY_TYPE 150 +#define PKCS7_R_ERROR_ADDING_RECIPIENT 120 +#define PKCS7_R_ERROR_SETTING_CIPHER 121 +#define PKCS7_R_INVALID_MIME_TYPE 131 +#define PKCS7_R_INVALID_NULL_POINTER 143 +#define PKCS7_R_MIME_NO_CONTENT_TYPE 132 +#define PKCS7_R_MIME_PARSE_ERROR 133 +#define PKCS7_R_MIME_SIG_PARSE_ERROR 134 +#define PKCS7_R_MISSING_CERIPEND_INFO 103 +#define PKCS7_R_NO_CONTENT 122 +#define PKCS7_R_NO_CONTENT_TYPE 135 +#define PKCS7_R_NO_DEFAULT_DIGEST 151 +#define PKCS7_R_NO_MATCHING_DIGEST_TYPE_FOUND 154 +#define PKCS7_R_NO_MULTIPART_BODY_FAILURE 136 +#define PKCS7_R_NO_MULTIPART_BOUNDARY 137 +#define PKCS7_R_NO_RECIPIENT_MATCHES_CERTIFICATE 115 +#define PKCS7_R_NO_RECIPIENT_MATCHES_KEY 146 +#define PKCS7_R_NO_SIGNATURES_ON_DATA 123 +#define PKCS7_R_NO_SIGNERS 142 +#define PKCS7_R_NO_SIG_CONTENT_TYPE 138 +#define PKCS7_R_OPERATION_NOT_SUPPORTED_ON_THIS_TYPE 104 +#define PKCS7_R_PKCS7_ADD_SIGNATURE_ERROR 124 +#define PKCS7_R_PKCS7_ADD_SIGNER_ERROR 153 +#define PKCS7_R_PKCS7_DATAFINAL 126 +#define PKCS7_R_PKCS7_DATAFINAL_ERROR 125 +#define PKCS7_R_PKCS7_DATASIGN 145 +#define PKCS7_R_PKCS7_PARSE_ERROR 139 +#define PKCS7_R_PKCS7_SIG_PARSE_ERROR 140 +#define PKCS7_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 127 +#define PKCS7_R_SIGNATURE_FAILURE 105 +#define PKCS7_R_SIGNER_CERTIFICATE_NOT_FOUND 128 +#define PKCS7_R_SIGNING_CTRL_FAILURE 147 +#define PKCS7_R_SIGNING_NOT_SUPPORTED_FOR_THIS_KEY_TYPE 148 +#define PKCS7_R_SIG_INVALID_MIME_TYPE 141 +#define PKCS7_R_SMIME_TEXT_ERROR 129 +#define PKCS7_R_UNABLE_TO_FIND_CERTIFICATE 106 +#define PKCS7_R_UNABLE_TO_FIND_MEM_BIO 107 +#define PKCS7_R_UNABLE_TO_FIND_MESSAGE_DIGEST 108 +#define PKCS7_R_UNKNOWN_DIGEST_TYPE 109 +#define PKCS7_R_UNKNOWN_OPERATION 110 +#define PKCS7_R_UNSUPPORTED_CIPHER_TYPE 111 +#define PKCS7_R_UNSUPPORTED_CONTENT_TYPE 112 +#define PKCS7_R_WRONG_CONTENT_TYPE 113 +#define PKCS7_R_WRONG_PKCS7_TYPE 114 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/pqueue.h b/Source/Import/OpenSSL/Include/openssl/pqueue.h new file mode 100644 index 0000000..87fc903 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/pqueue.h @@ -0,0 +1,94 @@ +/* crypto/pqueue/pqueue.h */ +/* + * DTLS implementation written by Nagendra Modadugu + * (nagendra@cs.stanford.edu) for the OpenSSL project 2005. + */ +/* ==================================================================== + * Copyright (c) 1999-2005 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_PQUEUE_H +#define HEADER_PQUEUE_H + +#include +#include +#include + +typedef struct _pqueue *pqueue; + +typedef struct _pitem + { + unsigned char priority[8]; /* 64-bit value in big-endian encoding */ + void *data; + struct _pitem *next; + } pitem; + +typedef struct _pitem *piterator; + +pitem *pitem_new(unsigned char *prio64be, void *data); +void pitem_free(pitem *item); + +pqueue pqueue_new(void); +void pqueue_free(pqueue pq); + +pitem *pqueue_insert(pqueue pq, pitem *item); +pitem *pqueue_peek(pqueue pq); +pitem *pqueue_pop(pqueue pq); +pitem *pqueue_find(pqueue pq, unsigned char *prio64be); +pitem *pqueue_iterator(pqueue pq); +pitem *pqueue_next(piterator *iter); + +void pqueue_print(pqueue pq); +int pqueue_size(pqueue pq); + +#endif /* ! HEADER_PQUEUE_H */ diff --git a/Source/Import/OpenSSL/Include/openssl/rand.h b/Source/Import/OpenSSL/Include/openssl/rand.h new file mode 100644 index 0000000..dc8fcf9 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/rand.h @@ -0,0 +1,149 @@ +/* crypto/rand/rand.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_RAND_H +#define HEADER_RAND_H + +#include +#include +#include + +#if defined(OPENSSL_SYS_WINDOWS) +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#if defined(OPENSSL_FIPS) +#define FIPS_RAND_SIZE_T size_t +#endif + +/* Already defined in ossl_typ.h */ +/* typedef struct rand_meth_st RAND_METHOD; */ + +struct rand_meth_st + { + void (*seed)(const void *buf, int num); + int (*bytes)(unsigned char *buf, int num); + void (*cleanup)(void); + void (*add)(const void *buf, int num, double entropy); + int (*pseudorand)(unsigned char *buf, int num); + int (*status)(void); + }; + +#ifdef BN_DEBUG +extern int rand_predictable; +#endif + +int RAND_set_rand_method(const RAND_METHOD *meth); +const RAND_METHOD *RAND_get_rand_method(void); +#ifndef OPENSSL_NO_ENGINE +int RAND_set_rand_engine(ENGINE *engine); +#endif +RAND_METHOD *RAND_SSLeay(void); +void RAND_cleanup(void ); +int RAND_bytes(unsigned char *buf,int num); +int RAND_pseudo_bytes(unsigned char *buf,int num); +void RAND_seed(const void *buf,int num); +void RAND_add(const void *buf,int num,double entropy); +int RAND_load_file(const char *file,long max_bytes); +int RAND_write_file(const char *file); +const char *RAND_file_name(char *file,size_t num); +int RAND_status(void); +int RAND_query_egd_bytes(const char *path, unsigned char *buf, int bytes); +int RAND_egd(const char *path); +int RAND_egd_bytes(const char *path,int bytes); +int RAND_poll(void); + +#if defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32) + +void RAND_screen(void); +int RAND_event(UINT, WPARAM, LPARAM); + +#endif + +#ifdef OPENSSL_FIPS +void RAND_set_fips_drbg_type(int type, int flags); +int RAND_init_fips(void); +#endif + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_RAND_strings(void); + +/* Error codes for the RAND functions. */ + +/* Function codes. */ +#define RAND_F_RAND_GET_RAND_METHOD 101 +#define RAND_F_RAND_INIT_FIPS 102 +#define RAND_F_SSLEAY_RAND_BYTES 100 + +/* Reason codes. */ +#define RAND_R_ERROR_INITIALISING_DRBG 102 +#define RAND_R_ERROR_INSTANTIATING_DRBG 103 +#define RAND_R_NO_FIPS_RANDOM_METHOD_SET 101 +#define RAND_R_PRNG_NOT_SEEDED 100 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/rc2.h b/Source/Import/OpenSSL/Include/openssl/rc2.h new file mode 100644 index 0000000..e542ec9 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/rc2.h @@ -0,0 +1,103 @@ +/* crypto/rc2/rc2.h */ +/* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_RC2_H +#define HEADER_RC2_H + +#include /* OPENSSL_NO_RC2, RC2_INT */ +#ifdef OPENSSL_NO_RC2 +#error RC2 is disabled. +#endif + +#define RC2_ENCRYPT 1 +#define RC2_DECRYPT 0 + +#define RC2_BLOCK 8 +#define RC2_KEY_LENGTH 16 + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct rc2_key_st + { + RC2_INT data[64]; + } RC2_KEY; + +#ifdef OPENSSL_FIPS +void private_RC2_set_key(RC2_KEY *key, int len, const unsigned char *data,int bits); +#endif +void RC2_set_key(RC2_KEY *key, int len, const unsigned char *data,int bits); +void RC2_ecb_encrypt(const unsigned char *in,unsigned char *out,RC2_KEY *key, + int enc); +void RC2_encrypt(unsigned long *data,RC2_KEY *key); +void RC2_decrypt(unsigned long *data,RC2_KEY *key); +void RC2_cbc_encrypt(const unsigned char *in, unsigned char *out, long length, + RC2_KEY *ks, unsigned char *iv, int enc); +void RC2_cfb64_encrypt(const unsigned char *in, unsigned char *out, + long length, RC2_KEY *schedule, unsigned char *ivec, + int *num, int enc); +void RC2_ofb64_encrypt(const unsigned char *in, unsigned char *out, + long length, RC2_KEY *schedule, unsigned char *ivec, + int *num); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/rc4.h b/Source/Import/OpenSSL/Include/openssl/rc4.h new file mode 100644 index 0000000..88ceb46 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/rc4.h @@ -0,0 +1,90 @@ +/* crypto/rc4/rc4.h */ +/* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_RC4_H +#define HEADER_RC4_H + +#include /* OPENSSL_NO_RC4, RC4_INT */ +#ifdef OPENSSL_NO_RC4 +#error RC4 is disabled. +#endif + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct rc4_key_st + { + RC4_INT x,y; + RC4_INT data[256]; + } RC4_KEY; + + +const char *RC4_options(void); +void RC4_set_key(RC4_KEY *key, int len, const unsigned char *data); +void private_RC4_set_key(RC4_KEY *key, int len, const unsigned char *data); +void RC4(RC4_KEY *key, size_t len, const unsigned char *indata, + unsigned char *outdata); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/ripemd.h b/Source/Import/OpenSSL/Include/openssl/ripemd.h new file mode 100644 index 0000000..189bd8c --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ripemd.h @@ -0,0 +1,107 @@ +/* crypto/ripemd/ripemd.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_RIPEMD_H +#define HEADER_RIPEMD_H + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef OPENSSL_NO_RIPEMD +#error RIPEMD is disabled. +#endif + +#if defined(__LP32__) +#define RIPEMD160_LONG unsigned long +#elif defined(OPENSSL_SYS_CRAY) || defined(__ILP64__) +#define RIPEMD160_LONG unsigned long +#define RIPEMD160_LONG_LOG2 3 +#else +#define RIPEMD160_LONG unsigned int +#endif + +#define RIPEMD160_CBLOCK 64 +#define RIPEMD160_LBLOCK (RIPEMD160_CBLOCK/4) +#define RIPEMD160_DIGEST_LENGTH 20 + +typedef struct RIPEMD160state_st + { + RIPEMD160_LONG A,B,C,D,E; + RIPEMD160_LONG Nl,Nh; + RIPEMD160_LONG data[RIPEMD160_LBLOCK]; + unsigned int num; + } RIPEMD160_CTX; + +#ifdef OPENSSL_FIPS +int private_RIPEMD160_Init(RIPEMD160_CTX *c); +#endif +int RIPEMD160_Init(RIPEMD160_CTX *c); +int RIPEMD160_Update(RIPEMD160_CTX *c, const void *data, size_t len); +int RIPEMD160_Final(unsigned char *md, RIPEMD160_CTX *c); +unsigned char *RIPEMD160(const unsigned char *d, size_t n, + unsigned char *md); +void RIPEMD160_Transform(RIPEMD160_CTX *c, const unsigned char *b); +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/rsa.h b/Source/Import/OpenSSL/Include/openssl/rsa.h new file mode 100644 index 0000000..4814a2f --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/rsa.h @@ -0,0 +1,582 @@ +/* crypto/rsa/rsa.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_RSA_H +#define HEADER_RSA_H + +#include + +#ifndef OPENSSL_NO_BIO +#include +#endif +#include +#include +#ifndef OPENSSL_NO_DEPRECATED +#include +#endif + +#ifdef OPENSSL_NO_RSA +#error RSA is disabled. +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/* Declared already in ossl_typ.h */ +/* typedef struct rsa_st RSA; */ +/* typedef struct rsa_meth_st RSA_METHOD; */ + +struct rsa_meth_st + { + const char *name; + int (*rsa_pub_enc)(int flen,const unsigned char *from, + unsigned char *to, + RSA *rsa,int padding); + int (*rsa_pub_dec)(int flen,const unsigned char *from, + unsigned char *to, + RSA *rsa,int padding); + int (*rsa_priv_enc)(int flen,const unsigned char *from, + unsigned char *to, + RSA *rsa,int padding); + int (*rsa_priv_dec)(int flen,const unsigned char *from, + unsigned char *to, + RSA *rsa,int padding); + int (*rsa_mod_exp)(BIGNUM *r0,const BIGNUM *I,RSA *rsa,BN_CTX *ctx); /* Can be null */ + int (*bn_mod_exp)(BIGNUM *r, const BIGNUM *a, const BIGNUM *p, + const BIGNUM *m, BN_CTX *ctx, + BN_MONT_CTX *m_ctx); /* Can be null */ + int (*init)(RSA *rsa); /* called at new */ + int (*finish)(RSA *rsa); /* called at free */ + int flags; /* RSA_METHOD_FLAG_* things */ + char *app_data; /* may be needed! */ +/* New sign and verify functions: some libraries don't allow arbitrary data + * to be signed/verified: this allows them to be used. Note: for this to work + * the RSA_public_decrypt() and RSA_private_encrypt() should *NOT* be used + * RSA_sign(), RSA_verify() should be used instead. Note: for backwards + * compatibility this functionality is only enabled if the RSA_FLAG_SIGN_VER + * option is set in 'flags'. + */ + int (*rsa_sign)(int type, + const unsigned char *m, unsigned int m_length, + unsigned char *sigret, unsigned int *siglen, const RSA *rsa); + int (*rsa_verify)(int dtype, + const unsigned char *m, unsigned int m_length, + const unsigned char *sigbuf, unsigned int siglen, + const RSA *rsa); +/* If this callback is NULL, the builtin software RSA key-gen will be used. This + * is for behavioural compatibility whilst the code gets rewired, but one day + * it would be nice to assume there are no such things as "builtin software" + * implementations. */ + int (*rsa_keygen)(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb); + }; + +struct rsa_st + { + /* The first parameter is used to pickup errors where + * this is passed instead of aEVP_PKEY, it is set to 0 */ + int pad; + long version; + const RSA_METHOD *meth; + /* functional reference if 'meth' is ENGINE-provided */ + ENGINE *engine; + BIGNUM *n; + BIGNUM *e; + BIGNUM *d; + BIGNUM *p; + BIGNUM *q; + BIGNUM *dmp1; + BIGNUM *dmq1; + BIGNUM *iqmp; + /* be careful using this if the RSA structure is shared */ + CRYPTO_EX_DATA ex_data; + int references; + int flags; + + /* Used to cache montgomery values */ + BN_MONT_CTX *_method_mod_n; + BN_MONT_CTX *_method_mod_p; + BN_MONT_CTX *_method_mod_q; + + /* all BIGNUM values are actually in the following data, if it is not + * NULL */ + char *bignum_data; + BN_BLINDING *blinding; + BN_BLINDING *mt_blinding; + }; + +#ifndef OPENSSL_RSA_MAX_MODULUS_BITS +# define OPENSSL_RSA_MAX_MODULUS_BITS 16384 +#endif + +#ifndef OPENSSL_RSA_SMALL_MODULUS_BITS +# define OPENSSL_RSA_SMALL_MODULUS_BITS 3072 +#endif +#ifndef OPENSSL_RSA_MAX_PUBEXP_BITS +# define OPENSSL_RSA_MAX_PUBEXP_BITS 64 /* exponent limit enforced for "large" modulus only */ +#endif + +#define RSA_3 0x3L +#define RSA_F4 0x10001L + +#define RSA_METHOD_FLAG_NO_CHECK 0x0001 /* don't check pub/private match */ + +#define RSA_FLAG_CACHE_PUBLIC 0x0002 +#define RSA_FLAG_CACHE_PRIVATE 0x0004 +#define RSA_FLAG_BLINDING 0x0008 +#define RSA_FLAG_THREAD_SAFE 0x0010 +/* This flag means the private key operations will be handled by rsa_mod_exp + * and that they do not depend on the private key components being present: + * for example a key stored in external hardware. Without this flag bn_mod_exp + * gets called when private key components are absent. + */ +#define RSA_FLAG_EXT_PKEY 0x0020 + +/* This flag in the RSA_METHOD enables the new rsa_sign, rsa_verify functions. + */ +#define RSA_FLAG_SIGN_VER 0x0040 + +#define RSA_FLAG_NO_BLINDING 0x0080 /* new with 0.9.6j and 0.9.7b; the built-in + * RSA implementation now uses blinding by + * default (ignoring RSA_FLAG_BLINDING), + * but other engines might not need it + */ +#define RSA_FLAG_NO_CONSTTIME 0x0100 /* new with 0.9.8f; the built-in RSA + * implementation now uses constant time + * operations by default in private key operations, + * e.g., constant time modular exponentiation, + * modular inverse without leaking branches, + * division without leaking branches. This + * flag disables these constant time + * operations and results in faster RSA + * private key operations. + */ +#ifndef OPENSSL_NO_DEPRECATED +#define RSA_FLAG_NO_EXP_CONSTTIME RSA_FLAG_NO_CONSTTIME /* deprecated name for the flag*/ + /* new with 0.9.7h; the built-in RSA + * implementation now uses constant time + * modular exponentiation for secret exponents + * by default. This flag causes the + * faster variable sliding window method to + * be used for all exponents. + */ +#endif + + +#define EVP_PKEY_CTX_set_rsa_padding(ctx, pad) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, -1, EVP_PKEY_CTRL_RSA_PADDING, \ + pad, NULL) + +#define EVP_PKEY_CTX_get_rsa_padding(ctx, ppad) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, -1, \ + EVP_PKEY_CTRL_GET_RSA_PADDING, 0, ppad) + +#define EVP_PKEY_CTX_set_rsa_pss_saltlen(ctx, len) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, \ + (EVP_PKEY_OP_SIGN|EVP_PKEY_OP_VERIFY), \ + EVP_PKEY_CTRL_RSA_PSS_SALTLEN, \ + len, NULL) + +#define EVP_PKEY_CTX_get_rsa_pss_saltlen(ctx, plen) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, \ + (EVP_PKEY_OP_SIGN|EVP_PKEY_OP_VERIFY), \ + EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN, \ + 0, plen) + +#define EVP_PKEY_CTX_set_rsa_keygen_bits(ctx, bits) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_KEYGEN, \ + EVP_PKEY_CTRL_RSA_KEYGEN_BITS, bits, NULL) + +#define EVP_PKEY_CTX_set_rsa_keygen_pubexp(ctx, pubexp) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_KEYGEN, \ + EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP, 0, pubexp) + +#define EVP_PKEY_CTX_set_rsa_mgf1_md(ctx, md) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_TYPE_SIG, \ + EVP_PKEY_CTRL_RSA_MGF1_MD, 0, (void *)md) + +#define EVP_PKEY_CTX_get_rsa_mgf1_md(ctx, pmd) \ + EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_RSA, EVP_PKEY_OP_TYPE_SIG, \ + EVP_PKEY_CTRL_GET_RSA_MGF1_MD, 0, (void *)pmd) + +#define EVP_PKEY_CTRL_RSA_PADDING (EVP_PKEY_ALG_CTRL + 1) +#define EVP_PKEY_CTRL_RSA_PSS_SALTLEN (EVP_PKEY_ALG_CTRL + 2) + +#define EVP_PKEY_CTRL_RSA_KEYGEN_BITS (EVP_PKEY_ALG_CTRL + 3) +#define EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP (EVP_PKEY_ALG_CTRL + 4) +#define EVP_PKEY_CTRL_RSA_MGF1_MD (EVP_PKEY_ALG_CTRL + 5) + +#define EVP_PKEY_CTRL_GET_RSA_PADDING (EVP_PKEY_ALG_CTRL + 6) +#define EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN (EVP_PKEY_ALG_CTRL + 7) +#define EVP_PKEY_CTRL_GET_RSA_MGF1_MD (EVP_PKEY_ALG_CTRL + 8) + +#define RSA_PKCS1_PADDING 1 +#define RSA_SSLV23_PADDING 2 +#define RSA_NO_PADDING 3 +#define RSA_PKCS1_OAEP_PADDING 4 +#define RSA_X931_PADDING 5 +/* EVP_PKEY_ only */ +#define RSA_PKCS1_PSS_PADDING 6 + +#define RSA_PKCS1_PADDING_SIZE 11 + +#define RSA_set_app_data(s,arg) RSA_set_ex_data(s,0,arg) +#define RSA_get_app_data(s) RSA_get_ex_data(s,0) + +RSA * RSA_new(void); +RSA * RSA_new_method(ENGINE *engine); +int RSA_size(const RSA *); + +/* Deprecated version */ +#ifndef OPENSSL_NO_DEPRECATED +RSA * RSA_generate_key(int bits, unsigned long e,void + (*callback)(int,int,void *),void *cb_arg); +#endif /* !defined(OPENSSL_NO_DEPRECATED) */ + +/* New version */ +int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb); + +int RSA_check_key(const RSA *); + /* next 4 return -1 on error */ +int RSA_public_encrypt(int flen, const unsigned char *from, + unsigned char *to, RSA *rsa,int padding); +int RSA_private_encrypt(int flen, const unsigned char *from, + unsigned char *to, RSA *rsa,int padding); +int RSA_public_decrypt(int flen, const unsigned char *from, + unsigned char *to, RSA *rsa,int padding); +int RSA_private_decrypt(int flen, const unsigned char *from, + unsigned char *to, RSA *rsa,int padding); +void RSA_free (RSA *r); +/* "up" the RSA object's reference count */ +int RSA_up_ref(RSA *r); + +int RSA_flags(const RSA *r); + +void RSA_set_default_method(const RSA_METHOD *meth); +const RSA_METHOD *RSA_get_default_method(void); +const RSA_METHOD *RSA_get_method(const RSA *rsa); +int RSA_set_method(RSA *rsa, const RSA_METHOD *meth); + +/* This function needs the memory locking malloc callbacks to be installed */ +int RSA_memory_lock(RSA *r); + +/* these are the actual SSLeay RSA functions */ +const RSA_METHOD *RSA_PKCS1_SSLeay(void); + +const RSA_METHOD *RSA_null_method(void); + +DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPublicKey) +DECLARE_ASN1_ENCODE_FUNCTIONS_const(RSA, RSAPrivateKey) + +typedef struct rsa_pss_params_st + { + X509_ALGOR *hashAlgorithm; + X509_ALGOR *maskGenAlgorithm; + ASN1_INTEGER *saltLength; + ASN1_INTEGER *trailerField; + } RSA_PSS_PARAMS; + +DECLARE_ASN1_FUNCTIONS(RSA_PSS_PARAMS) + +#ifndef OPENSSL_NO_FP_API +int RSA_print_fp(FILE *fp, const RSA *r,int offset); +#endif + +#ifndef OPENSSL_NO_BIO +int RSA_print(BIO *bp, const RSA *r,int offset); +#endif + +#ifndef OPENSSL_NO_RC4 +int i2d_RSA_NET(const RSA *a, unsigned char **pp, + int (*cb)(char *buf, int len, const char *prompt, int verify), + int sgckey); +RSA *d2i_RSA_NET(RSA **a, const unsigned char **pp, long length, + int (*cb)(char *buf, int len, const char *prompt, int verify), + int sgckey); + +int i2d_Netscape_RSA(const RSA *a, unsigned char **pp, + int (*cb)(char *buf, int len, const char *prompt, + int verify)); +RSA *d2i_Netscape_RSA(RSA **a, const unsigned char **pp, long length, + int (*cb)(char *buf, int len, const char *prompt, + int verify)); +#endif + +/* The following 2 functions sign and verify a X509_SIG ASN1 object + * inside PKCS#1 padded RSA encryption */ +int RSA_sign(int type, const unsigned char *m, unsigned int m_length, + unsigned char *sigret, unsigned int *siglen, RSA *rsa); +int RSA_verify(int type, const unsigned char *m, unsigned int m_length, + const unsigned char *sigbuf, unsigned int siglen, RSA *rsa); + +/* The following 2 function sign and verify a ASN1_OCTET_STRING + * object inside PKCS#1 padded RSA encryption */ +int RSA_sign_ASN1_OCTET_STRING(int type, + const unsigned char *m, unsigned int m_length, + unsigned char *sigret, unsigned int *siglen, RSA *rsa); +int RSA_verify_ASN1_OCTET_STRING(int type, + const unsigned char *m, unsigned int m_length, + unsigned char *sigbuf, unsigned int siglen, RSA *rsa); + +int RSA_blinding_on(RSA *rsa, BN_CTX *ctx); +void RSA_blinding_off(RSA *rsa); +BN_BLINDING *RSA_setup_blinding(RSA *rsa, BN_CTX *ctx); + +int RSA_padding_add_PKCS1_type_1(unsigned char *to,int tlen, + const unsigned char *f,int fl); +int RSA_padding_check_PKCS1_type_1(unsigned char *to,int tlen, + const unsigned char *f,int fl,int rsa_len); +int RSA_padding_add_PKCS1_type_2(unsigned char *to,int tlen, + const unsigned char *f,int fl); +int RSA_padding_check_PKCS1_type_2(unsigned char *to,int tlen, + const unsigned char *f,int fl,int rsa_len); +int PKCS1_MGF1(unsigned char *mask, long len, + const unsigned char *seed, long seedlen, const EVP_MD *dgst); +int RSA_padding_add_PKCS1_OAEP(unsigned char *to,int tlen, + const unsigned char *f,int fl, + const unsigned char *p,int pl); +int RSA_padding_check_PKCS1_OAEP(unsigned char *to,int tlen, + const unsigned char *f,int fl,int rsa_len, + const unsigned char *p,int pl); +int RSA_padding_add_SSLv23(unsigned char *to,int tlen, + const unsigned char *f,int fl); +int RSA_padding_check_SSLv23(unsigned char *to,int tlen, + const unsigned char *f,int fl,int rsa_len); +int RSA_padding_add_none(unsigned char *to,int tlen, + const unsigned char *f,int fl); +int RSA_padding_check_none(unsigned char *to,int tlen, + const unsigned char *f,int fl,int rsa_len); +int RSA_padding_add_X931(unsigned char *to,int tlen, + const unsigned char *f,int fl); +int RSA_padding_check_X931(unsigned char *to,int tlen, + const unsigned char *f,int fl,int rsa_len); +int RSA_X931_hash_id(int nid); + +int RSA_verify_PKCS1_PSS(RSA *rsa, const unsigned char *mHash, + const EVP_MD *Hash, const unsigned char *EM, int sLen); +int RSA_padding_add_PKCS1_PSS(RSA *rsa, unsigned char *EM, + const unsigned char *mHash, + const EVP_MD *Hash, int sLen); + +int RSA_verify_PKCS1_PSS_mgf1(RSA *rsa, const unsigned char *mHash, + const EVP_MD *Hash, const EVP_MD *mgf1Hash, + const unsigned char *EM, int sLen); + +int RSA_padding_add_PKCS1_PSS_mgf1(RSA *rsa, unsigned char *EM, + const unsigned char *mHash, + const EVP_MD *Hash, const EVP_MD *mgf1Hash, int sLen); + +int RSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); +int RSA_set_ex_data(RSA *r,int idx,void *arg); +void *RSA_get_ex_data(const RSA *r, int idx); + +RSA *RSAPublicKey_dup(RSA *rsa); +RSA *RSAPrivateKey_dup(RSA *rsa); + +/* If this flag is set the RSA method is FIPS compliant and can be used + * in FIPS mode. This is set in the validated module method. If an + * application sets this flag in its own methods it is its responsibility + * to ensure the result is compliant. + */ + +#define RSA_FLAG_FIPS_METHOD 0x0400 + +/* If this flag is set the operations normally disabled in FIPS mode are + * permitted it is then the applications responsibility to ensure that the + * usage is compliant. + */ + +#define RSA_FLAG_NON_FIPS_ALLOW 0x0400 +/* Application has decided PRNG is good enough to generate a key: don't + * check. + */ +#define RSA_FLAG_CHECKED 0x0800 + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_RSA_strings(void); + +/* Error codes for the RSA functions. */ + +/* Function codes. */ +#define RSA_F_CHECK_PADDING_MD 140 +#define RSA_F_DO_RSA_PRINT 146 +#define RSA_F_INT_RSA_VERIFY 145 +#define RSA_F_MEMORY_LOCK 100 +#define RSA_F_OLD_RSA_PRIV_DECODE 147 +#define RSA_F_PKEY_RSA_CTRL 143 +#define RSA_F_PKEY_RSA_CTRL_STR 144 +#define RSA_F_PKEY_RSA_SIGN 142 +#define RSA_F_PKEY_RSA_VERIFY 154 +#define RSA_F_PKEY_RSA_VERIFYRECOVER 141 +#define RSA_F_RSA_BUILTIN_KEYGEN 129 +#define RSA_F_RSA_CHECK_KEY 123 +#define RSA_F_RSA_EAY_PRIVATE_DECRYPT 101 +#define RSA_F_RSA_EAY_PRIVATE_ENCRYPT 102 +#define RSA_F_RSA_EAY_PUBLIC_DECRYPT 103 +#define RSA_F_RSA_EAY_PUBLIC_ENCRYPT 104 +#define RSA_F_RSA_GENERATE_KEY 105 +#define RSA_F_RSA_GENERATE_KEY_EX 155 +#define RSA_F_RSA_ITEM_VERIFY 156 +#define RSA_F_RSA_MEMORY_LOCK 130 +#define RSA_F_RSA_NEW_METHOD 106 +#define RSA_F_RSA_NULL 124 +#define RSA_F_RSA_NULL_MOD_EXP 131 +#define RSA_F_RSA_NULL_PRIVATE_DECRYPT 132 +#define RSA_F_RSA_NULL_PRIVATE_ENCRYPT 133 +#define RSA_F_RSA_NULL_PUBLIC_DECRYPT 134 +#define RSA_F_RSA_NULL_PUBLIC_ENCRYPT 135 +#define RSA_F_RSA_PADDING_ADD_NONE 107 +#define RSA_F_RSA_PADDING_ADD_PKCS1_OAEP 121 +#define RSA_F_RSA_PADDING_ADD_PKCS1_PSS 125 +#define RSA_F_RSA_PADDING_ADD_PKCS1_PSS_MGF1 148 +#define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_1 108 +#define RSA_F_RSA_PADDING_ADD_PKCS1_TYPE_2 109 +#define RSA_F_RSA_PADDING_ADD_SSLV23 110 +#define RSA_F_RSA_PADDING_ADD_X931 127 +#define RSA_F_RSA_PADDING_CHECK_NONE 111 +#define RSA_F_RSA_PADDING_CHECK_PKCS1_OAEP 122 +#define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_1 112 +#define RSA_F_RSA_PADDING_CHECK_PKCS1_TYPE_2 113 +#define RSA_F_RSA_PADDING_CHECK_SSLV23 114 +#define RSA_F_RSA_PADDING_CHECK_X931 128 +#define RSA_F_RSA_PRINT 115 +#define RSA_F_RSA_PRINT_FP 116 +#define RSA_F_RSA_PRIVATE_DECRYPT 150 +#define RSA_F_RSA_PRIVATE_ENCRYPT 151 +#define RSA_F_RSA_PRIV_DECODE 137 +#define RSA_F_RSA_PRIV_ENCODE 138 +#define RSA_F_RSA_PUBLIC_DECRYPT 152 +#define RSA_F_RSA_PUBLIC_ENCRYPT 153 +#define RSA_F_RSA_PUB_DECODE 139 +#define RSA_F_RSA_SETUP_BLINDING 136 +#define RSA_F_RSA_SIGN 117 +#define RSA_F_RSA_SIGN_ASN1_OCTET_STRING 118 +#define RSA_F_RSA_VERIFY 119 +#define RSA_F_RSA_VERIFY_ASN1_OCTET_STRING 120 +#define RSA_F_RSA_VERIFY_PKCS1_PSS 126 +#define RSA_F_RSA_VERIFY_PKCS1_PSS_MGF1 149 + +/* Reason codes. */ +#define RSA_R_ALGORITHM_MISMATCH 100 +#define RSA_R_BAD_E_VALUE 101 +#define RSA_R_BAD_FIXED_HEADER_DECRYPT 102 +#define RSA_R_BAD_PAD_BYTE_COUNT 103 +#define RSA_R_BAD_SIGNATURE 104 +#define RSA_R_BLOCK_TYPE_IS_NOT_01 106 +#define RSA_R_BLOCK_TYPE_IS_NOT_02 107 +#define RSA_R_DATA_GREATER_THAN_MOD_LEN 108 +#define RSA_R_DATA_TOO_LARGE 109 +#define RSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 110 +#define RSA_R_DATA_TOO_LARGE_FOR_MODULUS 132 +#define RSA_R_DATA_TOO_SMALL 111 +#define RSA_R_DATA_TOO_SMALL_FOR_KEY_SIZE 122 +#define RSA_R_DIGEST_TOO_BIG_FOR_RSA_KEY 112 +#define RSA_R_DMP1_NOT_CONGRUENT_TO_D 124 +#define RSA_R_DMQ1_NOT_CONGRUENT_TO_D 125 +#define RSA_R_D_E_NOT_CONGRUENT_TO_1 123 +#define RSA_R_FIRST_OCTET_INVALID 133 +#define RSA_R_ILLEGAL_OR_UNSUPPORTED_PADDING_MODE 144 +#define RSA_R_INVALID_DIGEST_LENGTH 143 +#define RSA_R_INVALID_HEADER 137 +#define RSA_R_INVALID_KEYBITS 145 +#define RSA_R_INVALID_MESSAGE_LENGTH 131 +#define RSA_R_INVALID_MGF1_MD 156 +#define RSA_R_INVALID_PADDING 138 +#define RSA_R_INVALID_PADDING_MODE 141 +#define RSA_R_INVALID_PSS_PARAMETERS 149 +#define RSA_R_INVALID_PSS_SALTLEN 146 +#define RSA_R_INVALID_SALT_LENGTH 150 +#define RSA_R_INVALID_TRAILER 139 +#define RSA_R_INVALID_X931_DIGEST 142 +#define RSA_R_IQMP_NOT_INVERSE_OF_Q 126 +#define RSA_R_KEY_SIZE_TOO_SMALL 120 +#define RSA_R_LAST_OCTET_INVALID 134 +#define RSA_R_MODULUS_TOO_LARGE 105 +#define RSA_R_NON_FIPS_RSA_METHOD 157 +#define RSA_R_NO_PUBLIC_EXPONENT 140 +#define RSA_R_NULL_BEFORE_BLOCK_MISSING 113 +#define RSA_R_N_DOES_NOT_EQUAL_P_Q 127 +#define RSA_R_OAEP_DECODING_ERROR 121 +#define RSA_R_OPERATION_NOT_ALLOWED_IN_FIPS_MODE 158 +#define RSA_R_OPERATION_NOT_SUPPORTED_FOR_THIS_KEYTYPE 148 +#define RSA_R_PADDING_CHECK_FAILED 114 +#define RSA_R_P_NOT_PRIME 128 +#define RSA_R_Q_NOT_PRIME 129 +#define RSA_R_RSA_OPERATIONS_NOT_SUPPORTED 130 +#define RSA_R_SLEN_CHECK_FAILED 136 +#define RSA_R_SLEN_RECOVERY_FAILED 135 +#define RSA_R_SSLV3_ROLLBACK_ATTACK 115 +#define RSA_R_THE_ASN1_OBJECT_IDENTIFIER_IS_NOT_KNOWN_FOR_THIS_MD 116 +#define RSA_R_UNKNOWN_ALGORITHM_TYPE 117 +#define RSA_R_UNKNOWN_MASK_DIGEST 151 +#define RSA_R_UNKNOWN_PADDING_TYPE 118 +#define RSA_R_UNKNOWN_PSS_DIGEST 152 +#define RSA_R_UNSUPPORTED_MASK_ALGORITHM 153 +#define RSA_R_UNSUPPORTED_MASK_PARAMETER 154 +#define RSA_R_UNSUPPORTED_SIGNATURE_TYPE 155 +#define RSA_R_VALUE_MISSING 147 +#define RSA_R_WRONG_SIGNATURE_LENGTH 119 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/safestack.h b/Source/Import/OpenSSL/Include/openssl/safestack.h new file mode 100644 index 0000000..ea3aa0d --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/safestack.h @@ -0,0 +1,2663 @@ +/* ==================================================================== + * Copyright (c) 1999 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_SAFESTACK_H +#define HEADER_SAFESTACK_H + +#include + +#ifndef CHECKED_PTR_OF +#define CHECKED_PTR_OF(type, p) \ + ((void*) (1 ? p : (type*)0)) +#endif + +/* In C++ we get problems because an explicit cast is needed from (void *) + * we use CHECKED_STACK_OF to ensure the correct type is passed in the macros + * below. + */ + +#define CHECKED_STACK_OF(type, p) \ + ((_STACK*) (1 ? p : (STACK_OF(type)*)0)) + +#define CHECKED_SK_FREE_FUNC(type, p) \ + ((void (*)(void *)) ((1 ? p : (void (*)(type *))0))) + +#define CHECKED_SK_FREE_FUNC2(type, p) \ + ((void (*)(void *)) ((1 ? p : (void (*)(type))0))) + +#define CHECKED_SK_CMP_FUNC(type, p) \ + ((int (*)(const void *, const void *)) \ + ((1 ? p : (int (*)(const type * const *, const type * const *))0))) + +#define STACK_OF(type) struct stack_st_##type +#define PREDECLARE_STACK_OF(type) STACK_OF(type); + +#define DECLARE_STACK_OF(type) \ +STACK_OF(type) \ + { \ + _STACK stack; \ + }; +#define DECLARE_SPECIAL_STACK_OF(type, type2) \ +STACK_OF(type) \ + { \ + _STACK stack; \ + }; + +#define IMPLEMENT_STACK_OF(type) /* nada (obsolete in new safestack approach)*/ + + +/* Strings are special: normally an lhash entry will point to a single + * (somewhat) mutable object. In the case of strings: + * + * a) Instead of a single char, there is an array of chars, NUL-terminated. + * b) The string may have be immutable. + * + * So, they need their own declarations. Especially important for + * type-checking tools, such as Deputy. + * +o * In practice, however, it appears to be hard to have a const + * string. For now, I'm settling for dealing with the fact it is a + * string at all. + */ +typedef char *OPENSSL_STRING; + +typedef const char *OPENSSL_CSTRING; + +/* Confusingly, LHASH_OF(STRING) deals with char ** throughout, but + * STACK_OF(STRING) is really more like STACK_OF(char), only, as + * mentioned above, instead of a single char each entry is a + * NUL-terminated array of chars. So, we have to implement STRING + * specially for STACK_OF. This is dealt with in the autogenerated + * macros below. + */ + +DECLARE_SPECIAL_STACK_OF(OPENSSL_STRING, char) + +/* Similarly, we sometimes use a block of characters, NOT + * nul-terminated. These should also be distinguished from "normal" + * stacks. */ + +typedef void *OPENSSL_BLOCK; +DECLARE_SPECIAL_STACK_OF(OPENSSL_BLOCK, void) + +/* SKM_sk_... stack macros are internal to safestack.h: + * never use them directly, use sk__... instead */ +#define SKM_sk_new(type, cmp) \ + ((STACK_OF(type) *)sk_new(CHECKED_SK_CMP_FUNC(type, cmp))) +#define SKM_sk_new_null(type) \ + ((STACK_OF(type) *)sk_new_null()) +#define SKM_sk_free(type, st) \ + sk_free(CHECKED_STACK_OF(type, st)) +#define SKM_sk_num(type, st) \ + sk_num(CHECKED_STACK_OF(type, st)) +#define SKM_sk_value(type, st,i) \ + ((type *)sk_value(CHECKED_STACK_OF(type, st), i)) +#define SKM_sk_set(type, st,i,val) \ + sk_set(CHECKED_STACK_OF(type, st), i, CHECKED_PTR_OF(type, val)) +#define SKM_sk_zero(type, st) \ + sk_zero(CHECKED_STACK_OF(type, st)) +#define SKM_sk_push(type, st, val) \ + sk_push(CHECKED_STACK_OF(type, st), CHECKED_PTR_OF(type, val)) +#define SKM_sk_unshift(type, st, val) \ + sk_unshift(CHECKED_STACK_OF(type, st), CHECKED_PTR_OF(type, val)) +#define SKM_sk_find(type, st, val) \ + sk_find(CHECKED_STACK_OF(type, st), CHECKED_PTR_OF(type, val)) +#define SKM_sk_find_ex(type, st, val) \ + sk_find_ex(CHECKED_STACK_OF(type, st), \ + CHECKED_PTR_OF(type, val)) +#define SKM_sk_delete(type, st, i) \ + (type *)sk_delete(CHECKED_STACK_OF(type, st), i) +#define SKM_sk_delete_ptr(type, st, ptr) \ + (type *)sk_delete_ptr(CHECKED_STACK_OF(type, st), CHECKED_PTR_OF(type, ptr)) +#define SKM_sk_insert(type, st,val, i) \ + sk_insert(CHECKED_STACK_OF(type, st), CHECKED_PTR_OF(type, val), i) +#define SKM_sk_set_cmp_func(type, st, cmp) \ + ((int (*)(const type * const *,const type * const *)) \ + sk_set_cmp_func(CHECKED_STACK_OF(type, st), CHECKED_SK_CMP_FUNC(type, cmp))) +#define SKM_sk_dup(type, st) \ + (STACK_OF(type) *)sk_dup(CHECKED_STACK_OF(type, st)) +#define SKM_sk_pop_free(type, st, free_func) \ + sk_pop_free(CHECKED_STACK_OF(type, st), CHECKED_SK_FREE_FUNC(type, free_func)) +#define SKM_sk_shift(type, st) \ + (type *)sk_shift(CHECKED_STACK_OF(type, st)) +#define SKM_sk_pop(type, st) \ + (type *)sk_pop(CHECKED_STACK_OF(type, st)) +#define SKM_sk_sort(type, st) \ + sk_sort(CHECKED_STACK_OF(type, st)) +#define SKM_sk_is_sorted(type, st) \ + sk_is_sorted(CHECKED_STACK_OF(type, st)) + +#define SKM_ASN1_SET_OF_d2i(type, st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + (STACK_OF(type) *)d2i_ASN1_SET( \ + (STACK_OF(OPENSSL_BLOCK) **)CHECKED_PTR_OF(STACK_OF(type)*, st), \ + pp, length, \ + CHECKED_D2I_OF(type, d2i_func), \ + CHECKED_SK_FREE_FUNC(type, free_func), \ + ex_tag, ex_class) + +#define SKM_ASN1_SET_OF_i2d(type, st, pp, i2d_func, ex_tag, ex_class, is_set) \ + i2d_ASN1_SET((STACK_OF(OPENSSL_BLOCK) *)CHECKED_STACK_OF(type, st), pp, \ + CHECKED_I2D_OF(type, i2d_func), \ + ex_tag, ex_class, is_set) + +#define SKM_ASN1_seq_pack(type, st, i2d_func, buf, len) \ + ASN1_seq_pack(CHECKED_PTR_OF(STACK_OF(type), st), \ + CHECKED_I2D_OF(type, i2d_func), buf, len) + +#define SKM_ASN1_seq_unpack(type, buf, len, d2i_func, free_func) \ + (STACK_OF(type) *)ASN1_seq_unpack(buf, len, CHECKED_D2I_OF(type, d2i_func), CHECKED_SK_FREE_FUNC(type, free_func)) + +#define SKM_PKCS12_decrypt_d2i(type, algor, d2i_func, free_func, pass, passlen, oct, seq) \ + (STACK_OF(type) *)PKCS12_decrypt_d2i(algor, \ + CHECKED_D2I_OF(type, d2i_func), \ + CHECKED_SK_FREE_FUNC(type, free_func), \ + pass, passlen, oct, seq) + +/* This block of defines is updated by util/mkstack.pl, please do not touch! */ +#define sk_ACCESS_DESCRIPTION_new(cmp) SKM_sk_new(ACCESS_DESCRIPTION, (cmp)) +#define sk_ACCESS_DESCRIPTION_new_null() SKM_sk_new_null(ACCESS_DESCRIPTION) +#define sk_ACCESS_DESCRIPTION_free(st) SKM_sk_free(ACCESS_DESCRIPTION, (st)) +#define sk_ACCESS_DESCRIPTION_num(st) SKM_sk_num(ACCESS_DESCRIPTION, (st)) +#define sk_ACCESS_DESCRIPTION_value(st, i) SKM_sk_value(ACCESS_DESCRIPTION, (st), (i)) +#define sk_ACCESS_DESCRIPTION_set(st, i, val) SKM_sk_set(ACCESS_DESCRIPTION, (st), (i), (val)) +#define sk_ACCESS_DESCRIPTION_zero(st) SKM_sk_zero(ACCESS_DESCRIPTION, (st)) +#define sk_ACCESS_DESCRIPTION_push(st, val) SKM_sk_push(ACCESS_DESCRIPTION, (st), (val)) +#define sk_ACCESS_DESCRIPTION_unshift(st, val) SKM_sk_unshift(ACCESS_DESCRIPTION, (st), (val)) +#define sk_ACCESS_DESCRIPTION_find(st, val) SKM_sk_find(ACCESS_DESCRIPTION, (st), (val)) +#define sk_ACCESS_DESCRIPTION_find_ex(st, val) SKM_sk_find_ex(ACCESS_DESCRIPTION, (st), (val)) +#define sk_ACCESS_DESCRIPTION_delete(st, i) SKM_sk_delete(ACCESS_DESCRIPTION, (st), (i)) +#define sk_ACCESS_DESCRIPTION_delete_ptr(st, ptr) SKM_sk_delete_ptr(ACCESS_DESCRIPTION, (st), (ptr)) +#define sk_ACCESS_DESCRIPTION_insert(st, val, i) SKM_sk_insert(ACCESS_DESCRIPTION, (st), (val), (i)) +#define sk_ACCESS_DESCRIPTION_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ACCESS_DESCRIPTION, (st), (cmp)) +#define sk_ACCESS_DESCRIPTION_dup(st) SKM_sk_dup(ACCESS_DESCRIPTION, st) +#define sk_ACCESS_DESCRIPTION_pop_free(st, free_func) SKM_sk_pop_free(ACCESS_DESCRIPTION, (st), (free_func)) +#define sk_ACCESS_DESCRIPTION_shift(st) SKM_sk_shift(ACCESS_DESCRIPTION, (st)) +#define sk_ACCESS_DESCRIPTION_pop(st) SKM_sk_pop(ACCESS_DESCRIPTION, (st)) +#define sk_ACCESS_DESCRIPTION_sort(st) SKM_sk_sort(ACCESS_DESCRIPTION, (st)) +#define sk_ACCESS_DESCRIPTION_is_sorted(st) SKM_sk_is_sorted(ACCESS_DESCRIPTION, (st)) + +#define sk_ASIdOrRange_new(cmp) SKM_sk_new(ASIdOrRange, (cmp)) +#define sk_ASIdOrRange_new_null() SKM_sk_new_null(ASIdOrRange) +#define sk_ASIdOrRange_free(st) SKM_sk_free(ASIdOrRange, (st)) +#define sk_ASIdOrRange_num(st) SKM_sk_num(ASIdOrRange, (st)) +#define sk_ASIdOrRange_value(st, i) SKM_sk_value(ASIdOrRange, (st), (i)) +#define sk_ASIdOrRange_set(st, i, val) SKM_sk_set(ASIdOrRange, (st), (i), (val)) +#define sk_ASIdOrRange_zero(st) SKM_sk_zero(ASIdOrRange, (st)) +#define sk_ASIdOrRange_push(st, val) SKM_sk_push(ASIdOrRange, (st), (val)) +#define sk_ASIdOrRange_unshift(st, val) SKM_sk_unshift(ASIdOrRange, (st), (val)) +#define sk_ASIdOrRange_find(st, val) SKM_sk_find(ASIdOrRange, (st), (val)) +#define sk_ASIdOrRange_find_ex(st, val) SKM_sk_find_ex(ASIdOrRange, (st), (val)) +#define sk_ASIdOrRange_delete(st, i) SKM_sk_delete(ASIdOrRange, (st), (i)) +#define sk_ASIdOrRange_delete_ptr(st, ptr) SKM_sk_delete_ptr(ASIdOrRange, (st), (ptr)) +#define sk_ASIdOrRange_insert(st, val, i) SKM_sk_insert(ASIdOrRange, (st), (val), (i)) +#define sk_ASIdOrRange_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ASIdOrRange, (st), (cmp)) +#define sk_ASIdOrRange_dup(st) SKM_sk_dup(ASIdOrRange, st) +#define sk_ASIdOrRange_pop_free(st, free_func) SKM_sk_pop_free(ASIdOrRange, (st), (free_func)) +#define sk_ASIdOrRange_shift(st) SKM_sk_shift(ASIdOrRange, (st)) +#define sk_ASIdOrRange_pop(st) SKM_sk_pop(ASIdOrRange, (st)) +#define sk_ASIdOrRange_sort(st) SKM_sk_sort(ASIdOrRange, (st)) +#define sk_ASIdOrRange_is_sorted(st) SKM_sk_is_sorted(ASIdOrRange, (st)) + +#define sk_ASN1_GENERALSTRING_new(cmp) SKM_sk_new(ASN1_GENERALSTRING, (cmp)) +#define sk_ASN1_GENERALSTRING_new_null() SKM_sk_new_null(ASN1_GENERALSTRING) +#define sk_ASN1_GENERALSTRING_free(st) SKM_sk_free(ASN1_GENERALSTRING, (st)) +#define sk_ASN1_GENERALSTRING_num(st) SKM_sk_num(ASN1_GENERALSTRING, (st)) +#define sk_ASN1_GENERALSTRING_value(st, i) SKM_sk_value(ASN1_GENERALSTRING, (st), (i)) +#define sk_ASN1_GENERALSTRING_set(st, i, val) SKM_sk_set(ASN1_GENERALSTRING, (st), (i), (val)) +#define sk_ASN1_GENERALSTRING_zero(st) SKM_sk_zero(ASN1_GENERALSTRING, (st)) +#define sk_ASN1_GENERALSTRING_push(st, val) SKM_sk_push(ASN1_GENERALSTRING, (st), (val)) +#define sk_ASN1_GENERALSTRING_unshift(st, val) SKM_sk_unshift(ASN1_GENERALSTRING, (st), (val)) +#define sk_ASN1_GENERALSTRING_find(st, val) SKM_sk_find(ASN1_GENERALSTRING, (st), (val)) +#define sk_ASN1_GENERALSTRING_find_ex(st, val) SKM_sk_find_ex(ASN1_GENERALSTRING, (st), (val)) +#define sk_ASN1_GENERALSTRING_delete(st, i) SKM_sk_delete(ASN1_GENERALSTRING, (st), (i)) +#define sk_ASN1_GENERALSTRING_delete_ptr(st, ptr) SKM_sk_delete_ptr(ASN1_GENERALSTRING, (st), (ptr)) +#define sk_ASN1_GENERALSTRING_insert(st, val, i) SKM_sk_insert(ASN1_GENERALSTRING, (st), (val), (i)) +#define sk_ASN1_GENERALSTRING_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ASN1_GENERALSTRING, (st), (cmp)) +#define sk_ASN1_GENERALSTRING_dup(st) SKM_sk_dup(ASN1_GENERALSTRING, st) +#define sk_ASN1_GENERALSTRING_pop_free(st, free_func) SKM_sk_pop_free(ASN1_GENERALSTRING, (st), (free_func)) +#define sk_ASN1_GENERALSTRING_shift(st) SKM_sk_shift(ASN1_GENERALSTRING, (st)) +#define sk_ASN1_GENERALSTRING_pop(st) SKM_sk_pop(ASN1_GENERALSTRING, (st)) +#define sk_ASN1_GENERALSTRING_sort(st) SKM_sk_sort(ASN1_GENERALSTRING, (st)) +#define sk_ASN1_GENERALSTRING_is_sorted(st) SKM_sk_is_sorted(ASN1_GENERALSTRING, (st)) + +#define sk_ASN1_INTEGER_new(cmp) SKM_sk_new(ASN1_INTEGER, (cmp)) +#define sk_ASN1_INTEGER_new_null() SKM_sk_new_null(ASN1_INTEGER) +#define sk_ASN1_INTEGER_free(st) SKM_sk_free(ASN1_INTEGER, (st)) +#define sk_ASN1_INTEGER_num(st) SKM_sk_num(ASN1_INTEGER, (st)) +#define sk_ASN1_INTEGER_value(st, i) SKM_sk_value(ASN1_INTEGER, (st), (i)) +#define sk_ASN1_INTEGER_set(st, i, val) SKM_sk_set(ASN1_INTEGER, (st), (i), (val)) +#define sk_ASN1_INTEGER_zero(st) SKM_sk_zero(ASN1_INTEGER, (st)) +#define sk_ASN1_INTEGER_push(st, val) SKM_sk_push(ASN1_INTEGER, (st), (val)) +#define sk_ASN1_INTEGER_unshift(st, val) SKM_sk_unshift(ASN1_INTEGER, (st), (val)) +#define sk_ASN1_INTEGER_find(st, val) SKM_sk_find(ASN1_INTEGER, (st), (val)) +#define sk_ASN1_INTEGER_find_ex(st, val) SKM_sk_find_ex(ASN1_INTEGER, (st), (val)) +#define sk_ASN1_INTEGER_delete(st, i) SKM_sk_delete(ASN1_INTEGER, (st), (i)) +#define sk_ASN1_INTEGER_delete_ptr(st, ptr) SKM_sk_delete_ptr(ASN1_INTEGER, (st), (ptr)) +#define sk_ASN1_INTEGER_insert(st, val, i) SKM_sk_insert(ASN1_INTEGER, (st), (val), (i)) +#define sk_ASN1_INTEGER_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ASN1_INTEGER, (st), (cmp)) +#define sk_ASN1_INTEGER_dup(st) SKM_sk_dup(ASN1_INTEGER, st) +#define sk_ASN1_INTEGER_pop_free(st, free_func) SKM_sk_pop_free(ASN1_INTEGER, (st), (free_func)) +#define sk_ASN1_INTEGER_shift(st) SKM_sk_shift(ASN1_INTEGER, (st)) +#define sk_ASN1_INTEGER_pop(st) SKM_sk_pop(ASN1_INTEGER, (st)) +#define sk_ASN1_INTEGER_sort(st) SKM_sk_sort(ASN1_INTEGER, (st)) +#define sk_ASN1_INTEGER_is_sorted(st) SKM_sk_is_sorted(ASN1_INTEGER, (st)) + +#define sk_ASN1_OBJECT_new(cmp) SKM_sk_new(ASN1_OBJECT, (cmp)) +#define sk_ASN1_OBJECT_new_null() SKM_sk_new_null(ASN1_OBJECT) +#define sk_ASN1_OBJECT_free(st) SKM_sk_free(ASN1_OBJECT, (st)) +#define sk_ASN1_OBJECT_num(st) SKM_sk_num(ASN1_OBJECT, (st)) +#define sk_ASN1_OBJECT_value(st, i) SKM_sk_value(ASN1_OBJECT, (st), (i)) +#define sk_ASN1_OBJECT_set(st, i, val) SKM_sk_set(ASN1_OBJECT, (st), (i), (val)) +#define sk_ASN1_OBJECT_zero(st) SKM_sk_zero(ASN1_OBJECT, (st)) +#define sk_ASN1_OBJECT_push(st, val) SKM_sk_push(ASN1_OBJECT, (st), (val)) +#define sk_ASN1_OBJECT_unshift(st, val) SKM_sk_unshift(ASN1_OBJECT, (st), (val)) +#define sk_ASN1_OBJECT_find(st, val) SKM_sk_find(ASN1_OBJECT, (st), (val)) +#define sk_ASN1_OBJECT_find_ex(st, val) SKM_sk_find_ex(ASN1_OBJECT, (st), (val)) +#define sk_ASN1_OBJECT_delete(st, i) SKM_sk_delete(ASN1_OBJECT, (st), (i)) +#define sk_ASN1_OBJECT_delete_ptr(st, ptr) SKM_sk_delete_ptr(ASN1_OBJECT, (st), (ptr)) +#define sk_ASN1_OBJECT_insert(st, val, i) SKM_sk_insert(ASN1_OBJECT, (st), (val), (i)) +#define sk_ASN1_OBJECT_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ASN1_OBJECT, (st), (cmp)) +#define sk_ASN1_OBJECT_dup(st) SKM_sk_dup(ASN1_OBJECT, st) +#define sk_ASN1_OBJECT_pop_free(st, free_func) SKM_sk_pop_free(ASN1_OBJECT, (st), (free_func)) +#define sk_ASN1_OBJECT_shift(st) SKM_sk_shift(ASN1_OBJECT, (st)) +#define sk_ASN1_OBJECT_pop(st) SKM_sk_pop(ASN1_OBJECT, (st)) +#define sk_ASN1_OBJECT_sort(st) SKM_sk_sort(ASN1_OBJECT, (st)) +#define sk_ASN1_OBJECT_is_sorted(st) SKM_sk_is_sorted(ASN1_OBJECT, (st)) + +#define sk_ASN1_STRING_TABLE_new(cmp) SKM_sk_new(ASN1_STRING_TABLE, (cmp)) +#define sk_ASN1_STRING_TABLE_new_null() SKM_sk_new_null(ASN1_STRING_TABLE) +#define sk_ASN1_STRING_TABLE_free(st) SKM_sk_free(ASN1_STRING_TABLE, (st)) +#define sk_ASN1_STRING_TABLE_num(st) SKM_sk_num(ASN1_STRING_TABLE, (st)) +#define sk_ASN1_STRING_TABLE_value(st, i) SKM_sk_value(ASN1_STRING_TABLE, (st), (i)) +#define sk_ASN1_STRING_TABLE_set(st, i, val) SKM_sk_set(ASN1_STRING_TABLE, (st), (i), (val)) +#define sk_ASN1_STRING_TABLE_zero(st) SKM_sk_zero(ASN1_STRING_TABLE, (st)) +#define sk_ASN1_STRING_TABLE_push(st, val) SKM_sk_push(ASN1_STRING_TABLE, (st), (val)) +#define sk_ASN1_STRING_TABLE_unshift(st, val) SKM_sk_unshift(ASN1_STRING_TABLE, (st), (val)) +#define sk_ASN1_STRING_TABLE_find(st, val) SKM_sk_find(ASN1_STRING_TABLE, (st), (val)) +#define sk_ASN1_STRING_TABLE_find_ex(st, val) SKM_sk_find_ex(ASN1_STRING_TABLE, (st), (val)) +#define sk_ASN1_STRING_TABLE_delete(st, i) SKM_sk_delete(ASN1_STRING_TABLE, (st), (i)) +#define sk_ASN1_STRING_TABLE_delete_ptr(st, ptr) SKM_sk_delete_ptr(ASN1_STRING_TABLE, (st), (ptr)) +#define sk_ASN1_STRING_TABLE_insert(st, val, i) SKM_sk_insert(ASN1_STRING_TABLE, (st), (val), (i)) +#define sk_ASN1_STRING_TABLE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ASN1_STRING_TABLE, (st), (cmp)) +#define sk_ASN1_STRING_TABLE_dup(st) SKM_sk_dup(ASN1_STRING_TABLE, st) +#define sk_ASN1_STRING_TABLE_pop_free(st, free_func) SKM_sk_pop_free(ASN1_STRING_TABLE, (st), (free_func)) +#define sk_ASN1_STRING_TABLE_shift(st) SKM_sk_shift(ASN1_STRING_TABLE, (st)) +#define sk_ASN1_STRING_TABLE_pop(st) SKM_sk_pop(ASN1_STRING_TABLE, (st)) +#define sk_ASN1_STRING_TABLE_sort(st) SKM_sk_sort(ASN1_STRING_TABLE, (st)) +#define sk_ASN1_STRING_TABLE_is_sorted(st) SKM_sk_is_sorted(ASN1_STRING_TABLE, (st)) + +#define sk_ASN1_TYPE_new(cmp) SKM_sk_new(ASN1_TYPE, (cmp)) +#define sk_ASN1_TYPE_new_null() SKM_sk_new_null(ASN1_TYPE) +#define sk_ASN1_TYPE_free(st) SKM_sk_free(ASN1_TYPE, (st)) +#define sk_ASN1_TYPE_num(st) SKM_sk_num(ASN1_TYPE, (st)) +#define sk_ASN1_TYPE_value(st, i) SKM_sk_value(ASN1_TYPE, (st), (i)) +#define sk_ASN1_TYPE_set(st, i, val) SKM_sk_set(ASN1_TYPE, (st), (i), (val)) +#define sk_ASN1_TYPE_zero(st) SKM_sk_zero(ASN1_TYPE, (st)) +#define sk_ASN1_TYPE_push(st, val) SKM_sk_push(ASN1_TYPE, (st), (val)) +#define sk_ASN1_TYPE_unshift(st, val) SKM_sk_unshift(ASN1_TYPE, (st), (val)) +#define sk_ASN1_TYPE_find(st, val) SKM_sk_find(ASN1_TYPE, (st), (val)) +#define sk_ASN1_TYPE_find_ex(st, val) SKM_sk_find_ex(ASN1_TYPE, (st), (val)) +#define sk_ASN1_TYPE_delete(st, i) SKM_sk_delete(ASN1_TYPE, (st), (i)) +#define sk_ASN1_TYPE_delete_ptr(st, ptr) SKM_sk_delete_ptr(ASN1_TYPE, (st), (ptr)) +#define sk_ASN1_TYPE_insert(st, val, i) SKM_sk_insert(ASN1_TYPE, (st), (val), (i)) +#define sk_ASN1_TYPE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ASN1_TYPE, (st), (cmp)) +#define sk_ASN1_TYPE_dup(st) SKM_sk_dup(ASN1_TYPE, st) +#define sk_ASN1_TYPE_pop_free(st, free_func) SKM_sk_pop_free(ASN1_TYPE, (st), (free_func)) +#define sk_ASN1_TYPE_shift(st) SKM_sk_shift(ASN1_TYPE, (st)) +#define sk_ASN1_TYPE_pop(st) SKM_sk_pop(ASN1_TYPE, (st)) +#define sk_ASN1_TYPE_sort(st) SKM_sk_sort(ASN1_TYPE, (st)) +#define sk_ASN1_TYPE_is_sorted(st) SKM_sk_is_sorted(ASN1_TYPE, (st)) + +#define sk_ASN1_UTF8STRING_new(cmp) SKM_sk_new(ASN1_UTF8STRING, (cmp)) +#define sk_ASN1_UTF8STRING_new_null() SKM_sk_new_null(ASN1_UTF8STRING) +#define sk_ASN1_UTF8STRING_free(st) SKM_sk_free(ASN1_UTF8STRING, (st)) +#define sk_ASN1_UTF8STRING_num(st) SKM_sk_num(ASN1_UTF8STRING, (st)) +#define sk_ASN1_UTF8STRING_value(st, i) SKM_sk_value(ASN1_UTF8STRING, (st), (i)) +#define sk_ASN1_UTF8STRING_set(st, i, val) SKM_sk_set(ASN1_UTF8STRING, (st), (i), (val)) +#define sk_ASN1_UTF8STRING_zero(st) SKM_sk_zero(ASN1_UTF8STRING, (st)) +#define sk_ASN1_UTF8STRING_push(st, val) SKM_sk_push(ASN1_UTF8STRING, (st), (val)) +#define sk_ASN1_UTF8STRING_unshift(st, val) SKM_sk_unshift(ASN1_UTF8STRING, (st), (val)) +#define sk_ASN1_UTF8STRING_find(st, val) SKM_sk_find(ASN1_UTF8STRING, (st), (val)) +#define sk_ASN1_UTF8STRING_find_ex(st, val) SKM_sk_find_ex(ASN1_UTF8STRING, (st), (val)) +#define sk_ASN1_UTF8STRING_delete(st, i) SKM_sk_delete(ASN1_UTF8STRING, (st), (i)) +#define sk_ASN1_UTF8STRING_delete_ptr(st, ptr) SKM_sk_delete_ptr(ASN1_UTF8STRING, (st), (ptr)) +#define sk_ASN1_UTF8STRING_insert(st, val, i) SKM_sk_insert(ASN1_UTF8STRING, (st), (val), (i)) +#define sk_ASN1_UTF8STRING_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ASN1_UTF8STRING, (st), (cmp)) +#define sk_ASN1_UTF8STRING_dup(st) SKM_sk_dup(ASN1_UTF8STRING, st) +#define sk_ASN1_UTF8STRING_pop_free(st, free_func) SKM_sk_pop_free(ASN1_UTF8STRING, (st), (free_func)) +#define sk_ASN1_UTF8STRING_shift(st) SKM_sk_shift(ASN1_UTF8STRING, (st)) +#define sk_ASN1_UTF8STRING_pop(st) SKM_sk_pop(ASN1_UTF8STRING, (st)) +#define sk_ASN1_UTF8STRING_sort(st) SKM_sk_sort(ASN1_UTF8STRING, (st)) +#define sk_ASN1_UTF8STRING_is_sorted(st) SKM_sk_is_sorted(ASN1_UTF8STRING, (st)) + +#define sk_ASN1_VALUE_new(cmp) SKM_sk_new(ASN1_VALUE, (cmp)) +#define sk_ASN1_VALUE_new_null() SKM_sk_new_null(ASN1_VALUE) +#define sk_ASN1_VALUE_free(st) SKM_sk_free(ASN1_VALUE, (st)) +#define sk_ASN1_VALUE_num(st) SKM_sk_num(ASN1_VALUE, (st)) +#define sk_ASN1_VALUE_value(st, i) SKM_sk_value(ASN1_VALUE, (st), (i)) +#define sk_ASN1_VALUE_set(st, i, val) SKM_sk_set(ASN1_VALUE, (st), (i), (val)) +#define sk_ASN1_VALUE_zero(st) SKM_sk_zero(ASN1_VALUE, (st)) +#define sk_ASN1_VALUE_push(st, val) SKM_sk_push(ASN1_VALUE, (st), (val)) +#define sk_ASN1_VALUE_unshift(st, val) SKM_sk_unshift(ASN1_VALUE, (st), (val)) +#define sk_ASN1_VALUE_find(st, val) SKM_sk_find(ASN1_VALUE, (st), (val)) +#define sk_ASN1_VALUE_find_ex(st, val) SKM_sk_find_ex(ASN1_VALUE, (st), (val)) +#define sk_ASN1_VALUE_delete(st, i) SKM_sk_delete(ASN1_VALUE, (st), (i)) +#define sk_ASN1_VALUE_delete_ptr(st, ptr) SKM_sk_delete_ptr(ASN1_VALUE, (st), (ptr)) +#define sk_ASN1_VALUE_insert(st, val, i) SKM_sk_insert(ASN1_VALUE, (st), (val), (i)) +#define sk_ASN1_VALUE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ASN1_VALUE, (st), (cmp)) +#define sk_ASN1_VALUE_dup(st) SKM_sk_dup(ASN1_VALUE, st) +#define sk_ASN1_VALUE_pop_free(st, free_func) SKM_sk_pop_free(ASN1_VALUE, (st), (free_func)) +#define sk_ASN1_VALUE_shift(st) SKM_sk_shift(ASN1_VALUE, (st)) +#define sk_ASN1_VALUE_pop(st) SKM_sk_pop(ASN1_VALUE, (st)) +#define sk_ASN1_VALUE_sort(st) SKM_sk_sort(ASN1_VALUE, (st)) +#define sk_ASN1_VALUE_is_sorted(st) SKM_sk_is_sorted(ASN1_VALUE, (st)) + +#define sk_BIO_new(cmp) SKM_sk_new(BIO, (cmp)) +#define sk_BIO_new_null() SKM_sk_new_null(BIO) +#define sk_BIO_free(st) SKM_sk_free(BIO, (st)) +#define sk_BIO_num(st) SKM_sk_num(BIO, (st)) +#define sk_BIO_value(st, i) SKM_sk_value(BIO, (st), (i)) +#define sk_BIO_set(st, i, val) SKM_sk_set(BIO, (st), (i), (val)) +#define sk_BIO_zero(st) SKM_sk_zero(BIO, (st)) +#define sk_BIO_push(st, val) SKM_sk_push(BIO, (st), (val)) +#define sk_BIO_unshift(st, val) SKM_sk_unshift(BIO, (st), (val)) +#define sk_BIO_find(st, val) SKM_sk_find(BIO, (st), (val)) +#define sk_BIO_find_ex(st, val) SKM_sk_find_ex(BIO, (st), (val)) +#define sk_BIO_delete(st, i) SKM_sk_delete(BIO, (st), (i)) +#define sk_BIO_delete_ptr(st, ptr) SKM_sk_delete_ptr(BIO, (st), (ptr)) +#define sk_BIO_insert(st, val, i) SKM_sk_insert(BIO, (st), (val), (i)) +#define sk_BIO_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(BIO, (st), (cmp)) +#define sk_BIO_dup(st) SKM_sk_dup(BIO, st) +#define sk_BIO_pop_free(st, free_func) SKM_sk_pop_free(BIO, (st), (free_func)) +#define sk_BIO_shift(st) SKM_sk_shift(BIO, (st)) +#define sk_BIO_pop(st) SKM_sk_pop(BIO, (st)) +#define sk_BIO_sort(st) SKM_sk_sort(BIO, (st)) +#define sk_BIO_is_sorted(st) SKM_sk_is_sorted(BIO, (st)) + +#define sk_BY_DIR_ENTRY_new(cmp) SKM_sk_new(BY_DIR_ENTRY, (cmp)) +#define sk_BY_DIR_ENTRY_new_null() SKM_sk_new_null(BY_DIR_ENTRY) +#define sk_BY_DIR_ENTRY_free(st) SKM_sk_free(BY_DIR_ENTRY, (st)) +#define sk_BY_DIR_ENTRY_num(st) SKM_sk_num(BY_DIR_ENTRY, (st)) +#define sk_BY_DIR_ENTRY_value(st, i) SKM_sk_value(BY_DIR_ENTRY, (st), (i)) +#define sk_BY_DIR_ENTRY_set(st, i, val) SKM_sk_set(BY_DIR_ENTRY, (st), (i), (val)) +#define sk_BY_DIR_ENTRY_zero(st) SKM_sk_zero(BY_DIR_ENTRY, (st)) +#define sk_BY_DIR_ENTRY_push(st, val) SKM_sk_push(BY_DIR_ENTRY, (st), (val)) +#define sk_BY_DIR_ENTRY_unshift(st, val) SKM_sk_unshift(BY_DIR_ENTRY, (st), (val)) +#define sk_BY_DIR_ENTRY_find(st, val) SKM_sk_find(BY_DIR_ENTRY, (st), (val)) +#define sk_BY_DIR_ENTRY_find_ex(st, val) SKM_sk_find_ex(BY_DIR_ENTRY, (st), (val)) +#define sk_BY_DIR_ENTRY_delete(st, i) SKM_sk_delete(BY_DIR_ENTRY, (st), (i)) +#define sk_BY_DIR_ENTRY_delete_ptr(st, ptr) SKM_sk_delete_ptr(BY_DIR_ENTRY, (st), (ptr)) +#define sk_BY_DIR_ENTRY_insert(st, val, i) SKM_sk_insert(BY_DIR_ENTRY, (st), (val), (i)) +#define sk_BY_DIR_ENTRY_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(BY_DIR_ENTRY, (st), (cmp)) +#define sk_BY_DIR_ENTRY_dup(st) SKM_sk_dup(BY_DIR_ENTRY, st) +#define sk_BY_DIR_ENTRY_pop_free(st, free_func) SKM_sk_pop_free(BY_DIR_ENTRY, (st), (free_func)) +#define sk_BY_DIR_ENTRY_shift(st) SKM_sk_shift(BY_DIR_ENTRY, (st)) +#define sk_BY_DIR_ENTRY_pop(st) SKM_sk_pop(BY_DIR_ENTRY, (st)) +#define sk_BY_DIR_ENTRY_sort(st) SKM_sk_sort(BY_DIR_ENTRY, (st)) +#define sk_BY_DIR_ENTRY_is_sorted(st) SKM_sk_is_sorted(BY_DIR_ENTRY, (st)) + +#define sk_BY_DIR_HASH_new(cmp) SKM_sk_new(BY_DIR_HASH, (cmp)) +#define sk_BY_DIR_HASH_new_null() SKM_sk_new_null(BY_DIR_HASH) +#define sk_BY_DIR_HASH_free(st) SKM_sk_free(BY_DIR_HASH, (st)) +#define sk_BY_DIR_HASH_num(st) SKM_sk_num(BY_DIR_HASH, (st)) +#define sk_BY_DIR_HASH_value(st, i) SKM_sk_value(BY_DIR_HASH, (st), (i)) +#define sk_BY_DIR_HASH_set(st, i, val) SKM_sk_set(BY_DIR_HASH, (st), (i), (val)) +#define sk_BY_DIR_HASH_zero(st) SKM_sk_zero(BY_DIR_HASH, (st)) +#define sk_BY_DIR_HASH_push(st, val) SKM_sk_push(BY_DIR_HASH, (st), (val)) +#define sk_BY_DIR_HASH_unshift(st, val) SKM_sk_unshift(BY_DIR_HASH, (st), (val)) +#define sk_BY_DIR_HASH_find(st, val) SKM_sk_find(BY_DIR_HASH, (st), (val)) +#define sk_BY_DIR_HASH_find_ex(st, val) SKM_sk_find_ex(BY_DIR_HASH, (st), (val)) +#define sk_BY_DIR_HASH_delete(st, i) SKM_sk_delete(BY_DIR_HASH, (st), (i)) +#define sk_BY_DIR_HASH_delete_ptr(st, ptr) SKM_sk_delete_ptr(BY_DIR_HASH, (st), (ptr)) +#define sk_BY_DIR_HASH_insert(st, val, i) SKM_sk_insert(BY_DIR_HASH, (st), (val), (i)) +#define sk_BY_DIR_HASH_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(BY_DIR_HASH, (st), (cmp)) +#define sk_BY_DIR_HASH_dup(st) SKM_sk_dup(BY_DIR_HASH, st) +#define sk_BY_DIR_HASH_pop_free(st, free_func) SKM_sk_pop_free(BY_DIR_HASH, (st), (free_func)) +#define sk_BY_DIR_HASH_shift(st) SKM_sk_shift(BY_DIR_HASH, (st)) +#define sk_BY_DIR_HASH_pop(st) SKM_sk_pop(BY_DIR_HASH, (st)) +#define sk_BY_DIR_HASH_sort(st) SKM_sk_sort(BY_DIR_HASH, (st)) +#define sk_BY_DIR_HASH_is_sorted(st) SKM_sk_is_sorted(BY_DIR_HASH, (st)) + +#define sk_CMS_CertificateChoices_new(cmp) SKM_sk_new(CMS_CertificateChoices, (cmp)) +#define sk_CMS_CertificateChoices_new_null() SKM_sk_new_null(CMS_CertificateChoices) +#define sk_CMS_CertificateChoices_free(st) SKM_sk_free(CMS_CertificateChoices, (st)) +#define sk_CMS_CertificateChoices_num(st) SKM_sk_num(CMS_CertificateChoices, (st)) +#define sk_CMS_CertificateChoices_value(st, i) SKM_sk_value(CMS_CertificateChoices, (st), (i)) +#define sk_CMS_CertificateChoices_set(st, i, val) SKM_sk_set(CMS_CertificateChoices, (st), (i), (val)) +#define sk_CMS_CertificateChoices_zero(st) SKM_sk_zero(CMS_CertificateChoices, (st)) +#define sk_CMS_CertificateChoices_push(st, val) SKM_sk_push(CMS_CertificateChoices, (st), (val)) +#define sk_CMS_CertificateChoices_unshift(st, val) SKM_sk_unshift(CMS_CertificateChoices, (st), (val)) +#define sk_CMS_CertificateChoices_find(st, val) SKM_sk_find(CMS_CertificateChoices, (st), (val)) +#define sk_CMS_CertificateChoices_find_ex(st, val) SKM_sk_find_ex(CMS_CertificateChoices, (st), (val)) +#define sk_CMS_CertificateChoices_delete(st, i) SKM_sk_delete(CMS_CertificateChoices, (st), (i)) +#define sk_CMS_CertificateChoices_delete_ptr(st, ptr) SKM_sk_delete_ptr(CMS_CertificateChoices, (st), (ptr)) +#define sk_CMS_CertificateChoices_insert(st, val, i) SKM_sk_insert(CMS_CertificateChoices, (st), (val), (i)) +#define sk_CMS_CertificateChoices_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(CMS_CertificateChoices, (st), (cmp)) +#define sk_CMS_CertificateChoices_dup(st) SKM_sk_dup(CMS_CertificateChoices, st) +#define sk_CMS_CertificateChoices_pop_free(st, free_func) SKM_sk_pop_free(CMS_CertificateChoices, (st), (free_func)) +#define sk_CMS_CertificateChoices_shift(st) SKM_sk_shift(CMS_CertificateChoices, (st)) +#define sk_CMS_CertificateChoices_pop(st) SKM_sk_pop(CMS_CertificateChoices, (st)) +#define sk_CMS_CertificateChoices_sort(st) SKM_sk_sort(CMS_CertificateChoices, (st)) +#define sk_CMS_CertificateChoices_is_sorted(st) SKM_sk_is_sorted(CMS_CertificateChoices, (st)) + +#define sk_CMS_RecipientInfo_new(cmp) SKM_sk_new(CMS_RecipientInfo, (cmp)) +#define sk_CMS_RecipientInfo_new_null() SKM_sk_new_null(CMS_RecipientInfo) +#define sk_CMS_RecipientInfo_free(st) SKM_sk_free(CMS_RecipientInfo, (st)) +#define sk_CMS_RecipientInfo_num(st) SKM_sk_num(CMS_RecipientInfo, (st)) +#define sk_CMS_RecipientInfo_value(st, i) SKM_sk_value(CMS_RecipientInfo, (st), (i)) +#define sk_CMS_RecipientInfo_set(st, i, val) SKM_sk_set(CMS_RecipientInfo, (st), (i), (val)) +#define sk_CMS_RecipientInfo_zero(st) SKM_sk_zero(CMS_RecipientInfo, (st)) +#define sk_CMS_RecipientInfo_push(st, val) SKM_sk_push(CMS_RecipientInfo, (st), (val)) +#define sk_CMS_RecipientInfo_unshift(st, val) SKM_sk_unshift(CMS_RecipientInfo, (st), (val)) +#define sk_CMS_RecipientInfo_find(st, val) SKM_sk_find(CMS_RecipientInfo, (st), (val)) +#define sk_CMS_RecipientInfo_find_ex(st, val) SKM_sk_find_ex(CMS_RecipientInfo, (st), (val)) +#define sk_CMS_RecipientInfo_delete(st, i) SKM_sk_delete(CMS_RecipientInfo, (st), (i)) +#define sk_CMS_RecipientInfo_delete_ptr(st, ptr) SKM_sk_delete_ptr(CMS_RecipientInfo, (st), (ptr)) +#define sk_CMS_RecipientInfo_insert(st, val, i) SKM_sk_insert(CMS_RecipientInfo, (st), (val), (i)) +#define sk_CMS_RecipientInfo_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(CMS_RecipientInfo, (st), (cmp)) +#define sk_CMS_RecipientInfo_dup(st) SKM_sk_dup(CMS_RecipientInfo, st) +#define sk_CMS_RecipientInfo_pop_free(st, free_func) SKM_sk_pop_free(CMS_RecipientInfo, (st), (free_func)) +#define sk_CMS_RecipientInfo_shift(st) SKM_sk_shift(CMS_RecipientInfo, (st)) +#define sk_CMS_RecipientInfo_pop(st) SKM_sk_pop(CMS_RecipientInfo, (st)) +#define sk_CMS_RecipientInfo_sort(st) SKM_sk_sort(CMS_RecipientInfo, (st)) +#define sk_CMS_RecipientInfo_is_sorted(st) SKM_sk_is_sorted(CMS_RecipientInfo, (st)) + +#define sk_CMS_RevocationInfoChoice_new(cmp) SKM_sk_new(CMS_RevocationInfoChoice, (cmp)) +#define sk_CMS_RevocationInfoChoice_new_null() SKM_sk_new_null(CMS_RevocationInfoChoice) +#define sk_CMS_RevocationInfoChoice_free(st) SKM_sk_free(CMS_RevocationInfoChoice, (st)) +#define sk_CMS_RevocationInfoChoice_num(st) SKM_sk_num(CMS_RevocationInfoChoice, (st)) +#define sk_CMS_RevocationInfoChoice_value(st, i) SKM_sk_value(CMS_RevocationInfoChoice, (st), (i)) +#define sk_CMS_RevocationInfoChoice_set(st, i, val) SKM_sk_set(CMS_RevocationInfoChoice, (st), (i), (val)) +#define sk_CMS_RevocationInfoChoice_zero(st) SKM_sk_zero(CMS_RevocationInfoChoice, (st)) +#define sk_CMS_RevocationInfoChoice_push(st, val) SKM_sk_push(CMS_RevocationInfoChoice, (st), (val)) +#define sk_CMS_RevocationInfoChoice_unshift(st, val) SKM_sk_unshift(CMS_RevocationInfoChoice, (st), (val)) +#define sk_CMS_RevocationInfoChoice_find(st, val) SKM_sk_find(CMS_RevocationInfoChoice, (st), (val)) +#define sk_CMS_RevocationInfoChoice_find_ex(st, val) SKM_sk_find_ex(CMS_RevocationInfoChoice, (st), (val)) +#define sk_CMS_RevocationInfoChoice_delete(st, i) SKM_sk_delete(CMS_RevocationInfoChoice, (st), (i)) +#define sk_CMS_RevocationInfoChoice_delete_ptr(st, ptr) SKM_sk_delete_ptr(CMS_RevocationInfoChoice, (st), (ptr)) +#define sk_CMS_RevocationInfoChoice_insert(st, val, i) SKM_sk_insert(CMS_RevocationInfoChoice, (st), (val), (i)) +#define sk_CMS_RevocationInfoChoice_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(CMS_RevocationInfoChoice, (st), (cmp)) +#define sk_CMS_RevocationInfoChoice_dup(st) SKM_sk_dup(CMS_RevocationInfoChoice, st) +#define sk_CMS_RevocationInfoChoice_pop_free(st, free_func) SKM_sk_pop_free(CMS_RevocationInfoChoice, (st), (free_func)) +#define sk_CMS_RevocationInfoChoice_shift(st) SKM_sk_shift(CMS_RevocationInfoChoice, (st)) +#define sk_CMS_RevocationInfoChoice_pop(st) SKM_sk_pop(CMS_RevocationInfoChoice, (st)) +#define sk_CMS_RevocationInfoChoice_sort(st) SKM_sk_sort(CMS_RevocationInfoChoice, (st)) +#define sk_CMS_RevocationInfoChoice_is_sorted(st) SKM_sk_is_sorted(CMS_RevocationInfoChoice, (st)) + +#define sk_CMS_SignerInfo_new(cmp) SKM_sk_new(CMS_SignerInfo, (cmp)) +#define sk_CMS_SignerInfo_new_null() SKM_sk_new_null(CMS_SignerInfo) +#define sk_CMS_SignerInfo_free(st) SKM_sk_free(CMS_SignerInfo, (st)) +#define sk_CMS_SignerInfo_num(st) SKM_sk_num(CMS_SignerInfo, (st)) +#define sk_CMS_SignerInfo_value(st, i) SKM_sk_value(CMS_SignerInfo, (st), (i)) +#define sk_CMS_SignerInfo_set(st, i, val) SKM_sk_set(CMS_SignerInfo, (st), (i), (val)) +#define sk_CMS_SignerInfo_zero(st) SKM_sk_zero(CMS_SignerInfo, (st)) +#define sk_CMS_SignerInfo_push(st, val) SKM_sk_push(CMS_SignerInfo, (st), (val)) +#define sk_CMS_SignerInfo_unshift(st, val) SKM_sk_unshift(CMS_SignerInfo, (st), (val)) +#define sk_CMS_SignerInfo_find(st, val) SKM_sk_find(CMS_SignerInfo, (st), (val)) +#define sk_CMS_SignerInfo_find_ex(st, val) SKM_sk_find_ex(CMS_SignerInfo, (st), (val)) +#define sk_CMS_SignerInfo_delete(st, i) SKM_sk_delete(CMS_SignerInfo, (st), (i)) +#define sk_CMS_SignerInfo_delete_ptr(st, ptr) SKM_sk_delete_ptr(CMS_SignerInfo, (st), (ptr)) +#define sk_CMS_SignerInfo_insert(st, val, i) SKM_sk_insert(CMS_SignerInfo, (st), (val), (i)) +#define sk_CMS_SignerInfo_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(CMS_SignerInfo, (st), (cmp)) +#define sk_CMS_SignerInfo_dup(st) SKM_sk_dup(CMS_SignerInfo, st) +#define sk_CMS_SignerInfo_pop_free(st, free_func) SKM_sk_pop_free(CMS_SignerInfo, (st), (free_func)) +#define sk_CMS_SignerInfo_shift(st) SKM_sk_shift(CMS_SignerInfo, (st)) +#define sk_CMS_SignerInfo_pop(st) SKM_sk_pop(CMS_SignerInfo, (st)) +#define sk_CMS_SignerInfo_sort(st) SKM_sk_sort(CMS_SignerInfo, (st)) +#define sk_CMS_SignerInfo_is_sorted(st) SKM_sk_is_sorted(CMS_SignerInfo, (st)) + +#define sk_CONF_IMODULE_new(cmp) SKM_sk_new(CONF_IMODULE, (cmp)) +#define sk_CONF_IMODULE_new_null() SKM_sk_new_null(CONF_IMODULE) +#define sk_CONF_IMODULE_free(st) SKM_sk_free(CONF_IMODULE, (st)) +#define sk_CONF_IMODULE_num(st) SKM_sk_num(CONF_IMODULE, (st)) +#define sk_CONF_IMODULE_value(st, i) SKM_sk_value(CONF_IMODULE, (st), (i)) +#define sk_CONF_IMODULE_set(st, i, val) SKM_sk_set(CONF_IMODULE, (st), (i), (val)) +#define sk_CONF_IMODULE_zero(st) SKM_sk_zero(CONF_IMODULE, (st)) +#define sk_CONF_IMODULE_push(st, val) SKM_sk_push(CONF_IMODULE, (st), (val)) +#define sk_CONF_IMODULE_unshift(st, val) SKM_sk_unshift(CONF_IMODULE, (st), (val)) +#define sk_CONF_IMODULE_find(st, val) SKM_sk_find(CONF_IMODULE, (st), (val)) +#define sk_CONF_IMODULE_find_ex(st, val) SKM_sk_find_ex(CONF_IMODULE, (st), (val)) +#define sk_CONF_IMODULE_delete(st, i) SKM_sk_delete(CONF_IMODULE, (st), (i)) +#define sk_CONF_IMODULE_delete_ptr(st, ptr) SKM_sk_delete_ptr(CONF_IMODULE, (st), (ptr)) +#define sk_CONF_IMODULE_insert(st, val, i) SKM_sk_insert(CONF_IMODULE, (st), (val), (i)) +#define sk_CONF_IMODULE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(CONF_IMODULE, (st), (cmp)) +#define sk_CONF_IMODULE_dup(st) SKM_sk_dup(CONF_IMODULE, st) +#define sk_CONF_IMODULE_pop_free(st, free_func) SKM_sk_pop_free(CONF_IMODULE, (st), (free_func)) +#define sk_CONF_IMODULE_shift(st) SKM_sk_shift(CONF_IMODULE, (st)) +#define sk_CONF_IMODULE_pop(st) SKM_sk_pop(CONF_IMODULE, (st)) +#define sk_CONF_IMODULE_sort(st) SKM_sk_sort(CONF_IMODULE, (st)) +#define sk_CONF_IMODULE_is_sorted(st) SKM_sk_is_sorted(CONF_IMODULE, (st)) + +#define sk_CONF_MODULE_new(cmp) SKM_sk_new(CONF_MODULE, (cmp)) +#define sk_CONF_MODULE_new_null() SKM_sk_new_null(CONF_MODULE) +#define sk_CONF_MODULE_free(st) SKM_sk_free(CONF_MODULE, (st)) +#define sk_CONF_MODULE_num(st) SKM_sk_num(CONF_MODULE, (st)) +#define sk_CONF_MODULE_value(st, i) SKM_sk_value(CONF_MODULE, (st), (i)) +#define sk_CONF_MODULE_set(st, i, val) SKM_sk_set(CONF_MODULE, (st), (i), (val)) +#define sk_CONF_MODULE_zero(st) SKM_sk_zero(CONF_MODULE, (st)) +#define sk_CONF_MODULE_push(st, val) SKM_sk_push(CONF_MODULE, (st), (val)) +#define sk_CONF_MODULE_unshift(st, val) SKM_sk_unshift(CONF_MODULE, (st), (val)) +#define sk_CONF_MODULE_find(st, val) SKM_sk_find(CONF_MODULE, (st), (val)) +#define sk_CONF_MODULE_find_ex(st, val) SKM_sk_find_ex(CONF_MODULE, (st), (val)) +#define sk_CONF_MODULE_delete(st, i) SKM_sk_delete(CONF_MODULE, (st), (i)) +#define sk_CONF_MODULE_delete_ptr(st, ptr) SKM_sk_delete_ptr(CONF_MODULE, (st), (ptr)) +#define sk_CONF_MODULE_insert(st, val, i) SKM_sk_insert(CONF_MODULE, (st), (val), (i)) +#define sk_CONF_MODULE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(CONF_MODULE, (st), (cmp)) +#define sk_CONF_MODULE_dup(st) SKM_sk_dup(CONF_MODULE, st) +#define sk_CONF_MODULE_pop_free(st, free_func) SKM_sk_pop_free(CONF_MODULE, (st), (free_func)) +#define sk_CONF_MODULE_shift(st) SKM_sk_shift(CONF_MODULE, (st)) +#define sk_CONF_MODULE_pop(st) SKM_sk_pop(CONF_MODULE, (st)) +#define sk_CONF_MODULE_sort(st) SKM_sk_sort(CONF_MODULE, (st)) +#define sk_CONF_MODULE_is_sorted(st) SKM_sk_is_sorted(CONF_MODULE, (st)) + +#define sk_CONF_VALUE_new(cmp) SKM_sk_new(CONF_VALUE, (cmp)) +#define sk_CONF_VALUE_new_null() SKM_sk_new_null(CONF_VALUE) +#define sk_CONF_VALUE_free(st) SKM_sk_free(CONF_VALUE, (st)) +#define sk_CONF_VALUE_num(st) SKM_sk_num(CONF_VALUE, (st)) +#define sk_CONF_VALUE_value(st, i) SKM_sk_value(CONF_VALUE, (st), (i)) +#define sk_CONF_VALUE_set(st, i, val) SKM_sk_set(CONF_VALUE, (st), (i), (val)) +#define sk_CONF_VALUE_zero(st) SKM_sk_zero(CONF_VALUE, (st)) +#define sk_CONF_VALUE_push(st, val) SKM_sk_push(CONF_VALUE, (st), (val)) +#define sk_CONF_VALUE_unshift(st, val) SKM_sk_unshift(CONF_VALUE, (st), (val)) +#define sk_CONF_VALUE_find(st, val) SKM_sk_find(CONF_VALUE, (st), (val)) +#define sk_CONF_VALUE_find_ex(st, val) SKM_sk_find_ex(CONF_VALUE, (st), (val)) +#define sk_CONF_VALUE_delete(st, i) SKM_sk_delete(CONF_VALUE, (st), (i)) +#define sk_CONF_VALUE_delete_ptr(st, ptr) SKM_sk_delete_ptr(CONF_VALUE, (st), (ptr)) +#define sk_CONF_VALUE_insert(st, val, i) SKM_sk_insert(CONF_VALUE, (st), (val), (i)) +#define sk_CONF_VALUE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(CONF_VALUE, (st), (cmp)) +#define sk_CONF_VALUE_dup(st) SKM_sk_dup(CONF_VALUE, st) +#define sk_CONF_VALUE_pop_free(st, free_func) SKM_sk_pop_free(CONF_VALUE, (st), (free_func)) +#define sk_CONF_VALUE_shift(st) SKM_sk_shift(CONF_VALUE, (st)) +#define sk_CONF_VALUE_pop(st) SKM_sk_pop(CONF_VALUE, (st)) +#define sk_CONF_VALUE_sort(st) SKM_sk_sort(CONF_VALUE, (st)) +#define sk_CONF_VALUE_is_sorted(st) SKM_sk_is_sorted(CONF_VALUE, (st)) + +#define sk_CRYPTO_EX_DATA_FUNCS_new(cmp) SKM_sk_new(CRYPTO_EX_DATA_FUNCS, (cmp)) +#define sk_CRYPTO_EX_DATA_FUNCS_new_null() SKM_sk_new_null(CRYPTO_EX_DATA_FUNCS) +#define sk_CRYPTO_EX_DATA_FUNCS_free(st) SKM_sk_free(CRYPTO_EX_DATA_FUNCS, (st)) +#define sk_CRYPTO_EX_DATA_FUNCS_num(st) SKM_sk_num(CRYPTO_EX_DATA_FUNCS, (st)) +#define sk_CRYPTO_EX_DATA_FUNCS_value(st, i) SKM_sk_value(CRYPTO_EX_DATA_FUNCS, (st), (i)) +#define sk_CRYPTO_EX_DATA_FUNCS_set(st, i, val) SKM_sk_set(CRYPTO_EX_DATA_FUNCS, (st), (i), (val)) +#define sk_CRYPTO_EX_DATA_FUNCS_zero(st) SKM_sk_zero(CRYPTO_EX_DATA_FUNCS, (st)) +#define sk_CRYPTO_EX_DATA_FUNCS_push(st, val) SKM_sk_push(CRYPTO_EX_DATA_FUNCS, (st), (val)) +#define sk_CRYPTO_EX_DATA_FUNCS_unshift(st, val) SKM_sk_unshift(CRYPTO_EX_DATA_FUNCS, (st), (val)) +#define sk_CRYPTO_EX_DATA_FUNCS_find(st, val) SKM_sk_find(CRYPTO_EX_DATA_FUNCS, (st), (val)) +#define sk_CRYPTO_EX_DATA_FUNCS_find_ex(st, val) SKM_sk_find_ex(CRYPTO_EX_DATA_FUNCS, (st), (val)) +#define sk_CRYPTO_EX_DATA_FUNCS_delete(st, i) SKM_sk_delete(CRYPTO_EX_DATA_FUNCS, (st), (i)) +#define sk_CRYPTO_EX_DATA_FUNCS_delete_ptr(st, ptr) SKM_sk_delete_ptr(CRYPTO_EX_DATA_FUNCS, (st), (ptr)) +#define sk_CRYPTO_EX_DATA_FUNCS_insert(st, val, i) SKM_sk_insert(CRYPTO_EX_DATA_FUNCS, (st), (val), (i)) +#define sk_CRYPTO_EX_DATA_FUNCS_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(CRYPTO_EX_DATA_FUNCS, (st), (cmp)) +#define sk_CRYPTO_EX_DATA_FUNCS_dup(st) SKM_sk_dup(CRYPTO_EX_DATA_FUNCS, st) +#define sk_CRYPTO_EX_DATA_FUNCS_pop_free(st, free_func) SKM_sk_pop_free(CRYPTO_EX_DATA_FUNCS, (st), (free_func)) +#define sk_CRYPTO_EX_DATA_FUNCS_shift(st) SKM_sk_shift(CRYPTO_EX_DATA_FUNCS, (st)) +#define sk_CRYPTO_EX_DATA_FUNCS_pop(st) SKM_sk_pop(CRYPTO_EX_DATA_FUNCS, (st)) +#define sk_CRYPTO_EX_DATA_FUNCS_sort(st) SKM_sk_sort(CRYPTO_EX_DATA_FUNCS, (st)) +#define sk_CRYPTO_EX_DATA_FUNCS_is_sorted(st) SKM_sk_is_sorted(CRYPTO_EX_DATA_FUNCS, (st)) + +#define sk_CRYPTO_dynlock_new(cmp) SKM_sk_new(CRYPTO_dynlock, (cmp)) +#define sk_CRYPTO_dynlock_new_null() SKM_sk_new_null(CRYPTO_dynlock) +#define sk_CRYPTO_dynlock_free(st) SKM_sk_free(CRYPTO_dynlock, (st)) +#define sk_CRYPTO_dynlock_num(st) SKM_sk_num(CRYPTO_dynlock, (st)) +#define sk_CRYPTO_dynlock_value(st, i) SKM_sk_value(CRYPTO_dynlock, (st), (i)) +#define sk_CRYPTO_dynlock_set(st, i, val) SKM_sk_set(CRYPTO_dynlock, (st), (i), (val)) +#define sk_CRYPTO_dynlock_zero(st) SKM_sk_zero(CRYPTO_dynlock, (st)) +#define sk_CRYPTO_dynlock_push(st, val) SKM_sk_push(CRYPTO_dynlock, (st), (val)) +#define sk_CRYPTO_dynlock_unshift(st, val) SKM_sk_unshift(CRYPTO_dynlock, (st), (val)) +#define sk_CRYPTO_dynlock_find(st, val) SKM_sk_find(CRYPTO_dynlock, (st), (val)) +#define sk_CRYPTO_dynlock_find_ex(st, val) SKM_sk_find_ex(CRYPTO_dynlock, (st), (val)) +#define sk_CRYPTO_dynlock_delete(st, i) SKM_sk_delete(CRYPTO_dynlock, (st), (i)) +#define sk_CRYPTO_dynlock_delete_ptr(st, ptr) SKM_sk_delete_ptr(CRYPTO_dynlock, (st), (ptr)) +#define sk_CRYPTO_dynlock_insert(st, val, i) SKM_sk_insert(CRYPTO_dynlock, (st), (val), (i)) +#define sk_CRYPTO_dynlock_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(CRYPTO_dynlock, (st), (cmp)) +#define sk_CRYPTO_dynlock_dup(st) SKM_sk_dup(CRYPTO_dynlock, st) +#define sk_CRYPTO_dynlock_pop_free(st, free_func) SKM_sk_pop_free(CRYPTO_dynlock, (st), (free_func)) +#define sk_CRYPTO_dynlock_shift(st) SKM_sk_shift(CRYPTO_dynlock, (st)) +#define sk_CRYPTO_dynlock_pop(st) SKM_sk_pop(CRYPTO_dynlock, (st)) +#define sk_CRYPTO_dynlock_sort(st) SKM_sk_sort(CRYPTO_dynlock, (st)) +#define sk_CRYPTO_dynlock_is_sorted(st) SKM_sk_is_sorted(CRYPTO_dynlock, (st)) + +#define sk_DIST_POINT_new(cmp) SKM_sk_new(DIST_POINT, (cmp)) +#define sk_DIST_POINT_new_null() SKM_sk_new_null(DIST_POINT) +#define sk_DIST_POINT_free(st) SKM_sk_free(DIST_POINT, (st)) +#define sk_DIST_POINT_num(st) SKM_sk_num(DIST_POINT, (st)) +#define sk_DIST_POINT_value(st, i) SKM_sk_value(DIST_POINT, (st), (i)) +#define sk_DIST_POINT_set(st, i, val) SKM_sk_set(DIST_POINT, (st), (i), (val)) +#define sk_DIST_POINT_zero(st) SKM_sk_zero(DIST_POINT, (st)) +#define sk_DIST_POINT_push(st, val) SKM_sk_push(DIST_POINT, (st), (val)) +#define sk_DIST_POINT_unshift(st, val) SKM_sk_unshift(DIST_POINT, (st), (val)) +#define sk_DIST_POINT_find(st, val) SKM_sk_find(DIST_POINT, (st), (val)) +#define sk_DIST_POINT_find_ex(st, val) SKM_sk_find_ex(DIST_POINT, (st), (val)) +#define sk_DIST_POINT_delete(st, i) SKM_sk_delete(DIST_POINT, (st), (i)) +#define sk_DIST_POINT_delete_ptr(st, ptr) SKM_sk_delete_ptr(DIST_POINT, (st), (ptr)) +#define sk_DIST_POINT_insert(st, val, i) SKM_sk_insert(DIST_POINT, (st), (val), (i)) +#define sk_DIST_POINT_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(DIST_POINT, (st), (cmp)) +#define sk_DIST_POINT_dup(st) SKM_sk_dup(DIST_POINT, st) +#define sk_DIST_POINT_pop_free(st, free_func) SKM_sk_pop_free(DIST_POINT, (st), (free_func)) +#define sk_DIST_POINT_shift(st) SKM_sk_shift(DIST_POINT, (st)) +#define sk_DIST_POINT_pop(st) SKM_sk_pop(DIST_POINT, (st)) +#define sk_DIST_POINT_sort(st) SKM_sk_sort(DIST_POINT, (st)) +#define sk_DIST_POINT_is_sorted(st) SKM_sk_is_sorted(DIST_POINT, (st)) + +#define sk_ENGINE_new(cmp) SKM_sk_new(ENGINE, (cmp)) +#define sk_ENGINE_new_null() SKM_sk_new_null(ENGINE) +#define sk_ENGINE_free(st) SKM_sk_free(ENGINE, (st)) +#define sk_ENGINE_num(st) SKM_sk_num(ENGINE, (st)) +#define sk_ENGINE_value(st, i) SKM_sk_value(ENGINE, (st), (i)) +#define sk_ENGINE_set(st, i, val) SKM_sk_set(ENGINE, (st), (i), (val)) +#define sk_ENGINE_zero(st) SKM_sk_zero(ENGINE, (st)) +#define sk_ENGINE_push(st, val) SKM_sk_push(ENGINE, (st), (val)) +#define sk_ENGINE_unshift(st, val) SKM_sk_unshift(ENGINE, (st), (val)) +#define sk_ENGINE_find(st, val) SKM_sk_find(ENGINE, (st), (val)) +#define sk_ENGINE_find_ex(st, val) SKM_sk_find_ex(ENGINE, (st), (val)) +#define sk_ENGINE_delete(st, i) SKM_sk_delete(ENGINE, (st), (i)) +#define sk_ENGINE_delete_ptr(st, ptr) SKM_sk_delete_ptr(ENGINE, (st), (ptr)) +#define sk_ENGINE_insert(st, val, i) SKM_sk_insert(ENGINE, (st), (val), (i)) +#define sk_ENGINE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ENGINE, (st), (cmp)) +#define sk_ENGINE_dup(st) SKM_sk_dup(ENGINE, st) +#define sk_ENGINE_pop_free(st, free_func) SKM_sk_pop_free(ENGINE, (st), (free_func)) +#define sk_ENGINE_shift(st) SKM_sk_shift(ENGINE, (st)) +#define sk_ENGINE_pop(st) SKM_sk_pop(ENGINE, (st)) +#define sk_ENGINE_sort(st) SKM_sk_sort(ENGINE, (st)) +#define sk_ENGINE_is_sorted(st) SKM_sk_is_sorted(ENGINE, (st)) + +#define sk_ENGINE_CLEANUP_ITEM_new(cmp) SKM_sk_new(ENGINE_CLEANUP_ITEM, (cmp)) +#define sk_ENGINE_CLEANUP_ITEM_new_null() SKM_sk_new_null(ENGINE_CLEANUP_ITEM) +#define sk_ENGINE_CLEANUP_ITEM_free(st) SKM_sk_free(ENGINE_CLEANUP_ITEM, (st)) +#define sk_ENGINE_CLEANUP_ITEM_num(st) SKM_sk_num(ENGINE_CLEANUP_ITEM, (st)) +#define sk_ENGINE_CLEANUP_ITEM_value(st, i) SKM_sk_value(ENGINE_CLEANUP_ITEM, (st), (i)) +#define sk_ENGINE_CLEANUP_ITEM_set(st, i, val) SKM_sk_set(ENGINE_CLEANUP_ITEM, (st), (i), (val)) +#define sk_ENGINE_CLEANUP_ITEM_zero(st) SKM_sk_zero(ENGINE_CLEANUP_ITEM, (st)) +#define sk_ENGINE_CLEANUP_ITEM_push(st, val) SKM_sk_push(ENGINE_CLEANUP_ITEM, (st), (val)) +#define sk_ENGINE_CLEANUP_ITEM_unshift(st, val) SKM_sk_unshift(ENGINE_CLEANUP_ITEM, (st), (val)) +#define sk_ENGINE_CLEANUP_ITEM_find(st, val) SKM_sk_find(ENGINE_CLEANUP_ITEM, (st), (val)) +#define sk_ENGINE_CLEANUP_ITEM_find_ex(st, val) SKM_sk_find_ex(ENGINE_CLEANUP_ITEM, (st), (val)) +#define sk_ENGINE_CLEANUP_ITEM_delete(st, i) SKM_sk_delete(ENGINE_CLEANUP_ITEM, (st), (i)) +#define sk_ENGINE_CLEANUP_ITEM_delete_ptr(st, ptr) SKM_sk_delete_ptr(ENGINE_CLEANUP_ITEM, (st), (ptr)) +#define sk_ENGINE_CLEANUP_ITEM_insert(st, val, i) SKM_sk_insert(ENGINE_CLEANUP_ITEM, (st), (val), (i)) +#define sk_ENGINE_CLEANUP_ITEM_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ENGINE_CLEANUP_ITEM, (st), (cmp)) +#define sk_ENGINE_CLEANUP_ITEM_dup(st) SKM_sk_dup(ENGINE_CLEANUP_ITEM, st) +#define sk_ENGINE_CLEANUP_ITEM_pop_free(st, free_func) SKM_sk_pop_free(ENGINE_CLEANUP_ITEM, (st), (free_func)) +#define sk_ENGINE_CLEANUP_ITEM_shift(st) SKM_sk_shift(ENGINE_CLEANUP_ITEM, (st)) +#define sk_ENGINE_CLEANUP_ITEM_pop(st) SKM_sk_pop(ENGINE_CLEANUP_ITEM, (st)) +#define sk_ENGINE_CLEANUP_ITEM_sort(st) SKM_sk_sort(ENGINE_CLEANUP_ITEM, (st)) +#define sk_ENGINE_CLEANUP_ITEM_is_sorted(st) SKM_sk_is_sorted(ENGINE_CLEANUP_ITEM, (st)) + +#define sk_ESS_CERT_ID_new(cmp) SKM_sk_new(ESS_CERT_ID, (cmp)) +#define sk_ESS_CERT_ID_new_null() SKM_sk_new_null(ESS_CERT_ID) +#define sk_ESS_CERT_ID_free(st) SKM_sk_free(ESS_CERT_ID, (st)) +#define sk_ESS_CERT_ID_num(st) SKM_sk_num(ESS_CERT_ID, (st)) +#define sk_ESS_CERT_ID_value(st, i) SKM_sk_value(ESS_CERT_ID, (st), (i)) +#define sk_ESS_CERT_ID_set(st, i, val) SKM_sk_set(ESS_CERT_ID, (st), (i), (val)) +#define sk_ESS_CERT_ID_zero(st) SKM_sk_zero(ESS_CERT_ID, (st)) +#define sk_ESS_CERT_ID_push(st, val) SKM_sk_push(ESS_CERT_ID, (st), (val)) +#define sk_ESS_CERT_ID_unshift(st, val) SKM_sk_unshift(ESS_CERT_ID, (st), (val)) +#define sk_ESS_CERT_ID_find(st, val) SKM_sk_find(ESS_CERT_ID, (st), (val)) +#define sk_ESS_CERT_ID_find_ex(st, val) SKM_sk_find_ex(ESS_CERT_ID, (st), (val)) +#define sk_ESS_CERT_ID_delete(st, i) SKM_sk_delete(ESS_CERT_ID, (st), (i)) +#define sk_ESS_CERT_ID_delete_ptr(st, ptr) SKM_sk_delete_ptr(ESS_CERT_ID, (st), (ptr)) +#define sk_ESS_CERT_ID_insert(st, val, i) SKM_sk_insert(ESS_CERT_ID, (st), (val), (i)) +#define sk_ESS_CERT_ID_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(ESS_CERT_ID, (st), (cmp)) +#define sk_ESS_CERT_ID_dup(st) SKM_sk_dup(ESS_CERT_ID, st) +#define sk_ESS_CERT_ID_pop_free(st, free_func) SKM_sk_pop_free(ESS_CERT_ID, (st), (free_func)) +#define sk_ESS_CERT_ID_shift(st) SKM_sk_shift(ESS_CERT_ID, (st)) +#define sk_ESS_CERT_ID_pop(st) SKM_sk_pop(ESS_CERT_ID, (st)) +#define sk_ESS_CERT_ID_sort(st) SKM_sk_sort(ESS_CERT_ID, (st)) +#define sk_ESS_CERT_ID_is_sorted(st) SKM_sk_is_sorted(ESS_CERT_ID, (st)) + +#define sk_EVP_MD_new(cmp) SKM_sk_new(EVP_MD, (cmp)) +#define sk_EVP_MD_new_null() SKM_sk_new_null(EVP_MD) +#define sk_EVP_MD_free(st) SKM_sk_free(EVP_MD, (st)) +#define sk_EVP_MD_num(st) SKM_sk_num(EVP_MD, (st)) +#define sk_EVP_MD_value(st, i) SKM_sk_value(EVP_MD, (st), (i)) +#define sk_EVP_MD_set(st, i, val) SKM_sk_set(EVP_MD, (st), (i), (val)) +#define sk_EVP_MD_zero(st) SKM_sk_zero(EVP_MD, (st)) +#define sk_EVP_MD_push(st, val) SKM_sk_push(EVP_MD, (st), (val)) +#define sk_EVP_MD_unshift(st, val) SKM_sk_unshift(EVP_MD, (st), (val)) +#define sk_EVP_MD_find(st, val) SKM_sk_find(EVP_MD, (st), (val)) +#define sk_EVP_MD_find_ex(st, val) SKM_sk_find_ex(EVP_MD, (st), (val)) +#define sk_EVP_MD_delete(st, i) SKM_sk_delete(EVP_MD, (st), (i)) +#define sk_EVP_MD_delete_ptr(st, ptr) SKM_sk_delete_ptr(EVP_MD, (st), (ptr)) +#define sk_EVP_MD_insert(st, val, i) SKM_sk_insert(EVP_MD, (st), (val), (i)) +#define sk_EVP_MD_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(EVP_MD, (st), (cmp)) +#define sk_EVP_MD_dup(st) SKM_sk_dup(EVP_MD, st) +#define sk_EVP_MD_pop_free(st, free_func) SKM_sk_pop_free(EVP_MD, (st), (free_func)) +#define sk_EVP_MD_shift(st) SKM_sk_shift(EVP_MD, (st)) +#define sk_EVP_MD_pop(st) SKM_sk_pop(EVP_MD, (st)) +#define sk_EVP_MD_sort(st) SKM_sk_sort(EVP_MD, (st)) +#define sk_EVP_MD_is_sorted(st) SKM_sk_is_sorted(EVP_MD, (st)) + +#define sk_EVP_PBE_CTL_new(cmp) SKM_sk_new(EVP_PBE_CTL, (cmp)) +#define sk_EVP_PBE_CTL_new_null() SKM_sk_new_null(EVP_PBE_CTL) +#define sk_EVP_PBE_CTL_free(st) SKM_sk_free(EVP_PBE_CTL, (st)) +#define sk_EVP_PBE_CTL_num(st) SKM_sk_num(EVP_PBE_CTL, (st)) +#define sk_EVP_PBE_CTL_value(st, i) SKM_sk_value(EVP_PBE_CTL, (st), (i)) +#define sk_EVP_PBE_CTL_set(st, i, val) SKM_sk_set(EVP_PBE_CTL, (st), (i), (val)) +#define sk_EVP_PBE_CTL_zero(st) SKM_sk_zero(EVP_PBE_CTL, (st)) +#define sk_EVP_PBE_CTL_push(st, val) SKM_sk_push(EVP_PBE_CTL, (st), (val)) +#define sk_EVP_PBE_CTL_unshift(st, val) SKM_sk_unshift(EVP_PBE_CTL, (st), (val)) +#define sk_EVP_PBE_CTL_find(st, val) SKM_sk_find(EVP_PBE_CTL, (st), (val)) +#define sk_EVP_PBE_CTL_find_ex(st, val) SKM_sk_find_ex(EVP_PBE_CTL, (st), (val)) +#define sk_EVP_PBE_CTL_delete(st, i) SKM_sk_delete(EVP_PBE_CTL, (st), (i)) +#define sk_EVP_PBE_CTL_delete_ptr(st, ptr) SKM_sk_delete_ptr(EVP_PBE_CTL, (st), (ptr)) +#define sk_EVP_PBE_CTL_insert(st, val, i) SKM_sk_insert(EVP_PBE_CTL, (st), (val), (i)) +#define sk_EVP_PBE_CTL_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(EVP_PBE_CTL, (st), (cmp)) +#define sk_EVP_PBE_CTL_dup(st) SKM_sk_dup(EVP_PBE_CTL, st) +#define sk_EVP_PBE_CTL_pop_free(st, free_func) SKM_sk_pop_free(EVP_PBE_CTL, (st), (free_func)) +#define sk_EVP_PBE_CTL_shift(st) SKM_sk_shift(EVP_PBE_CTL, (st)) +#define sk_EVP_PBE_CTL_pop(st) SKM_sk_pop(EVP_PBE_CTL, (st)) +#define sk_EVP_PBE_CTL_sort(st) SKM_sk_sort(EVP_PBE_CTL, (st)) +#define sk_EVP_PBE_CTL_is_sorted(st) SKM_sk_is_sorted(EVP_PBE_CTL, (st)) + +#define sk_EVP_PKEY_ASN1_METHOD_new(cmp) SKM_sk_new(EVP_PKEY_ASN1_METHOD, (cmp)) +#define sk_EVP_PKEY_ASN1_METHOD_new_null() SKM_sk_new_null(EVP_PKEY_ASN1_METHOD) +#define sk_EVP_PKEY_ASN1_METHOD_free(st) SKM_sk_free(EVP_PKEY_ASN1_METHOD, (st)) +#define sk_EVP_PKEY_ASN1_METHOD_num(st) SKM_sk_num(EVP_PKEY_ASN1_METHOD, (st)) +#define sk_EVP_PKEY_ASN1_METHOD_value(st, i) SKM_sk_value(EVP_PKEY_ASN1_METHOD, (st), (i)) +#define sk_EVP_PKEY_ASN1_METHOD_set(st, i, val) SKM_sk_set(EVP_PKEY_ASN1_METHOD, (st), (i), (val)) +#define sk_EVP_PKEY_ASN1_METHOD_zero(st) SKM_sk_zero(EVP_PKEY_ASN1_METHOD, (st)) +#define sk_EVP_PKEY_ASN1_METHOD_push(st, val) SKM_sk_push(EVP_PKEY_ASN1_METHOD, (st), (val)) +#define sk_EVP_PKEY_ASN1_METHOD_unshift(st, val) SKM_sk_unshift(EVP_PKEY_ASN1_METHOD, (st), (val)) +#define sk_EVP_PKEY_ASN1_METHOD_find(st, val) SKM_sk_find(EVP_PKEY_ASN1_METHOD, (st), (val)) +#define sk_EVP_PKEY_ASN1_METHOD_find_ex(st, val) SKM_sk_find_ex(EVP_PKEY_ASN1_METHOD, (st), (val)) +#define sk_EVP_PKEY_ASN1_METHOD_delete(st, i) SKM_sk_delete(EVP_PKEY_ASN1_METHOD, (st), (i)) +#define sk_EVP_PKEY_ASN1_METHOD_delete_ptr(st, ptr) SKM_sk_delete_ptr(EVP_PKEY_ASN1_METHOD, (st), (ptr)) +#define sk_EVP_PKEY_ASN1_METHOD_insert(st, val, i) SKM_sk_insert(EVP_PKEY_ASN1_METHOD, (st), (val), (i)) +#define sk_EVP_PKEY_ASN1_METHOD_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(EVP_PKEY_ASN1_METHOD, (st), (cmp)) +#define sk_EVP_PKEY_ASN1_METHOD_dup(st) SKM_sk_dup(EVP_PKEY_ASN1_METHOD, st) +#define sk_EVP_PKEY_ASN1_METHOD_pop_free(st, free_func) SKM_sk_pop_free(EVP_PKEY_ASN1_METHOD, (st), (free_func)) +#define sk_EVP_PKEY_ASN1_METHOD_shift(st) SKM_sk_shift(EVP_PKEY_ASN1_METHOD, (st)) +#define sk_EVP_PKEY_ASN1_METHOD_pop(st) SKM_sk_pop(EVP_PKEY_ASN1_METHOD, (st)) +#define sk_EVP_PKEY_ASN1_METHOD_sort(st) SKM_sk_sort(EVP_PKEY_ASN1_METHOD, (st)) +#define sk_EVP_PKEY_ASN1_METHOD_is_sorted(st) SKM_sk_is_sorted(EVP_PKEY_ASN1_METHOD, (st)) + +#define sk_EVP_PKEY_METHOD_new(cmp) SKM_sk_new(EVP_PKEY_METHOD, (cmp)) +#define sk_EVP_PKEY_METHOD_new_null() SKM_sk_new_null(EVP_PKEY_METHOD) +#define sk_EVP_PKEY_METHOD_free(st) SKM_sk_free(EVP_PKEY_METHOD, (st)) +#define sk_EVP_PKEY_METHOD_num(st) SKM_sk_num(EVP_PKEY_METHOD, (st)) +#define sk_EVP_PKEY_METHOD_value(st, i) SKM_sk_value(EVP_PKEY_METHOD, (st), (i)) +#define sk_EVP_PKEY_METHOD_set(st, i, val) SKM_sk_set(EVP_PKEY_METHOD, (st), (i), (val)) +#define sk_EVP_PKEY_METHOD_zero(st) SKM_sk_zero(EVP_PKEY_METHOD, (st)) +#define sk_EVP_PKEY_METHOD_push(st, val) SKM_sk_push(EVP_PKEY_METHOD, (st), (val)) +#define sk_EVP_PKEY_METHOD_unshift(st, val) SKM_sk_unshift(EVP_PKEY_METHOD, (st), (val)) +#define sk_EVP_PKEY_METHOD_find(st, val) SKM_sk_find(EVP_PKEY_METHOD, (st), (val)) +#define sk_EVP_PKEY_METHOD_find_ex(st, val) SKM_sk_find_ex(EVP_PKEY_METHOD, (st), (val)) +#define sk_EVP_PKEY_METHOD_delete(st, i) SKM_sk_delete(EVP_PKEY_METHOD, (st), (i)) +#define sk_EVP_PKEY_METHOD_delete_ptr(st, ptr) SKM_sk_delete_ptr(EVP_PKEY_METHOD, (st), (ptr)) +#define sk_EVP_PKEY_METHOD_insert(st, val, i) SKM_sk_insert(EVP_PKEY_METHOD, (st), (val), (i)) +#define sk_EVP_PKEY_METHOD_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(EVP_PKEY_METHOD, (st), (cmp)) +#define sk_EVP_PKEY_METHOD_dup(st) SKM_sk_dup(EVP_PKEY_METHOD, st) +#define sk_EVP_PKEY_METHOD_pop_free(st, free_func) SKM_sk_pop_free(EVP_PKEY_METHOD, (st), (free_func)) +#define sk_EVP_PKEY_METHOD_shift(st) SKM_sk_shift(EVP_PKEY_METHOD, (st)) +#define sk_EVP_PKEY_METHOD_pop(st) SKM_sk_pop(EVP_PKEY_METHOD, (st)) +#define sk_EVP_PKEY_METHOD_sort(st) SKM_sk_sort(EVP_PKEY_METHOD, (st)) +#define sk_EVP_PKEY_METHOD_is_sorted(st) SKM_sk_is_sorted(EVP_PKEY_METHOD, (st)) + +#define sk_GENERAL_NAME_new(cmp) SKM_sk_new(GENERAL_NAME, (cmp)) +#define sk_GENERAL_NAME_new_null() SKM_sk_new_null(GENERAL_NAME) +#define sk_GENERAL_NAME_free(st) SKM_sk_free(GENERAL_NAME, (st)) +#define sk_GENERAL_NAME_num(st) SKM_sk_num(GENERAL_NAME, (st)) +#define sk_GENERAL_NAME_value(st, i) SKM_sk_value(GENERAL_NAME, (st), (i)) +#define sk_GENERAL_NAME_set(st, i, val) SKM_sk_set(GENERAL_NAME, (st), (i), (val)) +#define sk_GENERAL_NAME_zero(st) SKM_sk_zero(GENERAL_NAME, (st)) +#define sk_GENERAL_NAME_push(st, val) SKM_sk_push(GENERAL_NAME, (st), (val)) +#define sk_GENERAL_NAME_unshift(st, val) SKM_sk_unshift(GENERAL_NAME, (st), (val)) +#define sk_GENERAL_NAME_find(st, val) SKM_sk_find(GENERAL_NAME, (st), (val)) +#define sk_GENERAL_NAME_find_ex(st, val) SKM_sk_find_ex(GENERAL_NAME, (st), (val)) +#define sk_GENERAL_NAME_delete(st, i) SKM_sk_delete(GENERAL_NAME, (st), (i)) +#define sk_GENERAL_NAME_delete_ptr(st, ptr) SKM_sk_delete_ptr(GENERAL_NAME, (st), (ptr)) +#define sk_GENERAL_NAME_insert(st, val, i) SKM_sk_insert(GENERAL_NAME, (st), (val), (i)) +#define sk_GENERAL_NAME_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(GENERAL_NAME, (st), (cmp)) +#define sk_GENERAL_NAME_dup(st) SKM_sk_dup(GENERAL_NAME, st) +#define sk_GENERAL_NAME_pop_free(st, free_func) SKM_sk_pop_free(GENERAL_NAME, (st), (free_func)) +#define sk_GENERAL_NAME_shift(st) SKM_sk_shift(GENERAL_NAME, (st)) +#define sk_GENERAL_NAME_pop(st) SKM_sk_pop(GENERAL_NAME, (st)) +#define sk_GENERAL_NAME_sort(st) SKM_sk_sort(GENERAL_NAME, (st)) +#define sk_GENERAL_NAME_is_sorted(st) SKM_sk_is_sorted(GENERAL_NAME, (st)) + +#define sk_GENERAL_NAMES_new(cmp) SKM_sk_new(GENERAL_NAMES, (cmp)) +#define sk_GENERAL_NAMES_new_null() SKM_sk_new_null(GENERAL_NAMES) +#define sk_GENERAL_NAMES_free(st) SKM_sk_free(GENERAL_NAMES, (st)) +#define sk_GENERAL_NAMES_num(st) SKM_sk_num(GENERAL_NAMES, (st)) +#define sk_GENERAL_NAMES_value(st, i) SKM_sk_value(GENERAL_NAMES, (st), (i)) +#define sk_GENERAL_NAMES_set(st, i, val) SKM_sk_set(GENERAL_NAMES, (st), (i), (val)) +#define sk_GENERAL_NAMES_zero(st) SKM_sk_zero(GENERAL_NAMES, (st)) +#define sk_GENERAL_NAMES_push(st, val) SKM_sk_push(GENERAL_NAMES, (st), (val)) +#define sk_GENERAL_NAMES_unshift(st, val) SKM_sk_unshift(GENERAL_NAMES, (st), (val)) +#define sk_GENERAL_NAMES_find(st, val) SKM_sk_find(GENERAL_NAMES, (st), (val)) +#define sk_GENERAL_NAMES_find_ex(st, val) SKM_sk_find_ex(GENERAL_NAMES, (st), (val)) +#define sk_GENERAL_NAMES_delete(st, i) SKM_sk_delete(GENERAL_NAMES, (st), (i)) +#define sk_GENERAL_NAMES_delete_ptr(st, ptr) SKM_sk_delete_ptr(GENERAL_NAMES, (st), (ptr)) +#define sk_GENERAL_NAMES_insert(st, val, i) SKM_sk_insert(GENERAL_NAMES, (st), (val), (i)) +#define sk_GENERAL_NAMES_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(GENERAL_NAMES, (st), (cmp)) +#define sk_GENERAL_NAMES_dup(st) SKM_sk_dup(GENERAL_NAMES, st) +#define sk_GENERAL_NAMES_pop_free(st, free_func) SKM_sk_pop_free(GENERAL_NAMES, (st), (free_func)) +#define sk_GENERAL_NAMES_shift(st) SKM_sk_shift(GENERAL_NAMES, (st)) +#define sk_GENERAL_NAMES_pop(st) SKM_sk_pop(GENERAL_NAMES, (st)) +#define sk_GENERAL_NAMES_sort(st) SKM_sk_sort(GENERAL_NAMES, (st)) +#define sk_GENERAL_NAMES_is_sorted(st) SKM_sk_is_sorted(GENERAL_NAMES, (st)) + +#define sk_GENERAL_SUBTREE_new(cmp) SKM_sk_new(GENERAL_SUBTREE, (cmp)) +#define sk_GENERAL_SUBTREE_new_null() SKM_sk_new_null(GENERAL_SUBTREE) +#define sk_GENERAL_SUBTREE_free(st) SKM_sk_free(GENERAL_SUBTREE, (st)) +#define sk_GENERAL_SUBTREE_num(st) SKM_sk_num(GENERAL_SUBTREE, (st)) +#define sk_GENERAL_SUBTREE_value(st, i) SKM_sk_value(GENERAL_SUBTREE, (st), (i)) +#define sk_GENERAL_SUBTREE_set(st, i, val) SKM_sk_set(GENERAL_SUBTREE, (st), (i), (val)) +#define sk_GENERAL_SUBTREE_zero(st) SKM_sk_zero(GENERAL_SUBTREE, (st)) +#define sk_GENERAL_SUBTREE_push(st, val) SKM_sk_push(GENERAL_SUBTREE, (st), (val)) +#define sk_GENERAL_SUBTREE_unshift(st, val) SKM_sk_unshift(GENERAL_SUBTREE, (st), (val)) +#define sk_GENERAL_SUBTREE_find(st, val) SKM_sk_find(GENERAL_SUBTREE, (st), (val)) +#define sk_GENERAL_SUBTREE_find_ex(st, val) SKM_sk_find_ex(GENERAL_SUBTREE, (st), (val)) +#define sk_GENERAL_SUBTREE_delete(st, i) SKM_sk_delete(GENERAL_SUBTREE, (st), (i)) +#define sk_GENERAL_SUBTREE_delete_ptr(st, ptr) SKM_sk_delete_ptr(GENERAL_SUBTREE, (st), (ptr)) +#define sk_GENERAL_SUBTREE_insert(st, val, i) SKM_sk_insert(GENERAL_SUBTREE, (st), (val), (i)) +#define sk_GENERAL_SUBTREE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(GENERAL_SUBTREE, (st), (cmp)) +#define sk_GENERAL_SUBTREE_dup(st) SKM_sk_dup(GENERAL_SUBTREE, st) +#define sk_GENERAL_SUBTREE_pop_free(st, free_func) SKM_sk_pop_free(GENERAL_SUBTREE, (st), (free_func)) +#define sk_GENERAL_SUBTREE_shift(st) SKM_sk_shift(GENERAL_SUBTREE, (st)) +#define sk_GENERAL_SUBTREE_pop(st) SKM_sk_pop(GENERAL_SUBTREE, (st)) +#define sk_GENERAL_SUBTREE_sort(st) SKM_sk_sort(GENERAL_SUBTREE, (st)) +#define sk_GENERAL_SUBTREE_is_sorted(st) SKM_sk_is_sorted(GENERAL_SUBTREE, (st)) + +#define sk_IPAddressFamily_new(cmp) SKM_sk_new(IPAddressFamily, (cmp)) +#define sk_IPAddressFamily_new_null() SKM_sk_new_null(IPAddressFamily) +#define sk_IPAddressFamily_free(st) SKM_sk_free(IPAddressFamily, (st)) +#define sk_IPAddressFamily_num(st) SKM_sk_num(IPAddressFamily, (st)) +#define sk_IPAddressFamily_value(st, i) SKM_sk_value(IPAddressFamily, (st), (i)) +#define sk_IPAddressFamily_set(st, i, val) SKM_sk_set(IPAddressFamily, (st), (i), (val)) +#define sk_IPAddressFamily_zero(st) SKM_sk_zero(IPAddressFamily, (st)) +#define sk_IPAddressFamily_push(st, val) SKM_sk_push(IPAddressFamily, (st), (val)) +#define sk_IPAddressFamily_unshift(st, val) SKM_sk_unshift(IPAddressFamily, (st), (val)) +#define sk_IPAddressFamily_find(st, val) SKM_sk_find(IPAddressFamily, (st), (val)) +#define sk_IPAddressFamily_find_ex(st, val) SKM_sk_find_ex(IPAddressFamily, (st), (val)) +#define sk_IPAddressFamily_delete(st, i) SKM_sk_delete(IPAddressFamily, (st), (i)) +#define sk_IPAddressFamily_delete_ptr(st, ptr) SKM_sk_delete_ptr(IPAddressFamily, (st), (ptr)) +#define sk_IPAddressFamily_insert(st, val, i) SKM_sk_insert(IPAddressFamily, (st), (val), (i)) +#define sk_IPAddressFamily_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(IPAddressFamily, (st), (cmp)) +#define sk_IPAddressFamily_dup(st) SKM_sk_dup(IPAddressFamily, st) +#define sk_IPAddressFamily_pop_free(st, free_func) SKM_sk_pop_free(IPAddressFamily, (st), (free_func)) +#define sk_IPAddressFamily_shift(st) SKM_sk_shift(IPAddressFamily, (st)) +#define sk_IPAddressFamily_pop(st) SKM_sk_pop(IPAddressFamily, (st)) +#define sk_IPAddressFamily_sort(st) SKM_sk_sort(IPAddressFamily, (st)) +#define sk_IPAddressFamily_is_sorted(st) SKM_sk_is_sorted(IPAddressFamily, (st)) + +#define sk_IPAddressOrRange_new(cmp) SKM_sk_new(IPAddressOrRange, (cmp)) +#define sk_IPAddressOrRange_new_null() SKM_sk_new_null(IPAddressOrRange) +#define sk_IPAddressOrRange_free(st) SKM_sk_free(IPAddressOrRange, (st)) +#define sk_IPAddressOrRange_num(st) SKM_sk_num(IPAddressOrRange, (st)) +#define sk_IPAddressOrRange_value(st, i) SKM_sk_value(IPAddressOrRange, (st), (i)) +#define sk_IPAddressOrRange_set(st, i, val) SKM_sk_set(IPAddressOrRange, (st), (i), (val)) +#define sk_IPAddressOrRange_zero(st) SKM_sk_zero(IPAddressOrRange, (st)) +#define sk_IPAddressOrRange_push(st, val) SKM_sk_push(IPAddressOrRange, (st), (val)) +#define sk_IPAddressOrRange_unshift(st, val) SKM_sk_unshift(IPAddressOrRange, (st), (val)) +#define sk_IPAddressOrRange_find(st, val) SKM_sk_find(IPAddressOrRange, (st), (val)) +#define sk_IPAddressOrRange_find_ex(st, val) SKM_sk_find_ex(IPAddressOrRange, (st), (val)) +#define sk_IPAddressOrRange_delete(st, i) SKM_sk_delete(IPAddressOrRange, (st), (i)) +#define sk_IPAddressOrRange_delete_ptr(st, ptr) SKM_sk_delete_ptr(IPAddressOrRange, (st), (ptr)) +#define sk_IPAddressOrRange_insert(st, val, i) SKM_sk_insert(IPAddressOrRange, (st), (val), (i)) +#define sk_IPAddressOrRange_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(IPAddressOrRange, (st), (cmp)) +#define sk_IPAddressOrRange_dup(st) SKM_sk_dup(IPAddressOrRange, st) +#define sk_IPAddressOrRange_pop_free(st, free_func) SKM_sk_pop_free(IPAddressOrRange, (st), (free_func)) +#define sk_IPAddressOrRange_shift(st) SKM_sk_shift(IPAddressOrRange, (st)) +#define sk_IPAddressOrRange_pop(st) SKM_sk_pop(IPAddressOrRange, (st)) +#define sk_IPAddressOrRange_sort(st) SKM_sk_sort(IPAddressOrRange, (st)) +#define sk_IPAddressOrRange_is_sorted(st) SKM_sk_is_sorted(IPAddressOrRange, (st)) + +#define sk_KRB5_APREQBODY_new(cmp) SKM_sk_new(KRB5_APREQBODY, (cmp)) +#define sk_KRB5_APREQBODY_new_null() SKM_sk_new_null(KRB5_APREQBODY) +#define sk_KRB5_APREQBODY_free(st) SKM_sk_free(KRB5_APREQBODY, (st)) +#define sk_KRB5_APREQBODY_num(st) SKM_sk_num(KRB5_APREQBODY, (st)) +#define sk_KRB5_APREQBODY_value(st, i) SKM_sk_value(KRB5_APREQBODY, (st), (i)) +#define sk_KRB5_APREQBODY_set(st, i, val) SKM_sk_set(KRB5_APREQBODY, (st), (i), (val)) +#define sk_KRB5_APREQBODY_zero(st) SKM_sk_zero(KRB5_APREQBODY, (st)) +#define sk_KRB5_APREQBODY_push(st, val) SKM_sk_push(KRB5_APREQBODY, (st), (val)) +#define sk_KRB5_APREQBODY_unshift(st, val) SKM_sk_unshift(KRB5_APREQBODY, (st), (val)) +#define sk_KRB5_APREQBODY_find(st, val) SKM_sk_find(KRB5_APREQBODY, (st), (val)) +#define sk_KRB5_APREQBODY_find_ex(st, val) SKM_sk_find_ex(KRB5_APREQBODY, (st), (val)) +#define sk_KRB5_APREQBODY_delete(st, i) SKM_sk_delete(KRB5_APREQBODY, (st), (i)) +#define sk_KRB5_APREQBODY_delete_ptr(st, ptr) SKM_sk_delete_ptr(KRB5_APREQBODY, (st), (ptr)) +#define sk_KRB5_APREQBODY_insert(st, val, i) SKM_sk_insert(KRB5_APREQBODY, (st), (val), (i)) +#define sk_KRB5_APREQBODY_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(KRB5_APREQBODY, (st), (cmp)) +#define sk_KRB5_APREQBODY_dup(st) SKM_sk_dup(KRB5_APREQBODY, st) +#define sk_KRB5_APREQBODY_pop_free(st, free_func) SKM_sk_pop_free(KRB5_APREQBODY, (st), (free_func)) +#define sk_KRB5_APREQBODY_shift(st) SKM_sk_shift(KRB5_APREQBODY, (st)) +#define sk_KRB5_APREQBODY_pop(st) SKM_sk_pop(KRB5_APREQBODY, (st)) +#define sk_KRB5_APREQBODY_sort(st) SKM_sk_sort(KRB5_APREQBODY, (st)) +#define sk_KRB5_APREQBODY_is_sorted(st) SKM_sk_is_sorted(KRB5_APREQBODY, (st)) + +#define sk_KRB5_AUTHDATA_new(cmp) SKM_sk_new(KRB5_AUTHDATA, (cmp)) +#define sk_KRB5_AUTHDATA_new_null() SKM_sk_new_null(KRB5_AUTHDATA) +#define sk_KRB5_AUTHDATA_free(st) SKM_sk_free(KRB5_AUTHDATA, (st)) +#define sk_KRB5_AUTHDATA_num(st) SKM_sk_num(KRB5_AUTHDATA, (st)) +#define sk_KRB5_AUTHDATA_value(st, i) SKM_sk_value(KRB5_AUTHDATA, (st), (i)) +#define sk_KRB5_AUTHDATA_set(st, i, val) SKM_sk_set(KRB5_AUTHDATA, (st), (i), (val)) +#define sk_KRB5_AUTHDATA_zero(st) SKM_sk_zero(KRB5_AUTHDATA, (st)) +#define sk_KRB5_AUTHDATA_push(st, val) SKM_sk_push(KRB5_AUTHDATA, (st), (val)) +#define sk_KRB5_AUTHDATA_unshift(st, val) SKM_sk_unshift(KRB5_AUTHDATA, (st), (val)) +#define sk_KRB5_AUTHDATA_find(st, val) SKM_sk_find(KRB5_AUTHDATA, (st), (val)) +#define sk_KRB5_AUTHDATA_find_ex(st, val) SKM_sk_find_ex(KRB5_AUTHDATA, (st), (val)) +#define sk_KRB5_AUTHDATA_delete(st, i) SKM_sk_delete(KRB5_AUTHDATA, (st), (i)) +#define sk_KRB5_AUTHDATA_delete_ptr(st, ptr) SKM_sk_delete_ptr(KRB5_AUTHDATA, (st), (ptr)) +#define sk_KRB5_AUTHDATA_insert(st, val, i) SKM_sk_insert(KRB5_AUTHDATA, (st), (val), (i)) +#define sk_KRB5_AUTHDATA_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(KRB5_AUTHDATA, (st), (cmp)) +#define sk_KRB5_AUTHDATA_dup(st) SKM_sk_dup(KRB5_AUTHDATA, st) +#define sk_KRB5_AUTHDATA_pop_free(st, free_func) SKM_sk_pop_free(KRB5_AUTHDATA, (st), (free_func)) +#define sk_KRB5_AUTHDATA_shift(st) SKM_sk_shift(KRB5_AUTHDATA, (st)) +#define sk_KRB5_AUTHDATA_pop(st) SKM_sk_pop(KRB5_AUTHDATA, (st)) +#define sk_KRB5_AUTHDATA_sort(st) SKM_sk_sort(KRB5_AUTHDATA, (st)) +#define sk_KRB5_AUTHDATA_is_sorted(st) SKM_sk_is_sorted(KRB5_AUTHDATA, (st)) + +#define sk_KRB5_AUTHENTBODY_new(cmp) SKM_sk_new(KRB5_AUTHENTBODY, (cmp)) +#define sk_KRB5_AUTHENTBODY_new_null() SKM_sk_new_null(KRB5_AUTHENTBODY) +#define sk_KRB5_AUTHENTBODY_free(st) SKM_sk_free(KRB5_AUTHENTBODY, (st)) +#define sk_KRB5_AUTHENTBODY_num(st) SKM_sk_num(KRB5_AUTHENTBODY, (st)) +#define sk_KRB5_AUTHENTBODY_value(st, i) SKM_sk_value(KRB5_AUTHENTBODY, (st), (i)) +#define sk_KRB5_AUTHENTBODY_set(st, i, val) SKM_sk_set(KRB5_AUTHENTBODY, (st), (i), (val)) +#define sk_KRB5_AUTHENTBODY_zero(st) SKM_sk_zero(KRB5_AUTHENTBODY, (st)) +#define sk_KRB5_AUTHENTBODY_push(st, val) SKM_sk_push(KRB5_AUTHENTBODY, (st), (val)) +#define sk_KRB5_AUTHENTBODY_unshift(st, val) SKM_sk_unshift(KRB5_AUTHENTBODY, (st), (val)) +#define sk_KRB5_AUTHENTBODY_find(st, val) SKM_sk_find(KRB5_AUTHENTBODY, (st), (val)) +#define sk_KRB5_AUTHENTBODY_find_ex(st, val) SKM_sk_find_ex(KRB5_AUTHENTBODY, (st), (val)) +#define sk_KRB5_AUTHENTBODY_delete(st, i) SKM_sk_delete(KRB5_AUTHENTBODY, (st), (i)) +#define sk_KRB5_AUTHENTBODY_delete_ptr(st, ptr) SKM_sk_delete_ptr(KRB5_AUTHENTBODY, (st), (ptr)) +#define sk_KRB5_AUTHENTBODY_insert(st, val, i) SKM_sk_insert(KRB5_AUTHENTBODY, (st), (val), (i)) +#define sk_KRB5_AUTHENTBODY_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(KRB5_AUTHENTBODY, (st), (cmp)) +#define sk_KRB5_AUTHENTBODY_dup(st) SKM_sk_dup(KRB5_AUTHENTBODY, st) +#define sk_KRB5_AUTHENTBODY_pop_free(st, free_func) SKM_sk_pop_free(KRB5_AUTHENTBODY, (st), (free_func)) +#define sk_KRB5_AUTHENTBODY_shift(st) SKM_sk_shift(KRB5_AUTHENTBODY, (st)) +#define sk_KRB5_AUTHENTBODY_pop(st) SKM_sk_pop(KRB5_AUTHENTBODY, (st)) +#define sk_KRB5_AUTHENTBODY_sort(st) SKM_sk_sort(KRB5_AUTHENTBODY, (st)) +#define sk_KRB5_AUTHENTBODY_is_sorted(st) SKM_sk_is_sorted(KRB5_AUTHENTBODY, (st)) + +#define sk_KRB5_CHECKSUM_new(cmp) SKM_sk_new(KRB5_CHECKSUM, (cmp)) +#define sk_KRB5_CHECKSUM_new_null() SKM_sk_new_null(KRB5_CHECKSUM) +#define sk_KRB5_CHECKSUM_free(st) SKM_sk_free(KRB5_CHECKSUM, (st)) +#define sk_KRB5_CHECKSUM_num(st) SKM_sk_num(KRB5_CHECKSUM, (st)) +#define sk_KRB5_CHECKSUM_value(st, i) SKM_sk_value(KRB5_CHECKSUM, (st), (i)) +#define sk_KRB5_CHECKSUM_set(st, i, val) SKM_sk_set(KRB5_CHECKSUM, (st), (i), (val)) +#define sk_KRB5_CHECKSUM_zero(st) SKM_sk_zero(KRB5_CHECKSUM, (st)) +#define sk_KRB5_CHECKSUM_push(st, val) SKM_sk_push(KRB5_CHECKSUM, (st), (val)) +#define sk_KRB5_CHECKSUM_unshift(st, val) SKM_sk_unshift(KRB5_CHECKSUM, (st), (val)) +#define sk_KRB5_CHECKSUM_find(st, val) SKM_sk_find(KRB5_CHECKSUM, (st), (val)) +#define sk_KRB5_CHECKSUM_find_ex(st, val) SKM_sk_find_ex(KRB5_CHECKSUM, (st), (val)) +#define sk_KRB5_CHECKSUM_delete(st, i) SKM_sk_delete(KRB5_CHECKSUM, (st), (i)) +#define sk_KRB5_CHECKSUM_delete_ptr(st, ptr) SKM_sk_delete_ptr(KRB5_CHECKSUM, (st), (ptr)) +#define sk_KRB5_CHECKSUM_insert(st, val, i) SKM_sk_insert(KRB5_CHECKSUM, (st), (val), (i)) +#define sk_KRB5_CHECKSUM_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(KRB5_CHECKSUM, (st), (cmp)) +#define sk_KRB5_CHECKSUM_dup(st) SKM_sk_dup(KRB5_CHECKSUM, st) +#define sk_KRB5_CHECKSUM_pop_free(st, free_func) SKM_sk_pop_free(KRB5_CHECKSUM, (st), (free_func)) +#define sk_KRB5_CHECKSUM_shift(st) SKM_sk_shift(KRB5_CHECKSUM, (st)) +#define sk_KRB5_CHECKSUM_pop(st) SKM_sk_pop(KRB5_CHECKSUM, (st)) +#define sk_KRB5_CHECKSUM_sort(st) SKM_sk_sort(KRB5_CHECKSUM, (st)) +#define sk_KRB5_CHECKSUM_is_sorted(st) SKM_sk_is_sorted(KRB5_CHECKSUM, (st)) + +#define sk_KRB5_ENCDATA_new(cmp) SKM_sk_new(KRB5_ENCDATA, (cmp)) +#define sk_KRB5_ENCDATA_new_null() SKM_sk_new_null(KRB5_ENCDATA) +#define sk_KRB5_ENCDATA_free(st) SKM_sk_free(KRB5_ENCDATA, (st)) +#define sk_KRB5_ENCDATA_num(st) SKM_sk_num(KRB5_ENCDATA, (st)) +#define sk_KRB5_ENCDATA_value(st, i) SKM_sk_value(KRB5_ENCDATA, (st), (i)) +#define sk_KRB5_ENCDATA_set(st, i, val) SKM_sk_set(KRB5_ENCDATA, (st), (i), (val)) +#define sk_KRB5_ENCDATA_zero(st) SKM_sk_zero(KRB5_ENCDATA, (st)) +#define sk_KRB5_ENCDATA_push(st, val) SKM_sk_push(KRB5_ENCDATA, (st), (val)) +#define sk_KRB5_ENCDATA_unshift(st, val) SKM_sk_unshift(KRB5_ENCDATA, (st), (val)) +#define sk_KRB5_ENCDATA_find(st, val) SKM_sk_find(KRB5_ENCDATA, (st), (val)) +#define sk_KRB5_ENCDATA_find_ex(st, val) SKM_sk_find_ex(KRB5_ENCDATA, (st), (val)) +#define sk_KRB5_ENCDATA_delete(st, i) SKM_sk_delete(KRB5_ENCDATA, (st), (i)) +#define sk_KRB5_ENCDATA_delete_ptr(st, ptr) SKM_sk_delete_ptr(KRB5_ENCDATA, (st), (ptr)) +#define sk_KRB5_ENCDATA_insert(st, val, i) SKM_sk_insert(KRB5_ENCDATA, (st), (val), (i)) +#define sk_KRB5_ENCDATA_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(KRB5_ENCDATA, (st), (cmp)) +#define sk_KRB5_ENCDATA_dup(st) SKM_sk_dup(KRB5_ENCDATA, st) +#define sk_KRB5_ENCDATA_pop_free(st, free_func) SKM_sk_pop_free(KRB5_ENCDATA, (st), (free_func)) +#define sk_KRB5_ENCDATA_shift(st) SKM_sk_shift(KRB5_ENCDATA, (st)) +#define sk_KRB5_ENCDATA_pop(st) SKM_sk_pop(KRB5_ENCDATA, (st)) +#define sk_KRB5_ENCDATA_sort(st) SKM_sk_sort(KRB5_ENCDATA, (st)) +#define sk_KRB5_ENCDATA_is_sorted(st) SKM_sk_is_sorted(KRB5_ENCDATA, (st)) + +#define sk_KRB5_ENCKEY_new(cmp) SKM_sk_new(KRB5_ENCKEY, (cmp)) +#define sk_KRB5_ENCKEY_new_null() SKM_sk_new_null(KRB5_ENCKEY) +#define sk_KRB5_ENCKEY_free(st) SKM_sk_free(KRB5_ENCKEY, (st)) +#define sk_KRB5_ENCKEY_num(st) SKM_sk_num(KRB5_ENCKEY, (st)) +#define sk_KRB5_ENCKEY_value(st, i) SKM_sk_value(KRB5_ENCKEY, (st), (i)) +#define sk_KRB5_ENCKEY_set(st, i, val) SKM_sk_set(KRB5_ENCKEY, (st), (i), (val)) +#define sk_KRB5_ENCKEY_zero(st) SKM_sk_zero(KRB5_ENCKEY, (st)) +#define sk_KRB5_ENCKEY_push(st, val) SKM_sk_push(KRB5_ENCKEY, (st), (val)) +#define sk_KRB5_ENCKEY_unshift(st, val) SKM_sk_unshift(KRB5_ENCKEY, (st), (val)) +#define sk_KRB5_ENCKEY_find(st, val) SKM_sk_find(KRB5_ENCKEY, (st), (val)) +#define sk_KRB5_ENCKEY_find_ex(st, val) SKM_sk_find_ex(KRB5_ENCKEY, (st), (val)) +#define sk_KRB5_ENCKEY_delete(st, i) SKM_sk_delete(KRB5_ENCKEY, (st), (i)) +#define sk_KRB5_ENCKEY_delete_ptr(st, ptr) SKM_sk_delete_ptr(KRB5_ENCKEY, (st), (ptr)) +#define sk_KRB5_ENCKEY_insert(st, val, i) SKM_sk_insert(KRB5_ENCKEY, (st), (val), (i)) +#define sk_KRB5_ENCKEY_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(KRB5_ENCKEY, (st), (cmp)) +#define sk_KRB5_ENCKEY_dup(st) SKM_sk_dup(KRB5_ENCKEY, st) +#define sk_KRB5_ENCKEY_pop_free(st, free_func) SKM_sk_pop_free(KRB5_ENCKEY, (st), (free_func)) +#define sk_KRB5_ENCKEY_shift(st) SKM_sk_shift(KRB5_ENCKEY, (st)) +#define sk_KRB5_ENCKEY_pop(st) SKM_sk_pop(KRB5_ENCKEY, (st)) +#define sk_KRB5_ENCKEY_sort(st) SKM_sk_sort(KRB5_ENCKEY, (st)) +#define sk_KRB5_ENCKEY_is_sorted(st) SKM_sk_is_sorted(KRB5_ENCKEY, (st)) + +#define sk_KRB5_PRINCNAME_new(cmp) SKM_sk_new(KRB5_PRINCNAME, (cmp)) +#define sk_KRB5_PRINCNAME_new_null() SKM_sk_new_null(KRB5_PRINCNAME) +#define sk_KRB5_PRINCNAME_free(st) SKM_sk_free(KRB5_PRINCNAME, (st)) +#define sk_KRB5_PRINCNAME_num(st) SKM_sk_num(KRB5_PRINCNAME, (st)) +#define sk_KRB5_PRINCNAME_value(st, i) SKM_sk_value(KRB5_PRINCNAME, (st), (i)) +#define sk_KRB5_PRINCNAME_set(st, i, val) SKM_sk_set(KRB5_PRINCNAME, (st), (i), (val)) +#define sk_KRB5_PRINCNAME_zero(st) SKM_sk_zero(KRB5_PRINCNAME, (st)) +#define sk_KRB5_PRINCNAME_push(st, val) SKM_sk_push(KRB5_PRINCNAME, (st), (val)) +#define sk_KRB5_PRINCNAME_unshift(st, val) SKM_sk_unshift(KRB5_PRINCNAME, (st), (val)) +#define sk_KRB5_PRINCNAME_find(st, val) SKM_sk_find(KRB5_PRINCNAME, (st), (val)) +#define sk_KRB5_PRINCNAME_find_ex(st, val) SKM_sk_find_ex(KRB5_PRINCNAME, (st), (val)) +#define sk_KRB5_PRINCNAME_delete(st, i) SKM_sk_delete(KRB5_PRINCNAME, (st), (i)) +#define sk_KRB5_PRINCNAME_delete_ptr(st, ptr) SKM_sk_delete_ptr(KRB5_PRINCNAME, (st), (ptr)) +#define sk_KRB5_PRINCNAME_insert(st, val, i) SKM_sk_insert(KRB5_PRINCNAME, (st), (val), (i)) +#define sk_KRB5_PRINCNAME_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(KRB5_PRINCNAME, (st), (cmp)) +#define sk_KRB5_PRINCNAME_dup(st) SKM_sk_dup(KRB5_PRINCNAME, st) +#define sk_KRB5_PRINCNAME_pop_free(st, free_func) SKM_sk_pop_free(KRB5_PRINCNAME, (st), (free_func)) +#define sk_KRB5_PRINCNAME_shift(st) SKM_sk_shift(KRB5_PRINCNAME, (st)) +#define sk_KRB5_PRINCNAME_pop(st) SKM_sk_pop(KRB5_PRINCNAME, (st)) +#define sk_KRB5_PRINCNAME_sort(st) SKM_sk_sort(KRB5_PRINCNAME, (st)) +#define sk_KRB5_PRINCNAME_is_sorted(st) SKM_sk_is_sorted(KRB5_PRINCNAME, (st)) + +#define sk_KRB5_TKTBODY_new(cmp) SKM_sk_new(KRB5_TKTBODY, (cmp)) +#define sk_KRB5_TKTBODY_new_null() SKM_sk_new_null(KRB5_TKTBODY) +#define sk_KRB5_TKTBODY_free(st) SKM_sk_free(KRB5_TKTBODY, (st)) +#define sk_KRB5_TKTBODY_num(st) SKM_sk_num(KRB5_TKTBODY, (st)) +#define sk_KRB5_TKTBODY_value(st, i) SKM_sk_value(KRB5_TKTBODY, (st), (i)) +#define sk_KRB5_TKTBODY_set(st, i, val) SKM_sk_set(KRB5_TKTBODY, (st), (i), (val)) +#define sk_KRB5_TKTBODY_zero(st) SKM_sk_zero(KRB5_TKTBODY, (st)) +#define sk_KRB5_TKTBODY_push(st, val) SKM_sk_push(KRB5_TKTBODY, (st), (val)) +#define sk_KRB5_TKTBODY_unshift(st, val) SKM_sk_unshift(KRB5_TKTBODY, (st), (val)) +#define sk_KRB5_TKTBODY_find(st, val) SKM_sk_find(KRB5_TKTBODY, (st), (val)) +#define sk_KRB5_TKTBODY_find_ex(st, val) SKM_sk_find_ex(KRB5_TKTBODY, (st), (val)) +#define sk_KRB5_TKTBODY_delete(st, i) SKM_sk_delete(KRB5_TKTBODY, (st), (i)) +#define sk_KRB5_TKTBODY_delete_ptr(st, ptr) SKM_sk_delete_ptr(KRB5_TKTBODY, (st), (ptr)) +#define sk_KRB5_TKTBODY_insert(st, val, i) SKM_sk_insert(KRB5_TKTBODY, (st), (val), (i)) +#define sk_KRB5_TKTBODY_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(KRB5_TKTBODY, (st), (cmp)) +#define sk_KRB5_TKTBODY_dup(st) SKM_sk_dup(KRB5_TKTBODY, st) +#define sk_KRB5_TKTBODY_pop_free(st, free_func) SKM_sk_pop_free(KRB5_TKTBODY, (st), (free_func)) +#define sk_KRB5_TKTBODY_shift(st) SKM_sk_shift(KRB5_TKTBODY, (st)) +#define sk_KRB5_TKTBODY_pop(st) SKM_sk_pop(KRB5_TKTBODY, (st)) +#define sk_KRB5_TKTBODY_sort(st) SKM_sk_sort(KRB5_TKTBODY, (st)) +#define sk_KRB5_TKTBODY_is_sorted(st) SKM_sk_is_sorted(KRB5_TKTBODY, (st)) + +#define sk_MEM_OBJECT_DATA_new(cmp) SKM_sk_new(MEM_OBJECT_DATA, (cmp)) +#define sk_MEM_OBJECT_DATA_new_null() SKM_sk_new_null(MEM_OBJECT_DATA) +#define sk_MEM_OBJECT_DATA_free(st) SKM_sk_free(MEM_OBJECT_DATA, (st)) +#define sk_MEM_OBJECT_DATA_num(st) SKM_sk_num(MEM_OBJECT_DATA, (st)) +#define sk_MEM_OBJECT_DATA_value(st, i) SKM_sk_value(MEM_OBJECT_DATA, (st), (i)) +#define sk_MEM_OBJECT_DATA_set(st, i, val) SKM_sk_set(MEM_OBJECT_DATA, (st), (i), (val)) +#define sk_MEM_OBJECT_DATA_zero(st) SKM_sk_zero(MEM_OBJECT_DATA, (st)) +#define sk_MEM_OBJECT_DATA_push(st, val) SKM_sk_push(MEM_OBJECT_DATA, (st), (val)) +#define sk_MEM_OBJECT_DATA_unshift(st, val) SKM_sk_unshift(MEM_OBJECT_DATA, (st), (val)) +#define sk_MEM_OBJECT_DATA_find(st, val) SKM_sk_find(MEM_OBJECT_DATA, (st), (val)) +#define sk_MEM_OBJECT_DATA_find_ex(st, val) SKM_sk_find_ex(MEM_OBJECT_DATA, (st), (val)) +#define sk_MEM_OBJECT_DATA_delete(st, i) SKM_sk_delete(MEM_OBJECT_DATA, (st), (i)) +#define sk_MEM_OBJECT_DATA_delete_ptr(st, ptr) SKM_sk_delete_ptr(MEM_OBJECT_DATA, (st), (ptr)) +#define sk_MEM_OBJECT_DATA_insert(st, val, i) SKM_sk_insert(MEM_OBJECT_DATA, (st), (val), (i)) +#define sk_MEM_OBJECT_DATA_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(MEM_OBJECT_DATA, (st), (cmp)) +#define sk_MEM_OBJECT_DATA_dup(st) SKM_sk_dup(MEM_OBJECT_DATA, st) +#define sk_MEM_OBJECT_DATA_pop_free(st, free_func) SKM_sk_pop_free(MEM_OBJECT_DATA, (st), (free_func)) +#define sk_MEM_OBJECT_DATA_shift(st) SKM_sk_shift(MEM_OBJECT_DATA, (st)) +#define sk_MEM_OBJECT_DATA_pop(st) SKM_sk_pop(MEM_OBJECT_DATA, (st)) +#define sk_MEM_OBJECT_DATA_sort(st) SKM_sk_sort(MEM_OBJECT_DATA, (st)) +#define sk_MEM_OBJECT_DATA_is_sorted(st) SKM_sk_is_sorted(MEM_OBJECT_DATA, (st)) + +#define sk_MIME_HEADER_new(cmp) SKM_sk_new(MIME_HEADER, (cmp)) +#define sk_MIME_HEADER_new_null() SKM_sk_new_null(MIME_HEADER) +#define sk_MIME_HEADER_free(st) SKM_sk_free(MIME_HEADER, (st)) +#define sk_MIME_HEADER_num(st) SKM_sk_num(MIME_HEADER, (st)) +#define sk_MIME_HEADER_value(st, i) SKM_sk_value(MIME_HEADER, (st), (i)) +#define sk_MIME_HEADER_set(st, i, val) SKM_sk_set(MIME_HEADER, (st), (i), (val)) +#define sk_MIME_HEADER_zero(st) SKM_sk_zero(MIME_HEADER, (st)) +#define sk_MIME_HEADER_push(st, val) SKM_sk_push(MIME_HEADER, (st), (val)) +#define sk_MIME_HEADER_unshift(st, val) SKM_sk_unshift(MIME_HEADER, (st), (val)) +#define sk_MIME_HEADER_find(st, val) SKM_sk_find(MIME_HEADER, (st), (val)) +#define sk_MIME_HEADER_find_ex(st, val) SKM_sk_find_ex(MIME_HEADER, (st), (val)) +#define sk_MIME_HEADER_delete(st, i) SKM_sk_delete(MIME_HEADER, (st), (i)) +#define sk_MIME_HEADER_delete_ptr(st, ptr) SKM_sk_delete_ptr(MIME_HEADER, (st), (ptr)) +#define sk_MIME_HEADER_insert(st, val, i) SKM_sk_insert(MIME_HEADER, (st), (val), (i)) +#define sk_MIME_HEADER_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(MIME_HEADER, (st), (cmp)) +#define sk_MIME_HEADER_dup(st) SKM_sk_dup(MIME_HEADER, st) +#define sk_MIME_HEADER_pop_free(st, free_func) SKM_sk_pop_free(MIME_HEADER, (st), (free_func)) +#define sk_MIME_HEADER_shift(st) SKM_sk_shift(MIME_HEADER, (st)) +#define sk_MIME_HEADER_pop(st) SKM_sk_pop(MIME_HEADER, (st)) +#define sk_MIME_HEADER_sort(st) SKM_sk_sort(MIME_HEADER, (st)) +#define sk_MIME_HEADER_is_sorted(st) SKM_sk_is_sorted(MIME_HEADER, (st)) + +#define sk_MIME_PARAM_new(cmp) SKM_sk_new(MIME_PARAM, (cmp)) +#define sk_MIME_PARAM_new_null() SKM_sk_new_null(MIME_PARAM) +#define sk_MIME_PARAM_free(st) SKM_sk_free(MIME_PARAM, (st)) +#define sk_MIME_PARAM_num(st) SKM_sk_num(MIME_PARAM, (st)) +#define sk_MIME_PARAM_value(st, i) SKM_sk_value(MIME_PARAM, (st), (i)) +#define sk_MIME_PARAM_set(st, i, val) SKM_sk_set(MIME_PARAM, (st), (i), (val)) +#define sk_MIME_PARAM_zero(st) SKM_sk_zero(MIME_PARAM, (st)) +#define sk_MIME_PARAM_push(st, val) SKM_sk_push(MIME_PARAM, (st), (val)) +#define sk_MIME_PARAM_unshift(st, val) SKM_sk_unshift(MIME_PARAM, (st), (val)) +#define sk_MIME_PARAM_find(st, val) SKM_sk_find(MIME_PARAM, (st), (val)) +#define sk_MIME_PARAM_find_ex(st, val) SKM_sk_find_ex(MIME_PARAM, (st), (val)) +#define sk_MIME_PARAM_delete(st, i) SKM_sk_delete(MIME_PARAM, (st), (i)) +#define sk_MIME_PARAM_delete_ptr(st, ptr) SKM_sk_delete_ptr(MIME_PARAM, (st), (ptr)) +#define sk_MIME_PARAM_insert(st, val, i) SKM_sk_insert(MIME_PARAM, (st), (val), (i)) +#define sk_MIME_PARAM_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(MIME_PARAM, (st), (cmp)) +#define sk_MIME_PARAM_dup(st) SKM_sk_dup(MIME_PARAM, st) +#define sk_MIME_PARAM_pop_free(st, free_func) SKM_sk_pop_free(MIME_PARAM, (st), (free_func)) +#define sk_MIME_PARAM_shift(st) SKM_sk_shift(MIME_PARAM, (st)) +#define sk_MIME_PARAM_pop(st) SKM_sk_pop(MIME_PARAM, (st)) +#define sk_MIME_PARAM_sort(st) SKM_sk_sort(MIME_PARAM, (st)) +#define sk_MIME_PARAM_is_sorted(st) SKM_sk_is_sorted(MIME_PARAM, (st)) + +#define sk_NAME_FUNCS_new(cmp) SKM_sk_new(NAME_FUNCS, (cmp)) +#define sk_NAME_FUNCS_new_null() SKM_sk_new_null(NAME_FUNCS) +#define sk_NAME_FUNCS_free(st) SKM_sk_free(NAME_FUNCS, (st)) +#define sk_NAME_FUNCS_num(st) SKM_sk_num(NAME_FUNCS, (st)) +#define sk_NAME_FUNCS_value(st, i) SKM_sk_value(NAME_FUNCS, (st), (i)) +#define sk_NAME_FUNCS_set(st, i, val) SKM_sk_set(NAME_FUNCS, (st), (i), (val)) +#define sk_NAME_FUNCS_zero(st) SKM_sk_zero(NAME_FUNCS, (st)) +#define sk_NAME_FUNCS_push(st, val) SKM_sk_push(NAME_FUNCS, (st), (val)) +#define sk_NAME_FUNCS_unshift(st, val) SKM_sk_unshift(NAME_FUNCS, (st), (val)) +#define sk_NAME_FUNCS_find(st, val) SKM_sk_find(NAME_FUNCS, (st), (val)) +#define sk_NAME_FUNCS_find_ex(st, val) SKM_sk_find_ex(NAME_FUNCS, (st), (val)) +#define sk_NAME_FUNCS_delete(st, i) SKM_sk_delete(NAME_FUNCS, (st), (i)) +#define sk_NAME_FUNCS_delete_ptr(st, ptr) SKM_sk_delete_ptr(NAME_FUNCS, (st), (ptr)) +#define sk_NAME_FUNCS_insert(st, val, i) SKM_sk_insert(NAME_FUNCS, (st), (val), (i)) +#define sk_NAME_FUNCS_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(NAME_FUNCS, (st), (cmp)) +#define sk_NAME_FUNCS_dup(st) SKM_sk_dup(NAME_FUNCS, st) +#define sk_NAME_FUNCS_pop_free(st, free_func) SKM_sk_pop_free(NAME_FUNCS, (st), (free_func)) +#define sk_NAME_FUNCS_shift(st) SKM_sk_shift(NAME_FUNCS, (st)) +#define sk_NAME_FUNCS_pop(st) SKM_sk_pop(NAME_FUNCS, (st)) +#define sk_NAME_FUNCS_sort(st) SKM_sk_sort(NAME_FUNCS, (st)) +#define sk_NAME_FUNCS_is_sorted(st) SKM_sk_is_sorted(NAME_FUNCS, (st)) + +#define sk_OCSP_CERTID_new(cmp) SKM_sk_new(OCSP_CERTID, (cmp)) +#define sk_OCSP_CERTID_new_null() SKM_sk_new_null(OCSP_CERTID) +#define sk_OCSP_CERTID_free(st) SKM_sk_free(OCSP_CERTID, (st)) +#define sk_OCSP_CERTID_num(st) SKM_sk_num(OCSP_CERTID, (st)) +#define sk_OCSP_CERTID_value(st, i) SKM_sk_value(OCSP_CERTID, (st), (i)) +#define sk_OCSP_CERTID_set(st, i, val) SKM_sk_set(OCSP_CERTID, (st), (i), (val)) +#define sk_OCSP_CERTID_zero(st) SKM_sk_zero(OCSP_CERTID, (st)) +#define sk_OCSP_CERTID_push(st, val) SKM_sk_push(OCSP_CERTID, (st), (val)) +#define sk_OCSP_CERTID_unshift(st, val) SKM_sk_unshift(OCSP_CERTID, (st), (val)) +#define sk_OCSP_CERTID_find(st, val) SKM_sk_find(OCSP_CERTID, (st), (val)) +#define sk_OCSP_CERTID_find_ex(st, val) SKM_sk_find_ex(OCSP_CERTID, (st), (val)) +#define sk_OCSP_CERTID_delete(st, i) SKM_sk_delete(OCSP_CERTID, (st), (i)) +#define sk_OCSP_CERTID_delete_ptr(st, ptr) SKM_sk_delete_ptr(OCSP_CERTID, (st), (ptr)) +#define sk_OCSP_CERTID_insert(st, val, i) SKM_sk_insert(OCSP_CERTID, (st), (val), (i)) +#define sk_OCSP_CERTID_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(OCSP_CERTID, (st), (cmp)) +#define sk_OCSP_CERTID_dup(st) SKM_sk_dup(OCSP_CERTID, st) +#define sk_OCSP_CERTID_pop_free(st, free_func) SKM_sk_pop_free(OCSP_CERTID, (st), (free_func)) +#define sk_OCSP_CERTID_shift(st) SKM_sk_shift(OCSP_CERTID, (st)) +#define sk_OCSP_CERTID_pop(st) SKM_sk_pop(OCSP_CERTID, (st)) +#define sk_OCSP_CERTID_sort(st) SKM_sk_sort(OCSP_CERTID, (st)) +#define sk_OCSP_CERTID_is_sorted(st) SKM_sk_is_sorted(OCSP_CERTID, (st)) + +#define sk_OCSP_ONEREQ_new(cmp) SKM_sk_new(OCSP_ONEREQ, (cmp)) +#define sk_OCSP_ONEREQ_new_null() SKM_sk_new_null(OCSP_ONEREQ) +#define sk_OCSP_ONEREQ_free(st) SKM_sk_free(OCSP_ONEREQ, (st)) +#define sk_OCSP_ONEREQ_num(st) SKM_sk_num(OCSP_ONEREQ, (st)) +#define sk_OCSP_ONEREQ_value(st, i) SKM_sk_value(OCSP_ONEREQ, (st), (i)) +#define sk_OCSP_ONEREQ_set(st, i, val) SKM_sk_set(OCSP_ONEREQ, (st), (i), (val)) +#define sk_OCSP_ONEREQ_zero(st) SKM_sk_zero(OCSP_ONEREQ, (st)) +#define sk_OCSP_ONEREQ_push(st, val) SKM_sk_push(OCSP_ONEREQ, (st), (val)) +#define sk_OCSP_ONEREQ_unshift(st, val) SKM_sk_unshift(OCSP_ONEREQ, (st), (val)) +#define sk_OCSP_ONEREQ_find(st, val) SKM_sk_find(OCSP_ONEREQ, (st), (val)) +#define sk_OCSP_ONEREQ_find_ex(st, val) SKM_sk_find_ex(OCSP_ONEREQ, (st), (val)) +#define sk_OCSP_ONEREQ_delete(st, i) SKM_sk_delete(OCSP_ONEREQ, (st), (i)) +#define sk_OCSP_ONEREQ_delete_ptr(st, ptr) SKM_sk_delete_ptr(OCSP_ONEREQ, (st), (ptr)) +#define sk_OCSP_ONEREQ_insert(st, val, i) SKM_sk_insert(OCSP_ONEREQ, (st), (val), (i)) +#define sk_OCSP_ONEREQ_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(OCSP_ONEREQ, (st), (cmp)) +#define sk_OCSP_ONEREQ_dup(st) SKM_sk_dup(OCSP_ONEREQ, st) +#define sk_OCSP_ONEREQ_pop_free(st, free_func) SKM_sk_pop_free(OCSP_ONEREQ, (st), (free_func)) +#define sk_OCSP_ONEREQ_shift(st) SKM_sk_shift(OCSP_ONEREQ, (st)) +#define sk_OCSP_ONEREQ_pop(st) SKM_sk_pop(OCSP_ONEREQ, (st)) +#define sk_OCSP_ONEREQ_sort(st) SKM_sk_sort(OCSP_ONEREQ, (st)) +#define sk_OCSP_ONEREQ_is_sorted(st) SKM_sk_is_sorted(OCSP_ONEREQ, (st)) + +#define sk_OCSP_RESPID_new(cmp) SKM_sk_new(OCSP_RESPID, (cmp)) +#define sk_OCSP_RESPID_new_null() SKM_sk_new_null(OCSP_RESPID) +#define sk_OCSP_RESPID_free(st) SKM_sk_free(OCSP_RESPID, (st)) +#define sk_OCSP_RESPID_num(st) SKM_sk_num(OCSP_RESPID, (st)) +#define sk_OCSP_RESPID_value(st, i) SKM_sk_value(OCSP_RESPID, (st), (i)) +#define sk_OCSP_RESPID_set(st, i, val) SKM_sk_set(OCSP_RESPID, (st), (i), (val)) +#define sk_OCSP_RESPID_zero(st) SKM_sk_zero(OCSP_RESPID, (st)) +#define sk_OCSP_RESPID_push(st, val) SKM_sk_push(OCSP_RESPID, (st), (val)) +#define sk_OCSP_RESPID_unshift(st, val) SKM_sk_unshift(OCSP_RESPID, (st), (val)) +#define sk_OCSP_RESPID_find(st, val) SKM_sk_find(OCSP_RESPID, (st), (val)) +#define sk_OCSP_RESPID_find_ex(st, val) SKM_sk_find_ex(OCSP_RESPID, (st), (val)) +#define sk_OCSP_RESPID_delete(st, i) SKM_sk_delete(OCSP_RESPID, (st), (i)) +#define sk_OCSP_RESPID_delete_ptr(st, ptr) SKM_sk_delete_ptr(OCSP_RESPID, (st), (ptr)) +#define sk_OCSP_RESPID_insert(st, val, i) SKM_sk_insert(OCSP_RESPID, (st), (val), (i)) +#define sk_OCSP_RESPID_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(OCSP_RESPID, (st), (cmp)) +#define sk_OCSP_RESPID_dup(st) SKM_sk_dup(OCSP_RESPID, st) +#define sk_OCSP_RESPID_pop_free(st, free_func) SKM_sk_pop_free(OCSP_RESPID, (st), (free_func)) +#define sk_OCSP_RESPID_shift(st) SKM_sk_shift(OCSP_RESPID, (st)) +#define sk_OCSP_RESPID_pop(st) SKM_sk_pop(OCSP_RESPID, (st)) +#define sk_OCSP_RESPID_sort(st) SKM_sk_sort(OCSP_RESPID, (st)) +#define sk_OCSP_RESPID_is_sorted(st) SKM_sk_is_sorted(OCSP_RESPID, (st)) + +#define sk_OCSP_SINGLERESP_new(cmp) SKM_sk_new(OCSP_SINGLERESP, (cmp)) +#define sk_OCSP_SINGLERESP_new_null() SKM_sk_new_null(OCSP_SINGLERESP) +#define sk_OCSP_SINGLERESP_free(st) SKM_sk_free(OCSP_SINGLERESP, (st)) +#define sk_OCSP_SINGLERESP_num(st) SKM_sk_num(OCSP_SINGLERESP, (st)) +#define sk_OCSP_SINGLERESP_value(st, i) SKM_sk_value(OCSP_SINGLERESP, (st), (i)) +#define sk_OCSP_SINGLERESP_set(st, i, val) SKM_sk_set(OCSP_SINGLERESP, (st), (i), (val)) +#define sk_OCSP_SINGLERESP_zero(st) SKM_sk_zero(OCSP_SINGLERESP, (st)) +#define sk_OCSP_SINGLERESP_push(st, val) SKM_sk_push(OCSP_SINGLERESP, (st), (val)) +#define sk_OCSP_SINGLERESP_unshift(st, val) SKM_sk_unshift(OCSP_SINGLERESP, (st), (val)) +#define sk_OCSP_SINGLERESP_find(st, val) SKM_sk_find(OCSP_SINGLERESP, (st), (val)) +#define sk_OCSP_SINGLERESP_find_ex(st, val) SKM_sk_find_ex(OCSP_SINGLERESP, (st), (val)) +#define sk_OCSP_SINGLERESP_delete(st, i) SKM_sk_delete(OCSP_SINGLERESP, (st), (i)) +#define sk_OCSP_SINGLERESP_delete_ptr(st, ptr) SKM_sk_delete_ptr(OCSP_SINGLERESP, (st), (ptr)) +#define sk_OCSP_SINGLERESP_insert(st, val, i) SKM_sk_insert(OCSP_SINGLERESP, (st), (val), (i)) +#define sk_OCSP_SINGLERESP_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(OCSP_SINGLERESP, (st), (cmp)) +#define sk_OCSP_SINGLERESP_dup(st) SKM_sk_dup(OCSP_SINGLERESP, st) +#define sk_OCSP_SINGLERESP_pop_free(st, free_func) SKM_sk_pop_free(OCSP_SINGLERESP, (st), (free_func)) +#define sk_OCSP_SINGLERESP_shift(st) SKM_sk_shift(OCSP_SINGLERESP, (st)) +#define sk_OCSP_SINGLERESP_pop(st) SKM_sk_pop(OCSP_SINGLERESP, (st)) +#define sk_OCSP_SINGLERESP_sort(st) SKM_sk_sort(OCSP_SINGLERESP, (st)) +#define sk_OCSP_SINGLERESP_is_sorted(st) SKM_sk_is_sorted(OCSP_SINGLERESP, (st)) + +#define sk_PKCS12_SAFEBAG_new(cmp) SKM_sk_new(PKCS12_SAFEBAG, (cmp)) +#define sk_PKCS12_SAFEBAG_new_null() SKM_sk_new_null(PKCS12_SAFEBAG) +#define sk_PKCS12_SAFEBAG_free(st) SKM_sk_free(PKCS12_SAFEBAG, (st)) +#define sk_PKCS12_SAFEBAG_num(st) SKM_sk_num(PKCS12_SAFEBAG, (st)) +#define sk_PKCS12_SAFEBAG_value(st, i) SKM_sk_value(PKCS12_SAFEBAG, (st), (i)) +#define sk_PKCS12_SAFEBAG_set(st, i, val) SKM_sk_set(PKCS12_SAFEBAG, (st), (i), (val)) +#define sk_PKCS12_SAFEBAG_zero(st) SKM_sk_zero(PKCS12_SAFEBAG, (st)) +#define sk_PKCS12_SAFEBAG_push(st, val) SKM_sk_push(PKCS12_SAFEBAG, (st), (val)) +#define sk_PKCS12_SAFEBAG_unshift(st, val) SKM_sk_unshift(PKCS12_SAFEBAG, (st), (val)) +#define sk_PKCS12_SAFEBAG_find(st, val) SKM_sk_find(PKCS12_SAFEBAG, (st), (val)) +#define sk_PKCS12_SAFEBAG_find_ex(st, val) SKM_sk_find_ex(PKCS12_SAFEBAG, (st), (val)) +#define sk_PKCS12_SAFEBAG_delete(st, i) SKM_sk_delete(PKCS12_SAFEBAG, (st), (i)) +#define sk_PKCS12_SAFEBAG_delete_ptr(st, ptr) SKM_sk_delete_ptr(PKCS12_SAFEBAG, (st), (ptr)) +#define sk_PKCS12_SAFEBAG_insert(st, val, i) SKM_sk_insert(PKCS12_SAFEBAG, (st), (val), (i)) +#define sk_PKCS12_SAFEBAG_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(PKCS12_SAFEBAG, (st), (cmp)) +#define sk_PKCS12_SAFEBAG_dup(st) SKM_sk_dup(PKCS12_SAFEBAG, st) +#define sk_PKCS12_SAFEBAG_pop_free(st, free_func) SKM_sk_pop_free(PKCS12_SAFEBAG, (st), (free_func)) +#define sk_PKCS12_SAFEBAG_shift(st) SKM_sk_shift(PKCS12_SAFEBAG, (st)) +#define sk_PKCS12_SAFEBAG_pop(st) SKM_sk_pop(PKCS12_SAFEBAG, (st)) +#define sk_PKCS12_SAFEBAG_sort(st) SKM_sk_sort(PKCS12_SAFEBAG, (st)) +#define sk_PKCS12_SAFEBAG_is_sorted(st) SKM_sk_is_sorted(PKCS12_SAFEBAG, (st)) + +#define sk_PKCS7_new(cmp) SKM_sk_new(PKCS7, (cmp)) +#define sk_PKCS7_new_null() SKM_sk_new_null(PKCS7) +#define sk_PKCS7_free(st) SKM_sk_free(PKCS7, (st)) +#define sk_PKCS7_num(st) SKM_sk_num(PKCS7, (st)) +#define sk_PKCS7_value(st, i) SKM_sk_value(PKCS7, (st), (i)) +#define sk_PKCS7_set(st, i, val) SKM_sk_set(PKCS7, (st), (i), (val)) +#define sk_PKCS7_zero(st) SKM_sk_zero(PKCS7, (st)) +#define sk_PKCS7_push(st, val) SKM_sk_push(PKCS7, (st), (val)) +#define sk_PKCS7_unshift(st, val) SKM_sk_unshift(PKCS7, (st), (val)) +#define sk_PKCS7_find(st, val) SKM_sk_find(PKCS7, (st), (val)) +#define sk_PKCS7_find_ex(st, val) SKM_sk_find_ex(PKCS7, (st), (val)) +#define sk_PKCS7_delete(st, i) SKM_sk_delete(PKCS7, (st), (i)) +#define sk_PKCS7_delete_ptr(st, ptr) SKM_sk_delete_ptr(PKCS7, (st), (ptr)) +#define sk_PKCS7_insert(st, val, i) SKM_sk_insert(PKCS7, (st), (val), (i)) +#define sk_PKCS7_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(PKCS7, (st), (cmp)) +#define sk_PKCS7_dup(st) SKM_sk_dup(PKCS7, st) +#define sk_PKCS7_pop_free(st, free_func) SKM_sk_pop_free(PKCS7, (st), (free_func)) +#define sk_PKCS7_shift(st) SKM_sk_shift(PKCS7, (st)) +#define sk_PKCS7_pop(st) SKM_sk_pop(PKCS7, (st)) +#define sk_PKCS7_sort(st) SKM_sk_sort(PKCS7, (st)) +#define sk_PKCS7_is_sorted(st) SKM_sk_is_sorted(PKCS7, (st)) + +#define sk_PKCS7_RECIP_INFO_new(cmp) SKM_sk_new(PKCS7_RECIP_INFO, (cmp)) +#define sk_PKCS7_RECIP_INFO_new_null() SKM_sk_new_null(PKCS7_RECIP_INFO) +#define sk_PKCS7_RECIP_INFO_free(st) SKM_sk_free(PKCS7_RECIP_INFO, (st)) +#define sk_PKCS7_RECIP_INFO_num(st) SKM_sk_num(PKCS7_RECIP_INFO, (st)) +#define sk_PKCS7_RECIP_INFO_value(st, i) SKM_sk_value(PKCS7_RECIP_INFO, (st), (i)) +#define sk_PKCS7_RECIP_INFO_set(st, i, val) SKM_sk_set(PKCS7_RECIP_INFO, (st), (i), (val)) +#define sk_PKCS7_RECIP_INFO_zero(st) SKM_sk_zero(PKCS7_RECIP_INFO, (st)) +#define sk_PKCS7_RECIP_INFO_push(st, val) SKM_sk_push(PKCS7_RECIP_INFO, (st), (val)) +#define sk_PKCS7_RECIP_INFO_unshift(st, val) SKM_sk_unshift(PKCS7_RECIP_INFO, (st), (val)) +#define sk_PKCS7_RECIP_INFO_find(st, val) SKM_sk_find(PKCS7_RECIP_INFO, (st), (val)) +#define sk_PKCS7_RECIP_INFO_find_ex(st, val) SKM_sk_find_ex(PKCS7_RECIP_INFO, (st), (val)) +#define sk_PKCS7_RECIP_INFO_delete(st, i) SKM_sk_delete(PKCS7_RECIP_INFO, (st), (i)) +#define sk_PKCS7_RECIP_INFO_delete_ptr(st, ptr) SKM_sk_delete_ptr(PKCS7_RECIP_INFO, (st), (ptr)) +#define sk_PKCS7_RECIP_INFO_insert(st, val, i) SKM_sk_insert(PKCS7_RECIP_INFO, (st), (val), (i)) +#define sk_PKCS7_RECIP_INFO_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(PKCS7_RECIP_INFO, (st), (cmp)) +#define sk_PKCS7_RECIP_INFO_dup(st) SKM_sk_dup(PKCS7_RECIP_INFO, st) +#define sk_PKCS7_RECIP_INFO_pop_free(st, free_func) SKM_sk_pop_free(PKCS7_RECIP_INFO, (st), (free_func)) +#define sk_PKCS7_RECIP_INFO_shift(st) SKM_sk_shift(PKCS7_RECIP_INFO, (st)) +#define sk_PKCS7_RECIP_INFO_pop(st) SKM_sk_pop(PKCS7_RECIP_INFO, (st)) +#define sk_PKCS7_RECIP_INFO_sort(st) SKM_sk_sort(PKCS7_RECIP_INFO, (st)) +#define sk_PKCS7_RECIP_INFO_is_sorted(st) SKM_sk_is_sorted(PKCS7_RECIP_INFO, (st)) + +#define sk_PKCS7_SIGNER_INFO_new(cmp) SKM_sk_new(PKCS7_SIGNER_INFO, (cmp)) +#define sk_PKCS7_SIGNER_INFO_new_null() SKM_sk_new_null(PKCS7_SIGNER_INFO) +#define sk_PKCS7_SIGNER_INFO_free(st) SKM_sk_free(PKCS7_SIGNER_INFO, (st)) +#define sk_PKCS7_SIGNER_INFO_num(st) SKM_sk_num(PKCS7_SIGNER_INFO, (st)) +#define sk_PKCS7_SIGNER_INFO_value(st, i) SKM_sk_value(PKCS7_SIGNER_INFO, (st), (i)) +#define sk_PKCS7_SIGNER_INFO_set(st, i, val) SKM_sk_set(PKCS7_SIGNER_INFO, (st), (i), (val)) +#define sk_PKCS7_SIGNER_INFO_zero(st) SKM_sk_zero(PKCS7_SIGNER_INFO, (st)) +#define sk_PKCS7_SIGNER_INFO_push(st, val) SKM_sk_push(PKCS7_SIGNER_INFO, (st), (val)) +#define sk_PKCS7_SIGNER_INFO_unshift(st, val) SKM_sk_unshift(PKCS7_SIGNER_INFO, (st), (val)) +#define sk_PKCS7_SIGNER_INFO_find(st, val) SKM_sk_find(PKCS7_SIGNER_INFO, (st), (val)) +#define sk_PKCS7_SIGNER_INFO_find_ex(st, val) SKM_sk_find_ex(PKCS7_SIGNER_INFO, (st), (val)) +#define sk_PKCS7_SIGNER_INFO_delete(st, i) SKM_sk_delete(PKCS7_SIGNER_INFO, (st), (i)) +#define sk_PKCS7_SIGNER_INFO_delete_ptr(st, ptr) SKM_sk_delete_ptr(PKCS7_SIGNER_INFO, (st), (ptr)) +#define sk_PKCS7_SIGNER_INFO_insert(st, val, i) SKM_sk_insert(PKCS7_SIGNER_INFO, (st), (val), (i)) +#define sk_PKCS7_SIGNER_INFO_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(PKCS7_SIGNER_INFO, (st), (cmp)) +#define sk_PKCS7_SIGNER_INFO_dup(st) SKM_sk_dup(PKCS7_SIGNER_INFO, st) +#define sk_PKCS7_SIGNER_INFO_pop_free(st, free_func) SKM_sk_pop_free(PKCS7_SIGNER_INFO, (st), (free_func)) +#define sk_PKCS7_SIGNER_INFO_shift(st) SKM_sk_shift(PKCS7_SIGNER_INFO, (st)) +#define sk_PKCS7_SIGNER_INFO_pop(st) SKM_sk_pop(PKCS7_SIGNER_INFO, (st)) +#define sk_PKCS7_SIGNER_INFO_sort(st) SKM_sk_sort(PKCS7_SIGNER_INFO, (st)) +#define sk_PKCS7_SIGNER_INFO_is_sorted(st) SKM_sk_is_sorted(PKCS7_SIGNER_INFO, (st)) + +#define sk_POLICYINFO_new(cmp) SKM_sk_new(POLICYINFO, (cmp)) +#define sk_POLICYINFO_new_null() SKM_sk_new_null(POLICYINFO) +#define sk_POLICYINFO_free(st) SKM_sk_free(POLICYINFO, (st)) +#define sk_POLICYINFO_num(st) SKM_sk_num(POLICYINFO, (st)) +#define sk_POLICYINFO_value(st, i) SKM_sk_value(POLICYINFO, (st), (i)) +#define sk_POLICYINFO_set(st, i, val) SKM_sk_set(POLICYINFO, (st), (i), (val)) +#define sk_POLICYINFO_zero(st) SKM_sk_zero(POLICYINFO, (st)) +#define sk_POLICYINFO_push(st, val) SKM_sk_push(POLICYINFO, (st), (val)) +#define sk_POLICYINFO_unshift(st, val) SKM_sk_unshift(POLICYINFO, (st), (val)) +#define sk_POLICYINFO_find(st, val) SKM_sk_find(POLICYINFO, (st), (val)) +#define sk_POLICYINFO_find_ex(st, val) SKM_sk_find_ex(POLICYINFO, (st), (val)) +#define sk_POLICYINFO_delete(st, i) SKM_sk_delete(POLICYINFO, (st), (i)) +#define sk_POLICYINFO_delete_ptr(st, ptr) SKM_sk_delete_ptr(POLICYINFO, (st), (ptr)) +#define sk_POLICYINFO_insert(st, val, i) SKM_sk_insert(POLICYINFO, (st), (val), (i)) +#define sk_POLICYINFO_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(POLICYINFO, (st), (cmp)) +#define sk_POLICYINFO_dup(st) SKM_sk_dup(POLICYINFO, st) +#define sk_POLICYINFO_pop_free(st, free_func) SKM_sk_pop_free(POLICYINFO, (st), (free_func)) +#define sk_POLICYINFO_shift(st) SKM_sk_shift(POLICYINFO, (st)) +#define sk_POLICYINFO_pop(st) SKM_sk_pop(POLICYINFO, (st)) +#define sk_POLICYINFO_sort(st) SKM_sk_sort(POLICYINFO, (st)) +#define sk_POLICYINFO_is_sorted(st) SKM_sk_is_sorted(POLICYINFO, (st)) + +#define sk_POLICYQUALINFO_new(cmp) SKM_sk_new(POLICYQUALINFO, (cmp)) +#define sk_POLICYQUALINFO_new_null() SKM_sk_new_null(POLICYQUALINFO) +#define sk_POLICYQUALINFO_free(st) SKM_sk_free(POLICYQUALINFO, (st)) +#define sk_POLICYQUALINFO_num(st) SKM_sk_num(POLICYQUALINFO, (st)) +#define sk_POLICYQUALINFO_value(st, i) SKM_sk_value(POLICYQUALINFO, (st), (i)) +#define sk_POLICYQUALINFO_set(st, i, val) SKM_sk_set(POLICYQUALINFO, (st), (i), (val)) +#define sk_POLICYQUALINFO_zero(st) SKM_sk_zero(POLICYQUALINFO, (st)) +#define sk_POLICYQUALINFO_push(st, val) SKM_sk_push(POLICYQUALINFO, (st), (val)) +#define sk_POLICYQUALINFO_unshift(st, val) SKM_sk_unshift(POLICYQUALINFO, (st), (val)) +#define sk_POLICYQUALINFO_find(st, val) SKM_sk_find(POLICYQUALINFO, (st), (val)) +#define sk_POLICYQUALINFO_find_ex(st, val) SKM_sk_find_ex(POLICYQUALINFO, (st), (val)) +#define sk_POLICYQUALINFO_delete(st, i) SKM_sk_delete(POLICYQUALINFO, (st), (i)) +#define sk_POLICYQUALINFO_delete_ptr(st, ptr) SKM_sk_delete_ptr(POLICYQUALINFO, (st), (ptr)) +#define sk_POLICYQUALINFO_insert(st, val, i) SKM_sk_insert(POLICYQUALINFO, (st), (val), (i)) +#define sk_POLICYQUALINFO_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(POLICYQUALINFO, (st), (cmp)) +#define sk_POLICYQUALINFO_dup(st) SKM_sk_dup(POLICYQUALINFO, st) +#define sk_POLICYQUALINFO_pop_free(st, free_func) SKM_sk_pop_free(POLICYQUALINFO, (st), (free_func)) +#define sk_POLICYQUALINFO_shift(st) SKM_sk_shift(POLICYQUALINFO, (st)) +#define sk_POLICYQUALINFO_pop(st) SKM_sk_pop(POLICYQUALINFO, (st)) +#define sk_POLICYQUALINFO_sort(st) SKM_sk_sort(POLICYQUALINFO, (st)) +#define sk_POLICYQUALINFO_is_sorted(st) SKM_sk_is_sorted(POLICYQUALINFO, (st)) + +#define sk_POLICY_MAPPING_new(cmp) SKM_sk_new(POLICY_MAPPING, (cmp)) +#define sk_POLICY_MAPPING_new_null() SKM_sk_new_null(POLICY_MAPPING) +#define sk_POLICY_MAPPING_free(st) SKM_sk_free(POLICY_MAPPING, (st)) +#define sk_POLICY_MAPPING_num(st) SKM_sk_num(POLICY_MAPPING, (st)) +#define sk_POLICY_MAPPING_value(st, i) SKM_sk_value(POLICY_MAPPING, (st), (i)) +#define sk_POLICY_MAPPING_set(st, i, val) SKM_sk_set(POLICY_MAPPING, (st), (i), (val)) +#define sk_POLICY_MAPPING_zero(st) SKM_sk_zero(POLICY_MAPPING, (st)) +#define sk_POLICY_MAPPING_push(st, val) SKM_sk_push(POLICY_MAPPING, (st), (val)) +#define sk_POLICY_MAPPING_unshift(st, val) SKM_sk_unshift(POLICY_MAPPING, (st), (val)) +#define sk_POLICY_MAPPING_find(st, val) SKM_sk_find(POLICY_MAPPING, (st), (val)) +#define sk_POLICY_MAPPING_find_ex(st, val) SKM_sk_find_ex(POLICY_MAPPING, (st), (val)) +#define sk_POLICY_MAPPING_delete(st, i) SKM_sk_delete(POLICY_MAPPING, (st), (i)) +#define sk_POLICY_MAPPING_delete_ptr(st, ptr) SKM_sk_delete_ptr(POLICY_MAPPING, (st), (ptr)) +#define sk_POLICY_MAPPING_insert(st, val, i) SKM_sk_insert(POLICY_MAPPING, (st), (val), (i)) +#define sk_POLICY_MAPPING_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(POLICY_MAPPING, (st), (cmp)) +#define sk_POLICY_MAPPING_dup(st) SKM_sk_dup(POLICY_MAPPING, st) +#define sk_POLICY_MAPPING_pop_free(st, free_func) SKM_sk_pop_free(POLICY_MAPPING, (st), (free_func)) +#define sk_POLICY_MAPPING_shift(st) SKM_sk_shift(POLICY_MAPPING, (st)) +#define sk_POLICY_MAPPING_pop(st) SKM_sk_pop(POLICY_MAPPING, (st)) +#define sk_POLICY_MAPPING_sort(st) SKM_sk_sort(POLICY_MAPPING, (st)) +#define sk_POLICY_MAPPING_is_sorted(st) SKM_sk_is_sorted(POLICY_MAPPING, (st)) + +#define sk_SRP_gN_new(cmp) SKM_sk_new(SRP_gN, (cmp)) +#define sk_SRP_gN_new_null() SKM_sk_new_null(SRP_gN) +#define sk_SRP_gN_free(st) SKM_sk_free(SRP_gN, (st)) +#define sk_SRP_gN_num(st) SKM_sk_num(SRP_gN, (st)) +#define sk_SRP_gN_value(st, i) SKM_sk_value(SRP_gN, (st), (i)) +#define sk_SRP_gN_set(st, i, val) SKM_sk_set(SRP_gN, (st), (i), (val)) +#define sk_SRP_gN_zero(st) SKM_sk_zero(SRP_gN, (st)) +#define sk_SRP_gN_push(st, val) SKM_sk_push(SRP_gN, (st), (val)) +#define sk_SRP_gN_unshift(st, val) SKM_sk_unshift(SRP_gN, (st), (val)) +#define sk_SRP_gN_find(st, val) SKM_sk_find(SRP_gN, (st), (val)) +#define sk_SRP_gN_find_ex(st, val) SKM_sk_find_ex(SRP_gN, (st), (val)) +#define sk_SRP_gN_delete(st, i) SKM_sk_delete(SRP_gN, (st), (i)) +#define sk_SRP_gN_delete_ptr(st, ptr) SKM_sk_delete_ptr(SRP_gN, (st), (ptr)) +#define sk_SRP_gN_insert(st, val, i) SKM_sk_insert(SRP_gN, (st), (val), (i)) +#define sk_SRP_gN_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(SRP_gN, (st), (cmp)) +#define sk_SRP_gN_dup(st) SKM_sk_dup(SRP_gN, st) +#define sk_SRP_gN_pop_free(st, free_func) SKM_sk_pop_free(SRP_gN, (st), (free_func)) +#define sk_SRP_gN_shift(st) SKM_sk_shift(SRP_gN, (st)) +#define sk_SRP_gN_pop(st) SKM_sk_pop(SRP_gN, (st)) +#define sk_SRP_gN_sort(st) SKM_sk_sort(SRP_gN, (st)) +#define sk_SRP_gN_is_sorted(st) SKM_sk_is_sorted(SRP_gN, (st)) + +#define sk_SRP_gN_cache_new(cmp) SKM_sk_new(SRP_gN_cache, (cmp)) +#define sk_SRP_gN_cache_new_null() SKM_sk_new_null(SRP_gN_cache) +#define sk_SRP_gN_cache_free(st) SKM_sk_free(SRP_gN_cache, (st)) +#define sk_SRP_gN_cache_num(st) SKM_sk_num(SRP_gN_cache, (st)) +#define sk_SRP_gN_cache_value(st, i) SKM_sk_value(SRP_gN_cache, (st), (i)) +#define sk_SRP_gN_cache_set(st, i, val) SKM_sk_set(SRP_gN_cache, (st), (i), (val)) +#define sk_SRP_gN_cache_zero(st) SKM_sk_zero(SRP_gN_cache, (st)) +#define sk_SRP_gN_cache_push(st, val) SKM_sk_push(SRP_gN_cache, (st), (val)) +#define sk_SRP_gN_cache_unshift(st, val) SKM_sk_unshift(SRP_gN_cache, (st), (val)) +#define sk_SRP_gN_cache_find(st, val) SKM_sk_find(SRP_gN_cache, (st), (val)) +#define sk_SRP_gN_cache_find_ex(st, val) SKM_sk_find_ex(SRP_gN_cache, (st), (val)) +#define sk_SRP_gN_cache_delete(st, i) SKM_sk_delete(SRP_gN_cache, (st), (i)) +#define sk_SRP_gN_cache_delete_ptr(st, ptr) SKM_sk_delete_ptr(SRP_gN_cache, (st), (ptr)) +#define sk_SRP_gN_cache_insert(st, val, i) SKM_sk_insert(SRP_gN_cache, (st), (val), (i)) +#define sk_SRP_gN_cache_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(SRP_gN_cache, (st), (cmp)) +#define sk_SRP_gN_cache_dup(st) SKM_sk_dup(SRP_gN_cache, st) +#define sk_SRP_gN_cache_pop_free(st, free_func) SKM_sk_pop_free(SRP_gN_cache, (st), (free_func)) +#define sk_SRP_gN_cache_shift(st) SKM_sk_shift(SRP_gN_cache, (st)) +#define sk_SRP_gN_cache_pop(st) SKM_sk_pop(SRP_gN_cache, (st)) +#define sk_SRP_gN_cache_sort(st) SKM_sk_sort(SRP_gN_cache, (st)) +#define sk_SRP_gN_cache_is_sorted(st) SKM_sk_is_sorted(SRP_gN_cache, (st)) + +#define sk_SRP_user_pwd_new(cmp) SKM_sk_new(SRP_user_pwd, (cmp)) +#define sk_SRP_user_pwd_new_null() SKM_sk_new_null(SRP_user_pwd) +#define sk_SRP_user_pwd_free(st) SKM_sk_free(SRP_user_pwd, (st)) +#define sk_SRP_user_pwd_num(st) SKM_sk_num(SRP_user_pwd, (st)) +#define sk_SRP_user_pwd_value(st, i) SKM_sk_value(SRP_user_pwd, (st), (i)) +#define sk_SRP_user_pwd_set(st, i, val) SKM_sk_set(SRP_user_pwd, (st), (i), (val)) +#define sk_SRP_user_pwd_zero(st) SKM_sk_zero(SRP_user_pwd, (st)) +#define sk_SRP_user_pwd_push(st, val) SKM_sk_push(SRP_user_pwd, (st), (val)) +#define sk_SRP_user_pwd_unshift(st, val) SKM_sk_unshift(SRP_user_pwd, (st), (val)) +#define sk_SRP_user_pwd_find(st, val) SKM_sk_find(SRP_user_pwd, (st), (val)) +#define sk_SRP_user_pwd_find_ex(st, val) SKM_sk_find_ex(SRP_user_pwd, (st), (val)) +#define sk_SRP_user_pwd_delete(st, i) SKM_sk_delete(SRP_user_pwd, (st), (i)) +#define sk_SRP_user_pwd_delete_ptr(st, ptr) SKM_sk_delete_ptr(SRP_user_pwd, (st), (ptr)) +#define sk_SRP_user_pwd_insert(st, val, i) SKM_sk_insert(SRP_user_pwd, (st), (val), (i)) +#define sk_SRP_user_pwd_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(SRP_user_pwd, (st), (cmp)) +#define sk_SRP_user_pwd_dup(st) SKM_sk_dup(SRP_user_pwd, st) +#define sk_SRP_user_pwd_pop_free(st, free_func) SKM_sk_pop_free(SRP_user_pwd, (st), (free_func)) +#define sk_SRP_user_pwd_shift(st) SKM_sk_shift(SRP_user_pwd, (st)) +#define sk_SRP_user_pwd_pop(st) SKM_sk_pop(SRP_user_pwd, (st)) +#define sk_SRP_user_pwd_sort(st) SKM_sk_sort(SRP_user_pwd, (st)) +#define sk_SRP_user_pwd_is_sorted(st) SKM_sk_is_sorted(SRP_user_pwd, (st)) + +#define sk_SRTP_PROTECTION_PROFILE_new(cmp) SKM_sk_new(SRTP_PROTECTION_PROFILE, (cmp)) +#define sk_SRTP_PROTECTION_PROFILE_new_null() SKM_sk_new_null(SRTP_PROTECTION_PROFILE) +#define sk_SRTP_PROTECTION_PROFILE_free(st) SKM_sk_free(SRTP_PROTECTION_PROFILE, (st)) +#define sk_SRTP_PROTECTION_PROFILE_num(st) SKM_sk_num(SRTP_PROTECTION_PROFILE, (st)) +#define sk_SRTP_PROTECTION_PROFILE_value(st, i) SKM_sk_value(SRTP_PROTECTION_PROFILE, (st), (i)) +#define sk_SRTP_PROTECTION_PROFILE_set(st, i, val) SKM_sk_set(SRTP_PROTECTION_PROFILE, (st), (i), (val)) +#define sk_SRTP_PROTECTION_PROFILE_zero(st) SKM_sk_zero(SRTP_PROTECTION_PROFILE, (st)) +#define sk_SRTP_PROTECTION_PROFILE_push(st, val) SKM_sk_push(SRTP_PROTECTION_PROFILE, (st), (val)) +#define sk_SRTP_PROTECTION_PROFILE_unshift(st, val) SKM_sk_unshift(SRTP_PROTECTION_PROFILE, (st), (val)) +#define sk_SRTP_PROTECTION_PROFILE_find(st, val) SKM_sk_find(SRTP_PROTECTION_PROFILE, (st), (val)) +#define sk_SRTP_PROTECTION_PROFILE_find_ex(st, val) SKM_sk_find_ex(SRTP_PROTECTION_PROFILE, (st), (val)) +#define sk_SRTP_PROTECTION_PROFILE_delete(st, i) SKM_sk_delete(SRTP_PROTECTION_PROFILE, (st), (i)) +#define sk_SRTP_PROTECTION_PROFILE_delete_ptr(st, ptr) SKM_sk_delete_ptr(SRTP_PROTECTION_PROFILE, (st), (ptr)) +#define sk_SRTP_PROTECTION_PROFILE_insert(st, val, i) SKM_sk_insert(SRTP_PROTECTION_PROFILE, (st), (val), (i)) +#define sk_SRTP_PROTECTION_PROFILE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(SRTP_PROTECTION_PROFILE, (st), (cmp)) +#define sk_SRTP_PROTECTION_PROFILE_dup(st) SKM_sk_dup(SRTP_PROTECTION_PROFILE, st) +#define sk_SRTP_PROTECTION_PROFILE_pop_free(st, free_func) SKM_sk_pop_free(SRTP_PROTECTION_PROFILE, (st), (free_func)) +#define sk_SRTP_PROTECTION_PROFILE_shift(st) SKM_sk_shift(SRTP_PROTECTION_PROFILE, (st)) +#define sk_SRTP_PROTECTION_PROFILE_pop(st) SKM_sk_pop(SRTP_PROTECTION_PROFILE, (st)) +#define sk_SRTP_PROTECTION_PROFILE_sort(st) SKM_sk_sort(SRTP_PROTECTION_PROFILE, (st)) +#define sk_SRTP_PROTECTION_PROFILE_is_sorted(st) SKM_sk_is_sorted(SRTP_PROTECTION_PROFILE, (st)) + +#define sk_SSL_CIPHER_new(cmp) SKM_sk_new(SSL_CIPHER, (cmp)) +#define sk_SSL_CIPHER_new_null() SKM_sk_new_null(SSL_CIPHER) +#define sk_SSL_CIPHER_free(st) SKM_sk_free(SSL_CIPHER, (st)) +#define sk_SSL_CIPHER_num(st) SKM_sk_num(SSL_CIPHER, (st)) +#define sk_SSL_CIPHER_value(st, i) SKM_sk_value(SSL_CIPHER, (st), (i)) +#define sk_SSL_CIPHER_set(st, i, val) SKM_sk_set(SSL_CIPHER, (st), (i), (val)) +#define sk_SSL_CIPHER_zero(st) SKM_sk_zero(SSL_CIPHER, (st)) +#define sk_SSL_CIPHER_push(st, val) SKM_sk_push(SSL_CIPHER, (st), (val)) +#define sk_SSL_CIPHER_unshift(st, val) SKM_sk_unshift(SSL_CIPHER, (st), (val)) +#define sk_SSL_CIPHER_find(st, val) SKM_sk_find(SSL_CIPHER, (st), (val)) +#define sk_SSL_CIPHER_find_ex(st, val) SKM_sk_find_ex(SSL_CIPHER, (st), (val)) +#define sk_SSL_CIPHER_delete(st, i) SKM_sk_delete(SSL_CIPHER, (st), (i)) +#define sk_SSL_CIPHER_delete_ptr(st, ptr) SKM_sk_delete_ptr(SSL_CIPHER, (st), (ptr)) +#define sk_SSL_CIPHER_insert(st, val, i) SKM_sk_insert(SSL_CIPHER, (st), (val), (i)) +#define sk_SSL_CIPHER_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(SSL_CIPHER, (st), (cmp)) +#define sk_SSL_CIPHER_dup(st) SKM_sk_dup(SSL_CIPHER, st) +#define sk_SSL_CIPHER_pop_free(st, free_func) SKM_sk_pop_free(SSL_CIPHER, (st), (free_func)) +#define sk_SSL_CIPHER_shift(st) SKM_sk_shift(SSL_CIPHER, (st)) +#define sk_SSL_CIPHER_pop(st) SKM_sk_pop(SSL_CIPHER, (st)) +#define sk_SSL_CIPHER_sort(st) SKM_sk_sort(SSL_CIPHER, (st)) +#define sk_SSL_CIPHER_is_sorted(st) SKM_sk_is_sorted(SSL_CIPHER, (st)) + +#define sk_SSL_COMP_new(cmp) SKM_sk_new(SSL_COMP, (cmp)) +#define sk_SSL_COMP_new_null() SKM_sk_new_null(SSL_COMP) +#define sk_SSL_COMP_free(st) SKM_sk_free(SSL_COMP, (st)) +#define sk_SSL_COMP_num(st) SKM_sk_num(SSL_COMP, (st)) +#define sk_SSL_COMP_value(st, i) SKM_sk_value(SSL_COMP, (st), (i)) +#define sk_SSL_COMP_set(st, i, val) SKM_sk_set(SSL_COMP, (st), (i), (val)) +#define sk_SSL_COMP_zero(st) SKM_sk_zero(SSL_COMP, (st)) +#define sk_SSL_COMP_push(st, val) SKM_sk_push(SSL_COMP, (st), (val)) +#define sk_SSL_COMP_unshift(st, val) SKM_sk_unshift(SSL_COMP, (st), (val)) +#define sk_SSL_COMP_find(st, val) SKM_sk_find(SSL_COMP, (st), (val)) +#define sk_SSL_COMP_find_ex(st, val) SKM_sk_find_ex(SSL_COMP, (st), (val)) +#define sk_SSL_COMP_delete(st, i) SKM_sk_delete(SSL_COMP, (st), (i)) +#define sk_SSL_COMP_delete_ptr(st, ptr) SKM_sk_delete_ptr(SSL_COMP, (st), (ptr)) +#define sk_SSL_COMP_insert(st, val, i) SKM_sk_insert(SSL_COMP, (st), (val), (i)) +#define sk_SSL_COMP_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(SSL_COMP, (st), (cmp)) +#define sk_SSL_COMP_dup(st) SKM_sk_dup(SSL_COMP, st) +#define sk_SSL_COMP_pop_free(st, free_func) SKM_sk_pop_free(SSL_COMP, (st), (free_func)) +#define sk_SSL_COMP_shift(st) SKM_sk_shift(SSL_COMP, (st)) +#define sk_SSL_COMP_pop(st) SKM_sk_pop(SSL_COMP, (st)) +#define sk_SSL_COMP_sort(st) SKM_sk_sort(SSL_COMP, (st)) +#define sk_SSL_COMP_is_sorted(st) SKM_sk_is_sorted(SSL_COMP, (st)) + +#define sk_STACK_OF_X509_NAME_ENTRY_new(cmp) SKM_sk_new(STACK_OF_X509_NAME_ENTRY, (cmp)) +#define sk_STACK_OF_X509_NAME_ENTRY_new_null() SKM_sk_new_null(STACK_OF_X509_NAME_ENTRY) +#define sk_STACK_OF_X509_NAME_ENTRY_free(st) SKM_sk_free(STACK_OF_X509_NAME_ENTRY, (st)) +#define sk_STACK_OF_X509_NAME_ENTRY_num(st) SKM_sk_num(STACK_OF_X509_NAME_ENTRY, (st)) +#define sk_STACK_OF_X509_NAME_ENTRY_value(st, i) SKM_sk_value(STACK_OF_X509_NAME_ENTRY, (st), (i)) +#define sk_STACK_OF_X509_NAME_ENTRY_set(st, i, val) SKM_sk_set(STACK_OF_X509_NAME_ENTRY, (st), (i), (val)) +#define sk_STACK_OF_X509_NAME_ENTRY_zero(st) SKM_sk_zero(STACK_OF_X509_NAME_ENTRY, (st)) +#define sk_STACK_OF_X509_NAME_ENTRY_push(st, val) SKM_sk_push(STACK_OF_X509_NAME_ENTRY, (st), (val)) +#define sk_STACK_OF_X509_NAME_ENTRY_unshift(st, val) SKM_sk_unshift(STACK_OF_X509_NAME_ENTRY, (st), (val)) +#define sk_STACK_OF_X509_NAME_ENTRY_find(st, val) SKM_sk_find(STACK_OF_X509_NAME_ENTRY, (st), (val)) +#define sk_STACK_OF_X509_NAME_ENTRY_find_ex(st, val) SKM_sk_find_ex(STACK_OF_X509_NAME_ENTRY, (st), (val)) +#define sk_STACK_OF_X509_NAME_ENTRY_delete(st, i) SKM_sk_delete(STACK_OF_X509_NAME_ENTRY, (st), (i)) +#define sk_STACK_OF_X509_NAME_ENTRY_delete_ptr(st, ptr) SKM_sk_delete_ptr(STACK_OF_X509_NAME_ENTRY, (st), (ptr)) +#define sk_STACK_OF_X509_NAME_ENTRY_insert(st, val, i) SKM_sk_insert(STACK_OF_X509_NAME_ENTRY, (st), (val), (i)) +#define sk_STACK_OF_X509_NAME_ENTRY_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(STACK_OF_X509_NAME_ENTRY, (st), (cmp)) +#define sk_STACK_OF_X509_NAME_ENTRY_dup(st) SKM_sk_dup(STACK_OF_X509_NAME_ENTRY, st) +#define sk_STACK_OF_X509_NAME_ENTRY_pop_free(st, free_func) SKM_sk_pop_free(STACK_OF_X509_NAME_ENTRY, (st), (free_func)) +#define sk_STACK_OF_X509_NAME_ENTRY_shift(st) SKM_sk_shift(STACK_OF_X509_NAME_ENTRY, (st)) +#define sk_STACK_OF_X509_NAME_ENTRY_pop(st) SKM_sk_pop(STACK_OF_X509_NAME_ENTRY, (st)) +#define sk_STACK_OF_X509_NAME_ENTRY_sort(st) SKM_sk_sort(STACK_OF_X509_NAME_ENTRY, (st)) +#define sk_STACK_OF_X509_NAME_ENTRY_is_sorted(st) SKM_sk_is_sorted(STACK_OF_X509_NAME_ENTRY, (st)) + +#define sk_STORE_ATTR_INFO_new(cmp) SKM_sk_new(STORE_ATTR_INFO, (cmp)) +#define sk_STORE_ATTR_INFO_new_null() SKM_sk_new_null(STORE_ATTR_INFO) +#define sk_STORE_ATTR_INFO_free(st) SKM_sk_free(STORE_ATTR_INFO, (st)) +#define sk_STORE_ATTR_INFO_num(st) SKM_sk_num(STORE_ATTR_INFO, (st)) +#define sk_STORE_ATTR_INFO_value(st, i) SKM_sk_value(STORE_ATTR_INFO, (st), (i)) +#define sk_STORE_ATTR_INFO_set(st, i, val) SKM_sk_set(STORE_ATTR_INFO, (st), (i), (val)) +#define sk_STORE_ATTR_INFO_zero(st) SKM_sk_zero(STORE_ATTR_INFO, (st)) +#define sk_STORE_ATTR_INFO_push(st, val) SKM_sk_push(STORE_ATTR_INFO, (st), (val)) +#define sk_STORE_ATTR_INFO_unshift(st, val) SKM_sk_unshift(STORE_ATTR_INFO, (st), (val)) +#define sk_STORE_ATTR_INFO_find(st, val) SKM_sk_find(STORE_ATTR_INFO, (st), (val)) +#define sk_STORE_ATTR_INFO_find_ex(st, val) SKM_sk_find_ex(STORE_ATTR_INFO, (st), (val)) +#define sk_STORE_ATTR_INFO_delete(st, i) SKM_sk_delete(STORE_ATTR_INFO, (st), (i)) +#define sk_STORE_ATTR_INFO_delete_ptr(st, ptr) SKM_sk_delete_ptr(STORE_ATTR_INFO, (st), (ptr)) +#define sk_STORE_ATTR_INFO_insert(st, val, i) SKM_sk_insert(STORE_ATTR_INFO, (st), (val), (i)) +#define sk_STORE_ATTR_INFO_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(STORE_ATTR_INFO, (st), (cmp)) +#define sk_STORE_ATTR_INFO_dup(st) SKM_sk_dup(STORE_ATTR_INFO, st) +#define sk_STORE_ATTR_INFO_pop_free(st, free_func) SKM_sk_pop_free(STORE_ATTR_INFO, (st), (free_func)) +#define sk_STORE_ATTR_INFO_shift(st) SKM_sk_shift(STORE_ATTR_INFO, (st)) +#define sk_STORE_ATTR_INFO_pop(st) SKM_sk_pop(STORE_ATTR_INFO, (st)) +#define sk_STORE_ATTR_INFO_sort(st) SKM_sk_sort(STORE_ATTR_INFO, (st)) +#define sk_STORE_ATTR_INFO_is_sorted(st) SKM_sk_is_sorted(STORE_ATTR_INFO, (st)) + +#define sk_STORE_OBJECT_new(cmp) SKM_sk_new(STORE_OBJECT, (cmp)) +#define sk_STORE_OBJECT_new_null() SKM_sk_new_null(STORE_OBJECT) +#define sk_STORE_OBJECT_free(st) SKM_sk_free(STORE_OBJECT, (st)) +#define sk_STORE_OBJECT_num(st) SKM_sk_num(STORE_OBJECT, (st)) +#define sk_STORE_OBJECT_value(st, i) SKM_sk_value(STORE_OBJECT, (st), (i)) +#define sk_STORE_OBJECT_set(st, i, val) SKM_sk_set(STORE_OBJECT, (st), (i), (val)) +#define sk_STORE_OBJECT_zero(st) SKM_sk_zero(STORE_OBJECT, (st)) +#define sk_STORE_OBJECT_push(st, val) SKM_sk_push(STORE_OBJECT, (st), (val)) +#define sk_STORE_OBJECT_unshift(st, val) SKM_sk_unshift(STORE_OBJECT, (st), (val)) +#define sk_STORE_OBJECT_find(st, val) SKM_sk_find(STORE_OBJECT, (st), (val)) +#define sk_STORE_OBJECT_find_ex(st, val) SKM_sk_find_ex(STORE_OBJECT, (st), (val)) +#define sk_STORE_OBJECT_delete(st, i) SKM_sk_delete(STORE_OBJECT, (st), (i)) +#define sk_STORE_OBJECT_delete_ptr(st, ptr) SKM_sk_delete_ptr(STORE_OBJECT, (st), (ptr)) +#define sk_STORE_OBJECT_insert(st, val, i) SKM_sk_insert(STORE_OBJECT, (st), (val), (i)) +#define sk_STORE_OBJECT_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(STORE_OBJECT, (st), (cmp)) +#define sk_STORE_OBJECT_dup(st) SKM_sk_dup(STORE_OBJECT, st) +#define sk_STORE_OBJECT_pop_free(st, free_func) SKM_sk_pop_free(STORE_OBJECT, (st), (free_func)) +#define sk_STORE_OBJECT_shift(st) SKM_sk_shift(STORE_OBJECT, (st)) +#define sk_STORE_OBJECT_pop(st) SKM_sk_pop(STORE_OBJECT, (st)) +#define sk_STORE_OBJECT_sort(st) SKM_sk_sort(STORE_OBJECT, (st)) +#define sk_STORE_OBJECT_is_sorted(st) SKM_sk_is_sorted(STORE_OBJECT, (st)) + +#define sk_SXNETID_new(cmp) SKM_sk_new(SXNETID, (cmp)) +#define sk_SXNETID_new_null() SKM_sk_new_null(SXNETID) +#define sk_SXNETID_free(st) SKM_sk_free(SXNETID, (st)) +#define sk_SXNETID_num(st) SKM_sk_num(SXNETID, (st)) +#define sk_SXNETID_value(st, i) SKM_sk_value(SXNETID, (st), (i)) +#define sk_SXNETID_set(st, i, val) SKM_sk_set(SXNETID, (st), (i), (val)) +#define sk_SXNETID_zero(st) SKM_sk_zero(SXNETID, (st)) +#define sk_SXNETID_push(st, val) SKM_sk_push(SXNETID, (st), (val)) +#define sk_SXNETID_unshift(st, val) SKM_sk_unshift(SXNETID, (st), (val)) +#define sk_SXNETID_find(st, val) SKM_sk_find(SXNETID, (st), (val)) +#define sk_SXNETID_find_ex(st, val) SKM_sk_find_ex(SXNETID, (st), (val)) +#define sk_SXNETID_delete(st, i) SKM_sk_delete(SXNETID, (st), (i)) +#define sk_SXNETID_delete_ptr(st, ptr) SKM_sk_delete_ptr(SXNETID, (st), (ptr)) +#define sk_SXNETID_insert(st, val, i) SKM_sk_insert(SXNETID, (st), (val), (i)) +#define sk_SXNETID_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(SXNETID, (st), (cmp)) +#define sk_SXNETID_dup(st) SKM_sk_dup(SXNETID, st) +#define sk_SXNETID_pop_free(st, free_func) SKM_sk_pop_free(SXNETID, (st), (free_func)) +#define sk_SXNETID_shift(st) SKM_sk_shift(SXNETID, (st)) +#define sk_SXNETID_pop(st) SKM_sk_pop(SXNETID, (st)) +#define sk_SXNETID_sort(st) SKM_sk_sort(SXNETID, (st)) +#define sk_SXNETID_is_sorted(st) SKM_sk_is_sorted(SXNETID, (st)) + +#define sk_UI_STRING_new(cmp) SKM_sk_new(UI_STRING, (cmp)) +#define sk_UI_STRING_new_null() SKM_sk_new_null(UI_STRING) +#define sk_UI_STRING_free(st) SKM_sk_free(UI_STRING, (st)) +#define sk_UI_STRING_num(st) SKM_sk_num(UI_STRING, (st)) +#define sk_UI_STRING_value(st, i) SKM_sk_value(UI_STRING, (st), (i)) +#define sk_UI_STRING_set(st, i, val) SKM_sk_set(UI_STRING, (st), (i), (val)) +#define sk_UI_STRING_zero(st) SKM_sk_zero(UI_STRING, (st)) +#define sk_UI_STRING_push(st, val) SKM_sk_push(UI_STRING, (st), (val)) +#define sk_UI_STRING_unshift(st, val) SKM_sk_unshift(UI_STRING, (st), (val)) +#define sk_UI_STRING_find(st, val) SKM_sk_find(UI_STRING, (st), (val)) +#define sk_UI_STRING_find_ex(st, val) SKM_sk_find_ex(UI_STRING, (st), (val)) +#define sk_UI_STRING_delete(st, i) SKM_sk_delete(UI_STRING, (st), (i)) +#define sk_UI_STRING_delete_ptr(st, ptr) SKM_sk_delete_ptr(UI_STRING, (st), (ptr)) +#define sk_UI_STRING_insert(st, val, i) SKM_sk_insert(UI_STRING, (st), (val), (i)) +#define sk_UI_STRING_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(UI_STRING, (st), (cmp)) +#define sk_UI_STRING_dup(st) SKM_sk_dup(UI_STRING, st) +#define sk_UI_STRING_pop_free(st, free_func) SKM_sk_pop_free(UI_STRING, (st), (free_func)) +#define sk_UI_STRING_shift(st) SKM_sk_shift(UI_STRING, (st)) +#define sk_UI_STRING_pop(st) SKM_sk_pop(UI_STRING, (st)) +#define sk_UI_STRING_sort(st) SKM_sk_sort(UI_STRING, (st)) +#define sk_UI_STRING_is_sorted(st) SKM_sk_is_sorted(UI_STRING, (st)) + +#define sk_X509_new(cmp) SKM_sk_new(X509, (cmp)) +#define sk_X509_new_null() SKM_sk_new_null(X509) +#define sk_X509_free(st) SKM_sk_free(X509, (st)) +#define sk_X509_num(st) SKM_sk_num(X509, (st)) +#define sk_X509_value(st, i) SKM_sk_value(X509, (st), (i)) +#define sk_X509_set(st, i, val) SKM_sk_set(X509, (st), (i), (val)) +#define sk_X509_zero(st) SKM_sk_zero(X509, (st)) +#define sk_X509_push(st, val) SKM_sk_push(X509, (st), (val)) +#define sk_X509_unshift(st, val) SKM_sk_unshift(X509, (st), (val)) +#define sk_X509_find(st, val) SKM_sk_find(X509, (st), (val)) +#define sk_X509_find_ex(st, val) SKM_sk_find_ex(X509, (st), (val)) +#define sk_X509_delete(st, i) SKM_sk_delete(X509, (st), (i)) +#define sk_X509_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509, (st), (ptr)) +#define sk_X509_insert(st, val, i) SKM_sk_insert(X509, (st), (val), (i)) +#define sk_X509_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509, (st), (cmp)) +#define sk_X509_dup(st) SKM_sk_dup(X509, st) +#define sk_X509_pop_free(st, free_func) SKM_sk_pop_free(X509, (st), (free_func)) +#define sk_X509_shift(st) SKM_sk_shift(X509, (st)) +#define sk_X509_pop(st) SKM_sk_pop(X509, (st)) +#define sk_X509_sort(st) SKM_sk_sort(X509, (st)) +#define sk_X509_is_sorted(st) SKM_sk_is_sorted(X509, (st)) + +#define sk_X509V3_EXT_METHOD_new(cmp) SKM_sk_new(X509V3_EXT_METHOD, (cmp)) +#define sk_X509V3_EXT_METHOD_new_null() SKM_sk_new_null(X509V3_EXT_METHOD) +#define sk_X509V3_EXT_METHOD_free(st) SKM_sk_free(X509V3_EXT_METHOD, (st)) +#define sk_X509V3_EXT_METHOD_num(st) SKM_sk_num(X509V3_EXT_METHOD, (st)) +#define sk_X509V3_EXT_METHOD_value(st, i) SKM_sk_value(X509V3_EXT_METHOD, (st), (i)) +#define sk_X509V3_EXT_METHOD_set(st, i, val) SKM_sk_set(X509V3_EXT_METHOD, (st), (i), (val)) +#define sk_X509V3_EXT_METHOD_zero(st) SKM_sk_zero(X509V3_EXT_METHOD, (st)) +#define sk_X509V3_EXT_METHOD_push(st, val) SKM_sk_push(X509V3_EXT_METHOD, (st), (val)) +#define sk_X509V3_EXT_METHOD_unshift(st, val) SKM_sk_unshift(X509V3_EXT_METHOD, (st), (val)) +#define sk_X509V3_EXT_METHOD_find(st, val) SKM_sk_find(X509V3_EXT_METHOD, (st), (val)) +#define sk_X509V3_EXT_METHOD_find_ex(st, val) SKM_sk_find_ex(X509V3_EXT_METHOD, (st), (val)) +#define sk_X509V3_EXT_METHOD_delete(st, i) SKM_sk_delete(X509V3_EXT_METHOD, (st), (i)) +#define sk_X509V3_EXT_METHOD_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509V3_EXT_METHOD, (st), (ptr)) +#define sk_X509V3_EXT_METHOD_insert(st, val, i) SKM_sk_insert(X509V3_EXT_METHOD, (st), (val), (i)) +#define sk_X509V3_EXT_METHOD_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509V3_EXT_METHOD, (st), (cmp)) +#define sk_X509V3_EXT_METHOD_dup(st) SKM_sk_dup(X509V3_EXT_METHOD, st) +#define sk_X509V3_EXT_METHOD_pop_free(st, free_func) SKM_sk_pop_free(X509V3_EXT_METHOD, (st), (free_func)) +#define sk_X509V3_EXT_METHOD_shift(st) SKM_sk_shift(X509V3_EXT_METHOD, (st)) +#define sk_X509V3_EXT_METHOD_pop(st) SKM_sk_pop(X509V3_EXT_METHOD, (st)) +#define sk_X509V3_EXT_METHOD_sort(st) SKM_sk_sort(X509V3_EXT_METHOD, (st)) +#define sk_X509V3_EXT_METHOD_is_sorted(st) SKM_sk_is_sorted(X509V3_EXT_METHOD, (st)) + +#define sk_X509_ALGOR_new(cmp) SKM_sk_new(X509_ALGOR, (cmp)) +#define sk_X509_ALGOR_new_null() SKM_sk_new_null(X509_ALGOR) +#define sk_X509_ALGOR_free(st) SKM_sk_free(X509_ALGOR, (st)) +#define sk_X509_ALGOR_num(st) SKM_sk_num(X509_ALGOR, (st)) +#define sk_X509_ALGOR_value(st, i) SKM_sk_value(X509_ALGOR, (st), (i)) +#define sk_X509_ALGOR_set(st, i, val) SKM_sk_set(X509_ALGOR, (st), (i), (val)) +#define sk_X509_ALGOR_zero(st) SKM_sk_zero(X509_ALGOR, (st)) +#define sk_X509_ALGOR_push(st, val) SKM_sk_push(X509_ALGOR, (st), (val)) +#define sk_X509_ALGOR_unshift(st, val) SKM_sk_unshift(X509_ALGOR, (st), (val)) +#define sk_X509_ALGOR_find(st, val) SKM_sk_find(X509_ALGOR, (st), (val)) +#define sk_X509_ALGOR_find_ex(st, val) SKM_sk_find_ex(X509_ALGOR, (st), (val)) +#define sk_X509_ALGOR_delete(st, i) SKM_sk_delete(X509_ALGOR, (st), (i)) +#define sk_X509_ALGOR_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_ALGOR, (st), (ptr)) +#define sk_X509_ALGOR_insert(st, val, i) SKM_sk_insert(X509_ALGOR, (st), (val), (i)) +#define sk_X509_ALGOR_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_ALGOR, (st), (cmp)) +#define sk_X509_ALGOR_dup(st) SKM_sk_dup(X509_ALGOR, st) +#define sk_X509_ALGOR_pop_free(st, free_func) SKM_sk_pop_free(X509_ALGOR, (st), (free_func)) +#define sk_X509_ALGOR_shift(st) SKM_sk_shift(X509_ALGOR, (st)) +#define sk_X509_ALGOR_pop(st) SKM_sk_pop(X509_ALGOR, (st)) +#define sk_X509_ALGOR_sort(st) SKM_sk_sort(X509_ALGOR, (st)) +#define sk_X509_ALGOR_is_sorted(st) SKM_sk_is_sorted(X509_ALGOR, (st)) + +#define sk_X509_ATTRIBUTE_new(cmp) SKM_sk_new(X509_ATTRIBUTE, (cmp)) +#define sk_X509_ATTRIBUTE_new_null() SKM_sk_new_null(X509_ATTRIBUTE) +#define sk_X509_ATTRIBUTE_free(st) SKM_sk_free(X509_ATTRIBUTE, (st)) +#define sk_X509_ATTRIBUTE_num(st) SKM_sk_num(X509_ATTRIBUTE, (st)) +#define sk_X509_ATTRIBUTE_value(st, i) SKM_sk_value(X509_ATTRIBUTE, (st), (i)) +#define sk_X509_ATTRIBUTE_set(st, i, val) SKM_sk_set(X509_ATTRIBUTE, (st), (i), (val)) +#define sk_X509_ATTRIBUTE_zero(st) SKM_sk_zero(X509_ATTRIBUTE, (st)) +#define sk_X509_ATTRIBUTE_push(st, val) SKM_sk_push(X509_ATTRIBUTE, (st), (val)) +#define sk_X509_ATTRIBUTE_unshift(st, val) SKM_sk_unshift(X509_ATTRIBUTE, (st), (val)) +#define sk_X509_ATTRIBUTE_find(st, val) SKM_sk_find(X509_ATTRIBUTE, (st), (val)) +#define sk_X509_ATTRIBUTE_find_ex(st, val) SKM_sk_find_ex(X509_ATTRIBUTE, (st), (val)) +#define sk_X509_ATTRIBUTE_delete(st, i) SKM_sk_delete(X509_ATTRIBUTE, (st), (i)) +#define sk_X509_ATTRIBUTE_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_ATTRIBUTE, (st), (ptr)) +#define sk_X509_ATTRIBUTE_insert(st, val, i) SKM_sk_insert(X509_ATTRIBUTE, (st), (val), (i)) +#define sk_X509_ATTRIBUTE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_ATTRIBUTE, (st), (cmp)) +#define sk_X509_ATTRIBUTE_dup(st) SKM_sk_dup(X509_ATTRIBUTE, st) +#define sk_X509_ATTRIBUTE_pop_free(st, free_func) SKM_sk_pop_free(X509_ATTRIBUTE, (st), (free_func)) +#define sk_X509_ATTRIBUTE_shift(st) SKM_sk_shift(X509_ATTRIBUTE, (st)) +#define sk_X509_ATTRIBUTE_pop(st) SKM_sk_pop(X509_ATTRIBUTE, (st)) +#define sk_X509_ATTRIBUTE_sort(st) SKM_sk_sort(X509_ATTRIBUTE, (st)) +#define sk_X509_ATTRIBUTE_is_sorted(st) SKM_sk_is_sorted(X509_ATTRIBUTE, (st)) + +#define sk_X509_CRL_new(cmp) SKM_sk_new(X509_CRL, (cmp)) +#define sk_X509_CRL_new_null() SKM_sk_new_null(X509_CRL) +#define sk_X509_CRL_free(st) SKM_sk_free(X509_CRL, (st)) +#define sk_X509_CRL_num(st) SKM_sk_num(X509_CRL, (st)) +#define sk_X509_CRL_value(st, i) SKM_sk_value(X509_CRL, (st), (i)) +#define sk_X509_CRL_set(st, i, val) SKM_sk_set(X509_CRL, (st), (i), (val)) +#define sk_X509_CRL_zero(st) SKM_sk_zero(X509_CRL, (st)) +#define sk_X509_CRL_push(st, val) SKM_sk_push(X509_CRL, (st), (val)) +#define sk_X509_CRL_unshift(st, val) SKM_sk_unshift(X509_CRL, (st), (val)) +#define sk_X509_CRL_find(st, val) SKM_sk_find(X509_CRL, (st), (val)) +#define sk_X509_CRL_find_ex(st, val) SKM_sk_find_ex(X509_CRL, (st), (val)) +#define sk_X509_CRL_delete(st, i) SKM_sk_delete(X509_CRL, (st), (i)) +#define sk_X509_CRL_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_CRL, (st), (ptr)) +#define sk_X509_CRL_insert(st, val, i) SKM_sk_insert(X509_CRL, (st), (val), (i)) +#define sk_X509_CRL_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_CRL, (st), (cmp)) +#define sk_X509_CRL_dup(st) SKM_sk_dup(X509_CRL, st) +#define sk_X509_CRL_pop_free(st, free_func) SKM_sk_pop_free(X509_CRL, (st), (free_func)) +#define sk_X509_CRL_shift(st) SKM_sk_shift(X509_CRL, (st)) +#define sk_X509_CRL_pop(st) SKM_sk_pop(X509_CRL, (st)) +#define sk_X509_CRL_sort(st) SKM_sk_sort(X509_CRL, (st)) +#define sk_X509_CRL_is_sorted(st) SKM_sk_is_sorted(X509_CRL, (st)) + +#define sk_X509_EXTENSION_new(cmp) SKM_sk_new(X509_EXTENSION, (cmp)) +#define sk_X509_EXTENSION_new_null() SKM_sk_new_null(X509_EXTENSION) +#define sk_X509_EXTENSION_free(st) SKM_sk_free(X509_EXTENSION, (st)) +#define sk_X509_EXTENSION_num(st) SKM_sk_num(X509_EXTENSION, (st)) +#define sk_X509_EXTENSION_value(st, i) SKM_sk_value(X509_EXTENSION, (st), (i)) +#define sk_X509_EXTENSION_set(st, i, val) SKM_sk_set(X509_EXTENSION, (st), (i), (val)) +#define sk_X509_EXTENSION_zero(st) SKM_sk_zero(X509_EXTENSION, (st)) +#define sk_X509_EXTENSION_push(st, val) SKM_sk_push(X509_EXTENSION, (st), (val)) +#define sk_X509_EXTENSION_unshift(st, val) SKM_sk_unshift(X509_EXTENSION, (st), (val)) +#define sk_X509_EXTENSION_find(st, val) SKM_sk_find(X509_EXTENSION, (st), (val)) +#define sk_X509_EXTENSION_find_ex(st, val) SKM_sk_find_ex(X509_EXTENSION, (st), (val)) +#define sk_X509_EXTENSION_delete(st, i) SKM_sk_delete(X509_EXTENSION, (st), (i)) +#define sk_X509_EXTENSION_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_EXTENSION, (st), (ptr)) +#define sk_X509_EXTENSION_insert(st, val, i) SKM_sk_insert(X509_EXTENSION, (st), (val), (i)) +#define sk_X509_EXTENSION_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_EXTENSION, (st), (cmp)) +#define sk_X509_EXTENSION_dup(st) SKM_sk_dup(X509_EXTENSION, st) +#define sk_X509_EXTENSION_pop_free(st, free_func) SKM_sk_pop_free(X509_EXTENSION, (st), (free_func)) +#define sk_X509_EXTENSION_shift(st) SKM_sk_shift(X509_EXTENSION, (st)) +#define sk_X509_EXTENSION_pop(st) SKM_sk_pop(X509_EXTENSION, (st)) +#define sk_X509_EXTENSION_sort(st) SKM_sk_sort(X509_EXTENSION, (st)) +#define sk_X509_EXTENSION_is_sorted(st) SKM_sk_is_sorted(X509_EXTENSION, (st)) + +#define sk_X509_INFO_new(cmp) SKM_sk_new(X509_INFO, (cmp)) +#define sk_X509_INFO_new_null() SKM_sk_new_null(X509_INFO) +#define sk_X509_INFO_free(st) SKM_sk_free(X509_INFO, (st)) +#define sk_X509_INFO_num(st) SKM_sk_num(X509_INFO, (st)) +#define sk_X509_INFO_value(st, i) SKM_sk_value(X509_INFO, (st), (i)) +#define sk_X509_INFO_set(st, i, val) SKM_sk_set(X509_INFO, (st), (i), (val)) +#define sk_X509_INFO_zero(st) SKM_sk_zero(X509_INFO, (st)) +#define sk_X509_INFO_push(st, val) SKM_sk_push(X509_INFO, (st), (val)) +#define sk_X509_INFO_unshift(st, val) SKM_sk_unshift(X509_INFO, (st), (val)) +#define sk_X509_INFO_find(st, val) SKM_sk_find(X509_INFO, (st), (val)) +#define sk_X509_INFO_find_ex(st, val) SKM_sk_find_ex(X509_INFO, (st), (val)) +#define sk_X509_INFO_delete(st, i) SKM_sk_delete(X509_INFO, (st), (i)) +#define sk_X509_INFO_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_INFO, (st), (ptr)) +#define sk_X509_INFO_insert(st, val, i) SKM_sk_insert(X509_INFO, (st), (val), (i)) +#define sk_X509_INFO_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_INFO, (st), (cmp)) +#define sk_X509_INFO_dup(st) SKM_sk_dup(X509_INFO, st) +#define sk_X509_INFO_pop_free(st, free_func) SKM_sk_pop_free(X509_INFO, (st), (free_func)) +#define sk_X509_INFO_shift(st) SKM_sk_shift(X509_INFO, (st)) +#define sk_X509_INFO_pop(st) SKM_sk_pop(X509_INFO, (st)) +#define sk_X509_INFO_sort(st) SKM_sk_sort(X509_INFO, (st)) +#define sk_X509_INFO_is_sorted(st) SKM_sk_is_sorted(X509_INFO, (st)) + +#define sk_X509_LOOKUP_new(cmp) SKM_sk_new(X509_LOOKUP, (cmp)) +#define sk_X509_LOOKUP_new_null() SKM_sk_new_null(X509_LOOKUP) +#define sk_X509_LOOKUP_free(st) SKM_sk_free(X509_LOOKUP, (st)) +#define sk_X509_LOOKUP_num(st) SKM_sk_num(X509_LOOKUP, (st)) +#define sk_X509_LOOKUP_value(st, i) SKM_sk_value(X509_LOOKUP, (st), (i)) +#define sk_X509_LOOKUP_set(st, i, val) SKM_sk_set(X509_LOOKUP, (st), (i), (val)) +#define sk_X509_LOOKUP_zero(st) SKM_sk_zero(X509_LOOKUP, (st)) +#define sk_X509_LOOKUP_push(st, val) SKM_sk_push(X509_LOOKUP, (st), (val)) +#define sk_X509_LOOKUP_unshift(st, val) SKM_sk_unshift(X509_LOOKUP, (st), (val)) +#define sk_X509_LOOKUP_find(st, val) SKM_sk_find(X509_LOOKUP, (st), (val)) +#define sk_X509_LOOKUP_find_ex(st, val) SKM_sk_find_ex(X509_LOOKUP, (st), (val)) +#define sk_X509_LOOKUP_delete(st, i) SKM_sk_delete(X509_LOOKUP, (st), (i)) +#define sk_X509_LOOKUP_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_LOOKUP, (st), (ptr)) +#define sk_X509_LOOKUP_insert(st, val, i) SKM_sk_insert(X509_LOOKUP, (st), (val), (i)) +#define sk_X509_LOOKUP_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_LOOKUP, (st), (cmp)) +#define sk_X509_LOOKUP_dup(st) SKM_sk_dup(X509_LOOKUP, st) +#define sk_X509_LOOKUP_pop_free(st, free_func) SKM_sk_pop_free(X509_LOOKUP, (st), (free_func)) +#define sk_X509_LOOKUP_shift(st) SKM_sk_shift(X509_LOOKUP, (st)) +#define sk_X509_LOOKUP_pop(st) SKM_sk_pop(X509_LOOKUP, (st)) +#define sk_X509_LOOKUP_sort(st) SKM_sk_sort(X509_LOOKUP, (st)) +#define sk_X509_LOOKUP_is_sorted(st) SKM_sk_is_sorted(X509_LOOKUP, (st)) + +#define sk_X509_NAME_new(cmp) SKM_sk_new(X509_NAME, (cmp)) +#define sk_X509_NAME_new_null() SKM_sk_new_null(X509_NAME) +#define sk_X509_NAME_free(st) SKM_sk_free(X509_NAME, (st)) +#define sk_X509_NAME_num(st) SKM_sk_num(X509_NAME, (st)) +#define sk_X509_NAME_value(st, i) SKM_sk_value(X509_NAME, (st), (i)) +#define sk_X509_NAME_set(st, i, val) SKM_sk_set(X509_NAME, (st), (i), (val)) +#define sk_X509_NAME_zero(st) SKM_sk_zero(X509_NAME, (st)) +#define sk_X509_NAME_push(st, val) SKM_sk_push(X509_NAME, (st), (val)) +#define sk_X509_NAME_unshift(st, val) SKM_sk_unshift(X509_NAME, (st), (val)) +#define sk_X509_NAME_find(st, val) SKM_sk_find(X509_NAME, (st), (val)) +#define sk_X509_NAME_find_ex(st, val) SKM_sk_find_ex(X509_NAME, (st), (val)) +#define sk_X509_NAME_delete(st, i) SKM_sk_delete(X509_NAME, (st), (i)) +#define sk_X509_NAME_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_NAME, (st), (ptr)) +#define sk_X509_NAME_insert(st, val, i) SKM_sk_insert(X509_NAME, (st), (val), (i)) +#define sk_X509_NAME_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_NAME, (st), (cmp)) +#define sk_X509_NAME_dup(st) SKM_sk_dup(X509_NAME, st) +#define sk_X509_NAME_pop_free(st, free_func) SKM_sk_pop_free(X509_NAME, (st), (free_func)) +#define sk_X509_NAME_shift(st) SKM_sk_shift(X509_NAME, (st)) +#define sk_X509_NAME_pop(st) SKM_sk_pop(X509_NAME, (st)) +#define sk_X509_NAME_sort(st) SKM_sk_sort(X509_NAME, (st)) +#define sk_X509_NAME_is_sorted(st) SKM_sk_is_sorted(X509_NAME, (st)) + +#define sk_X509_NAME_ENTRY_new(cmp) SKM_sk_new(X509_NAME_ENTRY, (cmp)) +#define sk_X509_NAME_ENTRY_new_null() SKM_sk_new_null(X509_NAME_ENTRY) +#define sk_X509_NAME_ENTRY_free(st) SKM_sk_free(X509_NAME_ENTRY, (st)) +#define sk_X509_NAME_ENTRY_num(st) SKM_sk_num(X509_NAME_ENTRY, (st)) +#define sk_X509_NAME_ENTRY_value(st, i) SKM_sk_value(X509_NAME_ENTRY, (st), (i)) +#define sk_X509_NAME_ENTRY_set(st, i, val) SKM_sk_set(X509_NAME_ENTRY, (st), (i), (val)) +#define sk_X509_NAME_ENTRY_zero(st) SKM_sk_zero(X509_NAME_ENTRY, (st)) +#define sk_X509_NAME_ENTRY_push(st, val) SKM_sk_push(X509_NAME_ENTRY, (st), (val)) +#define sk_X509_NAME_ENTRY_unshift(st, val) SKM_sk_unshift(X509_NAME_ENTRY, (st), (val)) +#define sk_X509_NAME_ENTRY_find(st, val) SKM_sk_find(X509_NAME_ENTRY, (st), (val)) +#define sk_X509_NAME_ENTRY_find_ex(st, val) SKM_sk_find_ex(X509_NAME_ENTRY, (st), (val)) +#define sk_X509_NAME_ENTRY_delete(st, i) SKM_sk_delete(X509_NAME_ENTRY, (st), (i)) +#define sk_X509_NAME_ENTRY_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_NAME_ENTRY, (st), (ptr)) +#define sk_X509_NAME_ENTRY_insert(st, val, i) SKM_sk_insert(X509_NAME_ENTRY, (st), (val), (i)) +#define sk_X509_NAME_ENTRY_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_NAME_ENTRY, (st), (cmp)) +#define sk_X509_NAME_ENTRY_dup(st) SKM_sk_dup(X509_NAME_ENTRY, st) +#define sk_X509_NAME_ENTRY_pop_free(st, free_func) SKM_sk_pop_free(X509_NAME_ENTRY, (st), (free_func)) +#define sk_X509_NAME_ENTRY_shift(st) SKM_sk_shift(X509_NAME_ENTRY, (st)) +#define sk_X509_NAME_ENTRY_pop(st) SKM_sk_pop(X509_NAME_ENTRY, (st)) +#define sk_X509_NAME_ENTRY_sort(st) SKM_sk_sort(X509_NAME_ENTRY, (st)) +#define sk_X509_NAME_ENTRY_is_sorted(st) SKM_sk_is_sorted(X509_NAME_ENTRY, (st)) + +#define sk_X509_OBJECT_new(cmp) SKM_sk_new(X509_OBJECT, (cmp)) +#define sk_X509_OBJECT_new_null() SKM_sk_new_null(X509_OBJECT) +#define sk_X509_OBJECT_free(st) SKM_sk_free(X509_OBJECT, (st)) +#define sk_X509_OBJECT_num(st) SKM_sk_num(X509_OBJECT, (st)) +#define sk_X509_OBJECT_value(st, i) SKM_sk_value(X509_OBJECT, (st), (i)) +#define sk_X509_OBJECT_set(st, i, val) SKM_sk_set(X509_OBJECT, (st), (i), (val)) +#define sk_X509_OBJECT_zero(st) SKM_sk_zero(X509_OBJECT, (st)) +#define sk_X509_OBJECT_push(st, val) SKM_sk_push(X509_OBJECT, (st), (val)) +#define sk_X509_OBJECT_unshift(st, val) SKM_sk_unshift(X509_OBJECT, (st), (val)) +#define sk_X509_OBJECT_find(st, val) SKM_sk_find(X509_OBJECT, (st), (val)) +#define sk_X509_OBJECT_find_ex(st, val) SKM_sk_find_ex(X509_OBJECT, (st), (val)) +#define sk_X509_OBJECT_delete(st, i) SKM_sk_delete(X509_OBJECT, (st), (i)) +#define sk_X509_OBJECT_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_OBJECT, (st), (ptr)) +#define sk_X509_OBJECT_insert(st, val, i) SKM_sk_insert(X509_OBJECT, (st), (val), (i)) +#define sk_X509_OBJECT_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_OBJECT, (st), (cmp)) +#define sk_X509_OBJECT_dup(st) SKM_sk_dup(X509_OBJECT, st) +#define sk_X509_OBJECT_pop_free(st, free_func) SKM_sk_pop_free(X509_OBJECT, (st), (free_func)) +#define sk_X509_OBJECT_shift(st) SKM_sk_shift(X509_OBJECT, (st)) +#define sk_X509_OBJECT_pop(st) SKM_sk_pop(X509_OBJECT, (st)) +#define sk_X509_OBJECT_sort(st) SKM_sk_sort(X509_OBJECT, (st)) +#define sk_X509_OBJECT_is_sorted(st) SKM_sk_is_sorted(X509_OBJECT, (st)) + +#define sk_X509_POLICY_DATA_new(cmp) SKM_sk_new(X509_POLICY_DATA, (cmp)) +#define sk_X509_POLICY_DATA_new_null() SKM_sk_new_null(X509_POLICY_DATA) +#define sk_X509_POLICY_DATA_free(st) SKM_sk_free(X509_POLICY_DATA, (st)) +#define sk_X509_POLICY_DATA_num(st) SKM_sk_num(X509_POLICY_DATA, (st)) +#define sk_X509_POLICY_DATA_value(st, i) SKM_sk_value(X509_POLICY_DATA, (st), (i)) +#define sk_X509_POLICY_DATA_set(st, i, val) SKM_sk_set(X509_POLICY_DATA, (st), (i), (val)) +#define sk_X509_POLICY_DATA_zero(st) SKM_sk_zero(X509_POLICY_DATA, (st)) +#define sk_X509_POLICY_DATA_push(st, val) SKM_sk_push(X509_POLICY_DATA, (st), (val)) +#define sk_X509_POLICY_DATA_unshift(st, val) SKM_sk_unshift(X509_POLICY_DATA, (st), (val)) +#define sk_X509_POLICY_DATA_find(st, val) SKM_sk_find(X509_POLICY_DATA, (st), (val)) +#define sk_X509_POLICY_DATA_find_ex(st, val) SKM_sk_find_ex(X509_POLICY_DATA, (st), (val)) +#define sk_X509_POLICY_DATA_delete(st, i) SKM_sk_delete(X509_POLICY_DATA, (st), (i)) +#define sk_X509_POLICY_DATA_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_POLICY_DATA, (st), (ptr)) +#define sk_X509_POLICY_DATA_insert(st, val, i) SKM_sk_insert(X509_POLICY_DATA, (st), (val), (i)) +#define sk_X509_POLICY_DATA_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_POLICY_DATA, (st), (cmp)) +#define sk_X509_POLICY_DATA_dup(st) SKM_sk_dup(X509_POLICY_DATA, st) +#define sk_X509_POLICY_DATA_pop_free(st, free_func) SKM_sk_pop_free(X509_POLICY_DATA, (st), (free_func)) +#define sk_X509_POLICY_DATA_shift(st) SKM_sk_shift(X509_POLICY_DATA, (st)) +#define sk_X509_POLICY_DATA_pop(st) SKM_sk_pop(X509_POLICY_DATA, (st)) +#define sk_X509_POLICY_DATA_sort(st) SKM_sk_sort(X509_POLICY_DATA, (st)) +#define sk_X509_POLICY_DATA_is_sorted(st) SKM_sk_is_sorted(X509_POLICY_DATA, (st)) + +#define sk_X509_POLICY_NODE_new(cmp) SKM_sk_new(X509_POLICY_NODE, (cmp)) +#define sk_X509_POLICY_NODE_new_null() SKM_sk_new_null(X509_POLICY_NODE) +#define sk_X509_POLICY_NODE_free(st) SKM_sk_free(X509_POLICY_NODE, (st)) +#define sk_X509_POLICY_NODE_num(st) SKM_sk_num(X509_POLICY_NODE, (st)) +#define sk_X509_POLICY_NODE_value(st, i) SKM_sk_value(X509_POLICY_NODE, (st), (i)) +#define sk_X509_POLICY_NODE_set(st, i, val) SKM_sk_set(X509_POLICY_NODE, (st), (i), (val)) +#define sk_X509_POLICY_NODE_zero(st) SKM_sk_zero(X509_POLICY_NODE, (st)) +#define sk_X509_POLICY_NODE_push(st, val) SKM_sk_push(X509_POLICY_NODE, (st), (val)) +#define sk_X509_POLICY_NODE_unshift(st, val) SKM_sk_unshift(X509_POLICY_NODE, (st), (val)) +#define sk_X509_POLICY_NODE_find(st, val) SKM_sk_find(X509_POLICY_NODE, (st), (val)) +#define sk_X509_POLICY_NODE_find_ex(st, val) SKM_sk_find_ex(X509_POLICY_NODE, (st), (val)) +#define sk_X509_POLICY_NODE_delete(st, i) SKM_sk_delete(X509_POLICY_NODE, (st), (i)) +#define sk_X509_POLICY_NODE_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_POLICY_NODE, (st), (ptr)) +#define sk_X509_POLICY_NODE_insert(st, val, i) SKM_sk_insert(X509_POLICY_NODE, (st), (val), (i)) +#define sk_X509_POLICY_NODE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_POLICY_NODE, (st), (cmp)) +#define sk_X509_POLICY_NODE_dup(st) SKM_sk_dup(X509_POLICY_NODE, st) +#define sk_X509_POLICY_NODE_pop_free(st, free_func) SKM_sk_pop_free(X509_POLICY_NODE, (st), (free_func)) +#define sk_X509_POLICY_NODE_shift(st) SKM_sk_shift(X509_POLICY_NODE, (st)) +#define sk_X509_POLICY_NODE_pop(st) SKM_sk_pop(X509_POLICY_NODE, (st)) +#define sk_X509_POLICY_NODE_sort(st) SKM_sk_sort(X509_POLICY_NODE, (st)) +#define sk_X509_POLICY_NODE_is_sorted(st) SKM_sk_is_sorted(X509_POLICY_NODE, (st)) + +#define sk_X509_PURPOSE_new(cmp) SKM_sk_new(X509_PURPOSE, (cmp)) +#define sk_X509_PURPOSE_new_null() SKM_sk_new_null(X509_PURPOSE) +#define sk_X509_PURPOSE_free(st) SKM_sk_free(X509_PURPOSE, (st)) +#define sk_X509_PURPOSE_num(st) SKM_sk_num(X509_PURPOSE, (st)) +#define sk_X509_PURPOSE_value(st, i) SKM_sk_value(X509_PURPOSE, (st), (i)) +#define sk_X509_PURPOSE_set(st, i, val) SKM_sk_set(X509_PURPOSE, (st), (i), (val)) +#define sk_X509_PURPOSE_zero(st) SKM_sk_zero(X509_PURPOSE, (st)) +#define sk_X509_PURPOSE_push(st, val) SKM_sk_push(X509_PURPOSE, (st), (val)) +#define sk_X509_PURPOSE_unshift(st, val) SKM_sk_unshift(X509_PURPOSE, (st), (val)) +#define sk_X509_PURPOSE_find(st, val) SKM_sk_find(X509_PURPOSE, (st), (val)) +#define sk_X509_PURPOSE_find_ex(st, val) SKM_sk_find_ex(X509_PURPOSE, (st), (val)) +#define sk_X509_PURPOSE_delete(st, i) SKM_sk_delete(X509_PURPOSE, (st), (i)) +#define sk_X509_PURPOSE_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_PURPOSE, (st), (ptr)) +#define sk_X509_PURPOSE_insert(st, val, i) SKM_sk_insert(X509_PURPOSE, (st), (val), (i)) +#define sk_X509_PURPOSE_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_PURPOSE, (st), (cmp)) +#define sk_X509_PURPOSE_dup(st) SKM_sk_dup(X509_PURPOSE, st) +#define sk_X509_PURPOSE_pop_free(st, free_func) SKM_sk_pop_free(X509_PURPOSE, (st), (free_func)) +#define sk_X509_PURPOSE_shift(st) SKM_sk_shift(X509_PURPOSE, (st)) +#define sk_X509_PURPOSE_pop(st) SKM_sk_pop(X509_PURPOSE, (st)) +#define sk_X509_PURPOSE_sort(st) SKM_sk_sort(X509_PURPOSE, (st)) +#define sk_X509_PURPOSE_is_sorted(st) SKM_sk_is_sorted(X509_PURPOSE, (st)) + +#define sk_X509_REVOKED_new(cmp) SKM_sk_new(X509_REVOKED, (cmp)) +#define sk_X509_REVOKED_new_null() SKM_sk_new_null(X509_REVOKED) +#define sk_X509_REVOKED_free(st) SKM_sk_free(X509_REVOKED, (st)) +#define sk_X509_REVOKED_num(st) SKM_sk_num(X509_REVOKED, (st)) +#define sk_X509_REVOKED_value(st, i) SKM_sk_value(X509_REVOKED, (st), (i)) +#define sk_X509_REVOKED_set(st, i, val) SKM_sk_set(X509_REVOKED, (st), (i), (val)) +#define sk_X509_REVOKED_zero(st) SKM_sk_zero(X509_REVOKED, (st)) +#define sk_X509_REVOKED_push(st, val) SKM_sk_push(X509_REVOKED, (st), (val)) +#define sk_X509_REVOKED_unshift(st, val) SKM_sk_unshift(X509_REVOKED, (st), (val)) +#define sk_X509_REVOKED_find(st, val) SKM_sk_find(X509_REVOKED, (st), (val)) +#define sk_X509_REVOKED_find_ex(st, val) SKM_sk_find_ex(X509_REVOKED, (st), (val)) +#define sk_X509_REVOKED_delete(st, i) SKM_sk_delete(X509_REVOKED, (st), (i)) +#define sk_X509_REVOKED_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_REVOKED, (st), (ptr)) +#define sk_X509_REVOKED_insert(st, val, i) SKM_sk_insert(X509_REVOKED, (st), (val), (i)) +#define sk_X509_REVOKED_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_REVOKED, (st), (cmp)) +#define sk_X509_REVOKED_dup(st) SKM_sk_dup(X509_REVOKED, st) +#define sk_X509_REVOKED_pop_free(st, free_func) SKM_sk_pop_free(X509_REVOKED, (st), (free_func)) +#define sk_X509_REVOKED_shift(st) SKM_sk_shift(X509_REVOKED, (st)) +#define sk_X509_REVOKED_pop(st) SKM_sk_pop(X509_REVOKED, (st)) +#define sk_X509_REVOKED_sort(st) SKM_sk_sort(X509_REVOKED, (st)) +#define sk_X509_REVOKED_is_sorted(st) SKM_sk_is_sorted(X509_REVOKED, (st)) + +#define sk_X509_TRUST_new(cmp) SKM_sk_new(X509_TRUST, (cmp)) +#define sk_X509_TRUST_new_null() SKM_sk_new_null(X509_TRUST) +#define sk_X509_TRUST_free(st) SKM_sk_free(X509_TRUST, (st)) +#define sk_X509_TRUST_num(st) SKM_sk_num(X509_TRUST, (st)) +#define sk_X509_TRUST_value(st, i) SKM_sk_value(X509_TRUST, (st), (i)) +#define sk_X509_TRUST_set(st, i, val) SKM_sk_set(X509_TRUST, (st), (i), (val)) +#define sk_X509_TRUST_zero(st) SKM_sk_zero(X509_TRUST, (st)) +#define sk_X509_TRUST_push(st, val) SKM_sk_push(X509_TRUST, (st), (val)) +#define sk_X509_TRUST_unshift(st, val) SKM_sk_unshift(X509_TRUST, (st), (val)) +#define sk_X509_TRUST_find(st, val) SKM_sk_find(X509_TRUST, (st), (val)) +#define sk_X509_TRUST_find_ex(st, val) SKM_sk_find_ex(X509_TRUST, (st), (val)) +#define sk_X509_TRUST_delete(st, i) SKM_sk_delete(X509_TRUST, (st), (i)) +#define sk_X509_TRUST_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_TRUST, (st), (ptr)) +#define sk_X509_TRUST_insert(st, val, i) SKM_sk_insert(X509_TRUST, (st), (val), (i)) +#define sk_X509_TRUST_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_TRUST, (st), (cmp)) +#define sk_X509_TRUST_dup(st) SKM_sk_dup(X509_TRUST, st) +#define sk_X509_TRUST_pop_free(st, free_func) SKM_sk_pop_free(X509_TRUST, (st), (free_func)) +#define sk_X509_TRUST_shift(st) SKM_sk_shift(X509_TRUST, (st)) +#define sk_X509_TRUST_pop(st) SKM_sk_pop(X509_TRUST, (st)) +#define sk_X509_TRUST_sort(st) SKM_sk_sort(X509_TRUST, (st)) +#define sk_X509_TRUST_is_sorted(st) SKM_sk_is_sorted(X509_TRUST, (st)) + +#define sk_X509_VERIFY_PARAM_new(cmp) SKM_sk_new(X509_VERIFY_PARAM, (cmp)) +#define sk_X509_VERIFY_PARAM_new_null() SKM_sk_new_null(X509_VERIFY_PARAM) +#define sk_X509_VERIFY_PARAM_free(st) SKM_sk_free(X509_VERIFY_PARAM, (st)) +#define sk_X509_VERIFY_PARAM_num(st) SKM_sk_num(X509_VERIFY_PARAM, (st)) +#define sk_X509_VERIFY_PARAM_value(st, i) SKM_sk_value(X509_VERIFY_PARAM, (st), (i)) +#define sk_X509_VERIFY_PARAM_set(st, i, val) SKM_sk_set(X509_VERIFY_PARAM, (st), (i), (val)) +#define sk_X509_VERIFY_PARAM_zero(st) SKM_sk_zero(X509_VERIFY_PARAM, (st)) +#define sk_X509_VERIFY_PARAM_push(st, val) SKM_sk_push(X509_VERIFY_PARAM, (st), (val)) +#define sk_X509_VERIFY_PARAM_unshift(st, val) SKM_sk_unshift(X509_VERIFY_PARAM, (st), (val)) +#define sk_X509_VERIFY_PARAM_find(st, val) SKM_sk_find(X509_VERIFY_PARAM, (st), (val)) +#define sk_X509_VERIFY_PARAM_find_ex(st, val) SKM_sk_find_ex(X509_VERIFY_PARAM, (st), (val)) +#define sk_X509_VERIFY_PARAM_delete(st, i) SKM_sk_delete(X509_VERIFY_PARAM, (st), (i)) +#define sk_X509_VERIFY_PARAM_delete_ptr(st, ptr) SKM_sk_delete_ptr(X509_VERIFY_PARAM, (st), (ptr)) +#define sk_X509_VERIFY_PARAM_insert(st, val, i) SKM_sk_insert(X509_VERIFY_PARAM, (st), (val), (i)) +#define sk_X509_VERIFY_PARAM_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(X509_VERIFY_PARAM, (st), (cmp)) +#define sk_X509_VERIFY_PARAM_dup(st) SKM_sk_dup(X509_VERIFY_PARAM, st) +#define sk_X509_VERIFY_PARAM_pop_free(st, free_func) SKM_sk_pop_free(X509_VERIFY_PARAM, (st), (free_func)) +#define sk_X509_VERIFY_PARAM_shift(st) SKM_sk_shift(X509_VERIFY_PARAM, (st)) +#define sk_X509_VERIFY_PARAM_pop(st) SKM_sk_pop(X509_VERIFY_PARAM, (st)) +#define sk_X509_VERIFY_PARAM_sort(st) SKM_sk_sort(X509_VERIFY_PARAM, (st)) +#define sk_X509_VERIFY_PARAM_is_sorted(st) SKM_sk_is_sorted(X509_VERIFY_PARAM, (st)) + +#define sk_nid_triple_new(cmp) SKM_sk_new(nid_triple, (cmp)) +#define sk_nid_triple_new_null() SKM_sk_new_null(nid_triple) +#define sk_nid_triple_free(st) SKM_sk_free(nid_triple, (st)) +#define sk_nid_triple_num(st) SKM_sk_num(nid_triple, (st)) +#define sk_nid_triple_value(st, i) SKM_sk_value(nid_triple, (st), (i)) +#define sk_nid_triple_set(st, i, val) SKM_sk_set(nid_triple, (st), (i), (val)) +#define sk_nid_triple_zero(st) SKM_sk_zero(nid_triple, (st)) +#define sk_nid_triple_push(st, val) SKM_sk_push(nid_triple, (st), (val)) +#define sk_nid_triple_unshift(st, val) SKM_sk_unshift(nid_triple, (st), (val)) +#define sk_nid_triple_find(st, val) SKM_sk_find(nid_triple, (st), (val)) +#define sk_nid_triple_find_ex(st, val) SKM_sk_find_ex(nid_triple, (st), (val)) +#define sk_nid_triple_delete(st, i) SKM_sk_delete(nid_triple, (st), (i)) +#define sk_nid_triple_delete_ptr(st, ptr) SKM_sk_delete_ptr(nid_triple, (st), (ptr)) +#define sk_nid_triple_insert(st, val, i) SKM_sk_insert(nid_triple, (st), (val), (i)) +#define sk_nid_triple_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(nid_triple, (st), (cmp)) +#define sk_nid_triple_dup(st) SKM_sk_dup(nid_triple, st) +#define sk_nid_triple_pop_free(st, free_func) SKM_sk_pop_free(nid_triple, (st), (free_func)) +#define sk_nid_triple_shift(st) SKM_sk_shift(nid_triple, (st)) +#define sk_nid_triple_pop(st) SKM_sk_pop(nid_triple, (st)) +#define sk_nid_triple_sort(st) SKM_sk_sort(nid_triple, (st)) +#define sk_nid_triple_is_sorted(st) SKM_sk_is_sorted(nid_triple, (st)) + +#define sk_void_new(cmp) SKM_sk_new(void, (cmp)) +#define sk_void_new_null() SKM_sk_new_null(void) +#define sk_void_free(st) SKM_sk_free(void, (st)) +#define sk_void_num(st) SKM_sk_num(void, (st)) +#define sk_void_value(st, i) SKM_sk_value(void, (st), (i)) +#define sk_void_set(st, i, val) SKM_sk_set(void, (st), (i), (val)) +#define sk_void_zero(st) SKM_sk_zero(void, (st)) +#define sk_void_push(st, val) SKM_sk_push(void, (st), (val)) +#define sk_void_unshift(st, val) SKM_sk_unshift(void, (st), (val)) +#define sk_void_find(st, val) SKM_sk_find(void, (st), (val)) +#define sk_void_find_ex(st, val) SKM_sk_find_ex(void, (st), (val)) +#define sk_void_delete(st, i) SKM_sk_delete(void, (st), (i)) +#define sk_void_delete_ptr(st, ptr) SKM_sk_delete_ptr(void, (st), (ptr)) +#define sk_void_insert(st, val, i) SKM_sk_insert(void, (st), (val), (i)) +#define sk_void_set_cmp_func(st, cmp) SKM_sk_set_cmp_func(void, (st), (cmp)) +#define sk_void_dup(st) SKM_sk_dup(void, st) +#define sk_void_pop_free(st, free_func) SKM_sk_pop_free(void, (st), (free_func)) +#define sk_void_shift(st) SKM_sk_shift(void, (st)) +#define sk_void_pop(st) SKM_sk_pop(void, (st)) +#define sk_void_sort(st) SKM_sk_sort(void, (st)) +#define sk_void_is_sorted(st) SKM_sk_is_sorted(void, (st)) + +#define sk_OPENSSL_STRING_new(cmp) ((STACK_OF(OPENSSL_STRING) *)sk_new(CHECKED_SK_CMP_FUNC(char, cmp))) +#define sk_OPENSSL_STRING_new_null() ((STACK_OF(OPENSSL_STRING) *)sk_new_null()) +#define sk_OPENSSL_STRING_push(st, val) sk_push(CHECKED_STACK_OF(OPENSSL_STRING, st), CHECKED_PTR_OF(char, val)) +#define sk_OPENSSL_STRING_find(st, val) sk_find(CHECKED_STACK_OF(OPENSSL_STRING, st), CHECKED_PTR_OF(char, val)) +#define sk_OPENSSL_STRING_value(st, i) ((OPENSSL_STRING)sk_value(CHECKED_STACK_OF(OPENSSL_STRING, st), i)) +#define sk_OPENSSL_STRING_num(st) SKM_sk_num(OPENSSL_STRING, st) +#define sk_OPENSSL_STRING_pop_free(st, free_func) sk_pop_free(CHECKED_STACK_OF(OPENSSL_STRING, st), CHECKED_SK_FREE_FUNC2(OPENSSL_STRING, free_func)) +#define sk_OPENSSL_STRING_insert(st, val, i) sk_insert(CHECKED_STACK_OF(OPENSSL_STRING, st), CHECKED_PTR_OF(char, val), i) +#define sk_OPENSSL_STRING_free(st) SKM_sk_free(OPENSSL_STRING, st) +#define sk_OPENSSL_STRING_set(st, i, val) sk_set(CHECKED_STACK_OF(OPENSSL_STRING, st), i, CHECKED_PTR_OF(char, val)) +#define sk_OPENSSL_STRING_zero(st) SKM_sk_zero(OPENSSL_STRING, (st)) +#define sk_OPENSSL_STRING_unshift(st, val) sk_unshift(CHECKED_STACK_OF(OPENSSL_STRING, st), CHECKED_PTR_OF(char, val)) +#define sk_OPENSSL_STRING_find_ex(st, val) sk_find_ex((_STACK *)CHECKED_CONST_PTR_OF(STACK_OF(OPENSSL_STRING), st), CHECKED_CONST_PTR_OF(char, val)) +#define sk_OPENSSL_STRING_delete(st, i) SKM_sk_delete(OPENSSL_STRING, (st), (i)) +#define sk_OPENSSL_STRING_delete_ptr(st, ptr) (OPENSSL_STRING *)sk_delete_ptr(CHECKED_STACK_OF(OPENSSL_STRING, st), CHECKED_PTR_OF(char, ptr)) +#define sk_OPENSSL_STRING_set_cmp_func(st, cmp) \ + ((int (*)(const char * const *,const char * const *)) \ + sk_set_cmp_func(CHECKED_STACK_OF(OPENSSL_STRING, st), CHECKED_SK_CMP_FUNC(char, cmp))) +#define sk_OPENSSL_STRING_dup(st) SKM_sk_dup(OPENSSL_STRING, st) +#define sk_OPENSSL_STRING_shift(st) SKM_sk_shift(OPENSSL_STRING, (st)) +#define sk_OPENSSL_STRING_pop(st) (char *)sk_pop(CHECKED_STACK_OF(OPENSSL_STRING, st)) +#define sk_OPENSSL_STRING_sort(st) SKM_sk_sort(OPENSSL_STRING, (st)) +#define sk_OPENSSL_STRING_is_sorted(st) SKM_sk_is_sorted(OPENSSL_STRING, (st)) + + +#define sk_OPENSSL_BLOCK_new(cmp) ((STACK_OF(OPENSSL_BLOCK) *)sk_new(CHECKED_SK_CMP_FUNC(void, cmp))) +#define sk_OPENSSL_BLOCK_new_null() ((STACK_OF(OPENSSL_BLOCK) *)sk_new_null()) +#define sk_OPENSSL_BLOCK_push(st, val) sk_push(CHECKED_STACK_OF(OPENSSL_BLOCK, st), CHECKED_PTR_OF(void, val)) +#define sk_OPENSSL_BLOCK_find(st, val) sk_find(CHECKED_STACK_OF(OPENSSL_BLOCK, st), CHECKED_PTR_OF(void, val)) +#define sk_OPENSSL_BLOCK_value(st, i) ((OPENSSL_BLOCK)sk_value(CHECKED_STACK_OF(OPENSSL_BLOCK, st), i)) +#define sk_OPENSSL_BLOCK_num(st) SKM_sk_num(OPENSSL_BLOCK, st) +#define sk_OPENSSL_BLOCK_pop_free(st, free_func) sk_pop_free(CHECKED_STACK_OF(OPENSSL_BLOCK, st), CHECKED_SK_FREE_FUNC2(OPENSSL_BLOCK, free_func)) +#define sk_OPENSSL_BLOCK_insert(st, val, i) sk_insert(CHECKED_STACK_OF(OPENSSL_BLOCK, st), CHECKED_PTR_OF(void, val), i) +#define sk_OPENSSL_BLOCK_free(st) SKM_sk_free(OPENSSL_BLOCK, st) +#define sk_OPENSSL_BLOCK_set(st, i, val) sk_set(CHECKED_STACK_OF(OPENSSL_BLOCK, st), i, CHECKED_PTR_OF(void, val)) +#define sk_OPENSSL_BLOCK_zero(st) SKM_sk_zero(OPENSSL_BLOCK, (st)) +#define sk_OPENSSL_BLOCK_unshift(st, val) sk_unshift(CHECKED_STACK_OF(OPENSSL_BLOCK, st), CHECKED_PTR_OF(void, val)) +#define sk_OPENSSL_BLOCK_find_ex(st, val) sk_find_ex((_STACK *)CHECKED_CONST_PTR_OF(STACK_OF(OPENSSL_BLOCK), st), CHECKED_CONST_PTR_OF(void, val)) +#define sk_OPENSSL_BLOCK_delete(st, i) SKM_sk_delete(OPENSSL_BLOCK, (st), (i)) +#define sk_OPENSSL_BLOCK_delete_ptr(st, ptr) (OPENSSL_BLOCK *)sk_delete_ptr(CHECKED_STACK_OF(OPENSSL_BLOCK, st), CHECKED_PTR_OF(void, ptr)) +#define sk_OPENSSL_BLOCK_set_cmp_func(st, cmp) \ + ((int (*)(const void * const *,const void * const *)) \ + sk_set_cmp_func(CHECKED_STACK_OF(OPENSSL_BLOCK, st), CHECKED_SK_CMP_FUNC(void, cmp))) +#define sk_OPENSSL_BLOCK_dup(st) SKM_sk_dup(OPENSSL_BLOCK, st) +#define sk_OPENSSL_BLOCK_shift(st) SKM_sk_shift(OPENSSL_BLOCK, (st)) +#define sk_OPENSSL_BLOCK_pop(st) (void *)sk_pop(CHECKED_STACK_OF(OPENSSL_BLOCK, st)) +#define sk_OPENSSL_BLOCK_sort(st) SKM_sk_sort(OPENSSL_BLOCK, (st)) +#define sk_OPENSSL_BLOCK_is_sorted(st) SKM_sk_is_sorted(OPENSSL_BLOCK, (st)) + + +#define sk_OPENSSL_PSTRING_new(cmp) ((STACK_OF(OPENSSL_PSTRING) *)sk_new(CHECKED_SK_CMP_FUNC(OPENSSL_STRING, cmp))) +#define sk_OPENSSL_PSTRING_new_null() ((STACK_OF(OPENSSL_PSTRING) *)sk_new_null()) +#define sk_OPENSSL_PSTRING_push(st, val) sk_push(CHECKED_STACK_OF(OPENSSL_PSTRING, st), CHECKED_PTR_OF(OPENSSL_STRING, val)) +#define sk_OPENSSL_PSTRING_find(st, val) sk_find(CHECKED_STACK_OF(OPENSSL_PSTRING, st), CHECKED_PTR_OF(OPENSSL_STRING, val)) +#define sk_OPENSSL_PSTRING_value(st, i) ((OPENSSL_PSTRING)sk_value(CHECKED_STACK_OF(OPENSSL_PSTRING, st), i)) +#define sk_OPENSSL_PSTRING_num(st) SKM_sk_num(OPENSSL_PSTRING, st) +#define sk_OPENSSL_PSTRING_pop_free(st, free_func) sk_pop_free(CHECKED_STACK_OF(OPENSSL_PSTRING, st), CHECKED_SK_FREE_FUNC2(OPENSSL_PSTRING, free_func)) +#define sk_OPENSSL_PSTRING_insert(st, val, i) sk_insert(CHECKED_STACK_OF(OPENSSL_PSTRING, st), CHECKED_PTR_OF(OPENSSL_STRING, val), i) +#define sk_OPENSSL_PSTRING_free(st) SKM_sk_free(OPENSSL_PSTRING, st) +#define sk_OPENSSL_PSTRING_set(st, i, val) sk_set(CHECKED_STACK_OF(OPENSSL_PSTRING, st), i, CHECKED_PTR_OF(OPENSSL_STRING, val)) +#define sk_OPENSSL_PSTRING_zero(st) SKM_sk_zero(OPENSSL_PSTRING, (st)) +#define sk_OPENSSL_PSTRING_unshift(st, val) sk_unshift(CHECKED_STACK_OF(OPENSSL_PSTRING, st), CHECKED_PTR_OF(OPENSSL_STRING, val)) +#define sk_OPENSSL_PSTRING_find_ex(st, val) sk_find_ex((_STACK *)CHECKED_CONST_PTR_OF(STACK_OF(OPENSSL_PSTRING), st), CHECKED_CONST_PTR_OF(OPENSSL_STRING, val)) +#define sk_OPENSSL_PSTRING_delete(st, i) SKM_sk_delete(OPENSSL_PSTRING, (st), (i)) +#define sk_OPENSSL_PSTRING_delete_ptr(st, ptr) (OPENSSL_PSTRING *)sk_delete_ptr(CHECKED_STACK_OF(OPENSSL_PSTRING, st), CHECKED_PTR_OF(OPENSSL_STRING, ptr)) +#define sk_OPENSSL_PSTRING_set_cmp_func(st, cmp) \ + ((int (*)(const OPENSSL_STRING * const *,const OPENSSL_STRING * const *)) \ + sk_set_cmp_func(CHECKED_STACK_OF(OPENSSL_PSTRING, st), CHECKED_SK_CMP_FUNC(OPENSSL_STRING, cmp))) +#define sk_OPENSSL_PSTRING_dup(st) SKM_sk_dup(OPENSSL_PSTRING, st) +#define sk_OPENSSL_PSTRING_shift(st) SKM_sk_shift(OPENSSL_PSTRING, (st)) +#define sk_OPENSSL_PSTRING_pop(st) (OPENSSL_STRING *)sk_pop(CHECKED_STACK_OF(OPENSSL_PSTRING, st)) +#define sk_OPENSSL_PSTRING_sort(st) SKM_sk_sort(OPENSSL_PSTRING, (st)) +#define sk_OPENSSL_PSTRING_is_sorted(st) SKM_sk_is_sorted(OPENSSL_PSTRING, (st)) + + +#define d2i_ASN1_SET_OF_ACCESS_DESCRIPTION(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(ACCESS_DESCRIPTION, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_ACCESS_DESCRIPTION(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(ACCESS_DESCRIPTION, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_ACCESS_DESCRIPTION(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(ACCESS_DESCRIPTION, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_ACCESS_DESCRIPTION(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(ACCESS_DESCRIPTION, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_ASN1_INTEGER(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(ASN1_INTEGER, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_ASN1_INTEGER(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(ASN1_INTEGER, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_ASN1_INTEGER(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(ASN1_INTEGER, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_ASN1_INTEGER(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(ASN1_INTEGER, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_ASN1_OBJECT(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(ASN1_OBJECT, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_ASN1_OBJECT(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(ASN1_OBJECT, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_ASN1_OBJECT(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(ASN1_OBJECT, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_ASN1_OBJECT(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(ASN1_OBJECT, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_ASN1_TYPE(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(ASN1_TYPE, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_ASN1_TYPE(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(ASN1_TYPE, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_ASN1_TYPE(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(ASN1_TYPE, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_ASN1_TYPE(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(ASN1_TYPE, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_ASN1_UTF8STRING(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(ASN1_UTF8STRING, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_ASN1_UTF8STRING(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(ASN1_UTF8STRING, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_ASN1_UTF8STRING(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(ASN1_UTF8STRING, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_ASN1_UTF8STRING(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(ASN1_UTF8STRING, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_DIST_POINT(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(DIST_POINT, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_DIST_POINT(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(DIST_POINT, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_DIST_POINT(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(DIST_POINT, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_DIST_POINT(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(DIST_POINT, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_ESS_CERT_ID(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(ESS_CERT_ID, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_ESS_CERT_ID(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(ESS_CERT_ID, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_ESS_CERT_ID(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(ESS_CERT_ID, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_ESS_CERT_ID(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(ESS_CERT_ID, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_EVP_MD(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(EVP_MD, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_EVP_MD(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(EVP_MD, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_EVP_MD(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(EVP_MD, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_EVP_MD(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(EVP_MD, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_GENERAL_NAME(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(GENERAL_NAME, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_GENERAL_NAME(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(GENERAL_NAME, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_GENERAL_NAME(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(GENERAL_NAME, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_GENERAL_NAME(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(GENERAL_NAME, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_OCSP_ONEREQ(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(OCSP_ONEREQ, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_OCSP_ONEREQ(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(OCSP_ONEREQ, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_OCSP_ONEREQ(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(OCSP_ONEREQ, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_OCSP_ONEREQ(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(OCSP_ONEREQ, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_OCSP_SINGLERESP(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(OCSP_SINGLERESP, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_OCSP_SINGLERESP(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(OCSP_SINGLERESP, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_OCSP_SINGLERESP(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(OCSP_SINGLERESP, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_OCSP_SINGLERESP(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(OCSP_SINGLERESP, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_PKCS12_SAFEBAG(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(PKCS12_SAFEBAG, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_PKCS12_SAFEBAG(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(PKCS12_SAFEBAG, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_PKCS12_SAFEBAG(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(PKCS12_SAFEBAG, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_PKCS12_SAFEBAG(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(PKCS12_SAFEBAG, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_PKCS7(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(PKCS7, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_PKCS7(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(PKCS7, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_PKCS7(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(PKCS7, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_PKCS7(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(PKCS7, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_PKCS7_RECIP_INFO(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(PKCS7_RECIP_INFO, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_PKCS7_RECIP_INFO(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(PKCS7_RECIP_INFO, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_PKCS7_RECIP_INFO(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(PKCS7_RECIP_INFO, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_PKCS7_RECIP_INFO(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(PKCS7_RECIP_INFO, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_PKCS7_SIGNER_INFO(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(PKCS7_SIGNER_INFO, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_PKCS7_SIGNER_INFO(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(PKCS7_SIGNER_INFO, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_PKCS7_SIGNER_INFO(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(PKCS7_SIGNER_INFO, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_PKCS7_SIGNER_INFO(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(PKCS7_SIGNER_INFO, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_POLICYINFO(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(POLICYINFO, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_POLICYINFO(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(POLICYINFO, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_POLICYINFO(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(POLICYINFO, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_POLICYINFO(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(POLICYINFO, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_POLICYQUALINFO(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(POLICYQUALINFO, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_POLICYQUALINFO(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(POLICYQUALINFO, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_POLICYQUALINFO(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(POLICYQUALINFO, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_POLICYQUALINFO(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(POLICYQUALINFO, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_SXNETID(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(SXNETID, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_SXNETID(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(SXNETID, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_SXNETID(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(SXNETID, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_SXNETID(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(SXNETID, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_X509(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(X509, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_X509(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(X509, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_X509(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(X509, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_X509(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(X509, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_X509_ALGOR(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(X509_ALGOR, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_X509_ALGOR(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(X509_ALGOR, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_X509_ALGOR(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(X509_ALGOR, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_X509_ALGOR(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(X509_ALGOR, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_X509_ATTRIBUTE(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(X509_ATTRIBUTE, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_X509_ATTRIBUTE(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(X509_ATTRIBUTE, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_X509_ATTRIBUTE(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(X509_ATTRIBUTE, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_X509_ATTRIBUTE(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(X509_ATTRIBUTE, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_X509_CRL(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(X509_CRL, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_X509_CRL(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(X509_CRL, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_X509_CRL(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(X509_CRL, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_X509_CRL(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(X509_CRL, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_X509_EXTENSION(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(X509_EXTENSION, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_X509_EXTENSION(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(X509_EXTENSION, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_X509_EXTENSION(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(X509_EXTENSION, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_X509_EXTENSION(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(X509_EXTENSION, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_X509_NAME_ENTRY(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(X509_NAME_ENTRY, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_X509_NAME_ENTRY(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(X509_NAME_ENTRY, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_X509_NAME_ENTRY(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(X509_NAME_ENTRY, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_X509_NAME_ENTRY(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(X509_NAME_ENTRY, (buf), (len), (d2i_func), (free_func)) + +#define d2i_ASN1_SET_OF_X509_REVOKED(st, pp, length, d2i_func, free_func, ex_tag, ex_class) \ + SKM_ASN1_SET_OF_d2i(X509_REVOKED, (st), (pp), (length), (d2i_func), (free_func), (ex_tag), (ex_class)) +#define i2d_ASN1_SET_OF_X509_REVOKED(st, pp, i2d_func, ex_tag, ex_class, is_set) \ + SKM_ASN1_SET_OF_i2d(X509_REVOKED, (st), (pp), (i2d_func), (ex_tag), (ex_class), (is_set)) +#define ASN1_seq_pack_X509_REVOKED(st, i2d_func, buf, len) \ + SKM_ASN1_seq_pack(X509_REVOKED, (st), (i2d_func), (buf), (len)) +#define ASN1_seq_unpack_X509_REVOKED(buf, len, d2i_func, free_func) \ + SKM_ASN1_seq_unpack(X509_REVOKED, (buf), (len), (d2i_func), (free_func)) + +#define PKCS12_decrypt_d2i_PKCS12_SAFEBAG(algor, d2i_func, free_func, pass, passlen, oct, seq) \ + SKM_PKCS12_decrypt_d2i(PKCS12_SAFEBAG, (algor), (d2i_func), (free_func), (pass), (passlen), (oct), (seq)) + +#define PKCS12_decrypt_d2i_PKCS7(algor, d2i_func, free_func, pass, passlen, oct, seq) \ + SKM_PKCS12_decrypt_d2i(PKCS7, (algor), (d2i_func), (free_func), (pass), (passlen), (oct), (seq)) + +#define lh_ADDED_OBJ_new() LHM_lh_new(ADDED_OBJ,added_obj) +#define lh_ADDED_OBJ_insert(lh,inst) LHM_lh_insert(ADDED_OBJ,lh,inst) +#define lh_ADDED_OBJ_retrieve(lh,inst) LHM_lh_retrieve(ADDED_OBJ,lh,inst) +#define lh_ADDED_OBJ_delete(lh,inst) LHM_lh_delete(ADDED_OBJ,lh,inst) +#define lh_ADDED_OBJ_doall(lh,fn) LHM_lh_doall(ADDED_OBJ,lh,fn) +#define lh_ADDED_OBJ_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(ADDED_OBJ,lh,fn,arg_type,arg) +#define lh_ADDED_OBJ_error(lh) LHM_lh_error(ADDED_OBJ,lh) +#define lh_ADDED_OBJ_num_items(lh) LHM_lh_num_items(ADDED_OBJ,lh) +#define lh_ADDED_OBJ_down_load(lh) LHM_lh_down_load(ADDED_OBJ,lh) +#define lh_ADDED_OBJ_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(ADDED_OBJ,lh,out) +#define lh_ADDED_OBJ_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(ADDED_OBJ,lh,out) +#define lh_ADDED_OBJ_stats_bio(lh,out) \ + LHM_lh_stats_bio(ADDED_OBJ,lh,out) +#define lh_ADDED_OBJ_free(lh) LHM_lh_free(ADDED_OBJ,lh) + +#define lh_APP_INFO_new() LHM_lh_new(APP_INFO,app_info) +#define lh_APP_INFO_insert(lh,inst) LHM_lh_insert(APP_INFO,lh,inst) +#define lh_APP_INFO_retrieve(lh,inst) LHM_lh_retrieve(APP_INFO,lh,inst) +#define lh_APP_INFO_delete(lh,inst) LHM_lh_delete(APP_INFO,lh,inst) +#define lh_APP_INFO_doall(lh,fn) LHM_lh_doall(APP_INFO,lh,fn) +#define lh_APP_INFO_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(APP_INFO,lh,fn,arg_type,arg) +#define lh_APP_INFO_error(lh) LHM_lh_error(APP_INFO,lh) +#define lh_APP_INFO_num_items(lh) LHM_lh_num_items(APP_INFO,lh) +#define lh_APP_INFO_down_load(lh) LHM_lh_down_load(APP_INFO,lh) +#define lh_APP_INFO_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(APP_INFO,lh,out) +#define lh_APP_INFO_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(APP_INFO,lh,out) +#define lh_APP_INFO_stats_bio(lh,out) \ + LHM_lh_stats_bio(APP_INFO,lh,out) +#define lh_APP_INFO_free(lh) LHM_lh_free(APP_INFO,lh) + +#define lh_CONF_VALUE_new() LHM_lh_new(CONF_VALUE,conf_value) +#define lh_CONF_VALUE_insert(lh,inst) LHM_lh_insert(CONF_VALUE,lh,inst) +#define lh_CONF_VALUE_retrieve(lh,inst) LHM_lh_retrieve(CONF_VALUE,lh,inst) +#define lh_CONF_VALUE_delete(lh,inst) LHM_lh_delete(CONF_VALUE,lh,inst) +#define lh_CONF_VALUE_doall(lh,fn) LHM_lh_doall(CONF_VALUE,lh,fn) +#define lh_CONF_VALUE_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(CONF_VALUE,lh,fn,arg_type,arg) +#define lh_CONF_VALUE_error(lh) LHM_lh_error(CONF_VALUE,lh) +#define lh_CONF_VALUE_num_items(lh) LHM_lh_num_items(CONF_VALUE,lh) +#define lh_CONF_VALUE_down_load(lh) LHM_lh_down_load(CONF_VALUE,lh) +#define lh_CONF_VALUE_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(CONF_VALUE,lh,out) +#define lh_CONF_VALUE_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(CONF_VALUE,lh,out) +#define lh_CONF_VALUE_stats_bio(lh,out) \ + LHM_lh_stats_bio(CONF_VALUE,lh,out) +#define lh_CONF_VALUE_free(lh) LHM_lh_free(CONF_VALUE,lh) + +#define lh_ENGINE_PILE_new() LHM_lh_new(ENGINE_PILE,engine_pile) +#define lh_ENGINE_PILE_insert(lh,inst) LHM_lh_insert(ENGINE_PILE,lh,inst) +#define lh_ENGINE_PILE_retrieve(lh,inst) LHM_lh_retrieve(ENGINE_PILE,lh,inst) +#define lh_ENGINE_PILE_delete(lh,inst) LHM_lh_delete(ENGINE_PILE,lh,inst) +#define lh_ENGINE_PILE_doall(lh,fn) LHM_lh_doall(ENGINE_PILE,lh,fn) +#define lh_ENGINE_PILE_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(ENGINE_PILE,lh,fn,arg_type,arg) +#define lh_ENGINE_PILE_error(lh) LHM_lh_error(ENGINE_PILE,lh) +#define lh_ENGINE_PILE_num_items(lh) LHM_lh_num_items(ENGINE_PILE,lh) +#define lh_ENGINE_PILE_down_load(lh) LHM_lh_down_load(ENGINE_PILE,lh) +#define lh_ENGINE_PILE_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(ENGINE_PILE,lh,out) +#define lh_ENGINE_PILE_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(ENGINE_PILE,lh,out) +#define lh_ENGINE_PILE_stats_bio(lh,out) \ + LHM_lh_stats_bio(ENGINE_PILE,lh,out) +#define lh_ENGINE_PILE_free(lh) LHM_lh_free(ENGINE_PILE,lh) + +#define lh_ERR_STATE_new() LHM_lh_new(ERR_STATE,err_state) +#define lh_ERR_STATE_insert(lh,inst) LHM_lh_insert(ERR_STATE,lh,inst) +#define lh_ERR_STATE_retrieve(lh,inst) LHM_lh_retrieve(ERR_STATE,lh,inst) +#define lh_ERR_STATE_delete(lh,inst) LHM_lh_delete(ERR_STATE,lh,inst) +#define lh_ERR_STATE_doall(lh,fn) LHM_lh_doall(ERR_STATE,lh,fn) +#define lh_ERR_STATE_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(ERR_STATE,lh,fn,arg_type,arg) +#define lh_ERR_STATE_error(lh) LHM_lh_error(ERR_STATE,lh) +#define lh_ERR_STATE_num_items(lh) LHM_lh_num_items(ERR_STATE,lh) +#define lh_ERR_STATE_down_load(lh) LHM_lh_down_load(ERR_STATE,lh) +#define lh_ERR_STATE_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(ERR_STATE,lh,out) +#define lh_ERR_STATE_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(ERR_STATE,lh,out) +#define lh_ERR_STATE_stats_bio(lh,out) \ + LHM_lh_stats_bio(ERR_STATE,lh,out) +#define lh_ERR_STATE_free(lh) LHM_lh_free(ERR_STATE,lh) + +#define lh_ERR_STRING_DATA_new() LHM_lh_new(ERR_STRING_DATA,err_string_data) +#define lh_ERR_STRING_DATA_insert(lh,inst) LHM_lh_insert(ERR_STRING_DATA,lh,inst) +#define lh_ERR_STRING_DATA_retrieve(lh,inst) LHM_lh_retrieve(ERR_STRING_DATA,lh,inst) +#define lh_ERR_STRING_DATA_delete(lh,inst) LHM_lh_delete(ERR_STRING_DATA,lh,inst) +#define lh_ERR_STRING_DATA_doall(lh,fn) LHM_lh_doall(ERR_STRING_DATA,lh,fn) +#define lh_ERR_STRING_DATA_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(ERR_STRING_DATA,lh,fn,arg_type,arg) +#define lh_ERR_STRING_DATA_error(lh) LHM_lh_error(ERR_STRING_DATA,lh) +#define lh_ERR_STRING_DATA_num_items(lh) LHM_lh_num_items(ERR_STRING_DATA,lh) +#define lh_ERR_STRING_DATA_down_load(lh) LHM_lh_down_load(ERR_STRING_DATA,lh) +#define lh_ERR_STRING_DATA_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(ERR_STRING_DATA,lh,out) +#define lh_ERR_STRING_DATA_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(ERR_STRING_DATA,lh,out) +#define lh_ERR_STRING_DATA_stats_bio(lh,out) \ + LHM_lh_stats_bio(ERR_STRING_DATA,lh,out) +#define lh_ERR_STRING_DATA_free(lh) LHM_lh_free(ERR_STRING_DATA,lh) + +#define lh_EX_CLASS_ITEM_new() LHM_lh_new(EX_CLASS_ITEM,ex_class_item) +#define lh_EX_CLASS_ITEM_insert(lh,inst) LHM_lh_insert(EX_CLASS_ITEM,lh,inst) +#define lh_EX_CLASS_ITEM_retrieve(lh,inst) LHM_lh_retrieve(EX_CLASS_ITEM,lh,inst) +#define lh_EX_CLASS_ITEM_delete(lh,inst) LHM_lh_delete(EX_CLASS_ITEM,lh,inst) +#define lh_EX_CLASS_ITEM_doall(lh,fn) LHM_lh_doall(EX_CLASS_ITEM,lh,fn) +#define lh_EX_CLASS_ITEM_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(EX_CLASS_ITEM,lh,fn,arg_type,arg) +#define lh_EX_CLASS_ITEM_error(lh) LHM_lh_error(EX_CLASS_ITEM,lh) +#define lh_EX_CLASS_ITEM_num_items(lh) LHM_lh_num_items(EX_CLASS_ITEM,lh) +#define lh_EX_CLASS_ITEM_down_load(lh) LHM_lh_down_load(EX_CLASS_ITEM,lh) +#define lh_EX_CLASS_ITEM_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(EX_CLASS_ITEM,lh,out) +#define lh_EX_CLASS_ITEM_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(EX_CLASS_ITEM,lh,out) +#define lh_EX_CLASS_ITEM_stats_bio(lh,out) \ + LHM_lh_stats_bio(EX_CLASS_ITEM,lh,out) +#define lh_EX_CLASS_ITEM_free(lh) LHM_lh_free(EX_CLASS_ITEM,lh) + +#define lh_FUNCTION_new() LHM_lh_new(FUNCTION,function) +#define lh_FUNCTION_insert(lh,inst) LHM_lh_insert(FUNCTION,lh,inst) +#define lh_FUNCTION_retrieve(lh,inst) LHM_lh_retrieve(FUNCTION,lh,inst) +#define lh_FUNCTION_delete(lh,inst) LHM_lh_delete(FUNCTION,lh,inst) +#define lh_FUNCTION_doall(lh,fn) LHM_lh_doall(FUNCTION,lh,fn) +#define lh_FUNCTION_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(FUNCTION,lh,fn,arg_type,arg) +#define lh_FUNCTION_error(lh) LHM_lh_error(FUNCTION,lh) +#define lh_FUNCTION_num_items(lh) LHM_lh_num_items(FUNCTION,lh) +#define lh_FUNCTION_down_load(lh) LHM_lh_down_load(FUNCTION,lh) +#define lh_FUNCTION_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(FUNCTION,lh,out) +#define lh_FUNCTION_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(FUNCTION,lh,out) +#define lh_FUNCTION_stats_bio(lh,out) \ + LHM_lh_stats_bio(FUNCTION,lh,out) +#define lh_FUNCTION_free(lh) LHM_lh_free(FUNCTION,lh) + +#define lh_MEM_new() LHM_lh_new(MEM,mem) +#define lh_MEM_insert(lh,inst) LHM_lh_insert(MEM,lh,inst) +#define lh_MEM_retrieve(lh,inst) LHM_lh_retrieve(MEM,lh,inst) +#define lh_MEM_delete(lh,inst) LHM_lh_delete(MEM,lh,inst) +#define lh_MEM_doall(lh,fn) LHM_lh_doall(MEM,lh,fn) +#define lh_MEM_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(MEM,lh,fn,arg_type,arg) +#define lh_MEM_error(lh) LHM_lh_error(MEM,lh) +#define lh_MEM_num_items(lh) LHM_lh_num_items(MEM,lh) +#define lh_MEM_down_load(lh) LHM_lh_down_load(MEM,lh) +#define lh_MEM_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(MEM,lh,out) +#define lh_MEM_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(MEM,lh,out) +#define lh_MEM_stats_bio(lh,out) \ + LHM_lh_stats_bio(MEM,lh,out) +#define lh_MEM_free(lh) LHM_lh_free(MEM,lh) + +#define lh_OBJ_NAME_new() LHM_lh_new(OBJ_NAME,obj_name) +#define lh_OBJ_NAME_insert(lh,inst) LHM_lh_insert(OBJ_NAME,lh,inst) +#define lh_OBJ_NAME_retrieve(lh,inst) LHM_lh_retrieve(OBJ_NAME,lh,inst) +#define lh_OBJ_NAME_delete(lh,inst) LHM_lh_delete(OBJ_NAME,lh,inst) +#define lh_OBJ_NAME_doall(lh,fn) LHM_lh_doall(OBJ_NAME,lh,fn) +#define lh_OBJ_NAME_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(OBJ_NAME,lh,fn,arg_type,arg) +#define lh_OBJ_NAME_error(lh) LHM_lh_error(OBJ_NAME,lh) +#define lh_OBJ_NAME_num_items(lh) LHM_lh_num_items(OBJ_NAME,lh) +#define lh_OBJ_NAME_down_load(lh) LHM_lh_down_load(OBJ_NAME,lh) +#define lh_OBJ_NAME_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(OBJ_NAME,lh,out) +#define lh_OBJ_NAME_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(OBJ_NAME,lh,out) +#define lh_OBJ_NAME_stats_bio(lh,out) \ + LHM_lh_stats_bio(OBJ_NAME,lh,out) +#define lh_OBJ_NAME_free(lh) LHM_lh_free(OBJ_NAME,lh) + +#define lh_OPENSSL_CSTRING_new() LHM_lh_new(OPENSSL_CSTRING,openssl_cstring) +#define lh_OPENSSL_CSTRING_insert(lh,inst) LHM_lh_insert(OPENSSL_CSTRING,lh,inst) +#define lh_OPENSSL_CSTRING_retrieve(lh,inst) LHM_lh_retrieve(OPENSSL_CSTRING,lh,inst) +#define lh_OPENSSL_CSTRING_delete(lh,inst) LHM_lh_delete(OPENSSL_CSTRING,lh,inst) +#define lh_OPENSSL_CSTRING_doall(lh,fn) LHM_lh_doall(OPENSSL_CSTRING,lh,fn) +#define lh_OPENSSL_CSTRING_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(OPENSSL_CSTRING,lh,fn,arg_type,arg) +#define lh_OPENSSL_CSTRING_error(lh) LHM_lh_error(OPENSSL_CSTRING,lh) +#define lh_OPENSSL_CSTRING_num_items(lh) LHM_lh_num_items(OPENSSL_CSTRING,lh) +#define lh_OPENSSL_CSTRING_down_load(lh) LHM_lh_down_load(OPENSSL_CSTRING,lh) +#define lh_OPENSSL_CSTRING_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(OPENSSL_CSTRING,lh,out) +#define lh_OPENSSL_CSTRING_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(OPENSSL_CSTRING,lh,out) +#define lh_OPENSSL_CSTRING_stats_bio(lh,out) \ + LHM_lh_stats_bio(OPENSSL_CSTRING,lh,out) +#define lh_OPENSSL_CSTRING_free(lh) LHM_lh_free(OPENSSL_CSTRING,lh) + +#define lh_OPENSSL_STRING_new() LHM_lh_new(OPENSSL_STRING,openssl_string) +#define lh_OPENSSL_STRING_insert(lh,inst) LHM_lh_insert(OPENSSL_STRING,lh,inst) +#define lh_OPENSSL_STRING_retrieve(lh,inst) LHM_lh_retrieve(OPENSSL_STRING,lh,inst) +#define lh_OPENSSL_STRING_delete(lh,inst) LHM_lh_delete(OPENSSL_STRING,lh,inst) +#define lh_OPENSSL_STRING_doall(lh,fn) LHM_lh_doall(OPENSSL_STRING,lh,fn) +#define lh_OPENSSL_STRING_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(OPENSSL_STRING,lh,fn,arg_type,arg) +#define lh_OPENSSL_STRING_error(lh) LHM_lh_error(OPENSSL_STRING,lh) +#define lh_OPENSSL_STRING_num_items(lh) LHM_lh_num_items(OPENSSL_STRING,lh) +#define lh_OPENSSL_STRING_down_load(lh) LHM_lh_down_load(OPENSSL_STRING,lh) +#define lh_OPENSSL_STRING_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(OPENSSL_STRING,lh,out) +#define lh_OPENSSL_STRING_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(OPENSSL_STRING,lh,out) +#define lh_OPENSSL_STRING_stats_bio(lh,out) \ + LHM_lh_stats_bio(OPENSSL_STRING,lh,out) +#define lh_OPENSSL_STRING_free(lh) LHM_lh_free(OPENSSL_STRING,lh) + +#define lh_SSL_SESSION_new() LHM_lh_new(SSL_SESSION,ssl_session) +#define lh_SSL_SESSION_insert(lh,inst) LHM_lh_insert(SSL_SESSION,lh,inst) +#define lh_SSL_SESSION_retrieve(lh,inst) LHM_lh_retrieve(SSL_SESSION,lh,inst) +#define lh_SSL_SESSION_delete(lh,inst) LHM_lh_delete(SSL_SESSION,lh,inst) +#define lh_SSL_SESSION_doall(lh,fn) LHM_lh_doall(SSL_SESSION,lh,fn) +#define lh_SSL_SESSION_doall_arg(lh,fn,arg_type,arg) \ + LHM_lh_doall_arg(SSL_SESSION,lh,fn,arg_type,arg) +#define lh_SSL_SESSION_error(lh) LHM_lh_error(SSL_SESSION,lh) +#define lh_SSL_SESSION_num_items(lh) LHM_lh_num_items(SSL_SESSION,lh) +#define lh_SSL_SESSION_down_load(lh) LHM_lh_down_load(SSL_SESSION,lh) +#define lh_SSL_SESSION_node_stats_bio(lh,out) \ + LHM_lh_node_stats_bio(SSL_SESSION,lh,out) +#define lh_SSL_SESSION_node_usage_stats_bio(lh,out) \ + LHM_lh_node_usage_stats_bio(SSL_SESSION,lh,out) +#define lh_SSL_SESSION_stats_bio(lh,out) \ + LHM_lh_stats_bio(SSL_SESSION,lh,out) +#define lh_SSL_SESSION_free(lh) LHM_lh_free(SSL_SESSION,lh) +/* End of util/mkstack.pl block, you may now edit :-) */ + +#endif /* !defined HEADER_SAFESTACK_H */ diff --git a/Source/Import/OpenSSL/Include/openssl/seed.h b/Source/Import/OpenSSL/Include/openssl/seed.h new file mode 100644 index 0000000..c50fdd3 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/seed.h @@ -0,0 +1,139 @@ +/* + * Copyright (c) 2007 KISA(Korea Information Security Agency). All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Neither the name of author nor the names of its contributors may + * be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + */ +/* ==================================================================== + * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + + +#ifndef HEADER_SEED_H +#define HEADER_SEED_H + +#include +#include +#include + +#ifdef OPENSSL_NO_SEED +#error SEED is disabled. +#endif + +#ifdef AES_LONG /* look whether we need 'long' to get 32 bits */ +# ifndef SEED_LONG +# define SEED_LONG 1 +# endif +#endif + +#if !defined(NO_SYS_TYPES_H) +# include +#endif + +#define SEED_BLOCK_SIZE 16 +#define SEED_KEY_LENGTH 16 + + +#ifdef __cplusplus +extern "C" { +#endif + + +typedef struct seed_key_st { +#ifdef SEED_LONG + unsigned long data[32]; +#else + unsigned int data[32]; +#endif +} SEED_KEY_SCHEDULE; + +#ifdef OPENSSL_FIPS +void private_SEED_set_key(const unsigned char rawkey[SEED_KEY_LENGTH], SEED_KEY_SCHEDULE *ks); +#endif +void SEED_set_key(const unsigned char rawkey[SEED_KEY_LENGTH], SEED_KEY_SCHEDULE *ks); + +void SEED_encrypt(const unsigned char s[SEED_BLOCK_SIZE], unsigned char d[SEED_BLOCK_SIZE], const SEED_KEY_SCHEDULE *ks); +void SEED_decrypt(const unsigned char s[SEED_BLOCK_SIZE], unsigned char d[SEED_BLOCK_SIZE], const SEED_KEY_SCHEDULE *ks); + +void SEED_ecb_encrypt(const unsigned char *in, unsigned char *out, const SEED_KEY_SCHEDULE *ks, int enc); +void SEED_cbc_encrypt(const unsigned char *in, unsigned char *out, + size_t len, const SEED_KEY_SCHEDULE *ks, unsigned char ivec[SEED_BLOCK_SIZE], int enc); +void SEED_cfb128_encrypt(const unsigned char *in, unsigned char *out, + size_t len, const SEED_KEY_SCHEDULE *ks, unsigned char ivec[SEED_BLOCK_SIZE], int *num, int enc); +void SEED_ofb128_encrypt(const unsigned char *in, unsigned char *out, + size_t len, const SEED_KEY_SCHEDULE *ks, unsigned char ivec[SEED_BLOCK_SIZE], int *num); + +#ifdef __cplusplus +} +#endif + +#endif /* HEADER_SEED_H */ diff --git a/Source/Import/OpenSSL/Include/openssl/sha.h b/Source/Import/OpenSSL/Include/openssl/sha.h new file mode 100644 index 0000000..8a6bf4b --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/sha.h @@ -0,0 +1,214 @@ +/* crypto/sha/sha.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_SHA_H +#define HEADER_SHA_H + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#if defined(OPENSSL_NO_SHA) || (defined(OPENSSL_NO_SHA0) && defined(OPENSSL_NO_SHA1)) +#error SHA is disabled. +#endif + +#if defined(OPENSSL_FIPS) +#define FIPS_SHA_SIZE_T size_t +#endif + +/* + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + * ! SHA_LONG has to be at least 32 bits wide. If it's wider, then ! + * ! SHA_LONG_LOG2 has to be defined along. ! + * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + */ + +#if defined(__LP32__) +#define SHA_LONG unsigned long +#elif defined(OPENSSL_SYS_CRAY) || defined(__ILP64__) +#define SHA_LONG unsigned long +#define SHA_LONG_LOG2 3 +#else +#define SHA_LONG unsigned int +#endif + +#define SHA_LBLOCK 16 +#define SHA_CBLOCK (SHA_LBLOCK*4) /* SHA treats input data as a + * contiguous array of 32 bit + * wide big-endian values. */ +#define SHA_LAST_BLOCK (SHA_CBLOCK-8) +#define SHA_DIGEST_LENGTH 20 + +typedef struct SHAstate_st + { + SHA_LONG h0,h1,h2,h3,h4; + SHA_LONG Nl,Nh; + SHA_LONG data[SHA_LBLOCK]; + unsigned int num; + } SHA_CTX; + +#ifndef OPENSSL_NO_SHA0 +#ifdef OPENSSL_FIPS +int private_SHA_Init(SHA_CTX *c); +#endif +int SHA_Init(SHA_CTX *c); +int SHA_Update(SHA_CTX *c, const void *data, size_t len); +int SHA_Final(unsigned char *md, SHA_CTX *c); +unsigned char *SHA(const unsigned char *d, size_t n, unsigned char *md); +void SHA_Transform(SHA_CTX *c, const unsigned char *data); +#endif +#ifndef OPENSSL_NO_SHA1 +#ifdef OPENSSL_FIPS +int private_SHA1_Init(SHA_CTX *c); +#endif +int SHA1_Init(SHA_CTX *c); +int SHA1_Update(SHA_CTX *c, const void *data, size_t len); +int SHA1_Final(unsigned char *md, SHA_CTX *c); +unsigned char *SHA1(const unsigned char *d, size_t n, unsigned char *md); +void SHA1_Transform(SHA_CTX *c, const unsigned char *data); +#endif + +#define SHA256_CBLOCK (SHA_LBLOCK*4) /* SHA-256 treats input data as a + * contiguous array of 32 bit + * wide big-endian values. */ +#define SHA224_DIGEST_LENGTH 28 +#define SHA256_DIGEST_LENGTH 32 + +typedef struct SHA256state_st + { + SHA_LONG h[8]; + SHA_LONG Nl,Nh; + SHA_LONG data[SHA_LBLOCK]; + unsigned int num,md_len; + } SHA256_CTX; + +#ifndef OPENSSL_NO_SHA256 +#ifdef OPENSSL_FIPS +int private_SHA224_Init(SHA256_CTX *c); +int private_SHA256_Init(SHA256_CTX *c); +#endif +int SHA224_Init(SHA256_CTX *c); +int SHA224_Update(SHA256_CTX *c, const void *data, size_t len); +int SHA224_Final(unsigned char *md, SHA256_CTX *c); +unsigned char *SHA224(const unsigned char *d, size_t n,unsigned char *md); +int SHA256_Init(SHA256_CTX *c); +int SHA256_Update(SHA256_CTX *c, const void *data, size_t len); +int SHA256_Final(unsigned char *md, SHA256_CTX *c); +unsigned char *SHA256(const unsigned char *d, size_t n,unsigned char *md); +void SHA256_Transform(SHA256_CTX *c, const unsigned char *data); +#endif + +#define SHA384_DIGEST_LENGTH 48 +#define SHA512_DIGEST_LENGTH 64 + +#ifndef OPENSSL_NO_SHA512 +/* + * Unlike 32-bit digest algorithms, SHA-512 *relies* on SHA_LONG64 + * being exactly 64-bit wide. See Implementation Notes in sha512.c + * for further details. + */ +#define SHA512_CBLOCK (SHA_LBLOCK*8) /* SHA-512 treats input data as a + * contiguous array of 64 bit + * wide big-endian values. */ +#if (defined(_WIN32) || defined(_WIN64)) && !defined(__MINGW32__) +#define SHA_LONG64 unsigned __int64 +#define U64(C) C##UI64 +#elif defined(__arch64__) +#define SHA_LONG64 unsigned long +#define U64(C) C##UL +#else +#define SHA_LONG64 unsigned long long +#define U64(C) C##ULL +#endif + +typedef struct SHA512state_st + { + SHA_LONG64 h[8]; + SHA_LONG64 Nl,Nh; + union { + SHA_LONG64 d[SHA_LBLOCK]; + unsigned char p[SHA512_CBLOCK]; + } u; + unsigned int num,md_len; + } SHA512_CTX; +#endif + +#ifndef OPENSSL_NO_SHA512 +#ifdef OPENSSL_FIPS +int private_SHA384_Init(SHA512_CTX *c); +int private_SHA512_Init(SHA512_CTX *c); +#endif +int SHA384_Init(SHA512_CTX *c); +int SHA384_Update(SHA512_CTX *c, const void *data, size_t len); +int SHA384_Final(unsigned char *md, SHA512_CTX *c); +unsigned char *SHA384(const unsigned char *d, size_t n,unsigned char *md); +int SHA512_Init(SHA512_CTX *c); +int SHA512_Update(SHA512_CTX *c, const void *data, size_t len); +int SHA512_Final(unsigned char *md, SHA512_CTX *c); +unsigned char *SHA512(const unsigned char *d, size_t n,unsigned char *md); +void SHA512_Transform(SHA512_CTX *c, const unsigned char *data); +#endif + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/srp.h b/Source/Import/OpenSSL/Include/openssl/srp.h new file mode 100644 index 0000000..7ec7825 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/srp.h @@ -0,0 +1,172 @@ +/* crypto/srp/srp.h */ +/* Written by Christophe Renou (christophe.renou@edelweb.fr) with + * the precious help of Peter Sylvester (peter.sylvester@edelweb.fr) + * for the EdelKey project and contributed to the OpenSSL project 2004. + */ +/* ==================================================================== + * Copyright (c) 2004 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +#ifndef __SRP_H__ +#define __SRP_H__ + +#ifndef OPENSSL_NO_SRP + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#include +#include + +typedef struct SRP_gN_cache_st + { + char *b64_bn; + BIGNUM *bn; + } SRP_gN_cache; + + +DECLARE_STACK_OF(SRP_gN_cache) + +typedef struct SRP_user_pwd_st + { + char *id; + BIGNUM *s; + BIGNUM *v; + const BIGNUM *g; + const BIGNUM *N; + char *info; + } SRP_user_pwd; + +DECLARE_STACK_OF(SRP_user_pwd) + +typedef struct SRP_VBASE_st + { + STACK_OF(SRP_user_pwd) *users_pwd; + STACK_OF(SRP_gN_cache) *gN_cache; +/* to simulate a user */ + char *seed_key; + BIGNUM *default_g; + BIGNUM *default_N; + } SRP_VBASE; + + +/*Structure interne pour retenir les couples N et g*/ +typedef struct SRP_gN_st + { + char *id; + BIGNUM *g; + BIGNUM *N; + } SRP_gN; + +DECLARE_STACK_OF(SRP_gN) + +SRP_VBASE *SRP_VBASE_new(char *seed_key); +int SRP_VBASE_free(SRP_VBASE *vb); +int SRP_VBASE_init(SRP_VBASE *vb, char * verifier_file); +SRP_user_pwd *SRP_VBASE_get_by_user(SRP_VBASE *vb, char *username); +char *SRP_create_verifier(const char *user, const char *pass, char **salt, + char **verifier, const char *N, const char *g); +int SRP_create_verifier_BN(const char *user, const char *pass, BIGNUM **salt, BIGNUM **verifier, BIGNUM *N, BIGNUM *g); + + +#define SRP_NO_ERROR 0 +#define SRP_ERR_VBASE_INCOMPLETE_FILE 1 +#define SRP_ERR_VBASE_BN_LIB 2 +#define SRP_ERR_OPEN_FILE 3 +#define SRP_ERR_MEMORY 4 + +#define DB_srptype 0 +#define DB_srpverifier 1 +#define DB_srpsalt 2 +#define DB_srpid 3 +#define DB_srpgN 4 +#define DB_srpinfo 5 +#undef DB_NUMBER +#define DB_NUMBER 6 + +#define DB_SRP_INDEX 'I' +#define DB_SRP_VALID 'V' +#define DB_SRP_REVOKED 'R' +#define DB_SRP_MODIF 'v' + + +/* see srp.c */ +char * SRP_check_known_gN_param(BIGNUM* g, BIGNUM* N); +SRP_gN *SRP_get_default_gN(const char * id) ; + +/* server side .... */ +BIGNUM *SRP_Calc_server_key(BIGNUM *A, BIGNUM *v, BIGNUM *u, BIGNUM *b, BIGNUM *N); +BIGNUM *SRP_Calc_B(BIGNUM *b, BIGNUM *N, BIGNUM *g, BIGNUM *v); +int SRP_Verify_A_mod_N(BIGNUM *A, BIGNUM *N); +BIGNUM *SRP_Calc_u(BIGNUM *A, BIGNUM *B, BIGNUM *N) ; + + + +/* client side .... */ +BIGNUM *SRP_Calc_x(BIGNUM *s, const char *user, const char *pass); +BIGNUM *SRP_Calc_A(BIGNUM *a, BIGNUM *N, BIGNUM *g); +BIGNUM *SRP_Calc_client_key(BIGNUM *N, BIGNUM *B, BIGNUM *g, BIGNUM *x, BIGNUM *a, BIGNUM *u); +int SRP_Verify_B_mod_N(BIGNUM *B, BIGNUM *N); + +#define SRP_MINIMAL_N 1024 + +#ifdef __cplusplus +} +#endif + +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/srtp.h b/Source/Import/OpenSSL/Include/openssl/srtp.h new file mode 100644 index 0000000..c0cf33e --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/srtp.h @@ -0,0 +1,145 @@ +/* ssl/tls1.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ +/* ==================================================================== + * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +/* + DTLS code by Eric Rescorla + + Copyright (C) 2006, Network Resonance, Inc. + Copyright (C) 2011, RTFM, Inc. +*/ + +#ifndef HEADER_D1_SRTP_H +#define HEADER_D1_SRTP_H + +#ifdef __cplusplus +extern "C" { +#endif + + +#define SRTP_AES128_CM_SHA1_80 0x0001 +#define SRTP_AES128_CM_SHA1_32 0x0002 +#define SRTP_AES128_F8_SHA1_80 0x0003 +#define SRTP_AES128_F8_SHA1_32 0x0004 +#define SRTP_NULL_SHA1_80 0x0005 +#define SRTP_NULL_SHA1_32 0x0006 + +int SSL_CTX_set_tlsext_use_srtp(SSL_CTX *ctx, const char *profiles); +int SSL_set_tlsext_use_srtp(SSL *ctx, const char *profiles); +SRTP_PROTECTION_PROFILE *SSL_get_selected_srtp_profile(SSL *s); + +STACK_OF(SRTP_PROTECTION_PROFILE) *SSL_get_srtp_profiles(SSL *ssl); +SRTP_PROTECTION_PROFILE *SSL_get_selected_srtp_profile(SSL *s); + +#ifdef __cplusplus +} +#endif + +#endif + diff --git a/Source/Import/OpenSSL/Include/openssl/ssl.h b/Source/Import/OpenSSL/Include/openssl/ssl.h new file mode 100644 index 0000000..8b0c2a2 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ssl.h @@ -0,0 +1,2573 @@ +/* ssl/ssl.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ +/* ==================================================================== + * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +/* ==================================================================== + * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. + * ECC cipher suite support in OpenSSL originally developed by + * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project. + */ +/* ==================================================================== + * Copyright 2005 Nokia. All rights reserved. + * + * The portions of the attached software ("Contribution") is developed by + * Nokia Corporation and is licensed pursuant to the OpenSSL open source + * license. + * + * The Contribution, originally written by Mika Kousa and Pasi Eronen of + * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites + * support (see RFC 4279) to OpenSSL. + * + * No patent licenses or other rights except those expressly stated in + * the OpenSSL open source license shall be deemed granted or received + * expressly, by implication, estoppel, or otherwise. + * + * No assurances are provided by Nokia that the Contribution does not + * infringe the patent or other intellectual property rights of any third + * party or that the license provides you with all the necessary rights + * to make use of the Contribution. + * + * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN + * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA + * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY + * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR + * OTHERWISE. + */ + +#ifndef HEADER_SSL_H +#define HEADER_SSL_H + +#include + +#ifndef OPENSSL_NO_COMP +#include +#endif +#ifndef OPENSSL_NO_BIO +#include +#endif +#ifndef OPENSSL_NO_DEPRECATED +#ifndef OPENSSL_NO_X509 +#include +#endif +#include +#include +#include +#endif +#include +#include + +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* SSLeay version number for ASN.1 encoding of the session information */ +/* Version 0 - initial version + * Version 1 - added the optional peer certificate + */ +#define SSL_SESSION_ASN1_VERSION 0x0001 + +/* text strings for the ciphers */ +#define SSL_TXT_NULL_WITH_MD5 SSL2_TXT_NULL_WITH_MD5 +#define SSL_TXT_RC4_128_WITH_MD5 SSL2_TXT_RC4_128_WITH_MD5 +#define SSL_TXT_RC4_128_EXPORT40_WITH_MD5 SSL2_TXT_RC4_128_EXPORT40_WITH_MD5 +#define SSL_TXT_RC2_128_CBC_WITH_MD5 SSL2_TXT_RC2_128_CBC_WITH_MD5 +#define SSL_TXT_RC2_128_CBC_EXPORT40_WITH_MD5 SSL2_TXT_RC2_128_CBC_EXPORT40_WITH_MD5 +#define SSL_TXT_IDEA_128_CBC_WITH_MD5 SSL2_TXT_IDEA_128_CBC_WITH_MD5 +#define SSL_TXT_DES_64_CBC_WITH_MD5 SSL2_TXT_DES_64_CBC_WITH_MD5 +#define SSL_TXT_DES_64_CBC_WITH_SHA SSL2_TXT_DES_64_CBC_WITH_SHA +#define SSL_TXT_DES_192_EDE3_CBC_WITH_MD5 SSL2_TXT_DES_192_EDE3_CBC_WITH_MD5 +#define SSL_TXT_DES_192_EDE3_CBC_WITH_SHA SSL2_TXT_DES_192_EDE3_CBC_WITH_SHA + +/* VRS Additional Kerberos5 entries + */ +#define SSL_TXT_KRB5_DES_64_CBC_SHA SSL3_TXT_KRB5_DES_64_CBC_SHA +#define SSL_TXT_KRB5_DES_192_CBC3_SHA SSL3_TXT_KRB5_DES_192_CBC3_SHA +#define SSL_TXT_KRB5_RC4_128_SHA SSL3_TXT_KRB5_RC4_128_SHA +#define SSL_TXT_KRB5_IDEA_128_CBC_SHA SSL3_TXT_KRB5_IDEA_128_CBC_SHA +#define SSL_TXT_KRB5_DES_64_CBC_MD5 SSL3_TXT_KRB5_DES_64_CBC_MD5 +#define SSL_TXT_KRB5_DES_192_CBC3_MD5 SSL3_TXT_KRB5_DES_192_CBC3_MD5 +#define SSL_TXT_KRB5_RC4_128_MD5 SSL3_TXT_KRB5_RC4_128_MD5 +#define SSL_TXT_KRB5_IDEA_128_CBC_MD5 SSL3_TXT_KRB5_IDEA_128_CBC_MD5 + +#define SSL_TXT_KRB5_DES_40_CBC_SHA SSL3_TXT_KRB5_DES_40_CBC_SHA +#define SSL_TXT_KRB5_RC2_40_CBC_SHA SSL3_TXT_KRB5_RC2_40_CBC_SHA +#define SSL_TXT_KRB5_RC4_40_SHA SSL3_TXT_KRB5_RC4_40_SHA +#define SSL_TXT_KRB5_DES_40_CBC_MD5 SSL3_TXT_KRB5_DES_40_CBC_MD5 +#define SSL_TXT_KRB5_RC2_40_CBC_MD5 SSL3_TXT_KRB5_RC2_40_CBC_MD5 +#define SSL_TXT_KRB5_RC4_40_MD5 SSL3_TXT_KRB5_RC4_40_MD5 + +#define SSL_TXT_KRB5_DES_40_CBC_SHA SSL3_TXT_KRB5_DES_40_CBC_SHA +#define SSL_TXT_KRB5_DES_40_CBC_MD5 SSL3_TXT_KRB5_DES_40_CBC_MD5 +#define SSL_TXT_KRB5_DES_64_CBC_SHA SSL3_TXT_KRB5_DES_64_CBC_SHA +#define SSL_TXT_KRB5_DES_64_CBC_MD5 SSL3_TXT_KRB5_DES_64_CBC_MD5 +#define SSL_TXT_KRB5_DES_192_CBC3_SHA SSL3_TXT_KRB5_DES_192_CBC3_SHA +#define SSL_TXT_KRB5_DES_192_CBC3_MD5 SSL3_TXT_KRB5_DES_192_CBC3_MD5 +#define SSL_MAX_KRB5_PRINCIPAL_LENGTH 256 + +#define SSL_MAX_SSL_SESSION_ID_LENGTH 32 +#define SSL_MAX_SID_CTX_LENGTH 32 + +#define SSL_MIN_RSA_MODULUS_LENGTH_IN_BYTES (512/8) +#define SSL_MAX_KEY_ARG_LENGTH 8 +#define SSL_MAX_MASTER_KEY_LENGTH 48 + + +/* These are used to specify which ciphers to use and not to use */ + +#define SSL_TXT_EXP40 "EXPORT40" +#define SSL_TXT_EXP56 "EXPORT56" +#define SSL_TXT_LOW "LOW" +#define SSL_TXT_MEDIUM "MEDIUM" +#define SSL_TXT_HIGH "HIGH" +#define SSL_TXT_FIPS "FIPS" + +#define SSL_TXT_kFZA "kFZA" /* unused! */ +#define SSL_TXT_aFZA "aFZA" /* unused! */ +#define SSL_TXT_eFZA "eFZA" /* unused! */ +#define SSL_TXT_FZA "FZA" /* unused! */ + +#define SSL_TXT_aNULL "aNULL" +#define SSL_TXT_eNULL "eNULL" +#define SSL_TXT_NULL "NULL" + +#define SSL_TXT_kRSA "kRSA" +#define SSL_TXT_kDHr "kDHr" /* no such ciphersuites supported! */ +#define SSL_TXT_kDHd "kDHd" /* no such ciphersuites supported! */ +#define SSL_TXT_kDH "kDH" /* no such ciphersuites supported! */ +#define SSL_TXT_kEDH "kEDH" +#define SSL_TXT_kKRB5 "kKRB5" +#define SSL_TXT_kECDHr "kECDHr" +#define SSL_TXT_kECDHe "kECDHe" +#define SSL_TXT_kECDH "kECDH" +#define SSL_TXT_kEECDH "kEECDH" +#define SSL_TXT_kPSK "kPSK" +#define SSL_TXT_kGOST "kGOST" +#define SSL_TXT_kSRP "kSRP" + +#define SSL_TXT_aRSA "aRSA" +#define SSL_TXT_aDSS "aDSS" +#define SSL_TXT_aDH "aDH" /* no such ciphersuites supported! */ +#define SSL_TXT_aECDH "aECDH" +#define SSL_TXT_aKRB5 "aKRB5" +#define SSL_TXT_aECDSA "aECDSA" +#define SSL_TXT_aPSK "aPSK" +#define SSL_TXT_aGOST94 "aGOST94" +#define SSL_TXT_aGOST01 "aGOST01" +#define SSL_TXT_aGOST "aGOST" + +#define SSL_TXT_DSS "DSS" +#define SSL_TXT_DH "DH" +#define SSL_TXT_EDH "EDH" /* same as "kEDH:-ADH" */ +#define SSL_TXT_ADH "ADH" +#define SSL_TXT_RSA "RSA" +#define SSL_TXT_ECDH "ECDH" +#define SSL_TXT_EECDH "EECDH" /* same as "kEECDH:-AECDH" */ +#define SSL_TXT_AECDH "AECDH" +#define SSL_TXT_ECDSA "ECDSA" +#define SSL_TXT_KRB5 "KRB5" +#define SSL_TXT_PSK "PSK" +#define SSL_TXT_SRP "SRP" + +#define SSL_TXT_DES "DES" +#define SSL_TXT_3DES "3DES" +#define SSL_TXT_RC4 "RC4" +#define SSL_TXT_RC2 "RC2" +#define SSL_TXT_IDEA "IDEA" +#define SSL_TXT_SEED "SEED" +#define SSL_TXT_AES128 "AES128" +#define SSL_TXT_AES256 "AES256" +#define SSL_TXT_AES "AES" +#define SSL_TXT_AES_GCM "AESGCM" +#define SSL_TXT_CAMELLIA128 "CAMELLIA128" +#define SSL_TXT_CAMELLIA256 "CAMELLIA256" +#define SSL_TXT_CAMELLIA "CAMELLIA" + +#define SSL_TXT_MD5 "MD5" +#define SSL_TXT_SHA1 "SHA1" +#define SSL_TXT_SHA "SHA" /* same as "SHA1" */ +#define SSL_TXT_GOST94 "GOST94" +#define SSL_TXT_GOST89MAC "GOST89MAC" +#define SSL_TXT_SHA256 "SHA256" +#define SSL_TXT_SHA384 "SHA384" + +#define SSL_TXT_SSLV2 "SSLv2" +#define SSL_TXT_SSLV3 "SSLv3" +#define SSL_TXT_TLSV1 "TLSv1" +#define SSL_TXT_TLSV1_1 "TLSv1.1" +#define SSL_TXT_TLSV1_2 "TLSv1.2" + +#define SSL_TXT_EXP "EXP" +#define SSL_TXT_EXPORT "EXPORT" + +#define SSL_TXT_ALL "ALL" + +/* + * COMPLEMENTOF* definitions. These identifiers are used to (de-select) + * ciphers normally not being used. + * Example: "RC4" will activate all ciphers using RC4 including ciphers + * without authentication, which would normally disabled by DEFAULT (due + * the "!ADH" being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT" + * will make sure that it is also disabled in the specific selection. + * COMPLEMENTOF* identifiers are portable between version, as adjustments + * to the default cipher setup will also be included here. + * + * COMPLEMENTOFDEFAULT does not experience the same special treatment that + * DEFAULT gets, as only selection is being done and no sorting as needed + * for DEFAULT. + */ +#define SSL_TXT_CMPALL "COMPLEMENTOFALL" +#define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT" + +/* The following cipher list is used by default. + * It also is substituted when an application-defined cipher list string + * starts with 'DEFAULT'. */ +#define SSL_DEFAULT_CIPHER_LIST "ALL:!aNULL:!eNULL:!SSLv2" +/* As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always + * starts with a reasonable order, and all we have to do for DEFAULT is + * throwing out anonymous and unencrypted ciphersuites! + * (The latter are not actually enabled by ALL, but "ALL:RSA" would enable + * some of them.) + */ + +/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */ +#define SSL_SENT_SHUTDOWN 1 +#define SSL_RECEIVED_SHUTDOWN 2 + +#ifdef __cplusplus +} +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#if (defined(OPENSSL_NO_RSA) || defined(OPENSSL_NO_MD5)) && !defined(OPENSSL_NO_SSL2) +#define OPENSSL_NO_SSL2 +#endif + +#define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1 +#define SSL_FILETYPE_PEM X509_FILETYPE_PEM + +/* This is needed to stop compilers complaining about the + * 'struct ssl_st *' function parameters used to prototype callbacks + * in SSL_CTX. */ +typedef struct ssl_st *ssl_crock_st; +typedef struct tls_session_ticket_ext_st TLS_SESSION_TICKET_EXT; +typedef struct ssl_method_st SSL_METHOD; +typedef struct ssl_cipher_st SSL_CIPHER; +typedef struct ssl_session_st SSL_SESSION; + +DECLARE_STACK_OF(SSL_CIPHER) + +/* SRTP protection profiles for use with the use_srtp extension (RFC 5764)*/ +typedef struct srtp_protection_profile_st + { + const char *name; + unsigned long id; + } SRTP_PROTECTION_PROFILE; + +DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE) + +typedef int (*tls_session_ticket_ext_cb_fn)(SSL *s, const unsigned char *data, int len, void *arg); +typedef int (*tls_session_secret_cb_fn)(SSL *s, void *secret, int *secret_len, STACK_OF(SSL_CIPHER) *peer_ciphers, SSL_CIPHER **cipher, void *arg); + + +#ifndef OPENSSL_NO_SSL_INTERN + +/* used to hold info on the particular ciphers used */ +struct ssl_cipher_st + { + int valid; + const char *name; /* text name */ + unsigned long id; /* id, 4 bytes, first is version */ + + /* changed in 0.9.9: these four used to be portions of a single value 'algorithms' */ + unsigned long algorithm_mkey; /* key exchange algorithm */ + unsigned long algorithm_auth; /* server authentication */ + unsigned long algorithm_enc; /* symmetric encryption */ + unsigned long algorithm_mac; /* symmetric authentication */ + unsigned long algorithm_ssl; /* (major) protocol version */ + + unsigned long algo_strength; /* strength and export flags */ + unsigned long algorithm2; /* Extra flags */ + int strength_bits; /* Number of bits really used */ + int alg_bits; /* Number of bits for algorithm */ + }; + + +/* Used to hold functions for SSLv2 or SSLv3/TLSv1 functions */ +struct ssl_method_st + { + int version; + int (*ssl_new)(SSL *s); + void (*ssl_clear)(SSL *s); + void (*ssl_free)(SSL *s); + int (*ssl_accept)(SSL *s); + int (*ssl_connect)(SSL *s); + int (*ssl_read)(SSL *s,void *buf,int len); + int (*ssl_peek)(SSL *s,void *buf,int len); + int (*ssl_write)(SSL *s,const void *buf,int len); + int (*ssl_shutdown)(SSL *s); + int (*ssl_renegotiate)(SSL *s); + int (*ssl_renegotiate_check)(SSL *s); + long (*ssl_get_message)(SSL *s, int st1, int stn, int mt, long + max, int *ok); + int (*ssl_read_bytes)(SSL *s, int type, unsigned char *buf, int len, + int peek); + int (*ssl_write_bytes)(SSL *s, int type, const void *buf_, int len); + int (*ssl_dispatch_alert)(SSL *s); + long (*ssl_ctrl)(SSL *s,int cmd,long larg,void *parg); + long (*ssl_ctx_ctrl)(SSL_CTX *ctx,int cmd,long larg,void *parg); + const SSL_CIPHER *(*get_cipher_by_char)(const unsigned char *ptr); + int (*put_cipher_by_char)(const SSL_CIPHER *cipher,unsigned char *ptr); + int (*ssl_pending)(const SSL *s); + int (*num_ciphers)(void); + const SSL_CIPHER *(*get_cipher)(unsigned ncipher); + const struct ssl_method_st *(*get_ssl_method)(int version); + long (*get_timeout)(void); + struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */ + int (*ssl_version)(void); + long (*ssl_callback_ctrl)(SSL *s, int cb_id, void (*fp)(void)); + long (*ssl_ctx_callback_ctrl)(SSL_CTX *s, int cb_id, void (*fp)(void)); + }; + +/* Lets make this into an ASN.1 type structure as follows + * SSL_SESSION_ID ::= SEQUENCE { + * version INTEGER, -- structure version number + * SSLversion INTEGER, -- SSL version number + * Cipher OCTET STRING, -- the 3 byte cipher ID + * Session_ID OCTET STRING, -- the Session ID + * Master_key OCTET STRING, -- the master key + * KRB5_principal OCTET STRING -- optional Kerberos principal + * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument + * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time + * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds + * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate + * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context + * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer' + * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension + * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint + * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity + * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket + * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only) + * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method + * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username + * } + * Look in ssl/ssl_asn1.c for more details + * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-). + */ +struct ssl_session_st + { + int ssl_version; /* what ssl version session info is + * being kept in here? */ + + /* only really used in SSLv2 */ + unsigned int key_arg_length; + unsigned char key_arg[SSL_MAX_KEY_ARG_LENGTH]; + int master_key_length; + unsigned char master_key[SSL_MAX_MASTER_KEY_LENGTH]; + /* session_id - valid? */ + unsigned int session_id_length; + unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH]; + /* this is used to determine whether the session is being reused in + * the appropriate context. It is up to the application to set this, + * via SSL_new */ + unsigned int sid_ctx_length; + unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH]; + +#ifndef OPENSSL_NO_KRB5 + unsigned int krb5_client_princ_len; + unsigned char krb5_client_princ[SSL_MAX_KRB5_PRINCIPAL_LENGTH]; +#endif /* OPENSSL_NO_KRB5 */ +#ifndef OPENSSL_NO_PSK + char *psk_identity_hint; + char *psk_identity; +#endif + int not_resumable; + + /* The cert is the certificate used to establish this connection */ + struct sess_cert_st /* SESS_CERT */ *sess_cert; + + /* This is the cert for the other end. + * On clients, it will be the same as sess_cert->peer_key->x509 + * (the latter is not enough as sess_cert is not retained + * in the external representation of sessions, see ssl_asn1.c). */ + X509 *peer; + /* when app_verify_callback accepts a session where the peer's certificate + * is not ok, we must remember the error for session reuse: */ + long verify_result; /* only for servers */ + + int references; + long timeout; + long time; + + unsigned int compress_meth; /* Need to lookup the method */ + + const SSL_CIPHER *cipher; + unsigned long cipher_id; /* when ASN.1 loaded, this + * needs to be used to load + * the 'cipher' structure */ + + STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */ + + CRYPTO_EX_DATA ex_data; /* application specific data */ + + /* These are used to make removal of session-ids more + * efficient and to implement a maximum cache size. */ + struct ssl_session_st *prev,*next; +#ifndef OPENSSL_NO_TLSEXT + char *tlsext_hostname; +#ifndef OPENSSL_NO_EC + size_t tlsext_ecpointformatlist_length; + unsigned char *tlsext_ecpointformatlist; /* peer's list */ + size_t tlsext_ellipticcurvelist_length; + unsigned char *tlsext_ellipticcurvelist; /* peer's list */ +#endif /* OPENSSL_NO_EC */ + /* RFC4507 info */ + unsigned char *tlsext_tick; /* Session ticket */ + size_t tlsext_ticklen; /* Session ticket length */ + long tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */ +#endif +#ifndef OPENSSL_NO_SRP + char *srp_username; +#endif + }; + +#endif + +#define SSL_OP_MICROSOFT_SESS_ID_BUG 0x00000001L +#define SSL_OP_NETSCAPE_CHALLENGE_BUG 0x00000002L +/* Allow initial connection to servers that don't support RI */ +#define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L +#define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG 0x00000008L +#define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0x00000010L +#define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L +#define SSL_OP_MSIE_SSLV2_RSA_PADDING 0x00000040L /* no effect since 0.9.7h and 0.9.8b */ +#define SSL_OP_SSLEAY_080_CLIENT_DH_BUG 0x00000080L +#define SSL_OP_TLS_D5_BUG 0x00000100L +#define SSL_OP_TLS_BLOCK_PADDING_BUG 0x00000200L + +/* Disable SSL 3.0/TLS 1.0 CBC vulnerability workaround that was added + * in OpenSSL 0.9.6d. Usually (depending on the application protocol) + * the workaround is not needed. Unfortunately some broken SSL/TLS + * implementations cannot handle it at all, which is why we include + * it in SSL_OP_ALL. */ +#define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0x00000800L /* added in 0.9.6e */ + +/* SSL_OP_ALL: various bug workarounds that should be rather harmless. + * This used to be 0x000FFFFFL before 0.9.7. */ +#define SSL_OP_ALL 0x80000BFFL + +/* DTLS options */ +#define SSL_OP_NO_QUERY_MTU 0x00001000L +/* Turn on Cookie Exchange (on relevant for servers) */ +#define SSL_OP_COOKIE_EXCHANGE 0x00002000L +/* Don't use RFC4507 ticket extension */ +#define SSL_OP_NO_TICKET 0x00004000L +/* Use Cisco's "speshul" version of DTLS_BAD_VER (as client) */ +#define SSL_OP_CISCO_ANYCONNECT 0x00008000L + +/* As server, disallow session resumption on renegotiation */ +#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0x00010000L +/* Don't use compression even if supported */ +#define SSL_OP_NO_COMPRESSION 0x00020000L +/* Permit unsafe legacy renegotiation */ +#define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0x00040000L +/* If set, always create a new key when using tmp_ecdh parameters */ +#define SSL_OP_SINGLE_ECDH_USE 0x00080000L +/* If set, always create a new key when using tmp_dh parameters */ +#define SSL_OP_SINGLE_DH_USE 0x00100000L +/* Set to always use the tmp_rsa key when doing RSA operations, + * even when this violates protocol specs */ +#define SSL_OP_EPHEMERAL_RSA 0x00200000L +/* Set on servers to choose the cipher according to the server's + * preferences */ +#define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L +/* If set, a server will allow a client to issue a SSLv3.0 version number + * as latest version supported in the premaster secret, even when TLSv1.0 + * (version 3.1) was announced in the client hello. Normally this is + * forbidden to prevent version rollback attacks. */ +#define SSL_OP_TLS_ROLLBACK_BUG 0x00800000L + +#define SSL_OP_NO_SSLv2 0x01000000L +#define SSL_OP_NO_SSLv3 0x02000000L +#define SSL_OP_NO_TLSv1 0x04000000L +#define SSL_OP_NO_TLSv1_2 0x08000000L +#define SSL_OP_NO_TLSv1_1 0x10000000L + +/* These next two were never actually used for anything since SSLeay + * zap so we have some more flags. + */ +/* The next flag deliberately changes the ciphertest, this is a check + * for the PKCS#1 attack */ +#define SSL_OP_PKCS1_CHECK_1 0x0 +#define SSL_OP_PKCS1_CHECK_2 0x0 + +#define SSL_OP_NETSCAPE_CA_DN_BUG 0x20000000L +#define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG 0x40000000L +/* Make server add server-hello extension from early version of + * cryptopro draft, when GOST ciphersuite is negotiated. + * Required for interoperability with CryptoPro CSP 3.x + */ +#define SSL_OP_CRYPTOPRO_TLSEXT_BUG 0x80000000L + +/* Allow SSL_write(..., n) to return r with 0 < r < n (i.e. report success + * when just a single record has been written): */ +#define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L +/* Make it possible to retry SSL_write() with changed buffer location + * (buffer contents must stay the same!); this is not the default to avoid + * the misconception that non-blocking SSL_write() behaves like + * non-blocking write(): */ +#define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L +/* Never bother the application with retries if the transport + * is blocking: */ +#define SSL_MODE_AUTO_RETRY 0x00000004L +/* Don't attempt to automatically build certificate chain */ +#define SSL_MODE_NO_AUTO_CHAIN 0x00000008L +/* Save RAM by releasing read and write buffers when they're empty. (SSL3 and + * TLS only.) "Released" buffers are put onto a free-list in the context + * or just freed (depending on the context's setting for freelist_max_len). */ +#define SSL_MODE_RELEASE_BUFFERS 0x00000010L + +/* Note: SSL[_CTX]_set_{options,mode} use |= op on the previous value, + * they cannot be used to clear bits. */ + +#define SSL_CTX_set_options(ctx,op) \ + SSL_CTX_ctrl((ctx),SSL_CTRL_OPTIONS,(op),NULL) +#define SSL_CTX_clear_options(ctx,op) \ + SSL_CTX_ctrl((ctx),SSL_CTRL_CLEAR_OPTIONS,(op),NULL) +#define SSL_CTX_get_options(ctx) \ + SSL_CTX_ctrl((ctx),SSL_CTRL_OPTIONS,0,NULL) +#define SSL_set_options(ssl,op) \ + SSL_ctrl((ssl),SSL_CTRL_OPTIONS,(op),NULL) +#define SSL_clear_options(ssl,op) \ + SSL_ctrl((ssl),SSL_CTRL_CLEAR_OPTIONS,(op),NULL) +#define SSL_get_options(ssl) \ + SSL_ctrl((ssl),SSL_CTRL_OPTIONS,0,NULL) + +#define SSL_CTX_set_mode(ctx,op) \ + SSL_CTX_ctrl((ctx),SSL_CTRL_MODE,(op),NULL) +#define SSL_CTX_clear_mode(ctx,op) \ + SSL_CTX_ctrl((ctx),SSL_CTRL_CLEAR_MODE,(op),NULL) +#define SSL_CTX_get_mode(ctx) \ + SSL_CTX_ctrl((ctx),SSL_CTRL_MODE,0,NULL) +#define SSL_clear_mode(ssl,op) \ + SSL_ctrl((ssl),SSL_CTRL_CLEAR_MODE,(op),NULL) +#define SSL_set_mode(ssl,op) \ + SSL_ctrl((ssl),SSL_CTRL_MODE,(op),NULL) +#define SSL_get_mode(ssl) \ + SSL_ctrl((ssl),SSL_CTRL_MODE,0,NULL) +#define SSL_set_mtu(ssl, mtu) \ + SSL_ctrl((ssl),SSL_CTRL_SET_MTU,(mtu),NULL) + +#define SSL_get_secure_renegotiation_support(ssl) \ + SSL_ctrl((ssl), SSL_CTRL_GET_RI_SUPPORT, 0, NULL) + +#ifndef OPENSSL_NO_HEARTBEATS +#define SSL_heartbeat(ssl) \ + SSL_ctrl((ssl),SSL_CTRL_TLS_EXT_SEND_HEARTBEAT,0,NULL) +#endif + +void SSL_CTX_set_msg_callback(SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg)); +void SSL_set_msg_callback(SSL *ssl, void (*cb)(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg)); +#define SSL_CTX_set_msg_callback_arg(ctx, arg) SSL_CTX_ctrl((ctx), SSL_CTRL_SET_MSG_CALLBACK_ARG, 0, (arg)) +#define SSL_set_msg_callback_arg(ssl, arg) SSL_ctrl((ssl), SSL_CTRL_SET_MSG_CALLBACK_ARG, 0, (arg)) + +#ifndef OPENSSL_NO_SRP + +#ifndef OPENSSL_NO_SSL_INTERN + +typedef struct srp_ctx_st + { + /* param for all the callbacks */ + void *SRP_cb_arg; + /* set client Hello login callback */ + int (*TLS_ext_srp_username_callback)(SSL *, int *, void *); + /* set SRP N/g param callback for verification */ + int (*SRP_verify_param_callback)(SSL *, void *); + /* set SRP client passwd callback */ + char *(*SRP_give_srp_client_pwd_callback)(SSL *, void *); + + char *login; + BIGNUM *N,*g,*s,*B,*A; + BIGNUM *a,*b,*v; + char *info; + int strength; + + unsigned long srp_Mask; + } SRP_CTX; + +#endif + +/* see tls_srp.c */ +int SSL_SRP_CTX_init(SSL *s); +int SSL_CTX_SRP_CTX_init(SSL_CTX *ctx); +int SSL_SRP_CTX_free(SSL *ctx); +int SSL_CTX_SRP_CTX_free(SSL_CTX *ctx); +int SSL_srp_server_param_with_username(SSL *s, int *ad); +int SRP_generate_server_master_secret(SSL *s,unsigned char *master_key); +int SRP_Calc_A_param(SSL *s); +int SRP_generate_client_master_secret(SSL *s,unsigned char *master_key); + +#endif + +#if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYS_WIN32) +#define SSL_MAX_CERT_LIST_DEFAULT 1024*30 /* 30k max cert list :-) */ +#else +#define SSL_MAX_CERT_LIST_DEFAULT 1024*100 /* 100k max cert list :-) */ +#endif + +#define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024*20) + +/* This callback type is used inside SSL_CTX, SSL, and in the functions that set + * them. It is used to override the generation of SSL/TLS session IDs in a + * server. Return value should be zero on an error, non-zero to proceed. Also, + * callbacks should themselves check if the id they generate is unique otherwise + * the SSL handshake will fail with an error - callbacks can do this using the + * 'ssl' value they're passed by; + * SSL_has_matching_session_id(ssl, id, *id_len) + * The length value passed in is set at the maximum size the session ID can be. + * In SSLv2 this is 16 bytes, whereas SSLv3/TLSv1 it is 32 bytes. The callback + * can alter this length to be less if desired, but under SSLv2 session IDs are + * supposed to be fixed at 16 bytes so the id will be padded after the callback + * returns in this case. It is also an error for the callback to set the size to + * zero. */ +typedef int (*GEN_SESSION_CB)(const SSL *ssl, unsigned char *id, + unsigned int *id_len); + +typedef struct ssl_comp_st SSL_COMP; + +#ifndef OPENSSL_NO_SSL_INTERN + +struct ssl_comp_st + { + int id; + const char *name; +#ifndef OPENSSL_NO_COMP + COMP_METHOD *method; +#else + char *method; +#endif + }; + +DECLARE_STACK_OF(SSL_COMP) +DECLARE_LHASH_OF(SSL_SESSION); + +struct ssl_ctx_st + { + const SSL_METHOD *method; + + STACK_OF(SSL_CIPHER) *cipher_list; + /* same as above but sorted for lookup */ + STACK_OF(SSL_CIPHER) *cipher_list_by_id; + + struct x509_store_st /* X509_STORE */ *cert_store; + LHASH_OF(SSL_SESSION) *sessions; + /* Most session-ids that will be cached, default is + * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */ + unsigned long session_cache_size; + struct ssl_session_st *session_cache_head; + struct ssl_session_st *session_cache_tail; + + /* This can have one of 2 values, ored together, + * SSL_SESS_CACHE_CLIENT, + * SSL_SESS_CACHE_SERVER, + * Default is SSL_SESSION_CACHE_SERVER, which means only + * SSL_accept which cache SSL_SESSIONS. */ + int session_cache_mode; + + /* If timeout is not 0, it is the default timeout value set + * when SSL_new() is called. This has been put in to make + * life easier to set things up */ + long session_timeout; + + /* If this callback is not null, it will be called each + * time a session id is added to the cache. If this function + * returns 1, it means that the callback will do a + * SSL_SESSION_free() when it has finished using it. Otherwise, + * on 0, it means the callback has finished with it. + * If remove_session_cb is not null, it will be called when + * a session-id is removed from the cache. After the call, + * OpenSSL will SSL_SESSION_free() it. */ + int (*new_session_cb)(struct ssl_st *ssl,SSL_SESSION *sess); + void (*remove_session_cb)(struct ssl_ctx_st *ctx,SSL_SESSION *sess); + SSL_SESSION *(*get_session_cb)(struct ssl_st *ssl, + unsigned char *data,int len,int *copy); + + struct + { + int sess_connect; /* SSL new conn - started */ + int sess_connect_renegotiate;/* SSL reneg - requested */ + int sess_connect_good; /* SSL new conne/reneg - finished */ + int sess_accept; /* SSL new accept - started */ + int sess_accept_renegotiate;/* SSL reneg - requested */ + int sess_accept_good; /* SSL accept/reneg - finished */ + int sess_miss; /* session lookup misses */ + int sess_timeout; /* reuse attempt on timeouted session */ + int sess_cache_full; /* session removed due to full cache */ + int sess_hit; /* session reuse actually done */ + int sess_cb_hit; /* session-id that was not + * in the cache was + * passed back via the callback. This + * indicates that the application is + * supplying session-id's from other + * processes - spooky :-) */ + } stats; + + int references; + + /* if defined, these override the X509_verify_cert() calls */ + int (*app_verify_callback)(X509_STORE_CTX *, void *); + void *app_verify_arg; + /* before OpenSSL 0.9.7, 'app_verify_arg' was ignored + * ('app_verify_callback' was called with just one argument) */ + + /* Default password callback. */ + pem_password_cb *default_passwd_callback; + + /* Default password callback user data. */ + void *default_passwd_callback_userdata; + + /* get client cert callback */ + int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey); + + /* cookie generate callback */ + int (*app_gen_cookie_cb)(SSL *ssl, unsigned char *cookie, + unsigned int *cookie_len); + + /* verify cookie callback */ + int (*app_verify_cookie_cb)(SSL *ssl, unsigned char *cookie, + unsigned int cookie_len); + + CRYPTO_EX_DATA ex_data; + + const EVP_MD *rsa_md5;/* For SSLv2 - name is 'ssl2-md5' */ + const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */ + const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */ + + STACK_OF(X509) *extra_certs; + STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */ + + + /* Default values used when no per-SSL value is defined follow */ + + void (*info_callback)(const SSL *ssl,int type,int val); /* used if SSL's info_callback is NULL */ + + /* what we put in client cert requests */ + STACK_OF(X509_NAME) *client_CA; + + + /* Default values to use in SSL structures follow (these are copied by SSL_new) */ + + unsigned long options; + unsigned long mode; + long max_cert_list; + + struct cert_st /* CERT */ *cert; + int read_ahead; + + /* callback that allows applications to peek at protocol messages */ + void (*msg_callback)(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg); + void *msg_callback_arg; + + int verify_mode; + unsigned int sid_ctx_length; + unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH]; + int (*default_verify_callback)(int ok,X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */ + + /* Default generate session ID callback. */ + GEN_SESSION_CB generate_session_id; + + X509_VERIFY_PARAM *param; + +#if 0 + int purpose; /* Purpose setting */ + int trust; /* Trust setting */ +#endif + + int quiet_shutdown; + + /* Maximum amount of data to send in one fragment. + * actual record size can be more than this due to + * padding and MAC overheads. + */ + unsigned int max_send_fragment; + +#ifndef OPENSSL_ENGINE + /* Engine to pass requests for client certs to + */ + ENGINE *client_cert_engine; +#endif + +#ifndef OPENSSL_NO_TLSEXT + /* TLS extensions servername callback */ + int (*tlsext_servername_callback)(SSL*, int *, void *); + void *tlsext_servername_arg; + /* RFC 4507 session ticket keys */ + unsigned char tlsext_tick_key_name[16]; + unsigned char tlsext_tick_hmac_key[16]; + unsigned char tlsext_tick_aes_key[16]; + /* Callback to support customisation of ticket key setting */ + int (*tlsext_ticket_key_cb)(SSL *ssl, + unsigned char *name, unsigned char *iv, + EVP_CIPHER_CTX *ectx, + HMAC_CTX *hctx, int enc); + + /* certificate status request info */ + /* Callback for status request */ + int (*tlsext_status_cb)(SSL *ssl, void *arg); + void *tlsext_status_arg; + /* draft-rescorla-tls-opaque-prf-input-00.txt information */ + int (*tlsext_opaque_prf_input_callback)(SSL *, void *peerinput, size_t len, void *arg); + void *tlsext_opaque_prf_input_callback_arg; +#endif + +#ifndef OPENSSL_NO_PSK + char *psk_identity_hint; + unsigned int (*psk_client_callback)(SSL *ssl, const char *hint, char *identity, + unsigned int max_identity_len, unsigned char *psk, + unsigned int max_psk_len); + unsigned int (*psk_server_callback)(SSL *ssl, const char *identity, + unsigned char *psk, unsigned int max_psk_len); +#endif + +#ifndef OPENSSL_NO_BUF_FREELISTS +#define SSL_MAX_BUF_FREELIST_LEN_DEFAULT 32 + unsigned int freelist_max_len; + struct ssl3_buf_freelist_st *wbuf_freelist; + struct ssl3_buf_freelist_st *rbuf_freelist; +#endif +#ifndef OPENSSL_NO_SRP + SRP_CTX srp_ctx; /* ctx for SRP authentication */ +#endif + +#ifndef OPENSSL_NO_TLSEXT +# ifndef OPENSSL_NO_NEXTPROTONEG + /* Next protocol negotiation information */ + /* (for experimental NPN extension). */ + + /* For a server, this contains a callback function by which the set of + * advertised protocols can be provided. */ + int (*next_protos_advertised_cb)(SSL *s, const unsigned char **buf, + unsigned int *len, void *arg); + void *next_protos_advertised_cb_arg; + /* For a client, this contains a callback function that selects the + * next protocol from the list provided by the server. */ + int (*next_proto_select_cb)(SSL *s, unsigned char **out, + unsigned char *outlen, + const unsigned char *in, + unsigned int inlen, + void *arg); + void *next_proto_select_cb_arg; +# endif + /* SRTP profiles we are willing to do from RFC 5764 */ + STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles; +#endif + }; + +#endif + +#define SSL_SESS_CACHE_OFF 0x0000 +#define SSL_SESS_CACHE_CLIENT 0x0001 +#define SSL_SESS_CACHE_SERVER 0x0002 +#define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT|SSL_SESS_CACHE_SERVER) +#define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080 +/* enough comments already ... see SSL_CTX_set_session_cache_mode(3) */ +#define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100 +#define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200 +#define SSL_SESS_CACHE_NO_INTERNAL \ + (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP|SSL_SESS_CACHE_NO_INTERNAL_STORE) + +LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx); +#define SSL_CTX_sess_number(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_NUMBER,0,NULL) +#define SSL_CTX_sess_connect(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT,0,NULL) +#define SSL_CTX_sess_connect_good(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT_GOOD,0,NULL) +#define SSL_CTX_sess_connect_renegotiate(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT_RENEGOTIATE,0,NULL) +#define SSL_CTX_sess_accept(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT,0,NULL) +#define SSL_CTX_sess_accept_renegotiate(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT_RENEGOTIATE,0,NULL) +#define SSL_CTX_sess_accept_good(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT_GOOD,0,NULL) +#define SSL_CTX_sess_hits(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_HIT,0,NULL) +#define SSL_CTX_sess_cb_hits(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CB_HIT,0,NULL) +#define SSL_CTX_sess_misses(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_MISSES,0,NULL) +#define SSL_CTX_sess_timeouts(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_TIMEOUTS,0,NULL) +#define SSL_CTX_sess_cache_full(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CACHE_FULL,0,NULL) + +void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx, int (*new_session_cb)(struct ssl_st *ssl,SSL_SESSION *sess)); +int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(struct ssl_st *ssl, SSL_SESSION *sess); +void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx, void (*remove_session_cb)(struct ssl_ctx_st *ctx,SSL_SESSION *sess)); +void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(struct ssl_ctx_st *ctx, SSL_SESSION *sess); +void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx, SSL_SESSION *(*get_session_cb)(struct ssl_st *ssl, unsigned char *data,int len,int *copy)); +SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(struct ssl_st *ssl, unsigned char *Data, int len, int *copy); +void SSL_CTX_set_info_callback(SSL_CTX *ctx, void (*cb)(const SSL *ssl,int type,int val)); +void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,int type,int val); +void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx, int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey)); +int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey); +#ifndef OPENSSL_NO_ENGINE +int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e); +#endif +void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx, int (*app_gen_cookie_cb)(SSL *ssl, unsigned char *cookie, unsigned int *cookie_len)); +void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx, int (*app_verify_cookie_cb)(SSL *ssl, unsigned char *cookie, unsigned int cookie_len)); +#ifndef OPENSSL_NO_NEXTPROTONEG +void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX *s, + int (*cb) (SSL *ssl, + const unsigned char **out, + unsigned int *outlen, + void *arg), + void *arg); +void SSL_CTX_set_next_proto_select_cb(SSL_CTX *s, + int (*cb) (SSL *ssl, + unsigned char **out, + unsigned char *outlen, + const unsigned char *in, + unsigned int inlen, + void *arg), + void *arg); + +int SSL_select_next_proto(unsigned char **out, unsigned char *outlen, + const unsigned char *in, unsigned int inlen, + const unsigned char *client, unsigned int client_len); +void SSL_get0_next_proto_negotiated(const SSL *s, + const unsigned char **data, unsigned *len); + +#define OPENSSL_NPN_UNSUPPORTED 0 +#define OPENSSL_NPN_NEGOTIATED 1 +#define OPENSSL_NPN_NO_OVERLAP 2 +#endif + +#ifndef OPENSSL_NO_PSK +/* the maximum length of the buffer given to callbacks containing the + * resulting identity/psk */ +#define PSK_MAX_IDENTITY_LEN 128 +#define PSK_MAX_PSK_LEN 256 +void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, + unsigned int (*psk_client_callback)(SSL *ssl, const char *hint, + char *identity, unsigned int max_identity_len, unsigned char *psk, + unsigned int max_psk_len)); +void SSL_set_psk_client_callback(SSL *ssl, + unsigned int (*psk_client_callback)(SSL *ssl, const char *hint, + char *identity, unsigned int max_identity_len, unsigned char *psk, + unsigned int max_psk_len)); +void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, + unsigned int (*psk_server_callback)(SSL *ssl, const char *identity, + unsigned char *psk, unsigned int max_psk_len)); +void SSL_set_psk_server_callback(SSL *ssl, + unsigned int (*psk_server_callback)(SSL *ssl, const char *identity, + unsigned char *psk, unsigned int max_psk_len)); +int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint); +int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint); +const char *SSL_get_psk_identity_hint(const SSL *s); +const char *SSL_get_psk_identity(const SSL *s); +#endif + +#define SSL_NOTHING 1 +#define SSL_WRITING 2 +#define SSL_READING 3 +#define SSL_X509_LOOKUP 4 + +/* These will only be used when doing non-blocking IO */ +#define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING) +#define SSL_want_read(s) (SSL_want(s) == SSL_READING) +#define SSL_want_write(s) (SSL_want(s) == SSL_WRITING) +#define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP) + +#define SSL_MAC_FLAG_READ_MAC_STREAM 1 +#define SSL_MAC_FLAG_WRITE_MAC_STREAM 2 + +#ifndef OPENSSL_NO_SSL_INTERN + +struct ssl_st + { + /* protocol version + * (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION, DTLS1_VERSION) + */ + int version; + int type; /* SSL_ST_CONNECT or SSL_ST_ACCEPT */ + + const SSL_METHOD *method; /* SSLv3 */ + + /* There are 2 BIO's even though they are normally both the + * same. This is so data can be read and written to different + * handlers */ + +#ifndef OPENSSL_NO_BIO + BIO *rbio; /* used by SSL_read */ + BIO *wbio; /* used by SSL_write */ + BIO *bbio; /* used during session-id reuse to concatenate + * messages */ +#else + char *rbio; /* used by SSL_read */ + char *wbio; /* used by SSL_write */ + char *bbio; +#endif + /* This holds a variable that indicates what we were doing + * when a 0 or -1 is returned. This is needed for + * non-blocking IO so we know what request needs re-doing when + * in SSL_accept or SSL_connect */ + int rwstate; + + /* true when we are actually in SSL_accept() or SSL_connect() */ + int in_handshake; + int (*handshake_func)(SSL *); + + /* Imagine that here's a boolean member "init" that is + * switched as soon as SSL_set_{accept/connect}_state + * is called for the first time, so that "state" and + * "handshake_func" are properly initialized. But as + * handshake_func is == 0 until then, we use this + * test instead of an "init" member. + */ + + int server; /* are we the server side? - mostly used by SSL_clear*/ + + int new_session;/* Generate a new session or reuse an old one. + * NB: For servers, the 'new' session may actually be a previously + * cached session or even the previous session unless + * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set */ + int quiet_shutdown;/* don't send shutdown packets */ + int shutdown; /* we have shut things down, 0x01 sent, 0x02 + * for received */ + int state; /* where we are */ + int rstate; /* where we are when reading */ + + BUF_MEM *init_buf; /* buffer used during init */ + void *init_msg; /* pointer to handshake message body, set by ssl3_get_message() */ + int init_num; /* amount read/written */ + int init_off; /* amount read/written */ + + /* used internally to point at a raw packet */ + unsigned char *packet; + unsigned int packet_length; + + struct ssl2_state_st *s2; /* SSLv2 variables */ + struct ssl3_state_st *s3; /* SSLv3 variables */ + struct dtls1_state_st *d1; /* DTLSv1 variables */ + + int read_ahead; /* Read as many input bytes as possible + * (for non-blocking reads) */ + + /* callback that allows applications to peek at protocol messages */ + void (*msg_callback)(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg); + void *msg_callback_arg; + + int hit; /* reusing a previous session */ + + X509_VERIFY_PARAM *param; + +#if 0 + int purpose; /* Purpose setting */ + int trust; /* Trust setting */ +#endif + + /* crypto */ + STACK_OF(SSL_CIPHER) *cipher_list; + STACK_OF(SSL_CIPHER) *cipher_list_by_id; + + /* These are the ones being used, the ones in SSL_SESSION are + * the ones to be 'copied' into these ones */ + int mac_flags; + EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */ + EVP_MD_CTX *read_hash; /* used for mac generation */ +#ifndef OPENSSL_NO_COMP + COMP_CTX *expand; /* uncompress */ +#else + char *expand; +#endif + + EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */ + EVP_MD_CTX *write_hash; /* used for mac generation */ +#ifndef OPENSSL_NO_COMP + COMP_CTX *compress; /* compression */ +#else + char *compress; +#endif + + /* session info */ + + /* client cert? */ + /* This is used to hold the server certificate used */ + struct cert_st /* CERT */ *cert; + + /* the session_id_context is used to ensure sessions are only reused + * in the appropriate context */ + unsigned int sid_ctx_length; + unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH]; + + /* This can also be in the session once a session is established */ + SSL_SESSION *session; + + /* Default generate session ID callback. */ + GEN_SESSION_CB generate_session_id; + + /* Used in SSL2 and SSL3 */ + int verify_mode; /* 0 don't care about verify failure. + * 1 fail if verify fails */ + int (*verify_callback)(int ok,X509_STORE_CTX *ctx); /* fail if callback returns 0 */ + + void (*info_callback)(const SSL *ssl,int type,int val); /* optional informational callback */ + + int error; /* error bytes to be written */ + int error_code; /* actual code */ + +#ifndef OPENSSL_NO_KRB5 + KSSL_CTX *kssl_ctx; /* Kerberos 5 context */ +#endif /* OPENSSL_NO_KRB5 */ + +#ifndef OPENSSL_NO_PSK + unsigned int (*psk_client_callback)(SSL *ssl, const char *hint, char *identity, + unsigned int max_identity_len, unsigned char *psk, + unsigned int max_psk_len); + unsigned int (*psk_server_callback)(SSL *ssl, const char *identity, + unsigned char *psk, unsigned int max_psk_len); +#endif + + SSL_CTX *ctx; + /* set this flag to 1 and a sleep(1) is put into all SSL_read() + * and SSL_write() calls, good for nbio debuging :-) */ + int debug; + + /* extra application data */ + long verify_result; + CRYPTO_EX_DATA ex_data; + + /* for server side, keep the list of CA_dn we can use */ + STACK_OF(X509_NAME) *client_CA; + + int references; + unsigned long options; /* protocol behaviour */ + unsigned long mode; /* API behaviour */ + long max_cert_list; + int first_packet; + int client_version; /* what was passed, used for + * SSLv3/TLS rollback check */ + unsigned int max_send_fragment; +#ifndef OPENSSL_NO_TLSEXT + /* TLS extension debug callback */ + void (*tlsext_debug_cb)(SSL *s, int client_server, int type, + unsigned char *data, int len, + void *arg); + void *tlsext_debug_arg; + char *tlsext_hostname; + int servername_done; /* no further mod of servername + 0 : call the servername extension callback. + 1 : prepare 2, allow last ack just after in server callback. + 2 : don't call servername callback, no ack in server hello + */ + /* certificate status request info */ + /* Status type or -1 if no status type */ + int tlsext_status_type; + /* Expect OCSP CertificateStatus message */ + int tlsext_status_expected; + /* OCSP status request only */ + STACK_OF(OCSP_RESPID) *tlsext_ocsp_ids; + X509_EXTENSIONS *tlsext_ocsp_exts; + /* OCSP response received or to be sent */ + unsigned char *tlsext_ocsp_resp; + int tlsext_ocsp_resplen; + + /* RFC4507 session ticket expected to be received or sent */ + int tlsext_ticket_expected; +#ifndef OPENSSL_NO_EC + size_t tlsext_ecpointformatlist_length; + unsigned char *tlsext_ecpointformatlist; /* our list */ + size_t tlsext_ellipticcurvelist_length; + unsigned char *tlsext_ellipticcurvelist; /* our list */ +#endif /* OPENSSL_NO_EC */ + + /* draft-rescorla-tls-opaque-prf-input-00.txt information to be used for handshakes */ + void *tlsext_opaque_prf_input; + size_t tlsext_opaque_prf_input_len; + + /* TLS Session Ticket extension override */ + TLS_SESSION_TICKET_EXT *tlsext_session_ticket; + + /* TLS Session Ticket extension callback */ + tls_session_ticket_ext_cb_fn tls_session_ticket_ext_cb; + void *tls_session_ticket_ext_cb_arg; + + /* TLS pre-shared secret session resumption */ + tls_session_secret_cb_fn tls_session_secret_cb; + void *tls_session_secret_cb_arg; + + SSL_CTX * initial_ctx; /* initial ctx, used to store sessions */ + +#ifndef OPENSSL_NO_NEXTPROTONEG + /* Next protocol negotiation. For the client, this is the protocol that + * we sent in NextProtocol and is set when handling ServerHello + * extensions. + * + * For a server, this is the client's selected_protocol from + * NextProtocol and is set when handling the NextProtocol message, + * before the Finished message. */ + unsigned char *next_proto_negotiated; + unsigned char next_proto_negotiated_len; +#endif + +#define session_ctx initial_ctx + + STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles; /* What we'll do */ + SRTP_PROTECTION_PROFILE *srtp_profile; /* What's been chosen */ + + unsigned int tlsext_heartbeat; /* Is use of the Heartbeat extension negotiated? + 0: disabled + 1: enabled + 2: enabled, but not allowed to send Requests + */ + unsigned int tlsext_hb_pending; /* Indicates if a HeartbeatRequest is in flight */ + unsigned int tlsext_hb_seq; /* HeartbeatRequest sequence number */ +#else +#define session_ctx ctx +#endif /* OPENSSL_NO_TLSEXT */ + + int renegotiate;/* 1 if we are renegotiating. + * 2 if we are a server and are inside a handshake + * (i.e. not just sending a HelloRequest) */ + +#ifndef OPENSSL_NO_SRP + SRP_CTX srp_ctx; /* ctx for SRP authentication */ +#endif + }; + +#endif + +#ifdef __cplusplus +} +#endif + +#include +#include +#include /* This is mostly sslv3 with a few tweaks */ +#include /* Datagram TLS */ +#include +#include /* Support for the use_srtp extension */ + +#ifdef __cplusplus +extern "C" { +#endif + +/* compatibility */ +#define SSL_set_app_data(s,arg) (SSL_set_ex_data(s,0,(char *)arg)) +#define SSL_get_app_data(s) (SSL_get_ex_data(s,0)) +#define SSL_SESSION_set_app_data(s,a) (SSL_SESSION_set_ex_data(s,0,(char *)a)) +#define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s,0)) +#define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx,0)) +#define SSL_CTX_set_app_data(ctx,arg) (SSL_CTX_set_ex_data(ctx,0,(char *)arg)) + +/* The following are the possible values for ssl->state are are + * used to indicate where we are up to in the SSL connection establishment. + * The macros that follow are about the only things you should need to use + * and even then, only when using non-blocking IO. + * It can also be useful to work out where you were when the connection + * failed */ + +#define SSL_ST_CONNECT 0x1000 +#define SSL_ST_ACCEPT 0x2000 +#define SSL_ST_MASK 0x0FFF +#define SSL_ST_INIT (SSL_ST_CONNECT|SSL_ST_ACCEPT) +#define SSL_ST_BEFORE 0x4000 +#define SSL_ST_OK 0x03 +#define SSL_ST_RENEGOTIATE (0x04|SSL_ST_INIT) + +#define SSL_CB_LOOP 0x01 +#define SSL_CB_EXIT 0x02 +#define SSL_CB_READ 0x04 +#define SSL_CB_WRITE 0x08 +#define SSL_CB_ALERT 0x4000 /* used in callback */ +#define SSL_CB_READ_ALERT (SSL_CB_ALERT|SSL_CB_READ) +#define SSL_CB_WRITE_ALERT (SSL_CB_ALERT|SSL_CB_WRITE) +#define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT|SSL_CB_LOOP) +#define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT|SSL_CB_EXIT) +#define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT|SSL_CB_LOOP) +#define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT|SSL_CB_EXIT) +#define SSL_CB_HANDSHAKE_START 0x10 +#define SSL_CB_HANDSHAKE_DONE 0x20 + +/* Is the SSL_connection established? */ +#define SSL_get_state(a) SSL_state(a) +#define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK) +#define SSL_in_init(a) (SSL_state(a)&SSL_ST_INIT) +#define SSL_in_before(a) (SSL_state(a)&SSL_ST_BEFORE) +#define SSL_in_connect_init(a) (SSL_state(a)&SSL_ST_CONNECT) +#define SSL_in_accept_init(a) (SSL_state(a)&SSL_ST_ACCEPT) + +/* The following 2 states are kept in ssl->rstate when reads fail, + * you should not need these */ +#define SSL_ST_READ_HEADER 0xF0 +#define SSL_ST_READ_BODY 0xF1 +#define SSL_ST_READ_DONE 0xF2 + +/* Obtain latest Finished message + * -- that we sent (SSL_get_finished) + * -- that we expected from peer (SSL_get_peer_finished). + * Returns length (0 == no Finished so far), copies up to 'count' bytes. */ +size_t SSL_get_finished(const SSL *s, void *buf, size_t count); +size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count); + +/* use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 2 options + * are 'ored' with SSL_VERIFY_PEER if they are desired */ +#define SSL_VERIFY_NONE 0x00 +#define SSL_VERIFY_PEER 0x01 +#define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02 +#define SSL_VERIFY_CLIENT_ONCE 0x04 + +#define OpenSSL_add_ssl_algorithms() SSL_library_init() +#define SSLeay_add_ssl_algorithms() SSL_library_init() + +/* this is for backward compatibility */ +#if 0 /* NEW_SSLEAY */ +#define SSL_CTX_set_default_verify(a,b,c) SSL_CTX_set_verify(a,b,c) +#define SSL_set_pref_cipher(c,n) SSL_set_cipher_list(c,n) +#define SSL_add_session(a,b) SSL_CTX_add_session((a),(b)) +#define SSL_remove_session(a,b) SSL_CTX_remove_session((a),(b)) +#define SSL_flush_sessions(a,b) SSL_CTX_flush_sessions((a),(b)) +#endif +/* More backward compatibility */ +#define SSL_get_cipher(s) \ + SSL_CIPHER_get_name(SSL_get_current_cipher(s)) +#define SSL_get_cipher_bits(s,np) \ + SSL_CIPHER_get_bits(SSL_get_current_cipher(s),np) +#define SSL_get_cipher_version(s) \ + SSL_CIPHER_get_version(SSL_get_current_cipher(s)) +#define SSL_get_cipher_name(s) \ + SSL_CIPHER_get_name(SSL_get_current_cipher(s)) +#define SSL_get_time(a) SSL_SESSION_get_time(a) +#define SSL_set_time(a,b) SSL_SESSION_set_time((a),(b)) +#define SSL_get_timeout(a) SSL_SESSION_get_timeout(a) +#define SSL_set_timeout(a,b) SSL_SESSION_set_timeout((a),(b)) + +#define d2i_SSL_SESSION_bio(bp,s_id) ASN1_d2i_bio_of(SSL_SESSION,SSL_SESSION_new,d2i_SSL_SESSION,bp,s_id) +#define i2d_SSL_SESSION_bio(bp,s_id) ASN1_i2d_bio_of(SSL_SESSION,i2d_SSL_SESSION,bp,s_id) + +DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION) + +#define SSL_AD_REASON_OFFSET 1000 /* offset to get SSL_R_... value from SSL_AD_... */ + +/* These alert types are for SSLv3 and TLSv1 */ +#define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY +#define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */ +#define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */ +#define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED +#define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW +#define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE/* fatal */ +#define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE/* fatal */ +#define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */ +#define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE +#define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE +#define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED +#define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED +#define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN +#define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */ +#define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */ +#define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */ +#define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */ +#define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR +#define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION/* fatal */ +#define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */ +#define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY/* fatal */ +#define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */ +#define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED +#define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION +#define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION +#define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE +#define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME +#define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE +#define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE +#define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */ + +#define SSL_ERROR_NONE 0 +#define SSL_ERROR_SSL 1 +#define SSL_ERROR_WANT_READ 2 +#define SSL_ERROR_WANT_WRITE 3 +#define SSL_ERROR_WANT_X509_LOOKUP 4 +#define SSL_ERROR_SYSCALL 5 /* look at error stack/return value/errno */ +#define SSL_ERROR_ZERO_RETURN 6 +#define SSL_ERROR_WANT_CONNECT 7 +#define SSL_ERROR_WANT_ACCEPT 8 + +#define SSL_CTRL_NEED_TMP_RSA 1 +#define SSL_CTRL_SET_TMP_RSA 2 +#define SSL_CTRL_SET_TMP_DH 3 +#define SSL_CTRL_SET_TMP_ECDH 4 +#define SSL_CTRL_SET_TMP_RSA_CB 5 +#define SSL_CTRL_SET_TMP_DH_CB 6 +#define SSL_CTRL_SET_TMP_ECDH_CB 7 + +#define SSL_CTRL_GET_SESSION_REUSED 8 +#define SSL_CTRL_GET_CLIENT_CERT_REQUEST 9 +#define SSL_CTRL_GET_NUM_RENEGOTIATIONS 10 +#define SSL_CTRL_CLEAR_NUM_RENEGOTIATIONS 11 +#define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS 12 +#define SSL_CTRL_GET_FLAGS 13 +#define SSL_CTRL_EXTRA_CHAIN_CERT 14 + +#define SSL_CTRL_SET_MSG_CALLBACK 15 +#define SSL_CTRL_SET_MSG_CALLBACK_ARG 16 + +/* only applies to datagram connections */ +#define SSL_CTRL_SET_MTU 17 +/* Stats */ +#define SSL_CTRL_SESS_NUMBER 20 +#define SSL_CTRL_SESS_CONNECT 21 +#define SSL_CTRL_SESS_CONNECT_GOOD 22 +#define SSL_CTRL_SESS_CONNECT_RENEGOTIATE 23 +#define SSL_CTRL_SESS_ACCEPT 24 +#define SSL_CTRL_SESS_ACCEPT_GOOD 25 +#define SSL_CTRL_SESS_ACCEPT_RENEGOTIATE 26 +#define SSL_CTRL_SESS_HIT 27 +#define SSL_CTRL_SESS_CB_HIT 28 +#define SSL_CTRL_SESS_MISSES 29 +#define SSL_CTRL_SESS_TIMEOUTS 30 +#define SSL_CTRL_SESS_CACHE_FULL 31 +#define SSL_CTRL_OPTIONS 32 +#define SSL_CTRL_MODE 33 + +#define SSL_CTRL_GET_READ_AHEAD 40 +#define SSL_CTRL_SET_READ_AHEAD 41 +#define SSL_CTRL_SET_SESS_CACHE_SIZE 42 +#define SSL_CTRL_GET_SESS_CACHE_SIZE 43 +#define SSL_CTRL_SET_SESS_CACHE_MODE 44 +#define SSL_CTRL_GET_SESS_CACHE_MODE 45 + +#define SSL_CTRL_GET_MAX_CERT_LIST 50 +#define SSL_CTRL_SET_MAX_CERT_LIST 51 + +#define SSL_CTRL_SET_MAX_SEND_FRAGMENT 52 + +/* see tls1.h for macros based on these */ +#ifndef OPENSSL_NO_TLSEXT +#define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB 53 +#define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG 54 +#define SSL_CTRL_SET_TLSEXT_HOSTNAME 55 +#define SSL_CTRL_SET_TLSEXT_DEBUG_CB 56 +#define SSL_CTRL_SET_TLSEXT_DEBUG_ARG 57 +#define SSL_CTRL_GET_TLSEXT_TICKET_KEYS 58 +#define SSL_CTRL_SET_TLSEXT_TICKET_KEYS 59 +#define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT 60 +#define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT_CB 61 +#define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT_CB_ARG 62 +#define SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB 63 +#define SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB_ARG 64 +#define SSL_CTRL_SET_TLSEXT_STATUS_REQ_TYPE 65 +#define SSL_CTRL_GET_TLSEXT_STATUS_REQ_EXTS 66 +#define SSL_CTRL_SET_TLSEXT_STATUS_REQ_EXTS 67 +#define SSL_CTRL_GET_TLSEXT_STATUS_REQ_IDS 68 +#define SSL_CTRL_SET_TLSEXT_STATUS_REQ_IDS 69 +#define SSL_CTRL_GET_TLSEXT_STATUS_REQ_OCSP_RESP 70 +#define SSL_CTRL_SET_TLSEXT_STATUS_REQ_OCSP_RESP 71 + +#define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB 72 + +#define SSL_CTRL_SET_TLS_EXT_SRP_USERNAME_CB 75 +#define SSL_CTRL_SET_SRP_VERIFY_PARAM_CB 76 +#define SSL_CTRL_SET_SRP_GIVE_CLIENT_PWD_CB 77 + +#define SSL_CTRL_SET_SRP_ARG 78 +#define SSL_CTRL_SET_TLS_EXT_SRP_USERNAME 79 +#define SSL_CTRL_SET_TLS_EXT_SRP_STRENGTH 80 +#define SSL_CTRL_SET_TLS_EXT_SRP_PASSWORD 81 +#ifndef OPENSSL_NO_HEARTBEATS +#define SSL_CTRL_TLS_EXT_SEND_HEARTBEAT 85 +#define SSL_CTRL_GET_TLS_EXT_HEARTBEAT_PENDING 86 +#define SSL_CTRL_SET_TLS_EXT_HEARTBEAT_NO_REQUESTS 87 +#endif +#endif + +#define DTLS_CTRL_GET_TIMEOUT 73 +#define DTLS_CTRL_HANDLE_TIMEOUT 74 +#define DTLS_CTRL_LISTEN 75 + +#define SSL_CTRL_GET_RI_SUPPORT 76 +#define SSL_CTRL_CLEAR_OPTIONS 77 +#define SSL_CTRL_CLEAR_MODE 78 + +#define SSL_CTRL_GET_EXTRA_CHAIN_CERTS 82 +#define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS 83 + +#define DTLSv1_get_timeout(ssl, arg) \ + SSL_ctrl(ssl,DTLS_CTRL_GET_TIMEOUT,0, (void *)arg) +#define DTLSv1_handle_timeout(ssl) \ + SSL_ctrl(ssl,DTLS_CTRL_HANDLE_TIMEOUT,0, NULL) +#define DTLSv1_listen(ssl, peer) \ + SSL_ctrl(ssl,DTLS_CTRL_LISTEN,0, (void *)peer) + +#define SSL_session_reused(ssl) \ + SSL_ctrl((ssl),SSL_CTRL_GET_SESSION_REUSED,0,NULL) +#define SSL_num_renegotiations(ssl) \ + SSL_ctrl((ssl),SSL_CTRL_GET_NUM_RENEGOTIATIONS,0,NULL) +#define SSL_clear_num_renegotiations(ssl) \ + SSL_ctrl((ssl),SSL_CTRL_CLEAR_NUM_RENEGOTIATIONS,0,NULL) +#define SSL_total_renegotiations(ssl) \ + SSL_ctrl((ssl),SSL_CTRL_GET_TOTAL_RENEGOTIATIONS,0,NULL) + +#define SSL_CTX_need_tmp_RSA(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_NEED_TMP_RSA,0,NULL) +#define SSL_CTX_set_tmp_rsa(ctx,rsa) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TMP_RSA,0,(char *)rsa) +#define SSL_CTX_set_tmp_dh(ctx,dh) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TMP_DH,0,(char *)dh) +#define SSL_CTX_set_tmp_ecdh(ctx,ecdh) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TMP_ECDH,0,(char *)ecdh) + +#define SSL_need_tmp_RSA(ssl) \ + SSL_ctrl(ssl,SSL_CTRL_NEED_TMP_RSA,0,NULL) +#define SSL_set_tmp_rsa(ssl,rsa) \ + SSL_ctrl(ssl,SSL_CTRL_SET_TMP_RSA,0,(char *)rsa) +#define SSL_set_tmp_dh(ssl,dh) \ + SSL_ctrl(ssl,SSL_CTRL_SET_TMP_DH,0,(char *)dh) +#define SSL_set_tmp_ecdh(ssl,ecdh) \ + SSL_ctrl(ssl,SSL_CTRL_SET_TMP_ECDH,0,(char *)ecdh) + +#define SSL_CTX_add_extra_chain_cert(ctx,x509) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_EXTRA_CHAIN_CERT,0,(char *)x509) +#define SSL_CTX_get_extra_chain_certs(ctx,px509) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_GET_EXTRA_CHAIN_CERTS,0,px509) +#define SSL_CTX_clear_extra_chain_certs(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS,0,NULL) + +#ifndef OPENSSL_NO_BIO +BIO_METHOD *BIO_f_ssl(void); +BIO *BIO_new_ssl(SSL_CTX *ctx,int client); +BIO *BIO_new_ssl_connect(SSL_CTX *ctx); +BIO *BIO_new_buffer_ssl_connect(SSL_CTX *ctx); +int BIO_ssl_copy_session_id(BIO *to,BIO *from); +void BIO_ssl_shutdown(BIO *ssl_bio); + +#endif + +int SSL_CTX_set_cipher_list(SSL_CTX *,const char *str); +SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth); +void SSL_CTX_free(SSL_CTX *); +long SSL_CTX_set_timeout(SSL_CTX *ctx,long t); +long SSL_CTX_get_timeout(const SSL_CTX *ctx); +X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *); +void SSL_CTX_set_cert_store(SSL_CTX *,X509_STORE *); +int SSL_want(const SSL *s); +int SSL_clear(SSL *s); + +void SSL_CTX_flush_sessions(SSL_CTX *ctx,long tm); + +const SSL_CIPHER *SSL_get_current_cipher(const SSL *s); +int SSL_CIPHER_get_bits(const SSL_CIPHER *c,int *alg_bits); +char * SSL_CIPHER_get_version(const SSL_CIPHER *c); +const char * SSL_CIPHER_get_name(const SSL_CIPHER *c); +unsigned long SSL_CIPHER_get_id(const SSL_CIPHER *c); + +int SSL_get_fd(const SSL *s); +int SSL_get_rfd(const SSL *s); +int SSL_get_wfd(const SSL *s); +const char * SSL_get_cipher_list(const SSL *s,int n); +char * SSL_get_shared_ciphers(const SSL *s, char *buf, int len); +int SSL_get_read_ahead(const SSL * s); +int SSL_pending(const SSL *s); +#ifndef OPENSSL_NO_SOCK +int SSL_set_fd(SSL *s, int fd); +int SSL_set_rfd(SSL *s, int fd); +int SSL_set_wfd(SSL *s, int fd); +#endif +#ifndef OPENSSL_NO_BIO +void SSL_set_bio(SSL *s, BIO *rbio,BIO *wbio); +BIO * SSL_get_rbio(const SSL *s); +BIO * SSL_get_wbio(const SSL *s); +#endif +int SSL_set_cipher_list(SSL *s, const char *str); +void SSL_set_read_ahead(SSL *s, int yes); +int SSL_get_verify_mode(const SSL *s); +int SSL_get_verify_depth(const SSL *s); +int (*SSL_get_verify_callback(const SSL *s))(int,X509_STORE_CTX *); +void SSL_set_verify(SSL *s, int mode, + int (*callback)(int ok,X509_STORE_CTX *ctx)); +void SSL_set_verify_depth(SSL *s, int depth); +#ifndef OPENSSL_NO_RSA +int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa); +#endif +int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, unsigned char *d, long len); +int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey); +int SSL_use_PrivateKey_ASN1(int pk,SSL *ssl, const unsigned char *d, long len); +int SSL_use_certificate(SSL *ssl, X509 *x); +int SSL_use_certificate_ASN1(SSL *ssl, const unsigned char *d, int len); + +#ifndef OPENSSL_NO_STDIO +int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type); +int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type); +int SSL_use_certificate_file(SSL *ssl, const char *file, int type); +int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type); +int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type); +int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, int type); +int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file); /* PEM type */ +STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file); +int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *stackCAs, + const char *file); +#ifndef OPENSSL_SYS_VMS +#ifndef OPENSSL_SYS_MACINTOSH_CLASSIC /* XXXXX: Better scheme needed! [was: #ifndef MAC_OS_pre_X] */ +int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *stackCAs, + const char *dir); +#endif +#endif + +#endif + +void SSL_load_error_strings(void ); +const char *SSL_state_string(const SSL *s); +const char *SSL_rstate_string(const SSL *s); +const char *SSL_state_string_long(const SSL *s); +const char *SSL_rstate_string_long(const SSL *s); +long SSL_SESSION_get_time(const SSL_SESSION *s); +long SSL_SESSION_set_time(SSL_SESSION *s, long t); +long SSL_SESSION_get_timeout(const SSL_SESSION *s); +long SSL_SESSION_set_timeout(SSL_SESSION *s, long t); +void SSL_copy_session_id(SSL *to,const SSL *from); +X509 *SSL_SESSION_get0_peer(SSL_SESSION *s); +int SSL_SESSION_set1_id_context(SSL_SESSION *s,const unsigned char *sid_ctx, + unsigned int sid_ctx_len); + +SSL_SESSION *SSL_SESSION_new(void); +const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s, + unsigned int *len); +unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s); +#ifndef OPENSSL_NO_FP_API +int SSL_SESSION_print_fp(FILE *fp,const SSL_SESSION *ses); +#endif +#ifndef OPENSSL_NO_BIO +int SSL_SESSION_print(BIO *fp,const SSL_SESSION *ses); +#endif +void SSL_SESSION_free(SSL_SESSION *ses); +int i2d_SSL_SESSION(SSL_SESSION *in,unsigned char **pp); +int SSL_set_session(SSL *to, SSL_SESSION *session); +int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c); +int SSL_CTX_remove_session(SSL_CTX *,SSL_SESSION *c); +int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB); +int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB); +int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id, + unsigned int id_len); +SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a,const unsigned char **pp, + long length); + +#ifdef HEADER_X509_H +X509 * SSL_get_peer_certificate(const SSL *s); +#endif + +STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s); + +int SSL_CTX_get_verify_mode(const SSL_CTX *ctx); +int SSL_CTX_get_verify_depth(const SSL_CTX *ctx); +int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(int,X509_STORE_CTX *); +void SSL_CTX_set_verify(SSL_CTX *ctx,int mode, + int (*callback)(int, X509_STORE_CTX *)); +void SSL_CTX_set_verify_depth(SSL_CTX *ctx,int depth); +void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx, int (*cb)(X509_STORE_CTX *,void *), void *arg); +#ifndef OPENSSL_NO_RSA +int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa); +#endif +int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, const unsigned char *d, long len); +int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey); +int SSL_CTX_use_PrivateKey_ASN1(int pk,SSL_CTX *ctx, + const unsigned char *d, long len); +int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x); +int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len, const unsigned char *d); + +void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb); +void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u); + +int SSL_CTX_check_private_key(const SSL_CTX *ctx); +int SSL_check_private_key(const SSL *ctx); + +int SSL_CTX_set_session_id_context(SSL_CTX *ctx,const unsigned char *sid_ctx, + unsigned int sid_ctx_len); + +SSL * SSL_new(SSL_CTX *ctx); +int SSL_set_session_id_context(SSL *ssl,const unsigned char *sid_ctx, + unsigned int sid_ctx_len); + +int SSL_CTX_set_purpose(SSL_CTX *s, int purpose); +int SSL_set_purpose(SSL *s, int purpose); +int SSL_CTX_set_trust(SSL_CTX *s, int trust); +int SSL_set_trust(SSL *s, int trust); + +int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm); +int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm); + +#ifndef OPENSSL_NO_SRP +int SSL_CTX_set_srp_username(SSL_CTX *ctx,char *name); +int SSL_CTX_set_srp_password(SSL_CTX *ctx,char *password); +int SSL_CTX_set_srp_strength(SSL_CTX *ctx, int strength); +int SSL_CTX_set_srp_client_pwd_callback(SSL_CTX *ctx, + char *(*cb)(SSL *,void *)); +int SSL_CTX_set_srp_verify_param_callback(SSL_CTX *ctx, + int (*cb)(SSL *,void *)); +int SSL_CTX_set_srp_username_callback(SSL_CTX *ctx, + int (*cb)(SSL *,int *,void *)); +int SSL_CTX_set_srp_cb_arg(SSL_CTX *ctx, void *arg); + +int SSL_set_srp_server_param(SSL *s, const BIGNUM *N, const BIGNUM *g, + BIGNUM *sa, BIGNUM *v, char *info); +int SSL_set_srp_server_param_pw(SSL *s, const char *user, const char *pass, + const char *grp); + +BIGNUM *SSL_get_srp_g(SSL *s); +BIGNUM *SSL_get_srp_N(SSL *s); + +char *SSL_get_srp_username(SSL *s); +char *SSL_get_srp_userinfo(SSL *s); +#endif + +void SSL_free(SSL *ssl); +int SSL_accept(SSL *ssl); +int SSL_connect(SSL *ssl); +int SSL_read(SSL *ssl,void *buf,int num); +int SSL_peek(SSL *ssl,void *buf,int num); +int SSL_write(SSL *ssl,const void *buf,int num); +long SSL_ctrl(SSL *ssl,int cmd, long larg, void *parg); +long SSL_callback_ctrl(SSL *, int, void (*)(void)); +long SSL_CTX_ctrl(SSL_CTX *ctx,int cmd, long larg, void *parg); +long SSL_CTX_callback_ctrl(SSL_CTX *, int, void (*)(void)); + +int SSL_get_error(const SSL *s,int ret_code); +const char *SSL_get_version(const SSL *s); + +/* This sets the 'default' SSL version that SSL_new() will create */ +int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth); + +#ifndef OPENSSL_NO_SSL2 +const SSL_METHOD *SSLv2_method(void); /* SSLv2 */ +const SSL_METHOD *SSLv2_server_method(void); /* SSLv2 */ +const SSL_METHOD *SSLv2_client_method(void); /* SSLv2 */ +#endif + +const SSL_METHOD *SSLv3_method(void); /* SSLv3 */ +const SSL_METHOD *SSLv3_server_method(void); /* SSLv3 */ +const SSL_METHOD *SSLv3_client_method(void); /* SSLv3 */ + +const SSL_METHOD *SSLv23_method(void); /* SSLv3 but can rollback to v2 */ +const SSL_METHOD *SSLv23_server_method(void); /* SSLv3 but can rollback to v2 */ +const SSL_METHOD *SSLv23_client_method(void); /* SSLv3 but can rollback to v2 */ + +const SSL_METHOD *TLSv1_method(void); /* TLSv1.0 */ +const SSL_METHOD *TLSv1_server_method(void); /* TLSv1.0 */ +const SSL_METHOD *TLSv1_client_method(void); /* TLSv1.0 */ + +const SSL_METHOD *TLSv1_1_method(void); /* TLSv1.1 */ +const SSL_METHOD *TLSv1_1_server_method(void); /* TLSv1.1 */ +const SSL_METHOD *TLSv1_1_client_method(void); /* TLSv1.1 */ + +const SSL_METHOD *TLSv1_2_method(void); /* TLSv1.2 */ +const SSL_METHOD *TLSv1_2_server_method(void); /* TLSv1.2 */ +const SSL_METHOD *TLSv1_2_client_method(void); /* TLSv1.2 */ + + +const SSL_METHOD *DTLSv1_method(void); /* DTLSv1.0 */ +const SSL_METHOD *DTLSv1_server_method(void); /* DTLSv1.0 */ +const SSL_METHOD *DTLSv1_client_method(void); /* DTLSv1.0 */ + +STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s); + +int SSL_do_handshake(SSL *s); +int SSL_renegotiate(SSL *s); +int SSL_renegotiate_abbreviated(SSL *s); +int SSL_renegotiate_pending(SSL *s); +int SSL_shutdown(SSL *s); + +const SSL_METHOD *SSL_get_ssl_method(SSL *s); +int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method); +const char *SSL_alert_type_string_long(int value); +const char *SSL_alert_type_string(int value); +const char *SSL_alert_desc_string_long(int value); +const char *SSL_alert_desc_string(int value); + +void SSL_set_client_CA_list(SSL *s, STACK_OF(X509_NAME) *name_list); +void SSL_CTX_set_client_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *name_list); +STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s); +STACK_OF(X509_NAME) *SSL_CTX_get_client_CA_list(const SSL_CTX *s); +int SSL_add_client_CA(SSL *ssl,X509 *x); +int SSL_CTX_add_client_CA(SSL_CTX *ctx,X509 *x); + +void SSL_set_connect_state(SSL *s); +void SSL_set_accept_state(SSL *s); + +long SSL_get_default_timeout(const SSL *s); + +int SSL_library_init(void ); + +char *SSL_CIPHER_description(const SSL_CIPHER *,char *buf,int size); +STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk); + +SSL *SSL_dup(SSL *ssl); + +X509 *SSL_get_certificate(const SSL *ssl); +/* EVP_PKEY */ struct evp_pkey_st *SSL_get_privatekey(SSL *ssl); + +void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx,int mode); +int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx); +void SSL_set_quiet_shutdown(SSL *ssl,int mode); +int SSL_get_quiet_shutdown(const SSL *ssl); +void SSL_set_shutdown(SSL *ssl,int mode); +int SSL_get_shutdown(const SSL *ssl); +int SSL_version(const SSL *ssl); +int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx); +int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile, + const char *CApath); +#define SSL_get0_session SSL_get_session /* just peek at pointer */ +SSL_SESSION *SSL_get_session(const SSL *ssl); +SSL_SESSION *SSL_get1_session(SSL *ssl); /* obtain a reference count */ +SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl); +SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX* ctx); +void SSL_set_info_callback(SSL *ssl, + void (*cb)(const SSL *ssl,int type,int val)); +void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,int type,int val); +int SSL_state(const SSL *ssl); +void SSL_set_state(SSL *ssl, int state); + +void SSL_set_verify_result(SSL *ssl,long v); +long SSL_get_verify_result(const SSL *ssl); + +int SSL_set_ex_data(SSL *ssl,int idx,void *data); +void *SSL_get_ex_data(const SSL *ssl,int idx); +int SSL_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); + +int SSL_SESSION_set_ex_data(SSL_SESSION *ss,int idx,void *data); +void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss,int idx); +int SSL_SESSION_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); + +int SSL_CTX_set_ex_data(SSL_CTX *ssl,int idx,void *data); +void *SSL_CTX_get_ex_data(const SSL_CTX *ssl,int idx); +int SSL_CTX_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); + +int SSL_get_ex_data_X509_STORE_CTX_idx(void ); + +#define SSL_CTX_sess_set_cache_size(ctx,t) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SESS_CACHE_SIZE,t,NULL) +#define SSL_CTX_sess_get_cache_size(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_GET_SESS_CACHE_SIZE,0,NULL) +#define SSL_CTX_set_session_cache_mode(ctx,m) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SESS_CACHE_MODE,m,NULL) +#define SSL_CTX_get_session_cache_mode(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_GET_SESS_CACHE_MODE,0,NULL) + +#define SSL_CTX_get_default_read_ahead(ctx) SSL_CTX_get_read_ahead(ctx) +#define SSL_CTX_set_default_read_ahead(ctx,m) SSL_CTX_set_read_ahead(ctx,m) +#define SSL_CTX_get_read_ahead(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_GET_READ_AHEAD,0,NULL) +#define SSL_CTX_set_read_ahead(ctx,m) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SET_READ_AHEAD,m,NULL) +#define SSL_CTX_get_max_cert_list(ctx) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_GET_MAX_CERT_LIST,0,NULL) +#define SSL_CTX_set_max_cert_list(ctx,m) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_CERT_LIST,m,NULL) +#define SSL_get_max_cert_list(ssl) \ + SSL_ctrl(ssl,SSL_CTRL_GET_MAX_CERT_LIST,0,NULL) +#define SSL_set_max_cert_list(ssl,m) \ + SSL_ctrl(ssl,SSL_CTRL_SET_MAX_CERT_LIST,m,NULL) + +#define SSL_CTX_set_max_send_fragment(ctx,m) \ + SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_SEND_FRAGMENT,m,NULL) +#define SSL_set_max_send_fragment(ssl,m) \ + SSL_ctrl(ssl,SSL_CTRL_SET_MAX_SEND_FRAGMENT,m,NULL) + + /* NB: the keylength is only applicable when is_export is true */ +#ifndef OPENSSL_NO_RSA +void SSL_CTX_set_tmp_rsa_callback(SSL_CTX *ctx, + RSA *(*cb)(SSL *ssl,int is_export, + int keylength)); + +void SSL_set_tmp_rsa_callback(SSL *ssl, + RSA *(*cb)(SSL *ssl,int is_export, + int keylength)); +#endif +#ifndef OPENSSL_NO_DH +void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx, + DH *(*dh)(SSL *ssl,int is_export, + int keylength)); +void SSL_set_tmp_dh_callback(SSL *ssl, + DH *(*dh)(SSL *ssl,int is_export, + int keylength)); +#endif +#ifndef OPENSSL_NO_ECDH +void SSL_CTX_set_tmp_ecdh_callback(SSL_CTX *ctx, + EC_KEY *(*ecdh)(SSL *ssl,int is_export, + int keylength)); +void SSL_set_tmp_ecdh_callback(SSL *ssl, + EC_KEY *(*ecdh)(SSL *ssl,int is_export, + int keylength)); +#endif + +#ifndef OPENSSL_NO_COMP +const COMP_METHOD *SSL_get_current_compression(SSL *s); +const COMP_METHOD *SSL_get_current_expansion(SSL *s); +const char *SSL_COMP_get_name(const COMP_METHOD *comp); +STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void); +int SSL_COMP_add_compression_method(int id,COMP_METHOD *cm); +#else +const void *SSL_get_current_compression(SSL *s); +const void *SSL_get_current_expansion(SSL *s); +const char *SSL_COMP_get_name(const void *comp); +void *SSL_COMP_get_compression_methods(void); +int SSL_COMP_add_compression_method(int id,void *cm); +#endif + +/* TLS extensions functions */ +int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len); + +int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb, + void *arg); + +/* Pre-shared secret session resumption functions */ +int SSL_set_session_secret_cb(SSL *s, tls_session_secret_cb_fn tls_session_secret_cb, void *arg); + +void SSL_set_debug(SSL *s, int debug); +int SSL_cache_hit(SSL *s); + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_SSL_strings(void); + +/* Error codes for the SSL functions. */ + +/* Function codes. */ +#define SSL_F_CLIENT_CERTIFICATE 100 +#define SSL_F_CLIENT_FINISHED 167 +#define SSL_F_CLIENT_HELLO 101 +#define SSL_F_CLIENT_MASTER_KEY 102 +#define SSL_F_D2I_SSL_SESSION 103 +#define SSL_F_DO_DTLS1_WRITE 245 +#define SSL_F_DO_SSL3_WRITE 104 +#define SSL_F_DTLS1_ACCEPT 246 +#define SSL_F_DTLS1_ADD_CERT_TO_BUF 295 +#define SSL_F_DTLS1_BUFFER_RECORD 247 +#define SSL_F_DTLS1_CHECK_TIMEOUT_NUM 316 +#define SSL_F_DTLS1_CLIENT_HELLO 248 +#define SSL_F_DTLS1_CONNECT 249 +#define SSL_F_DTLS1_ENC 250 +#define SSL_F_DTLS1_GET_HELLO_VERIFY 251 +#define SSL_F_DTLS1_GET_MESSAGE 252 +#define SSL_F_DTLS1_GET_MESSAGE_FRAGMENT 253 +#define SSL_F_DTLS1_GET_RECORD 254 +#define SSL_F_DTLS1_HANDLE_TIMEOUT 297 +#define SSL_F_DTLS1_HEARTBEAT 305 +#define SSL_F_DTLS1_OUTPUT_CERT_CHAIN 255 +#define SSL_F_DTLS1_PREPROCESS_FRAGMENT 288 +#define SSL_F_DTLS1_PROCESS_OUT_OF_SEQ_MESSAGE 256 +#define SSL_F_DTLS1_PROCESS_RECORD 257 +#define SSL_F_DTLS1_READ_BYTES 258 +#define SSL_F_DTLS1_READ_FAILED 259 +#define SSL_F_DTLS1_SEND_CERTIFICATE_REQUEST 260 +#define SSL_F_DTLS1_SEND_CLIENT_CERTIFICATE 261 +#define SSL_F_DTLS1_SEND_CLIENT_KEY_EXCHANGE 262 +#define SSL_F_DTLS1_SEND_CLIENT_VERIFY 263 +#define SSL_F_DTLS1_SEND_HELLO_VERIFY_REQUEST 264 +#define SSL_F_DTLS1_SEND_SERVER_CERTIFICATE 265 +#define SSL_F_DTLS1_SEND_SERVER_HELLO 266 +#define SSL_F_DTLS1_SEND_SERVER_KEY_EXCHANGE 267 +#define SSL_F_DTLS1_WRITE_APP_DATA_BYTES 268 +#define SSL_F_GET_CLIENT_FINISHED 105 +#define SSL_F_GET_CLIENT_HELLO 106 +#define SSL_F_GET_CLIENT_MASTER_KEY 107 +#define SSL_F_GET_SERVER_FINISHED 108 +#define SSL_F_GET_SERVER_HELLO 109 +#define SSL_F_GET_SERVER_VERIFY 110 +#define SSL_F_I2D_SSL_SESSION 111 +#define SSL_F_READ_N 112 +#define SSL_F_REQUEST_CERTIFICATE 113 +#define SSL_F_SERVER_FINISH 239 +#define SSL_F_SERVER_HELLO 114 +#define SSL_F_SERVER_VERIFY 240 +#define SSL_F_SSL23_ACCEPT 115 +#define SSL_F_SSL23_CLIENT_HELLO 116 +#define SSL_F_SSL23_CONNECT 117 +#define SSL_F_SSL23_GET_CLIENT_HELLO 118 +#define SSL_F_SSL23_GET_SERVER_HELLO 119 +#define SSL_F_SSL23_PEEK 237 +#define SSL_F_SSL23_READ 120 +#define SSL_F_SSL23_WRITE 121 +#define SSL_F_SSL2_ACCEPT 122 +#define SSL_F_SSL2_CONNECT 123 +#define SSL_F_SSL2_ENC_INIT 124 +#define SSL_F_SSL2_GENERATE_KEY_MATERIAL 241 +#define SSL_F_SSL2_PEEK 234 +#define SSL_F_SSL2_READ 125 +#define SSL_F_SSL2_READ_INTERNAL 236 +#define SSL_F_SSL2_SET_CERTIFICATE 126 +#define SSL_F_SSL2_WRITE 127 +#define SSL_F_SSL3_ACCEPT 128 +#define SSL_F_SSL3_ADD_CERT_TO_BUF 296 +#define SSL_F_SSL3_CALLBACK_CTRL 233 +#define SSL_F_SSL3_CHANGE_CIPHER_STATE 129 +#define SSL_F_SSL3_CHECK_CERT_AND_ALGORITHM 130 +#define SSL_F_SSL3_CHECK_CLIENT_HELLO 304 +#define SSL_F_SSL3_CLIENT_HELLO 131 +#define SSL_F_SSL3_CONNECT 132 +#define SSL_F_SSL3_CTRL 213 +#define SSL_F_SSL3_CTX_CTRL 133 +#define SSL_F_SSL3_DIGEST_CACHED_RECORDS 293 +#define SSL_F_SSL3_DO_CHANGE_CIPHER_SPEC 292 +#define SSL_F_SSL3_ENC 134 +#define SSL_F_SSL3_GENERATE_KEY_BLOCK 238 +#define SSL_F_SSL3_GET_CERTIFICATE_REQUEST 135 +#define SSL_F_SSL3_GET_CERT_STATUS 289 +#define SSL_F_SSL3_GET_CERT_VERIFY 136 +#define SSL_F_SSL3_GET_CLIENT_CERTIFICATE 137 +#define SSL_F_SSL3_GET_CLIENT_HELLO 138 +#define SSL_F_SSL3_GET_CLIENT_KEY_EXCHANGE 139 +#define SSL_F_SSL3_GET_FINISHED 140 +#define SSL_F_SSL3_GET_KEY_EXCHANGE 141 +#define SSL_F_SSL3_GET_MESSAGE 142 +#define SSL_F_SSL3_GET_NEW_SESSION_TICKET 283 +#define SSL_F_SSL3_GET_NEXT_PROTO 306 +#define SSL_F_SSL3_GET_RECORD 143 +#define SSL_F_SSL3_GET_SERVER_CERTIFICATE 144 +#define SSL_F_SSL3_GET_SERVER_DONE 145 +#define SSL_F_SSL3_GET_SERVER_HELLO 146 +#define SSL_F_SSL3_HANDSHAKE_MAC 285 +#define SSL_F_SSL3_NEW_SESSION_TICKET 287 +#define SSL_F_SSL3_OUTPUT_CERT_CHAIN 147 +#define SSL_F_SSL3_PEEK 235 +#define SSL_F_SSL3_READ_BYTES 148 +#define SSL_F_SSL3_READ_N 149 +#define SSL_F_SSL3_SEND_CERTIFICATE_REQUEST 150 +#define SSL_F_SSL3_SEND_CLIENT_CERTIFICATE 151 +#define SSL_F_SSL3_SEND_CLIENT_KEY_EXCHANGE 152 +#define SSL_F_SSL3_SEND_CLIENT_VERIFY 153 +#define SSL_F_SSL3_SEND_SERVER_CERTIFICATE 154 +#define SSL_F_SSL3_SEND_SERVER_HELLO 242 +#define SSL_F_SSL3_SEND_SERVER_KEY_EXCHANGE 155 +#define SSL_F_SSL3_SETUP_KEY_BLOCK 157 +#define SSL_F_SSL3_SETUP_READ_BUFFER 156 +#define SSL_F_SSL3_SETUP_WRITE_BUFFER 291 +#define SSL_F_SSL3_WRITE_BYTES 158 +#define SSL_F_SSL3_WRITE_PENDING 159 +#define SSL_F_SSL_ADD_CLIENTHELLO_RENEGOTIATE_EXT 298 +#define SSL_F_SSL_ADD_CLIENTHELLO_TLSEXT 277 +#define SSL_F_SSL_ADD_CLIENTHELLO_USE_SRTP_EXT 307 +#define SSL_F_SSL_ADD_DIR_CERT_SUBJECTS_TO_STACK 215 +#define SSL_F_SSL_ADD_FILE_CERT_SUBJECTS_TO_STACK 216 +#define SSL_F_SSL_ADD_SERVERHELLO_RENEGOTIATE_EXT 299 +#define SSL_F_SSL_ADD_SERVERHELLO_TLSEXT 278 +#define SSL_F_SSL_ADD_SERVERHELLO_USE_SRTP_EXT 308 +#define SSL_F_SSL_BAD_METHOD 160 +#define SSL_F_SSL_BYTES_TO_CIPHER_LIST 161 +#define SSL_F_SSL_CERT_DUP 221 +#define SSL_F_SSL_CERT_INST 222 +#define SSL_F_SSL_CERT_INSTANTIATE 214 +#define SSL_F_SSL_CERT_NEW 162 +#define SSL_F_SSL_CHECK_PRIVATE_KEY 163 +#define SSL_F_SSL_CHECK_SERVERHELLO_TLSEXT 280 +#define SSL_F_SSL_CHECK_SRVR_ECC_CERT_AND_ALG 279 +#define SSL_F_SSL_CIPHER_PROCESS_RULESTR 230 +#define SSL_F_SSL_CIPHER_STRENGTH_SORT 231 +#define SSL_F_SSL_CLEAR 164 +#define SSL_F_SSL_COMP_ADD_COMPRESSION_METHOD 165 +#define SSL_F_SSL_CREATE_CIPHER_LIST 166 +#define SSL_F_SSL_CTRL 232 +#define SSL_F_SSL_CTX_CHECK_PRIVATE_KEY 168 +#define SSL_F_SSL_CTX_MAKE_PROFILES 309 +#define SSL_F_SSL_CTX_NEW 169 +#define SSL_F_SSL_CTX_SET_CIPHER_LIST 269 +#define SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE 290 +#define SSL_F_SSL_CTX_SET_PURPOSE 226 +#define SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT 219 +#define SSL_F_SSL_CTX_SET_SSL_VERSION 170 +#define SSL_F_SSL_CTX_SET_TRUST 229 +#define SSL_F_SSL_CTX_USE_CERTIFICATE 171 +#define SSL_F_SSL_CTX_USE_CERTIFICATE_ASN1 172 +#define SSL_F_SSL_CTX_USE_CERTIFICATE_CHAIN_FILE 220 +#define SSL_F_SSL_CTX_USE_CERTIFICATE_FILE 173 +#define SSL_F_SSL_CTX_USE_PRIVATEKEY 174 +#define SSL_F_SSL_CTX_USE_PRIVATEKEY_ASN1 175 +#define SSL_F_SSL_CTX_USE_PRIVATEKEY_FILE 176 +#define SSL_F_SSL_CTX_USE_PSK_IDENTITY_HINT 272 +#define SSL_F_SSL_CTX_USE_RSAPRIVATEKEY 177 +#define SSL_F_SSL_CTX_USE_RSAPRIVATEKEY_ASN1 178 +#define SSL_F_SSL_CTX_USE_RSAPRIVATEKEY_FILE 179 +#define SSL_F_SSL_DO_HANDSHAKE 180 +#define SSL_F_SSL_GET_NEW_SESSION 181 +#define SSL_F_SSL_GET_PREV_SESSION 217 +#define SSL_F_SSL_GET_SERVER_SEND_CERT 182 +#define SSL_F_SSL_GET_SIGN_PKEY 183 +#define SSL_F_SSL_INIT_WBIO_BUFFER 184 +#define SSL_F_SSL_LOAD_CLIENT_CA_FILE 185 +#define SSL_F_SSL_NEW 186 +#define SSL_F_SSL_PARSE_CLIENTHELLO_RENEGOTIATE_EXT 300 +#define SSL_F_SSL_PARSE_CLIENTHELLO_TLSEXT 302 +#define SSL_F_SSL_PARSE_CLIENTHELLO_USE_SRTP_EXT 310 +#define SSL_F_SSL_PARSE_SERVERHELLO_RENEGOTIATE_EXT 301 +#define SSL_F_SSL_PARSE_SERVERHELLO_TLSEXT 303 +#define SSL_F_SSL_PARSE_SERVERHELLO_USE_SRTP_EXT 311 +#define SSL_F_SSL_PEEK 270 +#define SSL_F_SSL_PREPARE_CLIENTHELLO_TLSEXT 281 +#define SSL_F_SSL_PREPARE_SERVERHELLO_TLSEXT 282 +#define SSL_F_SSL_READ 223 +#define SSL_F_SSL_RSA_PRIVATE_DECRYPT 187 +#define SSL_F_SSL_RSA_PUBLIC_ENCRYPT 188 +#define SSL_F_SSL_SESSION_NEW 189 +#define SSL_F_SSL_SESSION_PRINT_FP 190 +#define SSL_F_SSL_SESSION_SET1_ID_CONTEXT 312 +#define SSL_F_SSL_SESS_CERT_NEW 225 +#define SSL_F_SSL_SET_CERT 191 +#define SSL_F_SSL_SET_CIPHER_LIST 271 +#define SSL_F_SSL_SET_FD 192 +#define SSL_F_SSL_SET_PKEY 193 +#define SSL_F_SSL_SET_PURPOSE 227 +#define SSL_F_SSL_SET_RFD 194 +#define SSL_F_SSL_SET_SESSION 195 +#define SSL_F_SSL_SET_SESSION_ID_CONTEXT 218 +#define SSL_F_SSL_SET_SESSION_TICKET_EXT 294 +#define SSL_F_SSL_SET_TRUST 228 +#define SSL_F_SSL_SET_WFD 196 +#define SSL_F_SSL_SHUTDOWN 224 +#define SSL_F_SSL_SRP_CTX_INIT 313 +#define SSL_F_SSL_UNDEFINED_CONST_FUNCTION 243 +#define SSL_F_SSL_UNDEFINED_FUNCTION 197 +#define SSL_F_SSL_UNDEFINED_VOID_FUNCTION 244 +#define SSL_F_SSL_USE_CERTIFICATE 198 +#define SSL_F_SSL_USE_CERTIFICATE_ASN1 199 +#define SSL_F_SSL_USE_CERTIFICATE_FILE 200 +#define SSL_F_SSL_USE_PRIVATEKEY 201 +#define SSL_F_SSL_USE_PRIVATEKEY_ASN1 202 +#define SSL_F_SSL_USE_PRIVATEKEY_FILE 203 +#define SSL_F_SSL_USE_PSK_IDENTITY_HINT 273 +#define SSL_F_SSL_USE_RSAPRIVATEKEY 204 +#define SSL_F_SSL_USE_RSAPRIVATEKEY_ASN1 205 +#define SSL_F_SSL_USE_RSAPRIVATEKEY_FILE 206 +#define SSL_F_SSL_VERIFY_CERT_CHAIN 207 +#define SSL_F_SSL_WRITE 208 +#define SSL_F_TLS1_CERT_VERIFY_MAC 286 +#define SSL_F_TLS1_CHANGE_CIPHER_STATE 209 +#define SSL_F_TLS1_CHECK_SERVERHELLO_TLSEXT 274 +#define SSL_F_TLS1_ENC 210 +#define SSL_F_TLS1_EXPORT_KEYING_MATERIAL 314 +#define SSL_F_TLS1_HEARTBEAT 315 +#define SSL_F_TLS1_PREPARE_CLIENTHELLO_TLSEXT 275 +#define SSL_F_TLS1_PREPARE_SERVERHELLO_TLSEXT 276 +#define SSL_F_TLS1_PRF 284 +#define SSL_F_TLS1_SETUP_KEY_BLOCK 211 +#define SSL_F_WRITE_PENDING 212 + +/* Reason codes. */ +#define SSL_R_APP_DATA_IN_HANDSHAKE 100 +#define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 272 +#define SSL_R_BAD_ALERT_RECORD 101 +#define SSL_R_BAD_AUTHENTICATION_TYPE 102 +#define SSL_R_BAD_CHANGE_CIPHER_SPEC 103 +#define SSL_R_BAD_CHECKSUM 104 +#define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 106 +#define SSL_R_BAD_DECOMPRESSION 107 +#define SSL_R_BAD_DH_G_LENGTH 108 +#define SSL_R_BAD_DH_PUB_KEY_LENGTH 109 +#define SSL_R_BAD_DH_P_LENGTH 110 +#define SSL_R_BAD_DIGEST_LENGTH 111 +#define SSL_R_BAD_DSA_SIGNATURE 112 +#define SSL_R_BAD_ECC_CERT 304 +#define SSL_R_BAD_ECDSA_SIGNATURE 305 +#define SSL_R_BAD_ECPOINT 306 +#define SSL_R_BAD_HANDSHAKE_LENGTH 332 +#define SSL_R_BAD_HELLO_REQUEST 105 +#define SSL_R_BAD_LENGTH 271 +#define SSL_R_BAD_MAC_DECODE 113 +#define SSL_R_BAD_MAC_LENGTH 333 +#define SSL_R_BAD_MESSAGE_TYPE 114 +#define SSL_R_BAD_PACKET_LENGTH 115 +#define SSL_R_BAD_PROTOCOL_VERSION_NUMBER 116 +#define SSL_R_BAD_PSK_IDENTITY_HINT_LENGTH 316 +#define SSL_R_BAD_RESPONSE_ARGUMENT 117 +#define SSL_R_BAD_RSA_DECRYPT 118 +#define SSL_R_BAD_RSA_ENCRYPT 119 +#define SSL_R_BAD_RSA_E_LENGTH 120 +#define SSL_R_BAD_RSA_MODULUS_LENGTH 121 +#define SSL_R_BAD_RSA_SIGNATURE 122 +#define SSL_R_BAD_SIGNATURE 123 +#define SSL_R_BAD_SRP_A_LENGTH 347 +#define SSL_R_BAD_SRP_B_LENGTH 348 +#define SSL_R_BAD_SRP_G_LENGTH 349 +#define SSL_R_BAD_SRP_N_LENGTH 350 +#define SSL_R_BAD_SRP_S_LENGTH 351 +#define SSL_R_BAD_SRTP_MKI_VALUE 352 +#define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 353 +#define SSL_R_BAD_SSL_FILETYPE 124 +#define SSL_R_BAD_SSL_SESSION_ID_LENGTH 125 +#define SSL_R_BAD_STATE 126 +#define SSL_R_BAD_WRITE_RETRY 127 +#define SSL_R_BIO_NOT_SET 128 +#define SSL_R_BLOCK_CIPHER_PAD_IS_WRONG 129 +#define SSL_R_BN_LIB 130 +#define SSL_R_CA_DN_LENGTH_MISMATCH 131 +#define SSL_R_CA_DN_TOO_LONG 132 +#define SSL_R_CCS_RECEIVED_EARLY 133 +#define SSL_R_CERTIFICATE_VERIFY_FAILED 134 +#define SSL_R_CERT_LENGTH_MISMATCH 135 +#define SSL_R_CHALLENGE_IS_DIFFERENT 136 +#define SSL_R_CIPHER_CODE_WRONG_LENGTH 137 +#define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 138 +#define SSL_R_CIPHER_TABLE_SRC_ERROR 139 +#define SSL_R_CLIENTHELLO_TLSEXT 226 +#define SSL_R_COMPRESSED_LENGTH_TOO_LONG 140 +#define SSL_R_COMPRESSION_DISABLED 343 +#define SSL_R_COMPRESSION_FAILURE 141 +#define SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE 307 +#define SSL_R_COMPRESSION_LIBRARY_ERROR 142 +#define SSL_R_CONNECTION_ID_IS_DIFFERENT 143 +#define SSL_R_CONNECTION_TYPE_NOT_SET 144 +#define SSL_R_COOKIE_MISMATCH 308 +#define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 145 +#define SSL_R_DATA_LENGTH_TOO_LONG 146 +#define SSL_R_DECRYPTION_FAILED 147 +#define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 281 +#define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 148 +#define SSL_R_DIGEST_CHECK_FAILED 149 +#define SSL_R_DTLS_MESSAGE_TOO_BIG 334 +#define SSL_R_DUPLICATE_COMPRESSION_ID 309 +#define SSL_R_ECC_CERT_NOT_FOR_KEY_AGREEMENT 317 +#define SSL_R_ECC_CERT_NOT_FOR_SIGNING 318 +#define SSL_R_ECC_CERT_SHOULD_HAVE_RSA_SIGNATURE 322 +#define SSL_R_ECC_CERT_SHOULD_HAVE_SHA1_SIGNATURE 323 +#define SSL_R_ECGROUP_TOO_LARGE_FOR_CIPHER 310 +#define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 354 +#define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 150 +#define SSL_R_ERROR_GENERATING_TMP_RSA_KEY 282 +#define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 151 +#define SSL_R_EXCESSIVE_MESSAGE_SIZE 152 +#define SSL_R_EXTRA_DATA_IN_MESSAGE 153 +#define SSL_R_GOT_A_FIN_BEFORE_A_CCS 154 +#define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 355 +#define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 356 +#define SSL_R_HTTPS_PROXY_REQUEST 155 +#define SSL_R_HTTP_REQUEST 156 +#define SSL_R_ILLEGAL_PADDING 283 +#define SSL_R_INCONSISTENT_COMPRESSION 340 +#define SSL_R_INVALID_CHALLENGE_LENGTH 158 +#define SSL_R_INVALID_COMMAND 280 +#define SSL_R_INVALID_COMPRESSION_ALGORITHM 341 +#define SSL_R_INVALID_PURPOSE 278 +#define SSL_R_INVALID_SRP_USERNAME 357 +#define SSL_R_INVALID_STATUS_RESPONSE 328 +#define SSL_R_INVALID_TICKET_KEYS_LENGTH 325 +#define SSL_R_INVALID_TRUST 279 +#define SSL_R_KEY_ARG_TOO_LONG 284 +#define SSL_R_KRB5 285 +#define SSL_R_KRB5_C_CC_PRINC 286 +#define SSL_R_KRB5_C_GET_CRED 287 +#define SSL_R_KRB5_C_INIT 288 +#define SSL_R_KRB5_C_MK_REQ 289 +#define SSL_R_KRB5_S_BAD_TICKET 290 +#define SSL_R_KRB5_S_INIT 291 +#define SSL_R_KRB5_S_RD_REQ 292 +#define SSL_R_KRB5_S_TKT_EXPIRED 293 +#define SSL_R_KRB5_S_TKT_NYV 294 +#define SSL_R_KRB5_S_TKT_SKEW 295 +#define SSL_R_LENGTH_MISMATCH 159 +#define SSL_R_LENGTH_TOO_SHORT 160 +#define SSL_R_LIBRARY_BUG 274 +#define SSL_R_LIBRARY_HAS_NO_CIPHERS 161 +#define SSL_R_MESSAGE_TOO_LONG 296 +#define SSL_R_MISSING_DH_DSA_CERT 162 +#define SSL_R_MISSING_DH_KEY 163 +#define SSL_R_MISSING_DH_RSA_CERT 164 +#define SSL_R_MISSING_DSA_SIGNING_CERT 165 +#define SSL_R_MISSING_EXPORT_TMP_DH_KEY 166 +#define SSL_R_MISSING_EXPORT_TMP_RSA_KEY 167 +#define SSL_R_MISSING_RSA_CERTIFICATE 168 +#define SSL_R_MISSING_RSA_ENCRYPTING_CERT 169 +#define SSL_R_MISSING_RSA_SIGNING_CERT 170 +#define SSL_R_MISSING_SRP_PARAM 358 +#define SSL_R_MISSING_TMP_DH_KEY 171 +#define SSL_R_MISSING_TMP_ECDH_KEY 311 +#define SSL_R_MISSING_TMP_RSA_KEY 172 +#define SSL_R_MISSING_TMP_RSA_PKEY 173 +#define SSL_R_MISSING_VERIFY_MESSAGE 174 +#define SSL_R_MULTIPLE_SGC_RESTARTS 346 +#define SSL_R_NON_SSLV2_INITIAL_PACKET 175 +#define SSL_R_NO_CERTIFICATES_RETURNED 176 +#define SSL_R_NO_CERTIFICATE_ASSIGNED 177 +#define SSL_R_NO_CERTIFICATE_RETURNED 178 +#define SSL_R_NO_CERTIFICATE_SET 179 +#define SSL_R_NO_CERTIFICATE_SPECIFIED 180 +#define SSL_R_NO_CIPHERS_AVAILABLE 181 +#define SSL_R_NO_CIPHERS_PASSED 182 +#define SSL_R_NO_CIPHERS_SPECIFIED 183 +#define SSL_R_NO_CIPHER_LIST 184 +#define SSL_R_NO_CIPHER_MATCH 185 +#define SSL_R_NO_CLIENT_CERT_METHOD 331 +#define SSL_R_NO_CLIENT_CERT_RECEIVED 186 +#define SSL_R_NO_COMPRESSION_SPECIFIED 187 +#define SSL_R_NO_GOST_CERTIFICATE_SENT_BY_PEER 330 +#define SSL_R_NO_METHOD_SPECIFIED 188 +#define SSL_R_NO_PRIVATEKEY 189 +#define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190 +#define SSL_R_NO_PROTOCOLS_AVAILABLE 191 +#define SSL_R_NO_PUBLICKEY 192 +#define SSL_R_NO_RENEGOTIATION 339 +#define SSL_R_NO_REQUIRED_DIGEST 324 +#define SSL_R_NO_SHARED_CIPHER 193 +#define SSL_R_NO_SRTP_PROFILES 359 +#define SSL_R_NO_VERIFY_CALLBACK 194 +#define SSL_R_NULL_SSL_CTX 195 +#define SSL_R_NULL_SSL_METHOD_PASSED 196 +#define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 197 +#define SSL_R_OLD_SESSION_COMPRESSION_ALGORITHM_NOT_RETURNED 344 +#define SSL_R_ONLY_TLS_ALLOWED_IN_FIPS_MODE 297 +#define SSL_R_OPAQUE_PRF_INPUT_TOO_LONG 327 +#define SSL_R_PACKET_LENGTH_TOO_LONG 198 +#define SSL_R_PARSE_TLSEXT 227 +#define SSL_R_PATH_TOO_LONG 270 +#define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 199 +#define SSL_R_PEER_ERROR 200 +#define SSL_R_PEER_ERROR_CERTIFICATE 201 +#define SSL_R_PEER_ERROR_NO_CERTIFICATE 202 +#define SSL_R_PEER_ERROR_NO_CIPHER 203 +#define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 204 +#define SSL_R_PRE_MAC_LENGTH_TOO_LONG 205 +#define SSL_R_PROBLEMS_MAPPING_CIPHER_FUNCTIONS 206 +#define SSL_R_PROTOCOL_IS_SHUTDOWN 207 +#define SSL_R_PSK_IDENTITY_NOT_FOUND 223 +#define SSL_R_PSK_NO_CLIENT_CB 224 +#define SSL_R_PSK_NO_SERVER_CB 225 +#define SSL_R_PUBLIC_KEY_ENCRYPT_ERROR 208 +#define SSL_R_PUBLIC_KEY_IS_NOT_RSA 209 +#define SSL_R_PUBLIC_KEY_NOT_RSA 210 +#define SSL_R_READ_BIO_NOT_SET 211 +#define SSL_R_READ_TIMEOUT_EXPIRED 312 +#define SSL_R_READ_WRONG_PACKET_TYPE 212 +#define SSL_R_RECORD_LENGTH_MISMATCH 213 +#define SSL_R_RECORD_TOO_LARGE 214 +#define SSL_R_RECORD_TOO_SMALL 298 +#define SSL_R_RENEGOTIATE_EXT_TOO_LONG 335 +#define SSL_R_RENEGOTIATION_ENCODING_ERR 336 +#define SSL_R_RENEGOTIATION_MISMATCH 337 +#define SSL_R_REQUIRED_CIPHER_MISSING 215 +#define SSL_R_REQUIRED_COMPRESSSION_ALGORITHM_MISSING 342 +#define SSL_R_REUSE_CERT_LENGTH_NOT_ZERO 216 +#define SSL_R_REUSE_CERT_TYPE_NOT_ZERO 217 +#define SSL_R_REUSE_CIPHER_LIST_NOT_ZERO 218 +#define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 345 +#define SSL_R_SERVERHELLO_TLSEXT 275 +#define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 277 +#define SSL_R_SHORT_READ 219 +#define SSL_R_SIGNATURE_ALGORITHMS_ERROR 360 +#define SSL_R_SIGNATURE_FOR_NON_SIGNING_CERTIFICATE 220 +#define SSL_R_SRP_A_CALC 361 +#define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 362 +#define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 363 +#define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 364 +#define SSL_R_SSL23_DOING_SESSION_ID_REUSE 221 +#define SSL_R_SSL2_CONNECTION_ID_TOO_LONG 299 +#define SSL_R_SSL3_EXT_INVALID_ECPOINTFORMAT 321 +#define SSL_R_SSL3_EXT_INVALID_SERVERNAME 319 +#define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 320 +#define SSL_R_SSL3_SESSION_ID_TOO_LONG 300 +#define SSL_R_SSL3_SESSION_ID_TOO_SHORT 222 +#define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042 +#define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020 +#define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045 +#define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044 +#define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046 +#define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030 +#define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040 +#define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047 +#define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041 +#define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010 +#define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043 +#define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 228 +#define SSL_R_SSL_HANDSHAKE_FAILURE 229 +#define SSL_R_SSL_LIBRARY_HAS_NO_CIPHERS 230 +#define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 301 +#define SSL_R_SSL_SESSION_ID_CONFLICT 302 +#define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 273 +#define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 303 +#define SSL_R_SSL_SESSION_ID_IS_DIFFERENT 231 +#define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049 +#define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050 +#define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021 +#define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051 +#define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060 +#define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071 +#define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080 +#define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100 +#define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070 +#define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022 +#define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048 +#define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090 +#define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114 +#define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113 +#define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111 +#define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112 +#define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110 +#define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232 +#define SSL_R_TLS_HEARTBEAT_PEER_DOESNT_ACCEPT 365 +#define SSL_R_TLS_HEARTBEAT_PENDING 366 +#define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 367 +#define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 157 +#define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 233 +#define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 234 +#define SSL_R_TRIED_TO_USE_UNSUPPORTED_CIPHER 235 +#define SSL_R_UNABLE_TO_DECODE_DH_CERTS 236 +#define SSL_R_UNABLE_TO_DECODE_ECDH_CERTS 313 +#define SSL_R_UNABLE_TO_EXTRACT_PUBLIC_KEY 237 +#define SSL_R_UNABLE_TO_FIND_DH_PARAMETERS 238 +#define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 314 +#define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239 +#define SSL_R_UNABLE_TO_FIND_SSL_METHOD 240 +#define SSL_R_UNABLE_TO_LOAD_SSL2_MD5_ROUTINES 241 +#define SSL_R_UNABLE_TO_LOAD_SSL3_MD5_ROUTINES 242 +#define SSL_R_UNABLE_TO_LOAD_SSL3_SHA1_ROUTINES 243 +#define SSL_R_UNEXPECTED_MESSAGE 244 +#define SSL_R_UNEXPECTED_RECORD 245 +#define SSL_R_UNINITIALIZED 276 +#define SSL_R_UNKNOWN_ALERT_TYPE 246 +#define SSL_R_UNKNOWN_CERTIFICATE_TYPE 247 +#define SSL_R_UNKNOWN_CIPHER_RETURNED 248 +#define SSL_R_UNKNOWN_CIPHER_TYPE 249 +#define SSL_R_UNKNOWN_DIGEST 368 +#define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250 +#define SSL_R_UNKNOWN_PKEY_TYPE 251 +#define SSL_R_UNKNOWN_PROTOCOL 252 +#define SSL_R_UNKNOWN_REMOTE_ERROR_TYPE 253 +#define SSL_R_UNKNOWN_SSL_VERSION 254 +#define SSL_R_UNKNOWN_STATE 255 +#define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 338 +#define SSL_R_UNSUPPORTED_CIPHER 256 +#define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257 +#define SSL_R_UNSUPPORTED_DIGEST_TYPE 326 +#define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 315 +#define SSL_R_UNSUPPORTED_PROTOCOL 258 +#define SSL_R_UNSUPPORTED_SSL_VERSION 259 +#define SSL_R_UNSUPPORTED_STATUS_TYPE 329 +#define SSL_R_USE_SRTP_NOT_NEGOTIATED 369 +#define SSL_R_WRITE_BIO_NOT_SET 260 +#define SSL_R_WRONG_CIPHER_RETURNED 261 +#define SSL_R_WRONG_MESSAGE_TYPE 262 +#define SSL_R_WRONG_NUMBER_OF_KEY_BITS 263 +#define SSL_R_WRONG_SIGNATURE_LENGTH 264 +#define SSL_R_WRONG_SIGNATURE_SIZE 265 +#define SSL_R_WRONG_SIGNATURE_TYPE 370 +#define SSL_R_WRONG_SSL_VERSION 266 +#define SSL_R_WRONG_VERSION_NUMBER 267 +#define SSL_R_X509_LIB 268 +#define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 269 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/ssl2.h b/Source/Import/OpenSSL/Include/openssl/ssl2.h new file mode 100644 index 0000000..eb25dcb --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ssl2.h @@ -0,0 +1,272 @@ +/* ssl/ssl2.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_SSL2_H +#define HEADER_SSL2_H + +#ifdef __cplusplus +extern "C" { +#endif + +/* Protocol Version Codes */ +#define SSL2_VERSION 0x0002 +#define SSL2_VERSION_MAJOR 0x00 +#define SSL2_VERSION_MINOR 0x02 +/* #define SSL2_CLIENT_VERSION 0x0002 */ +/* #define SSL2_SERVER_VERSION 0x0002 */ + +/* Protocol Message Codes */ +#define SSL2_MT_ERROR 0 +#define SSL2_MT_CLIENT_HELLO 1 +#define SSL2_MT_CLIENT_MASTER_KEY 2 +#define SSL2_MT_CLIENT_FINISHED 3 +#define SSL2_MT_SERVER_HELLO 4 +#define SSL2_MT_SERVER_VERIFY 5 +#define SSL2_MT_SERVER_FINISHED 6 +#define SSL2_MT_REQUEST_CERTIFICATE 7 +#define SSL2_MT_CLIENT_CERTIFICATE 8 + +/* Error Message Codes */ +#define SSL2_PE_UNDEFINED_ERROR 0x0000 +#define SSL2_PE_NO_CIPHER 0x0001 +#define SSL2_PE_NO_CERTIFICATE 0x0002 +#define SSL2_PE_BAD_CERTIFICATE 0x0004 +#define SSL2_PE_UNSUPPORTED_CERTIFICATE_TYPE 0x0006 + +/* Cipher Kind Values */ +#define SSL2_CK_NULL_WITH_MD5 0x02000000 /* v3 */ +#define SSL2_CK_RC4_128_WITH_MD5 0x02010080 +#define SSL2_CK_RC4_128_EXPORT40_WITH_MD5 0x02020080 +#define SSL2_CK_RC2_128_CBC_WITH_MD5 0x02030080 +#define SSL2_CK_RC2_128_CBC_EXPORT40_WITH_MD5 0x02040080 +#define SSL2_CK_IDEA_128_CBC_WITH_MD5 0x02050080 +#define SSL2_CK_DES_64_CBC_WITH_MD5 0x02060040 +#define SSL2_CK_DES_64_CBC_WITH_SHA 0x02060140 /* v3 */ +#define SSL2_CK_DES_192_EDE3_CBC_WITH_MD5 0x020700c0 +#define SSL2_CK_DES_192_EDE3_CBC_WITH_SHA 0x020701c0 /* v3 */ +#define SSL2_CK_RC4_64_WITH_MD5 0x02080080 /* MS hack */ + +#define SSL2_CK_DES_64_CFB64_WITH_MD5_1 0x02ff0800 /* SSLeay */ +#define SSL2_CK_NULL 0x02ff0810 /* SSLeay */ + +#define SSL2_TXT_DES_64_CFB64_WITH_MD5_1 "DES-CFB-M1" +#define SSL2_TXT_NULL_WITH_MD5 "NULL-MD5" +#define SSL2_TXT_RC4_128_WITH_MD5 "RC4-MD5" +#define SSL2_TXT_RC4_128_EXPORT40_WITH_MD5 "EXP-RC4-MD5" +#define SSL2_TXT_RC2_128_CBC_WITH_MD5 "RC2-CBC-MD5" +#define SSL2_TXT_RC2_128_CBC_EXPORT40_WITH_MD5 "EXP-RC2-CBC-MD5" +#define SSL2_TXT_IDEA_128_CBC_WITH_MD5 "IDEA-CBC-MD5" +#define SSL2_TXT_DES_64_CBC_WITH_MD5 "DES-CBC-MD5" +#define SSL2_TXT_DES_64_CBC_WITH_SHA "DES-CBC-SHA" +#define SSL2_TXT_DES_192_EDE3_CBC_WITH_MD5 "DES-CBC3-MD5" +#define SSL2_TXT_DES_192_EDE3_CBC_WITH_SHA "DES-CBC3-SHA" +#define SSL2_TXT_RC4_64_WITH_MD5 "RC4-64-MD5" + +#define SSL2_TXT_NULL "NULL" + +/* Flags for the SSL_CIPHER.algorithm2 field */ +#define SSL2_CF_5_BYTE_ENC 0x01 +#define SSL2_CF_8_BYTE_ENC 0x02 + +/* Certificate Type Codes */ +#define SSL2_CT_X509_CERTIFICATE 0x01 + +/* Authentication Type Code */ +#define SSL2_AT_MD5_WITH_RSA_ENCRYPTION 0x01 + +#define SSL2_MAX_SSL_SESSION_ID_LENGTH 32 + +/* Upper/Lower Bounds */ +#define SSL2_MAX_MASTER_KEY_LENGTH_IN_BITS 256 +#ifdef OPENSSL_SYS_MPE +#define SSL2_MAX_RECORD_LENGTH_2_BYTE_HEADER 29998u +#else +#define SSL2_MAX_RECORD_LENGTH_2_BYTE_HEADER 32767u /* 2^15-1 */ +#endif +#define SSL2_MAX_RECORD_LENGTH_3_BYTE_HEADER 16383 /* 2^14-1 */ + +#define SSL2_CHALLENGE_LENGTH 16 +/*#define SSL2_CHALLENGE_LENGTH 32 */ +#define SSL2_MIN_CHALLENGE_LENGTH 16 +#define SSL2_MAX_CHALLENGE_LENGTH 32 +#define SSL2_CONNECTION_ID_LENGTH 16 +#define SSL2_MAX_CONNECTION_ID_LENGTH 16 +#define SSL2_SSL_SESSION_ID_LENGTH 16 +#define SSL2_MAX_CERT_CHALLENGE_LENGTH 32 +#define SSL2_MIN_CERT_CHALLENGE_LENGTH 16 +#define SSL2_MAX_KEY_MATERIAL_LENGTH 24 + +#ifndef HEADER_SSL_LOCL_H +#define CERT char +#endif + +#ifndef OPENSSL_NO_SSL_INTERN + +typedef struct ssl2_state_st + { + int three_byte_header; + int clear_text; /* clear text */ + int escape; /* not used in SSLv2 */ + int ssl2_rollback; /* used if SSLv23 rolled back to SSLv2 */ + + /* non-blocking io info, used to make sure the same + * args were passwd */ + unsigned int wnum; /* number of bytes sent so far */ + int wpend_tot; + const unsigned char *wpend_buf; + + int wpend_off; /* offset to data to write */ + int wpend_len; /* number of bytes passwd to write */ + int wpend_ret; /* number of bytes to return to caller */ + + /* buffer raw data */ + int rbuf_left; + int rbuf_offs; + unsigned char *rbuf; + unsigned char *wbuf; + + unsigned char *write_ptr;/* used to point to the start due to + * 2/3 byte header. */ + + unsigned int padding; + unsigned int rlength; /* passed to ssl2_enc */ + int ract_data_length; /* Set when things are encrypted. */ + unsigned int wlength; /* passed to ssl2_enc */ + int wact_data_length; /* Set when things are decrypted. */ + unsigned char *ract_data; + unsigned char *wact_data; + unsigned char *mac_data; + + unsigned char *read_key; + unsigned char *write_key; + + /* Stuff specifically to do with this SSL session */ + unsigned int challenge_length; + unsigned char challenge[SSL2_MAX_CHALLENGE_LENGTH]; + unsigned int conn_id_length; + unsigned char conn_id[SSL2_MAX_CONNECTION_ID_LENGTH]; + unsigned int key_material_length; + unsigned char key_material[SSL2_MAX_KEY_MATERIAL_LENGTH*2]; + + unsigned long read_sequence; + unsigned long write_sequence; + + struct { + unsigned int conn_id_length; + unsigned int cert_type; + unsigned int cert_length; + unsigned int csl; + unsigned int clear; + unsigned int enc; + unsigned char ccl[SSL2_MAX_CERT_CHALLENGE_LENGTH]; + unsigned int cipher_spec_length; + unsigned int session_id_length; + unsigned int clen; + unsigned int rlen; + } tmp; + } SSL2_STATE; + +#endif + +/* SSLv2 */ +/* client */ +#define SSL2_ST_SEND_CLIENT_HELLO_A (0x10|SSL_ST_CONNECT) +#define SSL2_ST_SEND_CLIENT_HELLO_B (0x11|SSL_ST_CONNECT) +#define SSL2_ST_GET_SERVER_HELLO_A (0x20|SSL_ST_CONNECT) +#define SSL2_ST_GET_SERVER_HELLO_B (0x21|SSL_ST_CONNECT) +#define SSL2_ST_SEND_CLIENT_MASTER_KEY_A (0x30|SSL_ST_CONNECT) +#define SSL2_ST_SEND_CLIENT_MASTER_KEY_B (0x31|SSL_ST_CONNECT) +#define SSL2_ST_SEND_CLIENT_FINISHED_A (0x40|SSL_ST_CONNECT) +#define SSL2_ST_SEND_CLIENT_FINISHED_B (0x41|SSL_ST_CONNECT) +#define SSL2_ST_SEND_CLIENT_CERTIFICATE_A (0x50|SSL_ST_CONNECT) +#define SSL2_ST_SEND_CLIENT_CERTIFICATE_B (0x51|SSL_ST_CONNECT) +#define SSL2_ST_SEND_CLIENT_CERTIFICATE_C (0x52|SSL_ST_CONNECT) +#define SSL2_ST_SEND_CLIENT_CERTIFICATE_D (0x53|SSL_ST_CONNECT) +#define SSL2_ST_GET_SERVER_VERIFY_A (0x60|SSL_ST_CONNECT) +#define SSL2_ST_GET_SERVER_VERIFY_B (0x61|SSL_ST_CONNECT) +#define SSL2_ST_GET_SERVER_FINISHED_A (0x70|SSL_ST_CONNECT) +#define SSL2_ST_GET_SERVER_FINISHED_B (0x71|SSL_ST_CONNECT) +#define SSL2_ST_CLIENT_START_ENCRYPTION (0x80|SSL_ST_CONNECT) +#define SSL2_ST_X509_GET_CLIENT_CERTIFICATE (0x90|SSL_ST_CONNECT) +/* server */ +#define SSL2_ST_GET_CLIENT_HELLO_A (0x10|SSL_ST_ACCEPT) +#define SSL2_ST_GET_CLIENT_HELLO_B (0x11|SSL_ST_ACCEPT) +#define SSL2_ST_GET_CLIENT_HELLO_C (0x12|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_SERVER_HELLO_A (0x20|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_SERVER_HELLO_B (0x21|SSL_ST_ACCEPT) +#define SSL2_ST_GET_CLIENT_MASTER_KEY_A (0x30|SSL_ST_ACCEPT) +#define SSL2_ST_GET_CLIENT_MASTER_KEY_B (0x31|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_SERVER_VERIFY_A (0x40|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_SERVER_VERIFY_B (0x41|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_SERVER_VERIFY_C (0x42|SSL_ST_ACCEPT) +#define SSL2_ST_GET_CLIENT_FINISHED_A (0x50|SSL_ST_ACCEPT) +#define SSL2_ST_GET_CLIENT_FINISHED_B (0x51|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_SERVER_FINISHED_A (0x60|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_SERVER_FINISHED_B (0x61|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_REQUEST_CERTIFICATE_A (0x70|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_REQUEST_CERTIFICATE_B (0x71|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_REQUEST_CERTIFICATE_C (0x72|SSL_ST_ACCEPT) +#define SSL2_ST_SEND_REQUEST_CERTIFICATE_D (0x73|SSL_ST_ACCEPT) +#define SSL2_ST_SERVER_START_ENCRYPTION (0x80|SSL_ST_ACCEPT) +#define SSL2_ST_X509_GET_SERVER_CERTIFICATE (0x90|SSL_ST_ACCEPT) + +#ifdef __cplusplus +} +#endif +#endif + diff --git a/Source/Import/OpenSSL/Include/openssl/ssl23.h b/Source/Import/OpenSSL/Include/openssl/ssl23.h new file mode 100644 index 0000000..d322898 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ssl23.h @@ -0,0 +1,83 @@ +/* ssl/ssl23.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_SSL23_H +#define HEADER_SSL23_H + +#ifdef __cplusplus +extern "C" { +#endif + +/*client */ +/* write to server */ +#define SSL23_ST_CW_CLNT_HELLO_A (0x210|SSL_ST_CONNECT) +#define SSL23_ST_CW_CLNT_HELLO_B (0x211|SSL_ST_CONNECT) +/* read from server */ +#define SSL23_ST_CR_SRVR_HELLO_A (0x220|SSL_ST_CONNECT) +#define SSL23_ST_CR_SRVR_HELLO_B (0x221|SSL_ST_CONNECT) + +/* server */ +/* read from client */ +#define SSL23_ST_SR_CLNT_HELLO_A (0x210|SSL_ST_ACCEPT) +#define SSL23_ST_SR_CLNT_HELLO_B (0x211|SSL_ST_ACCEPT) + +#ifdef __cplusplus +} +#endif +#endif + diff --git a/Source/Import/OpenSSL/Include/openssl/ssl3.h b/Source/Import/OpenSSL/Include/openssl/ssl3.h new file mode 100644 index 0000000..112e627 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ssl3.h @@ -0,0 +1,678 @@ +/* ssl/ssl3.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ +/* ==================================================================== + * Copyright (c) 1998-2002 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +/* ==================================================================== + * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. + * ECC cipher suite support in OpenSSL originally developed by + * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project. + */ + +#ifndef HEADER_SSL3_H +#define HEADER_SSL3_H + +#ifndef OPENSSL_NO_COMP +#include +#endif +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Signalling cipher suite value: from draft-ietf-tls-renegotiation-03.txt */ +#define SSL3_CK_SCSV 0x030000FF + +#define SSL3_CK_RSA_NULL_MD5 0x03000001 +#define SSL3_CK_RSA_NULL_SHA 0x03000002 +#define SSL3_CK_RSA_RC4_40_MD5 0x03000003 +#define SSL3_CK_RSA_RC4_128_MD5 0x03000004 +#define SSL3_CK_RSA_RC4_128_SHA 0x03000005 +#define SSL3_CK_RSA_RC2_40_MD5 0x03000006 +#define SSL3_CK_RSA_IDEA_128_SHA 0x03000007 +#define SSL3_CK_RSA_DES_40_CBC_SHA 0x03000008 +#define SSL3_CK_RSA_DES_64_CBC_SHA 0x03000009 +#define SSL3_CK_RSA_DES_192_CBC3_SHA 0x0300000A + +#define SSL3_CK_DH_DSS_DES_40_CBC_SHA 0x0300000B +#define SSL3_CK_DH_DSS_DES_64_CBC_SHA 0x0300000C +#define SSL3_CK_DH_DSS_DES_192_CBC3_SHA 0x0300000D +#define SSL3_CK_DH_RSA_DES_40_CBC_SHA 0x0300000E +#define SSL3_CK_DH_RSA_DES_64_CBC_SHA 0x0300000F +#define SSL3_CK_DH_RSA_DES_192_CBC3_SHA 0x03000010 + +#define SSL3_CK_EDH_DSS_DES_40_CBC_SHA 0x03000011 +#define SSL3_CK_EDH_DSS_DES_64_CBC_SHA 0x03000012 +#define SSL3_CK_EDH_DSS_DES_192_CBC3_SHA 0x03000013 +#define SSL3_CK_EDH_RSA_DES_40_CBC_SHA 0x03000014 +#define SSL3_CK_EDH_RSA_DES_64_CBC_SHA 0x03000015 +#define SSL3_CK_EDH_RSA_DES_192_CBC3_SHA 0x03000016 + +#define SSL3_CK_ADH_RC4_40_MD5 0x03000017 +#define SSL3_CK_ADH_RC4_128_MD5 0x03000018 +#define SSL3_CK_ADH_DES_40_CBC_SHA 0x03000019 +#define SSL3_CK_ADH_DES_64_CBC_SHA 0x0300001A +#define SSL3_CK_ADH_DES_192_CBC_SHA 0x0300001B + +#if 0 + #define SSL3_CK_FZA_DMS_NULL_SHA 0x0300001C + #define SSL3_CK_FZA_DMS_FZA_SHA 0x0300001D + #if 0 /* Because it clashes with KRB5, is never used any more, and is safe + to remove according to David Hopwood + of the ietf-tls list */ + #define SSL3_CK_FZA_DMS_RC4_SHA 0x0300001E + #endif +#endif + +/* VRS Additional Kerberos5 entries + */ +#define SSL3_CK_KRB5_DES_64_CBC_SHA 0x0300001E +#define SSL3_CK_KRB5_DES_192_CBC3_SHA 0x0300001F +#define SSL3_CK_KRB5_RC4_128_SHA 0x03000020 +#define SSL3_CK_KRB5_IDEA_128_CBC_SHA 0x03000021 +#define SSL3_CK_KRB5_DES_64_CBC_MD5 0x03000022 +#define SSL3_CK_KRB5_DES_192_CBC3_MD5 0x03000023 +#define SSL3_CK_KRB5_RC4_128_MD5 0x03000024 +#define SSL3_CK_KRB5_IDEA_128_CBC_MD5 0x03000025 + +#define SSL3_CK_KRB5_DES_40_CBC_SHA 0x03000026 +#define SSL3_CK_KRB5_RC2_40_CBC_SHA 0x03000027 +#define SSL3_CK_KRB5_RC4_40_SHA 0x03000028 +#define SSL3_CK_KRB5_DES_40_CBC_MD5 0x03000029 +#define SSL3_CK_KRB5_RC2_40_CBC_MD5 0x0300002A +#define SSL3_CK_KRB5_RC4_40_MD5 0x0300002B + +#define SSL3_TXT_RSA_NULL_MD5 "NULL-MD5" +#define SSL3_TXT_RSA_NULL_SHA "NULL-SHA" +#define SSL3_TXT_RSA_RC4_40_MD5 "EXP-RC4-MD5" +#define SSL3_TXT_RSA_RC4_128_MD5 "RC4-MD5" +#define SSL3_TXT_RSA_RC4_128_SHA "RC4-SHA" +#define SSL3_TXT_RSA_RC2_40_MD5 "EXP-RC2-CBC-MD5" +#define SSL3_TXT_RSA_IDEA_128_SHA "IDEA-CBC-SHA" +#define SSL3_TXT_RSA_DES_40_CBC_SHA "EXP-DES-CBC-SHA" +#define SSL3_TXT_RSA_DES_64_CBC_SHA "DES-CBC-SHA" +#define SSL3_TXT_RSA_DES_192_CBC3_SHA "DES-CBC3-SHA" + +#define SSL3_TXT_DH_DSS_DES_40_CBC_SHA "EXP-DH-DSS-DES-CBC-SHA" +#define SSL3_TXT_DH_DSS_DES_64_CBC_SHA "DH-DSS-DES-CBC-SHA" +#define SSL3_TXT_DH_DSS_DES_192_CBC3_SHA "DH-DSS-DES-CBC3-SHA" +#define SSL3_TXT_DH_RSA_DES_40_CBC_SHA "EXP-DH-RSA-DES-CBC-SHA" +#define SSL3_TXT_DH_RSA_DES_64_CBC_SHA "DH-RSA-DES-CBC-SHA" +#define SSL3_TXT_DH_RSA_DES_192_CBC3_SHA "DH-RSA-DES-CBC3-SHA" + +#define SSL3_TXT_EDH_DSS_DES_40_CBC_SHA "EXP-EDH-DSS-DES-CBC-SHA" +#define SSL3_TXT_EDH_DSS_DES_64_CBC_SHA "EDH-DSS-DES-CBC-SHA" +#define SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA "EDH-DSS-DES-CBC3-SHA" +#define SSL3_TXT_EDH_RSA_DES_40_CBC_SHA "EXP-EDH-RSA-DES-CBC-SHA" +#define SSL3_TXT_EDH_RSA_DES_64_CBC_SHA "EDH-RSA-DES-CBC-SHA" +#define SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA "EDH-RSA-DES-CBC3-SHA" + +#define SSL3_TXT_ADH_RC4_40_MD5 "EXP-ADH-RC4-MD5" +#define SSL3_TXT_ADH_RC4_128_MD5 "ADH-RC4-MD5" +#define SSL3_TXT_ADH_DES_40_CBC_SHA "EXP-ADH-DES-CBC-SHA" +#define SSL3_TXT_ADH_DES_64_CBC_SHA "ADH-DES-CBC-SHA" +#define SSL3_TXT_ADH_DES_192_CBC_SHA "ADH-DES-CBC3-SHA" + +#if 0 + #define SSL3_TXT_FZA_DMS_NULL_SHA "FZA-NULL-SHA" + #define SSL3_TXT_FZA_DMS_FZA_SHA "FZA-FZA-CBC-SHA" + #define SSL3_TXT_FZA_DMS_RC4_SHA "FZA-RC4-SHA" +#endif + +#define SSL3_TXT_KRB5_DES_64_CBC_SHA "KRB5-DES-CBC-SHA" +#define SSL3_TXT_KRB5_DES_192_CBC3_SHA "KRB5-DES-CBC3-SHA" +#define SSL3_TXT_KRB5_RC4_128_SHA "KRB5-RC4-SHA" +#define SSL3_TXT_KRB5_IDEA_128_CBC_SHA "KRB5-IDEA-CBC-SHA" +#define SSL3_TXT_KRB5_DES_64_CBC_MD5 "KRB5-DES-CBC-MD5" +#define SSL3_TXT_KRB5_DES_192_CBC3_MD5 "KRB5-DES-CBC3-MD5" +#define SSL3_TXT_KRB5_RC4_128_MD5 "KRB5-RC4-MD5" +#define SSL3_TXT_KRB5_IDEA_128_CBC_MD5 "KRB5-IDEA-CBC-MD5" + +#define SSL3_TXT_KRB5_DES_40_CBC_SHA "EXP-KRB5-DES-CBC-SHA" +#define SSL3_TXT_KRB5_RC2_40_CBC_SHA "EXP-KRB5-RC2-CBC-SHA" +#define SSL3_TXT_KRB5_RC4_40_SHA "EXP-KRB5-RC4-SHA" +#define SSL3_TXT_KRB5_DES_40_CBC_MD5 "EXP-KRB5-DES-CBC-MD5" +#define SSL3_TXT_KRB5_RC2_40_CBC_MD5 "EXP-KRB5-RC2-CBC-MD5" +#define SSL3_TXT_KRB5_RC4_40_MD5 "EXP-KRB5-RC4-MD5" + +#define SSL3_SSL_SESSION_ID_LENGTH 32 +#define SSL3_MAX_SSL_SESSION_ID_LENGTH 32 + +#define SSL3_MASTER_SECRET_SIZE 48 +#define SSL3_RANDOM_SIZE 32 +#define SSL3_SESSION_ID_SIZE 32 +#define SSL3_RT_HEADER_LENGTH 5 + +#ifndef SSL3_ALIGN_PAYLOAD + /* Some will argue that this increases memory footprint, but it's + * not actually true. Point is that malloc has to return at least + * 64-bit aligned pointers, meaning that allocating 5 bytes wastes + * 3 bytes in either case. Suggested pre-gaping simply moves these + * wasted bytes from the end of allocated region to its front, + * but makes data payload aligned, which improves performance:-) */ +# define SSL3_ALIGN_PAYLOAD 8 +#else +# if (SSL3_ALIGN_PAYLOAD&(SSL3_ALIGN_PAYLOAD-1))!=0 +# error "insane SSL3_ALIGN_PAYLOAD" +# undef SSL3_ALIGN_PAYLOAD +# endif +#endif + +/* This is the maximum MAC (digest) size used by the SSL library. + * Currently maximum of 20 is used by SHA1, but we reserve for + * future extension for 512-bit hashes. + */ + +#define SSL3_RT_MAX_MD_SIZE 64 + +/* Maximum block size used in all ciphersuites. Currently 16 for AES. + */ + +#define SSL_RT_MAX_CIPHER_BLOCK_SIZE 16 + +#define SSL3_RT_MAX_EXTRA (16384) + +/* Maximum plaintext length: defined by SSL/TLS standards */ +#define SSL3_RT_MAX_PLAIN_LENGTH 16384 +/* Maximum compression overhead: defined by SSL/TLS standards */ +#define SSL3_RT_MAX_COMPRESSED_OVERHEAD 1024 + +/* The standards give a maximum encryption overhead of 1024 bytes. + * In practice the value is lower than this. The overhead is the maximum + * number of padding bytes (256) plus the mac size. + */ +#define SSL3_RT_MAX_ENCRYPTED_OVERHEAD (256 + SSL3_RT_MAX_MD_SIZE) + +/* OpenSSL currently only uses a padding length of at most one block so + * the send overhead is smaller. + */ + +#define SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD \ + (SSL_RT_MAX_CIPHER_BLOCK_SIZE + SSL3_RT_MAX_MD_SIZE) + +/* If compression isn't used don't include the compression overhead */ + +#ifdef OPENSSL_NO_COMP +#define SSL3_RT_MAX_COMPRESSED_LENGTH SSL3_RT_MAX_PLAIN_LENGTH +#else +#define SSL3_RT_MAX_COMPRESSED_LENGTH \ + (SSL3_RT_MAX_PLAIN_LENGTH+SSL3_RT_MAX_COMPRESSED_OVERHEAD) +#endif +#define SSL3_RT_MAX_ENCRYPTED_LENGTH \ + (SSL3_RT_MAX_ENCRYPTED_OVERHEAD+SSL3_RT_MAX_COMPRESSED_LENGTH) +#define SSL3_RT_MAX_PACKET_SIZE \ + (SSL3_RT_MAX_ENCRYPTED_LENGTH+SSL3_RT_HEADER_LENGTH) + +#define SSL3_MD_CLIENT_FINISHED_CONST "\x43\x4C\x4E\x54" +#define SSL3_MD_SERVER_FINISHED_CONST "\x53\x52\x56\x52" + +#define SSL3_VERSION 0x0300 +#define SSL3_VERSION_MAJOR 0x03 +#define SSL3_VERSION_MINOR 0x00 + +#define SSL3_RT_CHANGE_CIPHER_SPEC 20 +#define SSL3_RT_ALERT 21 +#define SSL3_RT_HANDSHAKE 22 +#define SSL3_RT_APPLICATION_DATA 23 +#define TLS1_RT_HEARTBEAT 24 + +#define SSL3_AL_WARNING 1 +#define SSL3_AL_FATAL 2 + +#define SSL3_AD_CLOSE_NOTIFY 0 +#define SSL3_AD_UNEXPECTED_MESSAGE 10 /* fatal */ +#define SSL3_AD_BAD_RECORD_MAC 20 /* fatal */ +#define SSL3_AD_DECOMPRESSION_FAILURE 30 /* fatal */ +#define SSL3_AD_HANDSHAKE_FAILURE 40 /* fatal */ +#define SSL3_AD_NO_CERTIFICATE 41 +#define SSL3_AD_BAD_CERTIFICATE 42 +#define SSL3_AD_UNSUPPORTED_CERTIFICATE 43 +#define SSL3_AD_CERTIFICATE_REVOKED 44 +#define SSL3_AD_CERTIFICATE_EXPIRED 45 +#define SSL3_AD_CERTIFICATE_UNKNOWN 46 +#define SSL3_AD_ILLEGAL_PARAMETER 47 /* fatal */ + +#define TLS1_HB_REQUEST 1 +#define TLS1_HB_RESPONSE 2 + +#ifndef OPENSSL_NO_SSL_INTERN + +typedef struct ssl3_record_st + { +/*r */ int type; /* type of record */ +/*rw*/ unsigned int length; /* How many bytes available */ +/*r */ unsigned int off; /* read/write offset into 'buf' */ +/*rw*/ unsigned char *data; /* pointer to the record data */ +/*rw*/ unsigned char *input; /* where the decode bytes are */ +/*r */ unsigned char *comp; /* only used with decompression - malloc()ed */ +/*r */ unsigned long epoch; /* epoch number, needed by DTLS1 */ +/*r */ unsigned char seq_num[8]; /* sequence number, needed by DTLS1 */ + } SSL3_RECORD; + +typedef struct ssl3_buffer_st + { + unsigned char *buf; /* at least SSL3_RT_MAX_PACKET_SIZE bytes, + * see ssl3_setup_buffers() */ + size_t len; /* buffer size */ + int offset; /* where to 'copy from' */ + int left; /* how many bytes left */ + } SSL3_BUFFER; + +#endif + +#define SSL3_CT_RSA_SIGN 1 +#define SSL3_CT_DSS_SIGN 2 +#define SSL3_CT_RSA_FIXED_DH 3 +#define SSL3_CT_DSS_FIXED_DH 4 +#define SSL3_CT_RSA_EPHEMERAL_DH 5 +#define SSL3_CT_DSS_EPHEMERAL_DH 6 +#define SSL3_CT_FORTEZZA_DMS 20 +/* SSL3_CT_NUMBER is used to size arrays and it must be large + * enough to contain all of the cert types defined either for + * SSLv3 and TLSv1. + */ +#define SSL3_CT_NUMBER 9 + + +#define SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS 0x0001 +#define SSL3_FLAGS_DELAY_CLIENT_FINISHED 0x0002 +#define SSL3_FLAGS_POP_BUFFER 0x0004 +#define TLS1_FLAGS_TLS_PADDING_BUG 0x0008 +#define TLS1_FLAGS_SKIP_CERT_VERIFY 0x0010 +#define TLS1_FLAGS_KEEP_HANDSHAKE 0x0020 + +/* SSL3_FLAGS_SGC_RESTART_DONE is set when we + * restart a handshake because of MS SGC and so prevents us + * from restarting the handshake in a loop. It's reset on a + * renegotiation, so effectively limits the client to one restart + * per negotiation. This limits the possibility of a DDoS + * attack where the client handshakes in a loop using SGC to + * restart. Servers which permit renegotiation can still be + * effected, but we can't prevent that. + */ +#define SSL3_FLAGS_SGC_RESTART_DONE 0x0040 + +#ifndef OPENSSL_NO_SSL_INTERN + +typedef struct ssl3_state_st + { + long flags; + int delay_buf_pop_ret; + + unsigned char read_sequence[8]; + int read_mac_secret_size; + unsigned char read_mac_secret[EVP_MAX_MD_SIZE]; + unsigned char write_sequence[8]; + int write_mac_secret_size; + unsigned char write_mac_secret[EVP_MAX_MD_SIZE]; + + unsigned char server_random[SSL3_RANDOM_SIZE]; + unsigned char client_random[SSL3_RANDOM_SIZE]; + + /* flags for countermeasure against known-IV weakness */ + int need_empty_fragments; + int empty_fragment_done; + + /* The value of 'extra' when the buffers were initialized */ + int init_extra; + + SSL3_BUFFER rbuf; /* read IO goes into here */ + SSL3_BUFFER wbuf; /* write IO goes into here */ + + SSL3_RECORD rrec; /* each decoded record goes in here */ + SSL3_RECORD wrec; /* goes out from here */ + + /* storage for Alert/Handshake protocol data received but not + * yet processed by ssl3_read_bytes: */ + unsigned char alert_fragment[2]; + unsigned int alert_fragment_len; + unsigned char handshake_fragment[4]; + unsigned int handshake_fragment_len; + + /* partial write - check the numbers match */ + unsigned int wnum; /* number of bytes sent so far */ + int wpend_tot; /* number bytes written */ + int wpend_type; + int wpend_ret; /* number of bytes submitted */ + const unsigned char *wpend_buf; + + /* used during startup, digest all incoming/outgoing packets */ + BIO *handshake_buffer; + /* When set of handshake digests is determined, buffer is hashed + * and freed and MD_CTX-es for all required digests are stored in + * this array */ + EVP_MD_CTX **handshake_dgst; + /* this is set whenerver we see a change_cipher_spec message + * come in when we are not looking for one */ + int change_cipher_spec; + + int warn_alert; + int fatal_alert; + /* we allow one fatal and one warning alert to be outstanding, + * send close alert via the warning alert */ + int alert_dispatch; + unsigned char send_alert[2]; + + /* This flag is set when we should renegotiate ASAP, basically when + * there is no more data in the read or write buffers */ + int renegotiate; + int total_renegotiations; + int num_renegotiations; + + int in_read_app_data; + + /* Opaque PRF input as used for the current handshake. + * These fields are used only if TLSEXT_TYPE_opaque_prf_input is defined + * (otherwise, they are merely present to improve binary compatibility) */ + void *client_opaque_prf_input; + size_t client_opaque_prf_input_len; + void *server_opaque_prf_input; + size_t server_opaque_prf_input_len; + + struct { + /* actually only needs to be 16+20 */ + unsigned char cert_verify_md[EVP_MAX_MD_SIZE*2]; + + /* actually only need to be 16+20 for SSLv3 and 12 for TLS */ + unsigned char finish_md[EVP_MAX_MD_SIZE*2]; + int finish_md_len; + unsigned char peer_finish_md[EVP_MAX_MD_SIZE*2]; + int peer_finish_md_len; + + unsigned long message_size; + int message_type; + + /* used to hold the new cipher we are going to use */ + const SSL_CIPHER *new_cipher; +#ifndef OPENSSL_NO_DH + DH *dh; +#endif + +#ifndef OPENSSL_NO_ECDH + EC_KEY *ecdh; /* holds short lived ECDH key */ +#endif + + /* used when SSL_ST_FLUSH_DATA is entered */ + int next_state; + + int reuse_message; + + /* used for certificate requests */ + int cert_req; + int ctype_num; + char ctype[SSL3_CT_NUMBER]; + STACK_OF(X509_NAME) *ca_names; + + int use_rsa_tmp; + + int key_block_length; + unsigned char *key_block; + + const EVP_CIPHER *new_sym_enc; + const EVP_MD *new_hash; + int new_mac_pkey_type; + int new_mac_secret_size; +#ifndef OPENSSL_NO_COMP + const SSL_COMP *new_compression; +#else + char *new_compression; +#endif + int cert_request; + } tmp; + + /* Connection binding to prevent renegotiation attacks */ + unsigned char previous_client_finished[EVP_MAX_MD_SIZE]; + unsigned char previous_client_finished_len; + unsigned char previous_server_finished[EVP_MAX_MD_SIZE]; + unsigned char previous_server_finished_len; + int send_connection_binding; /* TODOEKR */ + +#ifndef OPENSSL_NO_NEXTPROTONEG + /* Set if we saw the Next Protocol Negotiation extension from our peer. */ + int next_proto_neg_seen; +#endif + } SSL3_STATE; + +#endif + +/* SSLv3 */ +/*client */ +/* extra state */ +#define SSL3_ST_CW_FLUSH (0x100|SSL_ST_CONNECT) +#ifndef OPENSSL_NO_SCTP +#define DTLS1_SCTP_ST_CW_WRITE_SOCK (0x310|SSL_ST_CONNECT) +#define DTLS1_SCTP_ST_CR_READ_SOCK (0x320|SSL_ST_CONNECT) +#endif +/* write to server */ +#define SSL3_ST_CW_CLNT_HELLO_A (0x110|SSL_ST_CONNECT) +#define SSL3_ST_CW_CLNT_HELLO_B (0x111|SSL_ST_CONNECT) +/* read from server */ +#define SSL3_ST_CR_SRVR_HELLO_A (0x120|SSL_ST_CONNECT) +#define SSL3_ST_CR_SRVR_HELLO_B (0x121|SSL_ST_CONNECT) +#define DTLS1_ST_CR_HELLO_VERIFY_REQUEST_A (0x126|SSL_ST_CONNECT) +#define DTLS1_ST_CR_HELLO_VERIFY_REQUEST_B (0x127|SSL_ST_CONNECT) +#define SSL3_ST_CR_CERT_A (0x130|SSL_ST_CONNECT) +#define SSL3_ST_CR_CERT_B (0x131|SSL_ST_CONNECT) +#define SSL3_ST_CR_KEY_EXCH_A (0x140|SSL_ST_CONNECT) +#define SSL3_ST_CR_KEY_EXCH_B (0x141|SSL_ST_CONNECT) +#define SSL3_ST_CR_CERT_REQ_A (0x150|SSL_ST_CONNECT) +#define SSL3_ST_CR_CERT_REQ_B (0x151|SSL_ST_CONNECT) +#define SSL3_ST_CR_SRVR_DONE_A (0x160|SSL_ST_CONNECT) +#define SSL3_ST_CR_SRVR_DONE_B (0x161|SSL_ST_CONNECT) +/* write to server */ +#define SSL3_ST_CW_CERT_A (0x170|SSL_ST_CONNECT) +#define SSL3_ST_CW_CERT_B (0x171|SSL_ST_CONNECT) +#define SSL3_ST_CW_CERT_C (0x172|SSL_ST_CONNECT) +#define SSL3_ST_CW_CERT_D (0x173|SSL_ST_CONNECT) +#define SSL3_ST_CW_KEY_EXCH_A (0x180|SSL_ST_CONNECT) +#define SSL3_ST_CW_KEY_EXCH_B (0x181|SSL_ST_CONNECT) +#define SSL3_ST_CW_CERT_VRFY_A (0x190|SSL_ST_CONNECT) +#define SSL3_ST_CW_CERT_VRFY_B (0x191|SSL_ST_CONNECT) +#define SSL3_ST_CW_CHANGE_A (0x1A0|SSL_ST_CONNECT) +#define SSL3_ST_CW_CHANGE_B (0x1A1|SSL_ST_CONNECT) +#define SSL3_ST_CW_NEXT_PROTO_A (0x200|SSL_ST_CONNECT) +#define SSL3_ST_CW_NEXT_PROTO_B (0x201|SSL_ST_CONNECT) +#define SSL3_ST_CW_FINISHED_A (0x1B0|SSL_ST_CONNECT) +#define SSL3_ST_CW_FINISHED_B (0x1B1|SSL_ST_CONNECT) +/* read from server */ +#define SSL3_ST_CR_CHANGE_A (0x1C0|SSL_ST_CONNECT) +#define SSL3_ST_CR_CHANGE_B (0x1C1|SSL_ST_CONNECT) +#define SSL3_ST_CR_FINISHED_A (0x1D0|SSL_ST_CONNECT) +#define SSL3_ST_CR_FINISHED_B (0x1D1|SSL_ST_CONNECT) +#define SSL3_ST_CR_SESSION_TICKET_A (0x1E0|SSL_ST_CONNECT) +#define SSL3_ST_CR_SESSION_TICKET_B (0x1E1|SSL_ST_CONNECT) +#define SSL3_ST_CR_CERT_STATUS_A (0x1F0|SSL_ST_CONNECT) +#define SSL3_ST_CR_CERT_STATUS_B (0x1F1|SSL_ST_CONNECT) + +/* server */ +/* extra state */ +#define SSL3_ST_SW_FLUSH (0x100|SSL_ST_ACCEPT) +#ifndef OPENSSL_NO_SCTP +#define DTLS1_SCTP_ST_SW_WRITE_SOCK (0x310|SSL_ST_ACCEPT) +#define DTLS1_SCTP_ST_SR_READ_SOCK (0x320|SSL_ST_ACCEPT) +#endif +/* read from client */ +/* Do not change the number values, they do matter */ +#define SSL3_ST_SR_CLNT_HELLO_A (0x110|SSL_ST_ACCEPT) +#define SSL3_ST_SR_CLNT_HELLO_B (0x111|SSL_ST_ACCEPT) +#define SSL3_ST_SR_CLNT_HELLO_C (0x112|SSL_ST_ACCEPT) +/* write to client */ +#define DTLS1_ST_SW_HELLO_VERIFY_REQUEST_A (0x113|SSL_ST_ACCEPT) +#define DTLS1_ST_SW_HELLO_VERIFY_REQUEST_B (0x114|SSL_ST_ACCEPT) +#define SSL3_ST_SW_HELLO_REQ_A (0x120|SSL_ST_ACCEPT) +#define SSL3_ST_SW_HELLO_REQ_B (0x121|SSL_ST_ACCEPT) +#define SSL3_ST_SW_HELLO_REQ_C (0x122|SSL_ST_ACCEPT) +#define SSL3_ST_SW_SRVR_HELLO_A (0x130|SSL_ST_ACCEPT) +#define SSL3_ST_SW_SRVR_HELLO_B (0x131|SSL_ST_ACCEPT) +#define SSL3_ST_SW_CERT_A (0x140|SSL_ST_ACCEPT) +#define SSL3_ST_SW_CERT_B (0x141|SSL_ST_ACCEPT) +#define SSL3_ST_SW_KEY_EXCH_A (0x150|SSL_ST_ACCEPT) +#define SSL3_ST_SW_KEY_EXCH_B (0x151|SSL_ST_ACCEPT) +#define SSL3_ST_SW_CERT_REQ_A (0x160|SSL_ST_ACCEPT) +#define SSL3_ST_SW_CERT_REQ_B (0x161|SSL_ST_ACCEPT) +#define SSL3_ST_SW_SRVR_DONE_A (0x170|SSL_ST_ACCEPT) +#define SSL3_ST_SW_SRVR_DONE_B (0x171|SSL_ST_ACCEPT) +/* read from client */ +#define SSL3_ST_SR_CERT_A (0x180|SSL_ST_ACCEPT) +#define SSL3_ST_SR_CERT_B (0x181|SSL_ST_ACCEPT) +#define SSL3_ST_SR_KEY_EXCH_A (0x190|SSL_ST_ACCEPT) +#define SSL3_ST_SR_KEY_EXCH_B (0x191|SSL_ST_ACCEPT) +#define SSL3_ST_SR_CERT_VRFY_A (0x1A0|SSL_ST_ACCEPT) +#define SSL3_ST_SR_CERT_VRFY_B (0x1A1|SSL_ST_ACCEPT) +#define SSL3_ST_SR_CHANGE_A (0x1B0|SSL_ST_ACCEPT) +#define SSL3_ST_SR_CHANGE_B (0x1B1|SSL_ST_ACCEPT) +#define SSL3_ST_SR_NEXT_PROTO_A (0x210|SSL_ST_ACCEPT) +#define SSL3_ST_SR_NEXT_PROTO_B (0x211|SSL_ST_ACCEPT) +#define SSL3_ST_SR_FINISHED_A (0x1C0|SSL_ST_ACCEPT) +#define SSL3_ST_SR_FINISHED_B (0x1C1|SSL_ST_ACCEPT) +/* write to client */ +#define SSL3_ST_SW_CHANGE_A (0x1D0|SSL_ST_ACCEPT) +#define SSL3_ST_SW_CHANGE_B (0x1D1|SSL_ST_ACCEPT) +#define SSL3_ST_SW_FINISHED_A (0x1E0|SSL_ST_ACCEPT) +#define SSL3_ST_SW_FINISHED_B (0x1E1|SSL_ST_ACCEPT) +#define SSL3_ST_SW_SESSION_TICKET_A (0x1F0|SSL_ST_ACCEPT) +#define SSL3_ST_SW_SESSION_TICKET_B (0x1F1|SSL_ST_ACCEPT) +#define SSL3_ST_SW_CERT_STATUS_A (0x200|SSL_ST_ACCEPT) +#define SSL3_ST_SW_CERT_STATUS_B (0x201|SSL_ST_ACCEPT) + +#define SSL3_MT_HELLO_REQUEST 0 +#define SSL3_MT_CLIENT_HELLO 1 +#define SSL3_MT_SERVER_HELLO 2 +#define SSL3_MT_NEWSESSION_TICKET 4 +#define SSL3_MT_CERTIFICATE 11 +#define SSL3_MT_SERVER_KEY_EXCHANGE 12 +#define SSL3_MT_CERTIFICATE_REQUEST 13 +#define SSL3_MT_SERVER_DONE 14 +#define SSL3_MT_CERTIFICATE_VERIFY 15 +#define SSL3_MT_CLIENT_KEY_EXCHANGE 16 +#define SSL3_MT_FINISHED 20 +#define SSL3_MT_CERTIFICATE_STATUS 22 +#define SSL3_MT_NEXT_PROTO 67 +#define DTLS1_MT_HELLO_VERIFY_REQUEST 3 + + +#define SSL3_MT_CCS 1 + +/* These are used when changing over to a new cipher */ +#define SSL3_CC_READ 0x01 +#define SSL3_CC_WRITE 0x02 +#define SSL3_CC_CLIENT 0x10 +#define SSL3_CC_SERVER 0x20 +#define SSL3_CHANGE_CIPHER_CLIENT_WRITE (SSL3_CC_CLIENT|SSL3_CC_WRITE) +#define SSL3_CHANGE_CIPHER_SERVER_READ (SSL3_CC_SERVER|SSL3_CC_READ) +#define SSL3_CHANGE_CIPHER_CLIENT_READ (SSL3_CC_CLIENT|SSL3_CC_READ) +#define SSL3_CHANGE_CIPHER_SERVER_WRITE (SSL3_CC_SERVER|SSL3_CC_WRITE) + +#ifdef __cplusplus +} +#endif +#endif + diff --git a/Source/Import/OpenSSL/Include/openssl/stack.h b/Source/Import/OpenSSL/Include/openssl/stack.h new file mode 100644 index 0000000..ce35e55 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/stack.h @@ -0,0 +1,108 @@ +/* crypto/stack/stack.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_STACK_H +#define HEADER_STACK_H + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct stack_st + { + int num; + char **data; + int sorted; + + int num_alloc; + int (*comp)(const void *, const void *); + } _STACK; /* Use STACK_OF(...) instead */ + +#define M_sk_num(sk) ((sk) ? (sk)->num:-1) +#define M_sk_value(sk,n) ((sk) ? (sk)->data[n] : NULL) + +int sk_num(const _STACK *); +void *sk_value(const _STACK *, int); + +void *sk_set(_STACK *, int, void *); + +_STACK *sk_new(int (*cmp)(const void *, const void *)); +_STACK *sk_new_null(void); +void sk_free(_STACK *); +void sk_pop_free(_STACK *st, void (*func)(void *)); +int sk_insert(_STACK *sk, void *data, int where); +void *sk_delete(_STACK *st, int loc); +void *sk_delete_ptr(_STACK *st, void *p); +int sk_find(_STACK *st, void *data); +int sk_find_ex(_STACK *st, void *data); +int sk_push(_STACK *st, void *data); +int sk_unshift(_STACK *st, void *data); +void *sk_shift(_STACK *st); +void *sk_pop(_STACK *st); +void sk_zero(_STACK *st); +int (*sk_set_cmp_func(_STACK *sk, int (*c)(const void *, const void *))) + (const void *, const void *); +_STACK *sk_dup(_STACK *st); +void sk_sort(_STACK *st); +int sk_is_sorted(const _STACK *st); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/symhacks.h b/Source/Import/OpenSSL/Include/openssl/symhacks.h new file mode 100644 index 0000000..403f592 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/symhacks.h @@ -0,0 +1,477 @@ +/* ==================================================================== + * Copyright (c) 1999 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_SYMHACKS_H +#define HEADER_SYMHACKS_H + +#include + +/* Hacks to solve the problem with linkers incapable of handling very long + symbol names. In the case of VMS, the limit is 31 characters on VMS for + VAX. */ +/* Note that this affects util/libeay.num and util/ssleay.num... you may + change those manually, but that's not recommended, as those files are + controlled centrally and updated on Unix, and the central definition + may disagree with yours, which in turn may come with shareable library + incompatibilities. */ +#ifdef OPENSSL_SYS_VMS + +/* Hack a long name in crypto/ex_data.c */ +#undef CRYPTO_get_ex_data_implementation +#define CRYPTO_get_ex_data_implementation CRYPTO_get_ex_data_impl +#undef CRYPTO_set_ex_data_implementation +#define CRYPTO_set_ex_data_implementation CRYPTO_set_ex_data_impl + +/* Hack a long name in crypto/asn1/a_mbstr.c */ +#undef ASN1_STRING_set_default_mask_asc +#define ASN1_STRING_set_default_mask_asc ASN1_STRING_set_def_mask_asc + +#if 0 /* No longer needed, since safestack macro magic does the job */ +/* Hack the names created with DECLARE_ASN1_SET_OF(PKCS7_SIGNER_INFO) */ +#undef i2d_ASN1_SET_OF_PKCS7_SIGNER_INFO +#define i2d_ASN1_SET_OF_PKCS7_SIGNER_INFO i2d_ASN1_SET_OF_PKCS7_SIGINF +#undef d2i_ASN1_SET_OF_PKCS7_SIGNER_INFO +#define d2i_ASN1_SET_OF_PKCS7_SIGNER_INFO d2i_ASN1_SET_OF_PKCS7_SIGINF +#endif + +#if 0 /* No longer needed, since safestack macro magic does the job */ +/* Hack the names created with DECLARE_ASN1_SET_OF(PKCS7_RECIP_INFO) */ +#undef i2d_ASN1_SET_OF_PKCS7_RECIP_INFO +#define i2d_ASN1_SET_OF_PKCS7_RECIP_INFO i2d_ASN1_SET_OF_PKCS7_RECINF +#undef d2i_ASN1_SET_OF_PKCS7_RECIP_INFO +#define d2i_ASN1_SET_OF_PKCS7_RECIP_INFO d2i_ASN1_SET_OF_PKCS7_RECINF +#endif + +#if 0 /* No longer needed, since safestack macro magic does the job */ +/* Hack the names created with DECLARE_ASN1_SET_OF(ACCESS_DESCRIPTION) */ +#undef i2d_ASN1_SET_OF_ACCESS_DESCRIPTION +#define i2d_ASN1_SET_OF_ACCESS_DESCRIPTION i2d_ASN1_SET_OF_ACC_DESC +#undef d2i_ASN1_SET_OF_ACCESS_DESCRIPTION +#define d2i_ASN1_SET_OF_ACCESS_DESCRIPTION d2i_ASN1_SET_OF_ACC_DESC +#endif + +/* Hack the names created with DECLARE_PEM_rw(NETSCAPE_CERT_SEQUENCE) */ +#undef PEM_read_NETSCAPE_CERT_SEQUENCE +#define PEM_read_NETSCAPE_CERT_SEQUENCE PEM_read_NS_CERT_SEQ +#undef PEM_write_NETSCAPE_CERT_SEQUENCE +#define PEM_write_NETSCAPE_CERT_SEQUENCE PEM_write_NS_CERT_SEQ +#undef PEM_read_bio_NETSCAPE_CERT_SEQUENCE +#define PEM_read_bio_NETSCAPE_CERT_SEQUENCE PEM_read_bio_NS_CERT_SEQ +#undef PEM_write_bio_NETSCAPE_CERT_SEQUENCE +#define PEM_write_bio_NETSCAPE_CERT_SEQUENCE PEM_write_bio_NS_CERT_SEQ +#undef PEM_write_cb_bio_NETSCAPE_CERT_SEQUENCE +#define PEM_write_cb_bio_NETSCAPE_CERT_SEQUENCE PEM_write_cb_bio_NS_CERT_SEQ + +/* Hack the names created with DECLARE_PEM_rw(PKCS8_PRIV_KEY_INFO) */ +#undef PEM_read_PKCS8_PRIV_KEY_INFO +#define PEM_read_PKCS8_PRIV_KEY_INFO PEM_read_P8_PRIV_KEY_INFO +#undef PEM_write_PKCS8_PRIV_KEY_INFO +#define PEM_write_PKCS8_PRIV_KEY_INFO PEM_write_P8_PRIV_KEY_INFO +#undef PEM_read_bio_PKCS8_PRIV_KEY_INFO +#define PEM_read_bio_PKCS8_PRIV_KEY_INFO PEM_read_bio_P8_PRIV_KEY_INFO +#undef PEM_write_bio_PKCS8_PRIV_KEY_INFO +#define PEM_write_bio_PKCS8_PRIV_KEY_INFO PEM_write_bio_P8_PRIV_KEY_INFO +#undef PEM_write_cb_bio_PKCS8_PRIV_KEY_INFO +#define PEM_write_cb_bio_PKCS8_PRIV_KEY_INFO PEM_wrt_cb_bio_P8_PRIV_KEY_INFO + +/* Hack other PEM names */ +#undef PEM_write_bio_PKCS8PrivateKey_nid +#define PEM_write_bio_PKCS8PrivateKey_nid PEM_write_bio_PKCS8PrivKey_nid + +/* Hack some long X509 names */ +#undef X509_REVOKED_get_ext_by_critical +#define X509_REVOKED_get_ext_by_critical X509_REVOKED_get_ext_by_critic +#undef X509_policy_tree_get0_user_policies +#define X509_policy_tree_get0_user_policies X509_pcy_tree_get0_usr_policies +#undef X509_policy_node_get0_qualifiers +#define X509_policy_node_get0_qualifiers X509_pcy_node_get0_qualifiers +#undef X509_STORE_CTX_get_explicit_policy +#define X509_STORE_CTX_get_explicit_policy X509_STORE_CTX_get_expl_policy +#undef X509_STORE_CTX_get0_current_issuer +#define X509_STORE_CTX_get0_current_issuer X509_STORE_CTX_get0_cur_issuer + +/* Hack some long CRYPTO names */ +#undef CRYPTO_set_dynlock_destroy_callback +#define CRYPTO_set_dynlock_destroy_callback CRYPTO_set_dynlock_destroy_cb +#undef CRYPTO_set_dynlock_create_callback +#define CRYPTO_set_dynlock_create_callback CRYPTO_set_dynlock_create_cb +#undef CRYPTO_set_dynlock_lock_callback +#define CRYPTO_set_dynlock_lock_callback CRYPTO_set_dynlock_lock_cb +#undef CRYPTO_get_dynlock_lock_callback +#define CRYPTO_get_dynlock_lock_callback CRYPTO_get_dynlock_lock_cb +#undef CRYPTO_get_dynlock_destroy_callback +#define CRYPTO_get_dynlock_destroy_callback CRYPTO_get_dynlock_destroy_cb +#undef CRYPTO_get_dynlock_create_callback +#define CRYPTO_get_dynlock_create_callback CRYPTO_get_dynlock_create_cb +#undef CRYPTO_set_locked_mem_ex_functions +#define CRYPTO_set_locked_mem_ex_functions CRYPTO_set_locked_mem_ex_funcs +#undef CRYPTO_get_locked_mem_ex_functions +#define CRYPTO_get_locked_mem_ex_functions CRYPTO_get_locked_mem_ex_funcs + +/* Hack some long SSL names */ +#undef SSL_CTX_set_default_verify_paths +#define SSL_CTX_set_default_verify_paths SSL_CTX_set_def_verify_paths +#undef SSL_get_ex_data_X509_STORE_CTX_idx +#define SSL_get_ex_data_X509_STORE_CTX_idx SSL_get_ex_d_X509_STORE_CTX_idx +#undef SSL_add_file_cert_subjects_to_stack +#define SSL_add_file_cert_subjects_to_stack SSL_add_file_cert_subjs_to_stk +#undef SSL_add_dir_cert_subjects_to_stack +#define SSL_add_dir_cert_subjects_to_stack SSL_add_dir_cert_subjs_to_stk +#undef SSL_CTX_use_certificate_chain_file +#define SSL_CTX_use_certificate_chain_file SSL_CTX_use_cert_chain_file +#undef SSL_CTX_set_cert_verify_callback +#define SSL_CTX_set_cert_verify_callback SSL_CTX_set_cert_verify_cb +#undef SSL_CTX_set_default_passwd_cb_userdata +#define SSL_CTX_set_default_passwd_cb_userdata SSL_CTX_set_def_passwd_cb_ud +#undef SSL_COMP_get_compression_methods +#define SSL_COMP_get_compression_methods SSL_COMP_get_compress_methods +#undef ssl_add_clienthello_renegotiate_ext +#define ssl_add_clienthello_renegotiate_ext ssl_add_clienthello_reneg_ext +#undef ssl_add_serverhello_renegotiate_ext +#define ssl_add_serverhello_renegotiate_ext ssl_add_serverhello_reneg_ext +#undef ssl_parse_clienthello_renegotiate_ext +#define ssl_parse_clienthello_renegotiate_ext ssl_parse_clienthello_reneg_ext +#undef ssl_parse_serverhello_renegotiate_ext +#define ssl_parse_serverhello_renegotiate_ext ssl_parse_serverhello_reneg_ext +#undef SSL_srp_server_param_with_username +#define SSL_srp_server_param_with_username SSL_srp_server_param_with_un +#undef SSL_CTX_set_srp_client_pwd_callback +#define SSL_CTX_set_srp_client_pwd_callback SSL_CTX_set_srp_client_pwd_cb +#undef SSL_CTX_set_srp_verify_param_callback +#define SSL_CTX_set_srp_verify_param_callback SSL_CTX_set_srp_vfy_param_cb +#undef SSL_CTX_set_srp_username_callback +#define SSL_CTX_set_srp_username_callback SSL_CTX_set_srp_un_cb +#undef ssl_add_clienthello_use_srtp_ext +#define ssl_add_clienthello_use_srtp_ext ssl_add_clihello_use_srtp_ext +#undef ssl_add_serverhello_use_srtp_ext +#define ssl_add_serverhello_use_srtp_ext ssl_add_serhello_use_srtp_ext +#undef ssl_parse_clienthello_use_srtp_ext +#define ssl_parse_clienthello_use_srtp_ext ssl_parse_clihello_use_srtp_ext +#undef ssl_parse_serverhello_use_srtp_ext +#define ssl_parse_serverhello_use_srtp_ext ssl_parse_serhello_use_srtp_ext +#undef SSL_CTX_set_next_protos_advertised_cb +#define SSL_CTX_set_next_protos_advertised_cb SSL_CTX_set_next_protos_adv_cb +#undef SSL_CTX_set_next_proto_select_cb +#define SSL_CTX_set_next_proto_select_cb SSL_CTX_set_next_proto_sel_cb + +/* Hack some long ENGINE names */ +#undef ENGINE_get_default_BN_mod_exp_crt +#define ENGINE_get_default_BN_mod_exp_crt ENGINE_get_def_BN_mod_exp_crt +#undef ENGINE_set_default_BN_mod_exp_crt +#define ENGINE_set_default_BN_mod_exp_crt ENGINE_set_def_BN_mod_exp_crt +#undef ENGINE_set_load_privkey_function +#define ENGINE_set_load_privkey_function ENGINE_set_load_privkey_fn +#undef ENGINE_get_load_privkey_function +#define ENGINE_get_load_privkey_function ENGINE_get_load_privkey_fn +#undef ENGINE_unregister_pkey_asn1_meths +#define ENGINE_unregister_pkey_asn1_meths ENGINE_unreg_pkey_asn1_meths +#undef ENGINE_register_all_pkey_asn1_meths +#define ENGINE_register_all_pkey_asn1_meths ENGINE_reg_all_pkey_asn1_meths +#undef ENGINE_set_default_pkey_asn1_meths +#define ENGINE_set_default_pkey_asn1_meths ENGINE_set_def_pkey_asn1_meths +#undef ENGINE_get_pkey_asn1_meth_engine +#define ENGINE_get_pkey_asn1_meth_engine ENGINE_get_pkey_asn1_meth_eng +#undef ENGINE_set_load_ssl_client_cert_function +#define ENGINE_set_load_ssl_client_cert_function \ + ENGINE_set_ld_ssl_clnt_cert_fn +#undef ENGINE_get_ssl_client_cert_function +#define ENGINE_get_ssl_client_cert_function ENGINE_get_ssl_client_cert_fn + +/* Hack some long OCSP names */ +#undef OCSP_REQUEST_get_ext_by_critical +#define OCSP_REQUEST_get_ext_by_critical OCSP_REQUEST_get_ext_by_crit +#undef OCSP_BASICRESP_get_ext_by_critical +#define OCSP_BASICRESP_get_ext_by_critical OCSP_BASICRESP_get_ext_by_crit +#undef OCSP_SINGLERESP_get_ext_by_critical +#define OCSP_SINGLERESP_get_ext_by_critical OCSP_SINGLERESP_get_ext_by_crit + +/* Hack some long DES names */ +#undef _ossl_old_des_ede3_cfb64_encrypt +#define _ossl_old_des_ede3_cfb64_encrypt _ossl_odes_ede3_cfb64_encrypt +#undef _ossl_old_des_ede3_ofb64_encrypt +#define _ossl_old_des_ede3_ofb64_encrypt _ossl_odes_ede3_ofb64_encrypt + +/* Hack some long EVP names */ +#undef OPENSSL_add_all_algorithms_noconf +#define OPENSSL_add_all_algorithms_noconf OPENSSL_add_all_algo_noconf +#undef OPENSSL_add_all_algorithms_conf +#define OPENSSL_add_all_algorithms_conf OPENSSL_add_all_algo_conf +#undef EVP_PKEY_meth_set_verify_recover +#define EVP_PKEY_meth_set_verify_recover EVP_PKEY_meth_set_vrfy_recover + +/* Hack some long EC names */ +#undef EC_GROUP_set_point_conversion_form +#define EC_GROUP_set_point_conversion_form EC_GROUP_set_point_conv_form +#undef EC_GROUP_get_point_conversion_form +#define EC_GROUP_get_point_conversion_form EC_GROUP_get_point_conv_form +#undef EC_GROUP_clear_free_all_extra_data +#define EC_GROUP_clear_free_all_extra_data EC_GROUP_clr_free_all_xtra_data +#undef EC_KEY_set_public_key_affine_coordinates +#define EC_KEY_set_public_key_affine_coordinates \ + EC_KEY_set_pub_key_aff_coords +#undef EC_POINT_set_Jprojective_coordinates_GFp +#define EC_POINT_set_Jprojective_coordinates_GFp \ + EC_POINT_set_Jproj_coords_GFp +#undef EC_POINT_get_Jprojective_coordinates_GFp +#define EC_POINT_get_Jprojective_coordinates_GFp \ + EC_POINT_get_Jproj_coords_GFp +#undef EC_POINT_set_affine_coordinates_GFp +#define EC_POINT_set_affine_coordinates_GFp EC_POINT_set_affine_coords_GFp +#undef EC_POINT_get_affine_coordinates_GFp +#define EC_POINT_get_affine_coordinates_GFp EC_POINT_get_affine_coords_GFp +#undef EC_POINT_set_compressed_coordinates_GFp +#define EC_POINT_set_compressed_coordinates_GFp EC_POINT_set_compr_coords_GFp +#undef EC_POINT_set_affine_coordinates_GF2m +#define EC_POINT_set_affine_coordinates_GF2m EC_POINT_set_affine_coords_GF2m +#undef EC_POINT_get_affine_coordinates_GF2m +#define EC_POINT_get_affine_coordinates_GF2m EC_POINT_get_affine_coords_GF2m +#undef EC_POINT_set_compressed_coordinates_GF2m +#define EC_POINT_set_compressed_coordinates_GF2m \ + EC_POINT_set_compr_coords_GF2m +#undef ec_GF2m_simple_group_clear_finish +#define ec_GF2m_simple_group_clear_finish ec_GF2m_simple_grp_clr_finish +#undef ec_GF2m_simple_group_check_discriminant +#define ec_GF2m_simple_group_check_discriminant ec_GF2m_simple_grp_chk_discrim +#undef ec_GF2m_simple_point_clear_finish +#define ec_GF2m_simple_point_clear_finish ec_GF2m_simple_pt_clr_finish +#undef ec_GF2m_simple_point_set_to_infinity +#define ec_GF2m_simple_point_set_to_infinity ec_GF2m_simple_pt_set_to_inf +#undef ec_GF2m_simple_points_make_affine +#define ec_GF2m_simple_points_make_affine ec_GF2m_simple_pts_make_affine +#undef ec_GF2m_simple_point_set_affine_coordinates +#define ec_GF2m_simple_point_set_affine_coordinates \ + ec_GF2m_smp_pt_set_af_coords +#undef ec_GF2m_simple_point_get_affine_coordinates +#define ec_GF2m_simple_point_get_affine_coordinates \ + ec_GF2m_smp_pt_get_af_coords +#undef ec_GF2m_simple_set_compressed_coordinates +#define ec_GF2m_simple_set_compressed_coordinates \ + ec_GF2m_smp_set_compr_coords +#undef ec_GFp_simple_group_set_curve_GFp +#define ec_GFp_simple_group_set_curve_GFp ec_GFp_simple_grp_set_curve_GFp +#undef ec_GFp_simple_group_get_curve_GFp +#define ec_GFp_simple_group_get_curve_GFp ec_GFp_simple_grp_get_curve_GFp +#undef ec_GFp_simple_group_clear_finish +#define ec_GFp_simple_group_clear_finish ec_GFp_simple_grp_clear_finish +#undef ec_GFp_simple_group_set_generator +#define ec_GFp_simple_group_set_generator ec_GFp_simple_grp_set_generator +#undef ec_GFp_simple_group_get0_generator +#define ec_GFp_simple_group_get0_generator ec_GFp_simple_grp_gt0_generator +#undef ec_GFp_simple_group_get_cofactor +#define ec_GFp_simple_group_get_cofactor ec_GFp_simple_grp_get_cofactor +#undef ec_GFp_simple_point_clear_finish +#define ec_GFp_simple_point_clear_finish ec_GFp_simple_pt_clear_finish +#undef ec_GFp_simple_point_set_to_infinity +#define ec_GFp_simple_point_set_to_infinity ec_GFp_simple_pt_set_to_inf +#undef ec_GFp_simple_points_make_affine +#define ec_GFp_simple_points_make_affine ec_GFp_simple_pts_make_affine +#undef ec_GFp_simple_group_get_curve_GFp +#define ec_GFp_simple_group_get_curve_GFp ec_GFp_simple_grp_get_curve_GFp +#undef ec_GFp_simple_set_Jprojective_coordinates_GFp +#define ec_GFp_simple_set_Jprojective_coordinates_GFp \ + ec_GFp_smp_set_Jproj_coords_GFp +#undef ec_GFp_simple_get_Jprojective_coordinates_GFp +#define ec_GFp_simple_get_Jprojective_coordinates_GFp \ + ec_GFp_smp_get_Jproj_coords_GFp +#undef ec_GFp_simple_point_set_affine_coordinates_GFp +#define ec_GFp_simple_point_set_affine_coordinates_GFp \ + ec_GFp_smp_pt_set_af_coords_GFp +#undef ec_GFp_simple_point_get_affine_coordinates_GFp +#define ec_GFp_simple_point_get_affine_coordinates_GFp \ + ec_GFp_smp_pt_get_af_coords_GFp +#undef ec_GFp_simple_set_compressed_coordinates_GFp +#define ec_GFp_simple_set_compressed_coordinates_GFp \ + ec_GFp_smp_set_compr_coords_GFp +#undef ec_GFp_simple_point_set_affine_coordinates +#define ec_GFp_simple_point_set_affine_coordinates \ + ec_GFp_smp_pt_set_af_coords +#undef ec_GFp_simple_point_get_affine_coordinates +#define ec_GFp_simple_point_get_affine_coordinates \ + ec_GFp_smp_pt_get_af_coords +#undef ec_GFp_simple_set_compressed_coordinates +#define ec_GFp_simple_set_compressed_coordinates \ + ec_GFp_smp_set_compr_coords +#undef ec_GFp_simple_group_check_discriminant +#define ec_GFp_simple_group_check_discriminant ec_GFp_simple_grp_chk_discrim + +/* Hack som long STORE names */ +#undef STORE_method_set_initialise_function +#define STORE_method_set_initialise_function STORE_meth_set_initialise_fn +#undef STORE_method_set_cleanup_function +#define STORE_method_set_cleanup_function STORE_meth_set_cleanup_fn +#undef STORE_method_set_generate_function +#define STORE_method_set_generate_function STORE_meth_set_generate_fn +#undef STORE_method_set_modify_function +#define STORE_method_set_modify_function STORE_meth_set_modify_fn +#undef STORE_method_set_revoke_function +#define STORE_method_set_revoke_function STORE_meth_set_revoke_fn +#undef STORE_method_set_delete_function +#define STORE_method_set_delete_function STORE_meth_set_delete_fn +#undef STORE_method_set_list_start_function +#define STORE_method_set_list_start_function STORE_meth_set_list_start_fn +#undef STORE_method_set_list_next_function +#define STORE_method_set_list_next_function STORE_meth_set_list_next_fn +#undef STORE_method_set_list_end_function +#define STORE_method_set_list_end_function STORE_meth_set_list_end_fn +#undef STORE_method_set_update_store_function +#define STORE_method_set_update_store_function STORE_meth_set_update_store_fn +#undef STORE_method_set_lock_store_function +#define STORE_method_set_lock_store_function STORE_meth_set_lock_store_fn +#undef STORE_method_set_unlock_store_function +#define STORE_method_set_unlock_store_function STORE_meth_set_unlock_store_fn +#undef STORE_method_get_initialise_function +#define STORE_method_get_initialise_function STORE_meth_get_initialise_fn +#undef STORE_method_get_cleanup_function +#define STORE_method_get_cleanup_function STORE_meth_get_cleanup_fn +#undef STORE_method_get_generate_function +#define STORE_method_get_generate_function STORE_meth_get_generate_fn +#undef STORE_method_get_modify_function +#define STORE_method_get_modify_function STORE_meth_get_modify_fn +#undef STORE_method_get_revoke_function +#define STORE_method_get_revoke_function STORE_meth_get_revoke_fn +#undef STORE_method_get_delete_function +#define STORE_method_get_delete_function STORE_meth_get_delete_fn +#undef STORE_method_get_list_start_function +#define STORE_method_get_list_start_function STORE_meth_get_list_start_fn +#undef STORE_method_get_list_next_function +#define STORE_method_get_list_next_function STORE_meth_get_list_next_fn +#undef STORE_method_get_list_end_function +#define STORE_method_get_list_end_function STORE_meth_get_list_end_fn +#undef STORE_method_get_update_store_function +#define STORE_method_get_update_store_function STORE_meth_get_update_store_fn +#undef STORE_method_get_lock_store_function +#define STORE_method_get_lock_store_function STORE_meth_get_lock_store_fn +#undef STORE_method_get_unlock_store_function +#define STORE_method_get_unlock_store_function STORE_meth_get_unlock_store_fn + +/* Hack some long TS names */ +#undef TS_RESP_CTX_set_status_info_cond +#define TS_RESP_CTX_set_status_info_cond TS_RESP_CTX_set_stat_info_cond +#undef TS_RESP_CTX_set_clock_precision_digits +#define TS_RESP_CTX_set_clock_precision_digits TS_RESP_CTX_set_clk_prec_digits +#undef TS_CONF_set_clock_precision_digits +#define TS_CONF_set_clock_precision_digits TS_CONF_set_clk_prec_digits + +/* Hack some long CMS names */ +#undef CMS_RecipientInfo_ktri_get0_algs +#define CMS_RecipientInfo_ktri_get0_algs CMS_RecipInfo_ktri_get0_algs +#undef CMS_RecipientInfo_ktri_get0_signer_id +#define CMS_RecipientInfo_ktri_get0_signer_id CMS_RecipInfo_ktri_get0_sigr_id +#undef CMS_OtherRevocationInfoFormat_it +#define CMS_OtherRevocationInfoFormat_it CMS_OtherRevocInfoFormat_it +#undef CMS_KeyAgreeRecipientIdentifier_it +#define CMS_KeyAgreeRecipientIdentifier_it CMS_KeyAgreeRecipIdentifier_it +#undef CMS_OriginatorIdentifierOrKey_it +#define CMS_OriginatorIdentifierOrKey_it CMS_OriginatorIdOrKey_it +#undef cms_SignerIdentifier_get0_signer_id +#define cms_SignerIdentifier_get0_signer_id cms_SignerId_get0_signer_id + +/* Hack some long DTLS1 names */ +#undef dtls1_retransmit_buffered_messages +#define dtls1_retransmit_buffered_messages dtls1_retransmit_buffered_msgs + +/* Hack some long SRP names */ +#undef SRP_generate_server_master_secret +#define SRP_generate_server_master_secret SRP_gen_server_master_secret +#undef SRP_generate_client_master_secret +#define SRP_generate_client_master_secret SRP_gen_client_master_secret + +/* Hack some long UI names */ +#undef UI_method_get_prompt_constructor +#define UI_method_get_prompt_constructor UI_method_get_prompt_constructr +#undef UI_method_set_prompt_constructor +#define UI_method_set_prompt_constructor UI_method_set_prompt_constructr + +#endif /* defined OPENSSL_SYS_VMS */ + + +/* Case insensitive linking causes problems.... */ +#if defined(OPENSSL_SYS_VMS) || defined(OPENSSL_SYS_OS2) +#undef ERR_load_CRYPTO_strings +#define ERR_load_CRYPTO_strings ERR_load_CRYPTOlib_strings +#undef OCSP_crlID_new +#define OCSP_crlID_new OCSP_crlID2_new + +#undef d2i_ECPARAMETERS +#define d2i_ECPARAMETERS d2i_UC_ECPARAMETERS +#undef i2d_ECPARAMETERS +#define i2d_ECPARAMETERS i2d_UC_ECPARAMETERS +#undef d2i_ECPKPARAMETERS +#define d2i_ECPKPARAMETERS d2i_UC_ECPKPARAMETERS +#undef i2d_ECPKPARAMETERS +#define i2d_ECPKPARAMETERS i2d_UC_ECPKPARAMETERS + +/* These functions do not seem to exist! However, I'm paranoid... + Original command in x509v3.h: + These functions are being redefined in another directory, + and clash when the linker is case-insensitive, so let's + hide them a little, by giving them an extra 'o' at the + beginning of the name... */ +#undef X509v3_cleanup_extensions +#define X509v3_cleanup_extensions oX509v3_cleanup_extensions +#undef X509v3_add_extension +#define X509v3_add_extension oX509v3_add_extension +#undef X509v3_add_netscape_extensions +#define X509v3_add_netscape_extensions oX509v3_add_netscape_extensions +#undef X509v3_add_standard_extensions +#define X509v3_add_standard_extensions oX509v3_add_standard_extensions + +/* This one clashes with CMS_data_create */ +#undef cms_Data_create +#define cms_Data_create priv_cms_Data_create + +#endif + + +#endif /* ! defined HEADER_VMS_IDHACKS_H */ diff --git a/Source/Import/OpenSSL/Include/openssl/tls1.h b/Source/Import/OpenSSL/Include/openssl/tls1.h new file mode 100644 index 0000000..c39c267 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/tls1.h @@ -0,0 +1,735 @@ +/* ssl/tls1.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ +/* ==================================================================== + * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +/* ==================================================================== + * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. + * + * Portions of the attached software ("Contribution") are developed by + * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project. + * + * The Contribution is licensed pursuant to the OpenSSL open source + * license provided above. + * + * ECC cipher suite support in OpenSSL originally written by + * Vipul Gupta and Sumit Gupta of Sun Microsystems Laboratories. + * + */ +/* ==================================================================== + * Copyright 2005 Nokia. All rights reserved. + * + * The portions of the attached software ("Contribution") is developed by + * Nokia Corporation and is licensed pursuant to the OpenSSL open source + * license. + * + * The Contribution, originally written by Mika Kousa and Pasi Eronen of + * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites + * support (see RFC 4279) to OpenSSL. + * + * No patent licenses or other rights except those expressly stated in + * the OpenSSL open source license shall be deemed granted or received + * expressly, by implication, estoppel, or otherwise. + * + * No assurances are provided by Nokia that the Contribution does not + * infringe the patent or other intellectual property rights of any third + * party or that the license provides you with all the necessary rights + * to make use of the Contribution. + * + * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN + * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA + * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY + * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR + * OTHERWISE. + */ + +#ifndef HEADER_TLS1_H +#define HEADER_TLS1_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#define TLS1_ALLOW_EXPERIMENTAL_CIPHERSUITES 0 + +#define TLS1_2_VERSION 0x0303 +#define TLS1_2_VERSION_MAJOR 0x03 +#define TLS1_2_VERSION_MINOR 0x03 + +#define TLS1_1_VERSION 0x0302 +#define TLS1_1_VERSION_MAJOR 0x03 +#define TLS1_1_VERSION_MINOR 0x02 + +#define TLS1_VERSION 0x0301 +#define TLS1_VERSION_MAJOR 0x03 +#define TLS1_VERSION_MINOR 0x01 + +#define TLS1_get_version(s) \ + ((s->version >> 8) == TLS1_VERSION_MAJOR ? s->version : 0) + +#define TLS1_get_client_version(s) \ + ((s->client_version >> 8) == TLS1_VERSION_MAJOR ? s->client_version : 0) + +#define TLS1_AD_DECRYPTION_FAILED 21 +#define TLS1_AD_RECORD_OVERFLOW 22 +#define TLS1_AD_UNKNOWN_CA 48 /* fatal */ +#define TLS1_AD_ACCESS_DENIED 49 /* fatal */ +#define TLS1_AD_DECODE_ERROR 50 /* fatal */ +#define TLS1_AD_DECRYPT_ERROR 51 +#define TLS1_AD_EXPORT_RESTRICTION 60 /* fatal */ +#define TLS1_AD_PROTOCOL_VERSION 70 /* fatal */ +#define TLS1_AD_INSUFFICIENT_SECURITY 71 /* fatal */ +#define TLS1_AD_INTERNAL_ERROR 80 /* fatal */ +#define TLS1_AD_USER_CANCELLED 90 +#define TLS1_AD_NO_RENEGOTIATION 100 +/* codes 110-114 are from RFC3546 */ +#define TLS1_AD_UNSUPPORTED_EXTENSION 110 +#define TLS1_AD_CERTIFICATE_UNOBTAINABLE 111 +#define TLS1_AD_UNRECOGNIZED_NAME 112 +#define TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE 113 +#define TLS1_AD_BAD_CERTIFICATE_HASH_VALUE 114 +#define TLS1_AD_UNKNOWN_PSK_IDENTITY 115 /* fatal */ + +/* ExtensionType values from RFC3546 / RFC4366 / RFC6066 */ +#define TLSEXT_TYPE_server_name 0 +#define TLSEXT_TYPE_max_fragment_length 1 +#define TLSEXT_TYPE_client_certificate_url 2 +#define TLSEXT_TYPE_trusted_ca_keys 3 +#define TLSEXT_TYPE_truncated_hmac 4 +#define TLSEXT_TYPE_status_request 5 +/* ExtensionType values from RFC4681 */ +#define TLSEXT_TYPE_user_mapping 6 + +/* ExtensionType values from RFC5878 */ +#define TLSEXT_TYPE_client_authz 7 +#define TLSEXT_TYPE_server_authz 8 + +/* ExtensionType values from RFC6091 */ +#define TLSEXT_TYPE_cert_type 9 + +/* ExtensionType values from RFC4492 */ +#define TLSEXT_TYPE_elliptic_curves 10 +#define TLSEXT_TYPE_ec_point_formats 11 + +/* ExtensionType value from RFC5054 */ +#define TLSEXT_TYPE_srp 12 + +/* ExtensionType values from RFC5246 */ +#define TLSEXT_TYPE_signature_algorithms 13 + +/* ExtensionType value from RFC5764 */ +#define TLSEXT_TYPE_use_srtp 14 + +/* ExtensionType value from RFC5620 */ +#define TLSEXT_TYPE_heartbeat 15 + +/* ExtensionType value from RFC4507 */ +#define TLSEXT_TYPE_session_ticket 35 + +/* ExtensionType value from draft-rescorla-tls-opaque-prf-input-00.txt */ +#if 0 /* will have to be provided externally for now , + * i.e. build with -DTLSEXT_TYPE_opaque_prf_input=38183 + * using whatever extension number you'd like to try */ +# define TLSEXT_TYPE_opaque_prf_input ?? */ +#endif + +/* Temporary extension type */ +#define TLSEXT_TYPE_renegotiate 0xff01 + +#ifndef OPENSSL_NO_NEXTPROTONEG +/* This is not an IANA defined extension number */ +#define TLSEXT_TYPE_next_proto_neg 13172 +#endif + +/* NameType value from RFC 3546 */ +#define TLSEXT_NAMETYPE_host_name 0 +/* status request value from RFC 3546 */ +#define TLSEXT_STATUSTYPE_ocsp 1 + +/* ECPointFormat values from draft-ietf-tls-ecc-12 */ +#define TLSEXT_ECPOINTFORMAT_first 0 +#define TLSEXT_ECPOINTFORMAT_uncompressed 0 +#define TLSEXT_ECPOINTFORMAT_ansiX962_compressed_prime 1 +#define TLSEXT_ECPOINTFORMAT_ansiX962_compressed_char2 2 +#define TLSEXT_ECPOINTFORMAT_last 2 + +/* Signature and hash algorithms from RFC 5246 */ + +#define TLSEXT_signature_anonymous 0 +#define TLSEXT_signature_rsa 1 +#define TLSEXT_signature_dsa 2 +#define TLSEXT_signature_ecdsa 3 + +#define TLSEXT_hash_none 0 +#define TLSEXT_hash_md5 1 +#define TLSEXT_hash_sha1 2 +#define TLSEXT_hash_sha224 3 +#define TLSEXT_hash_sha256 4 +#define TLSEXT_hash_sha384 5 +#define TLSEXT_hash_sha512 6 + +#ifndef OPENSSL_NO_TLSEXT + +#define TLSEXT_MAXLEN_host_name 255 + +const char *SSL_get_servername(const SSL *s, const int type); +int SSL_get_servername_type(const SSL *s); +/* SSL_export_keying_material exports a value derived from the master secret, + * as specified in RFC 5705. It writes |olen| bytes to |out| given a label and + * optional context. (Since a zero length context is allowed, the |use_context| + * flag controls whether a context is included.) + * + * It returns 1 on success and zero otherwise. + */ +int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen, + const char *label, size_t llen, const unsigned char *p, size_t plen, + int use_context); + +#define SSL_set_tlsext_host_name(s,name) \ +SSL_ctrl(s,SSL_CTRL_SET_TLSEXT_HOSTNAME,TLSEXT_NAMETYPE_host_name,(char *)name) + +#define SSL_set_tlsext_debug_callback(ssl, cb) \ +SSL_callback_ctrl(ssl,SSL_CTRL_SET_TLSEXT_DEBUG_CB,(void (*)(void))cb) + +#define SSL_set_tlsext_debug_arg(ssl, arg) \ +SSL_ctrl(ssl,SSL_CTRL_SET_TLSEXT_DEBUG_ARG,0, (void *)arg) + +#define SSL_set_tlsext_status_type(ssl, type) \ +SSL_ctrl(ssl,SSL_CTRL_SET_TLSEXT_STATUS_REQ_TYPE,type, NULL) + +#define SSL_get_tlsext_status_exts(ssl, arg) \ +SSL_ctrl(ssl,SSL_CTRL_GET_TLSEXT_STATUS_REQ_EXTS,0, (void *)arg) + +#define SSL_set_tlsext_status_exts(ssl, arg) \ +SSL_ctrl(ssl,SSL_CTRL_SET_TLSEXT_STATUS_REQ_EXTS,0, (void *)arg) + +#define SSL_get_tlsext_status_ids(ssl, arg) \ +SSL_ctrl(ssl,SSL_CTRL_GET_TLSEXT_STATUS_REQ_IDS,0, (void *)arg) + +#define SSL_set_tlsext_status_ids(ssl, arg) \ +SSL_ctrl(ssl,SSL_CTRL_SET_TLSEXT_STATUS_REQ_IDS,0, (void *)arg) + +#define SSL_get_tlsext_status_ocsp_resp(ssl, arg) \ +SSL_ctrl(ssl,SSL_CTRL_GET_TLSEXT_STATUS_REQ_OCSP_RESP,0, (void *)arg) + +#define SSL_set_tlsext_status_ocsp_resp(ssl, arg, arglen) \ +SSL_ctrl(ssl,SSL_CTRL_SET_TLSEXT_STATUS_REQ_OCSP_RESP,arglen, (void *)arg) + +#define SSL_CTX_set_tlsext_servername_callback(ctx, cb) \ +SSL_CTX_callback_ctrl(ctx,SSL_CTRL_SET_TLSEXT_SERVERNAME_CB,(void (*)(void))cb) + +#define SSL_TLSEXT_ERR_OK 0 +#define SSL_TLSEXT_ERR_ALERT_WARNING 1 +#define SSL_TLSEXT_ERR_ALERT_FATAL 2 +#define SSL_TLSEXT_ERR_NOACK 3 + +#define SSL_CTX_set_tlsext_servername_arg(ctx, arg) \ +SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG,0, (void *)arg) + +#define SSL_CTX_get_tlsext_ticket_keys(ctx, keys, keylen) \ + SSL_CTX_ctrl((ctx),SSL_CTRL_GET_TLSEXT_TICKET_KEYS,(keylen),(keys)) +#define SSL_CTX_set_tlsext_ticket_keys(ctx, keys, keylen) \ + SSL_CTX_ctrl((ctx),SSL_CTRL_SET_TLSEXT_TICKET_KEYS,(keylen),(keys)) + +#define SSL_CTX_set_tlsext_status_cb(ssl, cb) \ +SSL_CTX_callback_ctrl(ssl,SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB,(void (*)(void))cb) + +#define SSL_CTX_set_tlsext_status_arg(ssl, arg) \ +SSL_CTX_ctrl(ssl,SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB_ARG,0, (void *)arg) + +#define SSL_set_tlsext_opaque_prf_input(s, src, len) \ +SSL_ctrl(s,SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT, len, src) +#define SSL_CTX_set_tlsext_opaque_prf_input_callback(ctx, cb) \ +SSL_CTX_callback_ctrl(ctx,SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT_CB, (void (*)(void))cb) +#define SSL_CTX_set_tlsext_opaque_prf_input_callback_arg(ctx, arg) \ +SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT_CB_ARG, 0, arg) + +#define SSL_CTX_set_tlsext_ticket_key_cb(ssl, cb) \ +SSL_CTX_callback_ctrl(ssl,SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB,(void (*)(void))cb) + +#ifndef OPENSSL_NO_HEARTBEATS +#define SSL_TLSEXT_HB_ENABLED 0x01 +#define SSL_TLSEXT_HB_DONT_SEND_REQUESTS 0x02 +#define SSL_TLSEXT_HB_DONT_RECV_REQUESTS 0x04 + +#define SSL_get_tlsext_heartbeat_pending(ssl) \ + SSL_ctrl((ssl),SSL_CTRL_GET_TLS_EXT_HEARTBEAT_PENDING,0,NULL) +#define SSL_set_tlsext_heartbeat_no_requests(ssl, arg) \ + SSL_ctrl((ssl),SSL_CTRL_SET_TLS_EXT_HEARTBEAT_NO_REQUESTS,arg,NULL) +#endif +#endif + +/* PSK ciphersuites from 4279 */ +#define TLS1_CK_PSK_WITH_RC4_128_SHA 0x0300008A +#define TLS1_CK_PSK_WITH_3DES_EDE_CBC_SHA 0x0300008B +#define TLS1_CK_PSK_WITH_AES_128_CBC_SHA 0x0300008C +#define TLS1_CK_PSK_WITH_AES_256_CBC_SHA 0x0300008D + +/* Additional TLS ciphersuites from expired Internet Draft + * draft-ietf-tls-56-bit-ciphersuites-01.txt + * (available if TLS1_ALLOW_EXPERIMENTAL_CIPHERSUITES is defined, see + * s3_lib.c). We actually treat them like SSL 3.0 ciphers, which we probably + * shouldn't. Note that the first two are actually not in the IDs. */ +#define TLS1_CK_RSA_EXPORT1024_WITH_RC4_56_MD5 0x03000060 /* not in ID */ +#define TLS1_CK_RSA_EXPORT1024_WITH_RC2_CBC_56_MD5 0x03000061 /* not in ID */ +#define TLS1_CK_RSA_EXPORT1024_WITH_DES_CBC_SHA 0x03000062 +#define TLS1_CK_DHE_DSS_EXPORT1024_WITH_DES_CBC_SHA 0x03000063 +#define TLS1_CK_RSA_EXPORT1024_WITH_RC4_56_SHA 0x03000064 +#define TLS1_CK_DHE_DSS_EXPORT1024_WITH_RC4_56_SHA 0x03000065 +#define TLS1_CK_DHE_DSS_WITH_RC4_128_SHA 0x03000066 + +/* AES ciphersuites from RFC3268 */ + +#define TLS1_CK_RSA_WITH_AES_128_SHA 0x0300002F +#define TLS1_CK_DH_DSS_WITH_AES_128_SHA 0x03000030 +#define TLS1_CK_DH_RSA_WITH_AES_128_SHA 0x03000031 +#define TLS1_CK_DHE_DSS_WITH_AES_128_SHA 0x03000032 +#define TLS1_CK_DHE_RSA_WITH_AES_128_SHA 0x03000033 +#define TLS1_CK_ADH_WITH_AES_128_SHA 0x03000034 + +#define TLS1_CK_RSA_WITH_AES_256_SHA 0x03000035 +#define TLS1_CK_DH_DSS_WITH_AES_256_SHA 0x03000036 +#define TLS1_CK_DH_RSA_WITH_AES_256_SHA 0x03000037 +#define TLS1_CK_DHE_DSS_WITH_AES_256_SHA 0x03000038 +#define TLS1_CK_DHE_RSA_WITH_AES_256_SHA 0x03000039 +#define TLS1_CK_ADH_WITH_AES_256_SHA 0x0300003A + +/* TLS v1.2 ciphersuites */ +#define TLS1_CK_RSA_WITH_NULL_SHA256 0x0300003B +#define TLS1_CK_RSA_WITH_AES_128_SHA256 0x0300003C +#define TLS1_CK_RSA_WITH_AES_256_SHA256 0x0300003D +#define TLS1_CK_DH_DSS_WITH_AES_128_SHA256 0x0300003E +#define TLS1_CK_DH_RSA_WITH_AES_128_SHA256 0x0300003F +#define TLS1_CK_DHE_DSS_WITH_AES_128_SHA256 0x03000040 + +/* Camellia ciphersuites from RFC4132 */ +#define TLS1_CK_RSA_WITH_CAMELLIA_128_CBC_SHA 0x03000041 +#define TLS1_CK_DH_DSS_WITH_CAMELLIA_128_CBC_SHA 0x03000042 +#define TLS1_CK_DH_RSA_WITH_CAMELLIA_128_CBC_SHA 0x03000043 +#define TLS1_CK_DHE_DSS_WITH_CAMELLIA_128_CBC_SHA 0x03000044 +#define TLS1_CK_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA 0x03000045 +#define TLS1_CK_ADH_WITH_CAMELLIA_128_CBC_SHA 0x03000046 + +/* TLS v1.2 ciphersuites */ +#define TLS1_CK_DHE_RSA_WITH_AES_128_SHA256 0x03000067 +#define TLS1_CK_DH_DSS_WITH_AES_256_SHA256 0x03000068 +#define TLS1_CK_DH_RSA_WITH_AES_256_SHA256 0x03000069 +#define TLS1_CK_DHE_DSS_WITH_AES_256_SHA256 0x0300006A +#define TLS1_CK_DHE_RSA_WITH_AES_256_SHA256 0x0300006B +#define TLS1_CK_ADH_WITH_AES_128_SHA256 0x0300006C +#define TLS1_CK_ADH_WITH_AES_256_SHA256 0x0300006D + +/* Camellia ciphersuites from RFC4132 */ +#define TLS1_CK_RSA_WITH_CAMELLIA_256_CBC_SHA 0x03000084 +#define TLS1_CK_DH_DSS_WITH_CAMELLIA_256_CBC_SHA 0x03000085 +#define TLS1_CK_DH_RSA_WITH_CAMELLIA_256_CBC_SHA 0x03000086 +#define TLS1_CK_DHE_DSS_WITH_CAMELLIA_256_CBC_SHA 0x03000087 +#define TLS1_CK_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA 0x03000088 +#define TLS1_CK_ADH_WITH_CAMELLIA_256_CBC_SHA 0x03000089 + +/* SEED ciphersuites from RFC4162 */ +#define TLS1_CK_RSA_WITH_SEED_SHA 0x03000096 +#define TLS1_CK_DH_DSS_WITH_SEED_SHA 0x03000097 +#define TLS1_CK_DH_RSA_WITH_SEED_SHA 0x03000098 +#define TLS1_CK_DHE_DSS_WITH_SEED_SHA 0x03000099 +#define TLS1_CK_DHE_RSA_WITH_SEED_SHA 0x0300009A +#define TLS1_CK_ADH_WITH_SEED_SHA 0x0300009B + +/* TLS v1.2 GCM ciphersuites from RFC5288 */ +#define TLS1_CK_RSA_WITH_AES_128_GCM_SHA256 0x0300009C +#define TLS1_CK_RSA_WITH_AES_256_GCM_SHA384 0x0300009D +#define TLS1_CK_DHE_RSA_WITH_AES_128_GCM_SHA256 0x0300009E +#define TLS1_CK_DHE_RSA_WITH_AES_256_GCM_SHA384 0x0300009F +#define TLS1_CK_DH_RSA_WITH_AES_128_GCM_SHA256 0x030000A0 +#define TLS1_CK_DH_RSA_WITH_AES_256_GCM_SHA384 0x030000A1 +#define TLS1_CK_DHE_DSS_WITH_AES_128_GCM_SHA256 0x030000A2 +#define TLS1_CK_DHE_DSS_WITH_AES_256_GCM_SHA384 0x030000A3 +#define TLS1_CK_DH_DSS_WITH_AES_128_GCM_SHA256 0x030000A4 +#define TLS1_CK_DH_DSS_WITH_AES_256_GCM_SHA384 0x030000A5 +#define TLS1_CK_ADH_WITH_AES_128_GCM_SHA256 0x030000A6 +#define TLS1_CK_ADH_WITH_AES_256_GCM_SHA384 0x030000A7 + +/* ECC ciphersuites from draft-ietf-tls-ecc-12.txt with changes soon to be in draft 13 */ +#define TLS1_CK_ECDH_ECDSA_WITH_NULL_SHA 0x0300C001 +#define TLS1_CK_ECDH_ECDSA_WITH_RC4_128_SHA 0x0300C002 +#define TLS1_CK_ECDH_ECDSA_WITH_DES_192_CBC3_SHA 0x0300C003 +#define TLS1_CK_ECDH_ECDSA_WITH_AES_128_CBC_SHA 0x0300C004 +#define TLS1_CK_ECDH_ECDSA_WITH_AES_256_CBC_SHA 0x0300C005 + +#define TLS1_CK_ECDHE_ECDSA_WITH_NULL_SHA 0x0300C006 +#define TLS1_CK_ECDHE_ECDSA_WITH_RC4_128_SHA 0x0300C007 +#define TLS1_CK_ECDHE_ECDSA_WITH_DES_192_CBC3_SHA 0x0300C008 +#define TLS1_CK_ECDHE_ECDSA_WITH_AES_128_CBC_SHA 0x0300C009 +#define TLS1_CK_ECDHE_ECDSA_WITH_AES_256_CBC_SHA 0x0300C00A + +#define TLS1_CK_ECDH_RSA_WITH_NULL_SHA 0x0300C00B +#define TLS1_CK_ECDH_RSA_WITH_RC4_128_SHA 0x0300C00C +#define TLS1_CK_ECDH_RSA_WITH_DES_192_CBC3_SHA 0x0300C00D +#define TLS1_CK_ECDH_RSA_WITH_AES_128_CBC_SHA 0x0300C00E +#define TLS1_CK_ECDH_RSA_WITH_AES_256_CBC_SHA 0x0300C00F + +#define TLS1_CK_ECDHE_RSA_WITH_NULL_SHA 0x0300C010 +#define TLS1_CK_ECDHE_RSA_WITH_RC4_128_SHA 0x0300C011 +#define TLS1_CK_ECDHE_RSA_WITH_DES_192_CBC3_SHA 0x0300C012 +#define TLS1_CK_ECDHE_RSA_WITH_AES_128_CBC_SHA 0x0300C013 +#define TLS1_CK_ECDHE_RSA_WITH_AES_256_CBC_SHA 0x0300C014 + +#define TLS1_CK_ECDH_anon_WITH_NULL_SHA 0x0300C015 +#define TLS1_CK_ECDH_anon_WITH_RC4_128_SHA 0x0300C016 +#define TLS1_CK_ECDH_anon_WITH_DES_192_CBC3_SHA 0x0300C017 +#define TLS1_CK_ECDH_anon_WITH_AES_128_CBC_SHA 0x0300C018 +#define TLS1_CK_ECDH_anon_WITH_AES_256_CBC_SHA 0x0300C019 + +/* SRP ciphersuites from RFC 5054 */ +#define TLS1_CK_SRP_SHA_WITH_3DES_EDE_CBC_SHA 0x0300C01A +#define TLS1_CK_SRP_SHA_RSA_WITH_3DES_EDE_CBC_SHA 0x0300C01B +#define TLS1_CK_SRP_SHA_DSS_WITH_3DES_EDE_CBC_SHA 0x0300C01C +#define TLS1_CK_SRP_SHA_WITH_AES_128_CBC_SHA 0x0300C01D +#define TLS1_CK_SRP_SHA_RSA_WITH_AES_128_CBC_SHA 0x0300C01E +#define TLS1_CK_SRP_SHA_DSS_WITH_AES_128_CBC_SHA 0x0300C01F +#define TLS1_CK_SRP_SHA_WITH_AES_256_CBC_SHA 0x0300C020 +#define TLS1_CK_SRP_SHA_RSA_WITH_AES_256_CBC_SHA 0x0300C021 +#define TLS1_CK_SRP_SHA_DSS_WITH_AES_256_CBC_SHA 0x0300C022 + +/* ECDH HMAC based ciphersuites from RFC5289 */ + +#define TLS1_CK_ECDHE_ECDSA_WITH_AES_128_SHA256 0x0300C023 +#define TLS1_CK_ECDHE_ECDSA_WITH_AES_256_SHA384 0x0300C024 +#define TLS1_CK_ECDH_ECDSA_WITH_AES_128_SHA256 0x0300C025 +#define TLS1_CK_ECDH_ECDSA_WITH_AES_256_SHA384 0x0300C026 +#define TLS1_CK_ECDHE_RSA_WITH_AES_128_SHA256 0x0300C027 +#define TLS1_CK_ECDHE_RSA_WITH_AES_256_SHA384 0x0300C028 +#define TLS1_CK_ECDH_RSA_WITH_AES_128_SHA256 0x0300C029 +#define TLS1_CK_ECDH_RSA_WITH_AES_256_SHA384 0x0300C02A + +/* ECDH GCM based ciphersuites from RFC5289 */ +#define TLS1_CK_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 0x0300C02B +#define TLS1_CK_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 0x0300C02C +#define TLS1_CK_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 0x0300C02D +#define TLS1_CK_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 0x0300C02E +#define TLS1_CK_ECDHE_RSA_WITH_AES_128_GCM_SHA256 0x0300C02F +#define TLS1_CK_ECDHE_RSA_WITH_AES_256_GCM_SHA384 0x0300C030 +#define TLS1_CK_ECDH_RSA_WITH_AES_128_GCM_SHA256 0x0300C031 +#define TLS1_CK_ECDH_RSA_WITH_AES_256_GCM_SHA384 0x0300C032 + +/* XXX + * Inconsistency alert: + * The OpenSSL names of ciphers with ephemeral DH here include the string + * "DHE", while elsewhere it has always been "EDH". + * (The alias for the list of all such ciphers also is "EDH".) + * The specifications speak of "EDH"; maybe we should allow both forms + * for everything. */ +#define TLS1_TXT_RSA_EXPORT1024_WITH_RC4_56_MD5 "EXP1024-RC4-MD5" +#define TLS1_TXT_RSA_EXPORT1024_WITH_RC2_CBC_56_MD5 "EXP1024-RC2-CBC-MD5" +#define TLS1_TXT_RSA_EXPORT1024_WITH_DES_CBC_SHA "EXP1024-DES-CBC-SHA" +#define TLS1_TXT_DHE_DSS_EXPORT1024_WITH_DES_CBC_SHA "EXP1024-DHE-DSS-DES-CBC-SHA" +#define TLS1_TXT_RSA_EXPORT1024_WITH_RC4_56_SHA "EXP1024-RC4-SHA" +#define TLS1_TXT_DHE_DSS_EXPORT1024_WITH_RC4_56_SHA "EXP1024-DHE-DSS-RC4-SHA" +#define TLS1_TXT_DHE_DSS_WITH_RC4_128_SHA "DHE-DSS-RC4-SHA" + +/* AES ciphersuites from RFC3268 */ +#define TLS1_TXT_RSA_WITH_AES_128_SHA "AES128-SHA" +#define TLS1_TXT_DH_DSS_WITH_AES_128_SHA "DH-DSS-AES128-SHA" +#define TLS1_TXT_DH_RSA_WITH_AES_128_SHA "DH-RSA-AES128-SHA" +#define TLS1_TXT_DHE_DSS_WITH_AES_128_SHA "DHE-DSS-AES128-SHA" +#define TLS1_TXT_DHE_RSA_WITH_AES_128_SHA "DHE-RSA-AES128-SHA" +#define TLS1_TXT_ADH_WITH_AES_128_SHA "ADH-AES128-SHA" + +#define TLS1_TXT_RSA_WITH_AES_256_SHA "AES256-SHA" +#define TLS1_TXT_DH_DSS_WITH_AES_256_SHA "DH-DSS-AES256-SHA" +#define TLS1_TXT_DH_RSA_WITH_AES_256_SHA "DH-RSA-AES256-SHA" +#define TLS1_TXT_DHE_DSS_WITH_AES_256_SHA "DHE-DSS-AES256-SHA" +#define TLS1_TXT_DHE_RSA_WITH_AES_256_SHA "DHE-RSA-AES256-SHA" +#define TLS1_TXT_ADH_WITH_AES_256_SHA "ADH-AES256-SHA" + +/* ECC ciphersuites from draft-ietf-tls-ecc-01.txt (Mar 15, 2001) */ +#define TLS1_TXT_ECDH_ECDSA_WITH_NULL_SHA "ECDH-ECDSA-NULL-SHA" +#define TLS1_TXT_ECDH_ECDSA_WITH_RC4_128_SHA "ECDH-ECDSA-RC4-SHA" +#define TLS1_TXT_ECDH_ECDSA_WITH_DES_192_CBC3_SHA "ECDH-ECDSA-DES-CBC3-SHA" +#define TLS1_TXT_ECDH_ECDSA_WITH_AES_128_CBC_SHA "ECDH-ECDSA-AES128-SHA" +#define TLS1_TXT_ECDH_ECDSA_WITH_AES_256_CBC_SHA "ECDH-ECDSA-AES256-SHA" + +#define TLS1_TXT_ECDHE_ECDSA_WITH_NULL_SHA "ECDHE-ECDSA-NULL-SHA" +#define TLS1_TXT_ECDHE_ECDSA_WITH_RC4_128_SHA "ECDHE-ECDSA-RC4-SHA" +#define TLS1_TXT_ECDHE_ECDSA_WITH_DES_192_CBC3_SHA "ECDHE-ECDSA-DES-CBC3-SHA" +#define TLS1_TXT_ECDHE_ECDSA_WITH_AES_128_CBC_SHA "ECDHE-ECDSA-AES128-SHA" +#define TLS1_TXT_ECDHE_ECDSA_WITH_AES_256_CBC_SHA "ECDHE-ECDSA-AES256-SHA" + +#define TLS1_TXT_ECDH_RSA_WITH_NULL_SHA "ECDH-RSA-NULL-SHA" +#define TLS1_TXT_ECDH_RSA_WITH_RC4_128_SHA "ECDH-RSA-RC4-SHA" +#define TLS1_TXT_ECDH_RSA_WITH_DES_192_CBC3_SHA "ECDH-RSA-DES-CBC3-SHA" +#define TLS1_TXT_ECDH_RSA_WITH_AES_128_CBC_SHA "ECDH-RSA-AES128-SHA" +#define TLS1_TXT_ECDH_RSA_WITH_AES_256_CBC_SHA "ECDH-RSA-AES256-SHA" + +#define TLS1_TXT_ECDHE_RSA_WITH_NULL_SHA "ECDHE-RSA-NULL-SHA" +#define TLS1_TXT_ECDHE_RSA_WITH_RC4_128_SHA "ECDHE-RSA-RC4-SHA" +#define TLS1_TXT_ECDHE_RSA_WITH_DES_192_CBC3_SHA "ECDHE-RSA-DES-CBC3-SHA" +#define TLS1_TXT_ECDHE_RSA_WITH_AES_128_CBC_SHA "ECDHE-RSA-AES128-SHA" +#define TLS1_TXT_ECDHE_RSA_WITH_AES_256_CBC_SHA "ECDHE-RSA-AES256-SHA" + +#define TLS1_TXT_ECDH_anon_WITH_NULL_SHA "AECDH-NULL-SHA" +#define TLS1_TXT_ECDH_anon_WITH_RC4_128_SHA "AECDH-RC4-SHA" +#define TLS1_TXT_ECDH_anon_WITH_DES_192_CBC3_SHA "AECDH-DES-CBC3-SHA" +#define TLS1_TXT_ECDH_anon_WITH_AES_128_CBC_SHA "AECDH-AES128-SHA" +#define TLS1_TXT_ECDH_anon_WITH_AES_256_CBC_SHA "AECDH-AES256-SHA" + +/* PSK ciphersuites from RFC 4279 */ +#define TLS1_TXT_PSK_WITH_RC4_128_SHA "PSK-RC4-SHA" +#define TLS1_TXT_PSK_WITH_3DES_EDE_CBC_SHA "PSK-3DES-EDE-CBC-SHA" +#define TLS1_TXT_PSK_WITH_AES_128_CBC_SHA "PSK-AES128-CBC-SHA" +#define TLS1_TXT_PSK_WITH_AES_256_CBC_SHA "PSK-AES256-CBC-SHA" + +/* SRP ciphersuite from RFC 5054 */ +#define TLS1_TXT_SRP_SHA_WITH_3DES_EDE_CBC_SHA "SRP-3DES-EDE-CBC-SHA" +#define TLS1_TXT_SRP_SHA_RSA_WITH_3DES_EDE_CBC_SHA "SRP-RSA-3DES-EDE-CBC-SHA" +#define TLS1_TXT_SRP_SHA_DSS_WITH_3DES_EDE_CBC_SHA "SRP-DSS-3DES-EDE-CBC-SHA" +#define TLS1_TXT_SRP_SHA_WITH_AES_128_CBC_SHA "SRP-AES-128-CBC-SHA" +#define TLS1_TXT_SRP_SHA_RSA_WITH_AES_128_CBC_SHA "SRP-RSA-AES-128-CBC-SHA" +#define TLS1_TXT_SRP_SHA_DSS_WITH_AES_128_CBC_SHA "SRP-DSS-AES-128-CBC-SHA" +#define TLS1_TXT_SRP_SHA_WITH_AES_256_CBC_SHA "SRP-AES-256-CBC-SHA" +#define TLS1_TXT_SRP_SHA_RSA_WITH_AES_256_CBC_SHA "SRP-RSA-AES-256-CBC-SHA" +#define TLS1_TXT_SRP_SHA_DSS_WITH_AES_256_CBC_SHA "SRP-DSS-AES-256-CBC-SHA" + +/* Camellia ciphersuites from RFC4132 */ +#define TLS1_TXT_RSA_WITH_CAMELLIA_128_CBC_SHA "CAMELLIA128-SHA" +#define TLS1_TXT_DH_DSS_WITH_CAMELLIA_128_CBC_SHA "DH-DSS-CAMELLIA128-SHA" +#define TLS1_TXT_DH_RSA_WITH_CAMELLIA_128_CBC_SHA "DH-RSA-CAMELLIA128-SHA" +#define TLS1_TXT_DHE_DSS_WITH_CAMELLIA_128_CBC_SHA "DHE-DSS-CAMELLIA128-SHA" +#define TLS1_TXT_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA "DHE-RSA-CAMELLIA128-SHA" +#define TLS1_TXT_ADH_WITH_CAMELLIA_128_CBC_SHA "ADH-CAMELLIA128-SHA" + +#define TLS1_TXT_RSA_WITH_CAMELLIA_256_CBC_SHA "CAMELLIA256-SHA" +#define TLS1_TXT_DH_DSS_WITH_CAMELLIA_256_CBC_SHA "DH-DSS-CAMELLIA256-SHA" +#define TLS1_TXT_DH_RSA_WITH_CAMELLIA_256_CBC_SHA "DH-RSA-CAMELLIA256-SHA" +#define TLS1_TXT_DHE_DSS_WITH_CAMELLIA_256_CBC_SHA "DHE-DSS-CAMELLIA256-SHA" +#define TLS1_TXT_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA "DHE-RSA-CAMELLIA256-SHA" +#define TLS1_TXT_ADH_WITH_CAMELLIA_256_CBC_SHA "ADH-CAMELLIA256-SHA" + +/* SEED ciphersuites from RFC4162 */ +#define TLS1_TXT_RSA_WITH_SEED_SHA "SEED-SHA" +#define TLS1_TXT_DH_DSS_WITH_SEED_SHA "DH-DSS-SEED-SHA" +#define TLS1_TXT_DH_RSA_WITH_SEED_SHA "DH-RSA-SEED-SHA" +#define TLS1_TXT_DHE_DSS_WITH_SEED_SHA "DHE-DSS-SEED-SHA" +#define TLS1_TXT_DHE_RSA_WITH_SEED_SHA "DHE-RSA-SEED-SHA" +#define TLS1_TXT_ADH_WITH_SEED_SHA "ADH-SEED-SHA" + +/* TLS v1.2 ciphersuites */ +#define TLS1_TXT_RSA_WITH_NULL_SHA256 "NULL-SHA256" +#define TLS1_TXT_RSA_WITH_AES_128_SHA256 "AES128-SHA256" +#define TLS1_TXT_RSA_WITH_AES_256_SHA256 "AES256-SHA256" +#define TLS1_TXT_DH_DSS_WITH_AES_128_SHA256 "DH-DSS-AES128-SHA256" +#define TLS1_TXT_DH_RSA_WITH_AES_128_SHA256 "DH-RSA-AES128-SHA256" +#define TLS1_TXT_DHE_DSS_WITH_AES_128_SHA256 "DHE-DSS-AES128-SHA256" +#define TLS1_TXT_DHE_RSA_WITH_AES_128_SHA256 "DHE-RSA-AES128-SHA256" +#define TLS1_TXT_DH_DSS_WITH_AES_256_SHA256 "DH-DSS-AES256-SHA256" +#define TLS1_TXT_DH_RSA_WITH_AES_256_SHA256 "DH-RSA-AES256-SHA256" +#define TLS1_TXT_DHE_DSS_WITH_AES_256_SHA256 "DHE-DSS-AES256-SHA256" +#define TLS1_TXT_DHE_RSA_WITH_AES_256_SHA256 "DHE-RSA-AES256-SHA256" +#define TLS1_TXT_ADH_WITH_AES_128_SHA256 "ADH-AES128-SHA256" +#define TLS1_TXT_ADH_WITH_AES_256_SHA256 "ADH-AES256-SHA256" + +/* TLS v1.2 GCM ciphersuites from RFC5288 */ +#define TLS1_TXT_RSA_WITH_AES_128_GCM_SHA256 "AES128-GCM-SHA256" +#define TLS1_TXT_RSA_WITH_AES_256_GCM_SHA384 "AES256-GCM-SHA384" +#define TLS1_TXT_DHE_RSA_WITH_AES_128_GCM_SHA256 "DHE-RSA-AES128-GCM-SHA256" +#define TLS1_TXT_DHE_RSA_WITH_AES_256_GCM_SHA384 "DHE-RSA-AES256-GCM-SHA384" +#define TLS1_TXT_DH_RSA_WITH_AES_128_GCM_SHA256 "DH-RSA-AES128-GCM-SHA256" +#define TLS1_TXT_DH_RSA_WITH_AES_256_GCM_SHA384 "DH-RSA-AES256-GCM-SHA384" +#define TLS1_TXT_DHE_DSS_WITH_AES_128_GCM_SHA256 "DHE-DSS-AES128-GCM-SHA256" +#define TLS1_TXT_DHE_DSS_WITH_AES_256_GCM_SHA384 "DHE-DSS-AES256-GCM-SHA384" +#define TLS1_TXT_DH_DSS_WITH_AES_128_GCM_SHA256 "DH-DSS-AES128-GCM-SHA256" +#define TLS1_TXT_DH_DSS_WITH_AES_256_GCM_SHA384 "DH-DSS-AES256-GCM-SHA384" +#define TLS1_TXT_ADH_WITH_AES_128_GCM_SHA256 "ADH-AES128-GCM-SHA256" +#define TLS1_TXT_ADH_WITH_AES_256_GCM_SHA384 "ADH-AES256-GCM-SHA384" + +/* ECDH HMAC based ciphersuites from RFC5289 */ + +#define TLS1_TXT_ECDHE_ECDSA_WITH_AES_128_SHA256 "ECDHE-ECDSA-AES128-SHA256" +#define TLS1_TXT_ECDHE_ECDSA_WITH_AES_256_SHA384 "ECDHE-ECDSA-AES256-SHA384" +#define TLS1_TXT_ECDH_ECDSA_WITH_AES_128_SHA256 "ECDH-ECDSA-AES128-SHA256" +#define TLS1_TXT_ECDH_ECDSA_WITH_AES_256_SHA384 "ECDH-ECDSA-AES256-SHA384" +#define TLS1_TXT_ECDHE_RSA_WITH_AES_128_SHA256 "ECDHE-RSA-AES128-SHA256" +#define TLS1_TXT_ECDHE_RSA_WITH_AES_256_SHA384 "ECDHE-RSA-AES256-SHA384" +#define TLS1_TXT_ECDH_RSA_WITH_AES_128_SHA256 "ECDH-RSA-AES128-SHA256" +#define TLS1_TXT_ECDH_RSA_WITH_AES_256_SHA384 "ECDH-RSA-AES256-SHA384" + +/* ECDH GCM based ciphersuites from RFC5289 */ +#define TLS1_TXT_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 "ECDHE-ECDSA-AES128-GCM-SHA256" +#define TLS1_TXT_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 "ECDHE-ECDSA-AES256-GCM-SHA384" +#define TLS1_TXT_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 "ECDH-ECDSA-AES128-GCM-SHA256" +#define TLS1_TXT_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 "ECDH-ECDSA-AES256-GCM-SHA384" +#define TLS1_TXT_ECDHE_RSA_WITH_AES_128_GCM_SHA256 "ECDHE-RSA-AES128-GCM-SHA256" +#define TLS1_TXT_ECDHE_RSA_WITH_AES_256_GCM_SHA384 "ECDHE-RSA-AES256-GCM-SHA384" +#define TLS1_TXT_ECDH_RSA_WITH_AES_128_GCM_SHA256 "ECDH-RSA-AES128-GCM-SHA256" +#define TLS1_TXT_ECDH_RSA_WITH_AES_256_GCM_SHA384 "ECDH-RSA-AES256-GCM-SHA384" + +#define TLS_CT_RSA_SIGN 1 +#define TLS_CT_DSS_SIGN 2 +#define TLS_CT_RSA_FIXED_DH 3 +#define TLS_CT_DSS_FIXED_DH 4 +#define TLS_CT_ECDSA_SIGN 64 +#define TLS_CT_RSA_FIXED_ECDH 65 +#define TLS_CT_ECDSA_FIXED_ECDH 66 +#define TLS_CT_GOST94_SIGN 21 +#define TLS_CT_GOST01_SIGN 22 +/* when correcting this number, correct also SSL3_CT_NUMBER in ssl3.h (see + * comment there) */ +#define TLS_CT_NUMBER 9 + +#define TLS1_FINISH_MAC_LENGTH 12 + +#define TLS_MD_MAX_CONST_SIZE 20 +#define TLS_MD_CLIENT_FINISH_CONST "client finished" +#define TLS_MD_CLIENT_FINISH_CONST_SIZE 15 +#define TLS_MD_SERVER_FINISH_CONST "server finished" +#define TLS_MD_SERVER_FINISH_CONST_SIZE 15 +#define TLS_MD_SERVER_WRITE_KEY_CONST "server write key" +#define TLS_MD_SERVER_WRITE_KEY_CONST_SIZE 16 +#define TLS_MD_KEY_EXPANSION_CONST "key expansion" +#define TLS_MD_KEY_EXPANSION_CONST_SIZE 13 +#define TLS_MD_CLIENT_WRITE_KEY_CONST "client write key" +#define TLS_MD_CLIENT_WRITE_KEY_CONST_SIZE 16 +#define TLS_MD_SERVER_WRITE_KEY_CONST "server write key" +#define TLS_MD_SERVER_WRITE_KEY_CONST_SIZE 16 +#define TLS_MD_IV_BLOCK_CONST "IV block" +#define TLS_MD_IV_BLOCK_CONST_SIZE 8 +#define TLS_MD_MASTER_SECRET_CONST "master secret" +#define TLS_MD_MASTER_SECRET_CONST_SIZE 13 + +#ifdef CHARSET_EBCDIC +#undef TLS_MD_CLIENT_FINISH_CONST +#define TLS_MD_CLIENT_FINISH_CONST "\x63\x6c\x69\x65\x6e\x74\x20\x66\x69\x6e\x69\x73\x68\x65\x64" /*client finished*/ +#undef TLS_MD_SERVER_FINISH_CONST +#define TLS_MD_SERVER_FINISH_CONST "\x73\x65\x72\x76\x65\x72\x20\x66\x69\x6e\x69\x73\x68\x65\x64" /*server finished*/ +#undef TLS_MD_SERVER_WRITE_KEY_CONST +#define TLS_MD_SERVER_WRITE_KEY_CONST "\x73\x65\x72\x76\x65\x72\x20\x77\x72\x69\x74\x65\x20\x6b\x65\x79" /*server write key*/ +#undef TLS_MD_KEY_EXPANSION_CONST +#define TLS_MD_KEY_EXPANSION_CONST "\x6b\x65\x79\x20\x65\x78\x70\x61\x6e\x73\x69\x6f\x6e" /*key expansion*/ +#undef TLS_MD_CLIENT_WRITE_KEY_CONST +#define TLS_MD_CLIENT_WRITE_KEY_CONST "\x63\x6c\x69\x65\x6e\x74\x20\x77\x72\x69\x74\x65\x20\x6b\x65\x79" /*client write key*/ +#undef TLS_MD_SERVER_WRITE_KEY_CONST +#define TLS_MD_SERVER_WRITE_KEY_CONST "\x73\x65\x72\x76\x65\x72\x20\x77\x72\x69\x74\x65\x20\x6b\x65\x79" /*server write key*/ +#undef TLS_MD_IV_BLOCK_CONST +#define TLS_MD_IV_BLOCK_CONST "\x49\x56\x20\x62\x6c\x6f\x63\x6b" /*IV block*/ +#undef TLS_MD_MASTER_SECRET_CONST +#define TLS_MD_MASTER_SECRET_CONST "\x6d\x61\x73\x74\x65\x72\x20\x73\x65\x63\x72\x65\x74" /*master secret*/ +#endif + +/* TLS Session Ticket extension struct */ +struct tls_session_ticket_ext_st + { + unsigned short length; + void *data; + }; + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/ts.h b/Source/Import/OpenSSL/Include/openssl/ts.h new file mode 100644 index 0000000..c2448e3 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ts.h @@ -0,0 +1,858 @@ +/* crypto/ts/ts.h */ +/* Written by Zoltan Glozik (zglozik@opentsa.org) for the OpenSSL + * project 2002, 2003, 2004. + */ +/* ==================================================================== + * Copyright (c) 2006 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_TS_H +#define HEADER_TS_H + +#include +#include +#ifndef OPENSSL_NO_BUFFER +#include +#endif +#ifndef OPENSSL_NO_EVP +#include +#endif +#ifndef OPENSSL_NO_BIO +#include +#endif +#include +#include +#include + +#ifndef OPENSSL_NO_RSA +#include +#endif + +#ifndef OPENSSL_NO_DSA +#include +#endif + +#ifndef OPENSSL_NO_DH +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef WIN32 +/* Under Win32 this is defined in wincrypt.h */ +#undef X509_NAME +#endif + +#include +#include + +/* +MessageImprint ::= SEQUENCE { + hashAlgorithm AlgorithmIdentifier, + hashedMessage OCTET STRING } +*/ + +typedef struct TS_msg_imprint_st + { + X509_ALGOR *hash_algo; + ASN1_OCTET_STRING *hashed_msg; + } TS_MSG_IMPRINT; + +/* +TimeStampReq ::= SEQUENCE { + version INTEGER { v1(1) }, + messageImprint MessageImprint, + --a hash algorithm OID and the hash value of the data to be + --time-stamped + reqPolicy TSAPolicyId OPTIONAL, + nonce INTEGER OPTIONAL, + certReq BOOLEAN DEFAULT FALSE, + extensions [0] IMPLICIT Extensions OPTIONAL } +*/ + +typedef struct TS_req_st + { + ASN1_INTEGER *version; + TS_MSG_IMPRINT *msg_imprint; + ASN1_OBJECT *policy_id; /* OPTIONAL */ + ASN1_INTEGER *nonce; /* OPTIONAL */ + ASN1_BOOLEAN cert_req; /* DEFAULT FALSE */ + STACK_OF(X509_EXTENSION) *extensions; /* [0] OPTIONAL */ + } TS_REQ; + +/* +Accuracy ::= SEQUENCE { + seconds INTEGER OPTIONAL, + millis [0] INTEGER (1..999) OPTIONAL, + micros [1] INTEGER (1..999) OPTIONAL } +*/ + +typedef struct TS_accuracy_st + { + ASN1_INTEGER *seconds; + ASN1_INTEGER *millis; + ASN1_INTEGER *micros; + } TS_ACCURACY; + +/* +TSTInfo ::= SEQUENCE { + version INTEGER { v1(1) }, + policy TSAPolicyId, + messageImprint MessageImprint, + -- MUST have the same value as the similar field in + -- TimeStampReq + serialNumber INTEGER, + -- Time-Stamping users MUST be ready to accommodate integers + -- up to 160 bits. + genTime GeneralizedTime, + accuracy Accuracy OPTIONAL, + ordering BOOLEAN DEFAULT FALSE, + nonce INTEGER OPTIONAL, + -- MUST be present if the similar field was present + -- in TimeStampReq. In that case it MUST have the same value. + tsa [0] GeneralName OPTIONAL, + extensions [1] IMPLICIT Extensions OPTIONAL } +*/ + +typedef struct TS_tst_info_st + { + ASN1_INTEGER *version; + ASN1_OBJECT *policy_id; + TS_MSG_IMPRINT *msg_imprint; + ASN1_INTEGER *serial; + ASN1_GENERALIZEDTIME *time; + TS_ACCURACY *accuracy; + ASN1_BOOLEAN ordering; + ASN1_INTEGER *nonce; + GENERAL_NAME *tsa; + STACK_OF(X509_EXTENSION) *extensions; + } TS_TST_INFO; + +/* +PKIStatusInfo ::= SEQUENCE { + status PKIStatus, + statusString PKIFreeText OPTIONAL, + failInfo PKIFailureInfo OPTIONAL } + +From RFC 1510 - section 3.1.1: +PKIFreeText ::= SEQUENCE SIZE (1..MAX) OF UTF8String + -- text encoded as UTF-8 String (note: each UTF8String SHOULD + -- include an RFC 1766 language tag to indicate the language + -- of the contained text) +*/ + +/* Possible values for status. See ts_resp_print.c && ts_resp_verify.c. */ + +#define TS_STATUS_GRANTED 0 +#define TS_STATUS_GRANTED_WITH_MODS 1 +#define TS_STATUS_REJECTION 2 +#define TS_STATUS_WAITING 3 +#define TS_STATUS_REVOCATION_WARNING 4 +#define TS_STATUS_REVOCATION_NOTIFICATION 5 + +/* Possible values for failure_info. See ts_resp_print.c && ts_resp_verify.c */ + +#define TS_INFO_BAD_ALG 0 +#define TS_INFO_BAD_REQUEST 2 +#define TS_INFO_BAD_DATA_FORMAT 5 +#define TS_INFO_TIME_NOT_AVAILABLE 14 +#define TS_INFO_UNACCEPTED_POLICY 15 +#define TS_INFO_UNACCEPTED_EXTENSION 16 +#define TS_INFO_ADD_INFO_NOT_AVAILABLE 17 +#define TS_INFO_SYSTEM_FAILURE 25 + +typedef struct TS_status_info_st + { + ASN1_INTEGER *status; + STACK_OF(ASN1_UTF8STRING) *text; + ASN1_BIT_STRING *failure_info; + } TS_STATUS_INFO; + +DECLARE_STACK_OF(ASN1_UTF8STRING) +DECLARE_ASN1_SET_OF(ASN1_UTF8STRING) + +/* +TimeStampResp ::= SEQUENCE { + status PKIStatusInfo, + timeStampToken TimeStampToken OPTIONAL } +*/ + +typedef struct TS_resp_st + { + TS_STATUS_INFO *status_info; + PKCS7 *token; + TS_TST_INFO *tst_info; + } TS_RESP; + +/* The structure below would belong to the ESS component. */ + +/* +IssuerSerial ::= SEQUENCE { + issuer GeneralNames, + serialNumber CertificateSerialNumber + } +*/ + +typedef struct ESS_issuer_serial + { + STACK_OF(GENERAL_NAME) *issuer; + ASN1_INTEGER *serial; + } ESS_ISSUER_SERIAL; + +/* +ESSCertID ::= SEQUENCE { + certHash Hash, + issuerSerial IssuerSerial OPTIONAL +} +*/ + +typedef struct ESS_cert_id + { + ASN1_OCTET_STRING *hash; /* Always SHA-1 digest. */ + ESS_ISSUER_SERIAL *issuer_serial; + } ESS_CERT_ID; + +DECLARE_STACK_OF(ESS_CERT_ID) +DECLARE_ASN1_SET_OF(ESS_CERT_ID) + +/* +SigningCertificate ::= SEQUENCE { + certs SEQUENCE OF ESSCertID, + policies SEQUENCE OF PolicyInformation OPTIONAL +} +*/ + +typedef struct ESS_signing_cert + { + STACK_OF(ESS_CERT_ID) *cert_ids; + STACK_OF(POLICYINFO) *policy_info; + } ESS_SIGNING_CERT; + + +TS_REQ *TS_REQ_new(void); +void TS_REQ_free(TS_REQ *a); +int i2d_TS_REQ(const TS_REQ *a, unsigned char **pp); +TS_REQ *d2i_TS_REQ(TS_REQ **a, const unsigned char **pp, long length); + +TS_REQ *TS_REQ_dup(TS_REQ *a); + +TS_REQ *d2i_TS_REQ_fp(FILE *fp, TS_REQ **a); +int i2d_TS_REQ_fp(FILE *fp, TS_REQ *a); +TS_REQ *d2i_TS_REQ_bio(BIO *fp, TS_REQ **a); +int i2d_TS_REQ_bio(BIO *fp, TS_REQ *a); + +TS_MSG_IMPRINT *TS_MSG_IMPRINT_new(void); +void TS_MSG_IMPRINT_free(TS_MSG_IMPRINT *a); +int i2d_TS_MSG_IMPRINT(const TS_MSG_IMPRINT *a, unsigned char **pp); +TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT(TS_MSG_IMPRINT **a, + const unsigned char **pp, long length); + +TS_MSG_IMPRINT *TS_MSG_IMPRINT_dup(TS_MSG_IMPRINT *a); + +TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT **a); +int i2d_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT *a); +TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_bio(BIO *fp, TS_MSG_IMPRINT **a); +int i2d_TS_MSG_IMPRINT_bio(BIO *fp, TS_MSG_IMPRINT *a); + +TS_RESP *TS_RESP_new(void); +void TS_RESP_free(TS_RESP *a); +int i2d_TS_RESP(const TS_RESP *a, unsigned char **pp); +TS_RESP *d2i_TS_RESP(TS_RESP **a, const unsigned char **pp, long length); +TS_TST_INFO *PKCS7_to_TS_TST_INFO(PKCS7 *token); +TS_RESP *TS_RESP_dup(TS_RESP *a); + +TS_RESP *d2i_TS_RESP_fp(FILE *fp, TS_RESP **a); +int i2d_TS_RESP_fp(FILE *fp, TS_RESP *a); +TS_RESP *d2i_TS_RESP_bio(BIO *fp, TS_RESP **a); +int i2d_TS_RESP_bio(BIO *fp, TS_RESP *a); + +TS_STATUS_INFO *TS_STATUS_INFO_new(void); +void TS_STATUS_INFO_free(TS_STATUS_INFO *a); +int i2d_TS_STATUS_INFO(const TS_STATUS_INFO *a, unsigned char **pp); +TS_STATUS_INFO *d2i_TS_STATUS_INFO(TS_STATUS_INFO **a, + const unsigned char **pp, long length); +TS_STATUS_INFO *TS_STATUS_INFO_dup(TS_STATUS_INFO *a); + +TS_TST_INFO *TS_TST_INFO_new(void); +void TS_TST_INFO_free(TS_TST_INFO *a); +int i2d_TS_TST_INFO(const TS_TST_INFO *a, unsigned char **pp); +TS_TST_INFO *d2i_TS_TST_INFO(TS_TST_INFO **a, const unsigned char **pp, + long length); +TS_TST_INFO *TS_TST_INFO_dup(TS_TST_INFO *a); + +TS_TST_INFO *d2i_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO **a); +int i2d_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO *a); +TS_TST_INFO *d2i_TS_TST_INFO_bio(BIO *fp, TS_TST_INFO **a); +int i2d_TS_TST_INFO_bio(BIO *fp, TS_TST_INFO *a); + +TS_ACCURACY *TS_ACCURACY_new(void); +void TS_ACCURACY_free(TS_ACCURACY *a); +int i2d_TS_ACCURACY(const TS_ACCURACY *a, unsigned char **pp); +TS_ACCURACY *d2i_TS_ACCURACY(TS_ACCURACY **a, const unsigned char **pp, + long length); +TS_ACCURACY *TS_ACCURACY_dup(TS_ACCURACY *a); + +ESS_ISSUER_SERIAL *ESS_ISSUER_SERIAL_new(void); +void ESS_ISSUER_SERIAL_free(ESS_ISSUER_SERIAL *a); +int i2d_ESS_ISSUER_SERIAL(const ESS_ISSUER_SERIAL *a, + unsigned char **pp); +ESS_ISSUER_SERIAL *d2i_ESS_ISSUER_SERIAL(ESS_ISSUER_SERIAL **a, + const unsigned char **pp, long length); +ESS_ISSUER_SERIAL *ESS_ISSUER_SERIAL_dup(ESS_ISSUER_SERIAL *a); + +ESS_CERT_ID *ESS_CERT_ID_new(void); +void ESS_CERT_ID_free(ESS_CERT_ID *a); +int i2d_ESS_CERT_ID(const ESS_CERT_ID *a, unsigned char **pp); +ESS_CERT_ID *d2i_ESS_CERT_ID(ESS_CERT_ID **a, const unsigned char **pp, + long length); +ESS_CERT_ID *ESS_CERT_ID_dup(ESS_CERT_ID *a); + +ESS_SIGNING_CERT *ESS_SIGNING_CERT_new(void); +void ESS_SIGNING_CERT_free(ESS_SIGNING_CERT *a); +int i2d_ESS_SIGNING_CERT(const ESS_SIGNING_CERT *a, + unsigned char **pp); +ESS_SIGNING_CERT *d2i_ESS_SIGNING_CERT(ESS_SIGNING_CERT **a, + const unsigned char **pp, long length); +ESS_SIGNING_CERT *ESS_SIGNING_CERT_dup(ESS_SIGNING_CERT *a); + +void ERR_load_TS_strings(void); + +int TS_REQ_set_version(TS_REQ *a, long version); +long TS_REQ_get_version(const TS_REQ *a); + +int TS_REQ_set_msg_imprint(TS_REQ *a, TS_MSG_IMPRINT *msg_imprint); +TS_MSG_IMPRINT *TS_REQ_get_msg_imprint(TS_REQ *a); + +int TS_MSG_IMPRINT_set_algo(TS_MSG_IMPRINT *a, X509_ALGOR *alg); +X509_ALGOR *TS_MSG_IMPRINT_get_algo(TS_MSG_IMPRINT *a); + +int TS_MSG_IMPRINT_set_msg(TS_MSG_IMPRINT *a, unsigned char *d, int len); +ASN1_OCTET_STRING *TS_MSG_IMPRINT_get_msg(TS_MSG_IMPRINT *a); + +int TS_REQ_set_policy_id(TS_REQ *a, ASN1_OBJECT *policy); +ASN1_OBJECT *TS_REQ_get_policy_id(TS_REQ *a); + +int TS_REQ_set_nonce(TS_REQ *a, const ASN1_INTEGER *nonce); +const ASN1_INTEGER *TS_REQ_get_nonce(const TS_REQ *a); + +int TS_REQ_set_cert_req(TS_REQ *a, int cert_req); +int TS_REQ_get_cert_req(const TS_REQ *a); + +STACK_OF(X509_EXTENSION) *TS_REQ_get_exts(TS_REQ *a); +void TS_REQ_ext_free(TS_REQ *a); +int TS_REQ_get_ext_count(TS_REQ *a); +int TS_REQ_get_ext_by_NID(TS_REQ *a, int nid, int lastpos); +int TS_REQ_get_ext_by_OBJ(TS_REQ *a, ASN1_OBJECT *obj, int lastpos); +int TS_REQ_get_ext_by_critical(TS_REQ *a, int crit, int lastpos); +X509_EXTENSION *TS_REQ_get_ext(TS_REQ *a, int loc); +X509_EXTENSION *TS_REQ_delete_ext(TS_REQ *a, int loc); +int TS_REQ_add_ext(TS_REQ *a, X509_EXTENSION *ex, int loc); +void *TS_REQ_get_ext_d2i(TS_REQ *a, int nid, int *crit, int *idx); + +/* Function declarations for TS_REQ defined in ts/ts_req_print.c */ + +int TS_REQ_print_bio(BIO *bio, TS_REQ *a); + +/* Function declarations for TS_RESP defined in ts/ts_resp_utils.c */ + +int TS_RESP_set_status_info(TS_RESP *a, TS_STATUS_INFO *info); +TS_STATUS_INFO *TS_RESP_get_status_info(TS_RESP *a); + +/* Caller loses ownership of PKCS7 and TS_TST_INFO objects. */ +void TS_RESP_set_tst_info(TS_RESP *a, PKCS7 *p7, TS_TST_INFO *tst_info); +PKCS7 *TS_RESP_get_token(TS_RESP *a); +TS_TST_INFO *TS_RESP_get_tst_info(TS_RESP *a); + +int TS_TST_INFO_set_version(TS_TST_INFO *a, long version); +long TS_TST_INFO_get_version(const TS_TST_INFO *a); + +int TS_TST_INFO_set_policy_id(TS_TST_INFO *a, ASN1_OBJECT *policy_id); +ASN1_OBJECT *TS_TST_INFO_get_policy_id(TS_TST_INFO *a); + +int TS_TST_INFO_set_msg_imprint(TS_TST_INFO *a, TS_MSG_IMPRINT *msg_imprint); +TS_MSG_IMPRINT *TS_TST_INFO_get_msg_imprint(TS_TST_INFO *a); + +int TS_TST_INFO_set_serial(TS_TST_INFO *a, const ASN1_INTEGER *serial); +const ASN1_INTEGER *TS_TST_INFO_get_serial(const TS_TST_INFO *a); + +int TS_TST_INFO_set_time(TS_TST_INFO *a, const ASN1_GENERALIZEDTIME *gtime); +const ASN1_GENERALIZEDTIME *TS_TST_INFO_get_time(const TS_TST_INFO *a); + +int TS_TST_INFO_set_accuracy(TS_TST_INFO *a, TS_ACCURACY *accuracy); +TS_ACCURACY *TS_TST_INFO_get_accuracy(TS_TST_INFO *a); + +int TS_ACCURACY_set_seconds(TS_ACCURACY *a, const ASN1_INTEGER *seconds); +const ASN1_INTEGER *TS_ACCURACY_get_seconds(const TS_ACCURACY *a); + +int TS_ACCURACY_set_millis(TS_ACCURACY *a, const ASN1_INTEGER *millis); +const ASN1_INTEGER *TS_ACCURACY_get_millis(const TS_ACCURACY *a); + +int TS_ACCURACY_set_micros(TS_ACCURACY *a, const ASN1_INTEGER *micros); +const ASN1_INTEGER *TS_ACCURACY_get_micros(const TS_ACCURACY *a); + +int TS_TST_INFO_set_ordering(TS_TST_INFO *a, int ordering); +int TS_TST_INFO_get_ordering(const TS_TST_INFO *a); + +int TS_TST_INFO_set_nonce(TS_TST_INFO *a, const ASN1_INTEGER *nonce); +const ASN1_INTEGER *TS_TST_INFO_get_nonce(const TS_TST_INFO *a); + +int TS_TST_INFO_set_tsa(TS_TST_INFO *a, GENERAL_NAME *tsa); +GENERAL_NAME *TS_TST_INFO_get_tsa(TS_TST_INFO *a); + +STACK_OF(X509_EXTENSION) *TS_TST_INFO_get_exts(TS_TST_INFO *a); +void TS_TST_INFO_ext_free(TS_TST_INFO *a); +int TS_TST_INFO_get_ext_count(TS_TST_INFO *a); +int TS_TST_INFO_get_ext_by_NID(TS_TST_INFO *a, int nid, int lastpos); +int TS_TST_INFO_get_ext_by_OBJ(TS_TST_INFO *a, ASN1_OBJECT *obj, int lastpos); +int TS_TST_INFO_get_ext_by_critical(TS_TST_INFO *a, int crit, int lastpos); +X509_EXTENSION *TS_TST_INFO_get_ext(TS_TST_INFO *a, int loc); +X509_EXTENSION *TS_TST_INFO_delete_ext(TS_TST_INFO *a, int loc); +int TS_TST_INFO_add_ext(TS_TST_INFO *a, X509_EXTENSION *ex, int loc); +void *TS_TST_INFO_get_ext_d2i(TS_TST_INFO *a, int nid, int *crit, int *idx); + +/* Declarations related to response generation, defined in ts/ts_resp_sign.c. */ + +/* Optional flags for response generation. */ + +/* Don't include the TSA name in response. */ +#define TS_TSA_NAME 0x01 + +/* Set ordering to true in response. */ +#define TS_ORDERING 0x02 + +/* + * Include the signer certificate and the other specified certificates in + * the ESS signing certificate attribute beside the PKCS7 signed data. + * Only the signer certificates is included by default. + */ +#define TS_ESS_CERT_ID_CHAIN 0x04 + +/* Forward declaration. */ +struct TS_resp_ctx; + +/* This must return a unique number less than 160 bits long. */ +typedef ASN1_INTEGER *(*TS_serial_cb)(struct TS_resp_ctx *, void *); + +/* This must return the seconds and microseconds since Jan 1, 1970 in + the sec and usec variables allocated by the caller. + Return non-zero for success and zero for failure. */ +typedef int (*TS_time_cb)(struct TS_resp_ctx *, void *, long *sec, long *usec); + +/* This must process the given extension. + * It can modify the TS_TST_INFO object of the context. + * Return values: !0 (processed), 0 (error, it must set the + * status info/failure info of the response). + */ +typedef int (*TS_extension_cb)(struct TS_resp_ctx *, X509_EXTENSION *, void *); + +typedef struct TS_resp_ctx + { + X509 *signer_cert; + EVP_PKEY *signer_key; + STACK_OF(X509) *certs; /* Certs to include in signed data. */ + STACK_OF(ASN1_OBJECT) *policies; /* Acceptable policies. */ + ASN1_OBJECT *default_policy; /* It may appear in policies, too. */ + STACK_OF(EVP_MD) *mds; /* Acceptable message digests. */ + ASN1_INTEGER *seconds; /* accuracy, 0 means not specified. */ + ASN1_INTEGER *millis; /* accuracy, 0 means not specified. */ + ASN1_INTEGER *micros; /* accuracy, 0 means not specified. */ + unsigned clock_precision_digits; /* fraction of seconds in + time stamp token. */ + unsigned flags; /* Optional info, see values above. */ + + /* Callback functions. */ + TS_serial_cb serial_cb; + void *serial_cb_data; /* User data for serial_cb. */ + + TS_time_cb time_cb; + void *time_cb_data; /* User data for time_cb. */ + + TS_extension_cb extension_cb; + void *extension_cb_data; /* User data for extension_cb. */ + + /* These members are used only while creating the response. */ + TS_REQ *request; + TS_RESP *response; + TS_TST_INFO *tst_info; + } TS_RESP_CTX; + +DECLARE_STACK_OF(EVP_MD) +DECLARE_ASN1_SET_OF(EVP_MD) + +/* Creates a response context that can be used for generating responses. */ +TS_RESP_CTX *TS_RESP_CTX_new(void); +void TS_RESP_CTX_free(TS_RESP_CTX *ctx); + +/* This parameter must be set. */ +int TS_RESP_CTX_set_signer_cert(TS_RESP_CTX *ctx, X509 *signer); + +/* This parameter must be set. */ +int TS_RESP_CTX_set_signer_key(TS_RESP_CTX *ctx, EVP_PKEY *key); + +/* This parameter must be set. */ +int TS_RESP_CTX_set_def_policy(TS_RESP_CTX *ctx, ASN1_OBJECT *def_policy); + +/* No additional certs are included in the response by default. */ +int TS_RESP_CTX_set_certs(TS_RESP_CTX *ctx, STACK_OF(X509) *certs); + +/* Adds a new acceptable policy, only the default policy + is accepted by default. */ +int TS_RESP_CTX_add_policy(TS_RESP_CTX *ctx, ASN1_OBJECT *policy); + +/* Adds a new acceptable message digest. Note that no message digests + are accepted by default. The md argument is shared with the caller. */ +int TS_RESP_CTX_add_md(TS_RESP_CTX *ctx, const EVP_MD *md); + +/* Accuracy is not included by default. */ +int TS_RESP_CTX_set_accuracy(TS_RESP_CTX *ctx, + int secs, int millis, int micros); + +/* Clock precision digits, i.e. the number of decimal digits: + '0' means sec, '3' msec, '6' usec, and so on. Default is 0. */ +int TS_RESP_CTX_set_clock_precision_digits(TS_RESP_CTX *ctx, + unsigned clock_precision_digits); +/* At most we accept usec precision. */ +#define TS_MAX_CLOCK_PRECISION_DIGITS 6 + +/* No flags are set by default. */ +void TS_RESP_CTX_add_flags(TS_RESP_CTX *ctx, int flags); + +/* Default callback always returns a constant. */ +void TS_RESP_CTX_set_serial_cb(TS_RESP_CTX *ctx, TS_serial_cb cb, void *data); + +/* Default callback uses the gettimeofday() and gmtime() system calls. */ +void TS_RESP_CTX_set_time_cb(TS_RESP_CTX *ctx, TS_time_cb cb, void *data); + +/* Default callback rejects all extensions. The extension callback is called + * when the TS_TST_INFO object is already set up and not signed yet. */ +/* FIXME: extension handling is not tested yet. */ +void TS_RESP_CTX_set_extension_cb(TS_RESP_CTX *ctx, + TS_extension_cb cb, void *data); + +/* The following methods can be used in the callbacks. */ +int TS_RESP_CTX_set_status_info(TS_RESP_CTX *ctx, + int status, const char *text); + +/* Sets the status info only if it is still TS_STATUS_GRANTED. */ +int TS_RESP_CTX_set_status_info_cond(TS_RESP_CTX *ctx, + int status, const char *text); + +int TS_RESP_CTX_add_failure_info(TS_RESP_CTX *ctx, int failure); + +/* The get methods below can be used in the extension callback. */ +TS_REQ *TS_RESP_CTX_get_request(TS_RESP_CTX *ctx); + +TS_TST_INFO *TS_RESP_CTX_get_tst_info(TS_RESP_CTX *ctx); + +/* + * Creates the signed TS_TST_INFO and puts it in TS_RESP. + * In case of errors it sets the status info properly. + * Returns NULL only in case of memory allocation/fatal error. + */ +TS_RESP *TS_RESP_create_response(TS_RESP_CTX *ctx, BIO *req_bio); + +/* + * Declarations related to response verification, + * they are defined in ts/ts_resp_verify.c. + */ + +int TS_RESP_verify_signature(PKCS7 *token, STACK_OF(X509) *certs, + X509_STORE *store, X509 **signer_out); + +/* Context structure for the generic verify method. */ + +/* Verify the signer's certificate and the signature of the response. */ +#define TS_VFY_SIGNATURE (1u << 0) +/* Verify the version number of the response. */ +#define TS_VFY_VERSION (1u << 1) +/* Verify if the policy supplied by the user matches the policy of the TSA. */ +#define TS_VFY_POLICY (1u << 2) +/* Verify the message imprint provided by the user. This flag should not be + specified with TS_VFY_DATA. */ +#define TS_VFY_IMPRINT (1u << 3) +/* Verify the message imprint computed by the verify method from the user + provided data and the MD algorithm of the response. This flag should not be + specified with TS_VFY_IMPRINT. */ +#define TS_VFY_DATA (1u << 4) +/* Verify the nonce value. */ +#define TS_VFY_NONCE (1u << 5) +/* Verify if the TSA name field matches the signer certificate. */ +#define TS_VFY_SIGNER (1u << 6) +/* Verify if the TSA name field equals to the user provided name. */ +#define TS_VFY_TSA_NAME (1u << 7) + +/* You can use the following convenience constants. */ +#define TS_VFY_ALL_IMPRINT (TS_VFY_SIGNATURE \ + | TS_VFY_VERSION \ + | TS_VFY_POLICY \ + | TS_VFY_IMPRINT \ + | TS_VFY_NONCE \ + | TS_VFY_SIGNER \ + | TS_VFY_TSA_NAME) +#define TS_VFY_ALL_DATA (TS_VFY_SIGNATURE \ + | TS_VFY_VERSION \ + | TS_VFY_POLICY \ + | TS_VFY_DATA \ + | TS_VFY_NONCE \ + | TS_VFY_SIGNER \ + | TS_VFY_TSA_NAME) + +typedef struct TS_verify_ctx + { + /* Set this to the union of TS_VFY_... flags you want to carry out. */ + unsigned flags; + + /* Must be set only with TS_VFY_SIGNATURE. certs is optional. */ + X509_STORE *store; + STACK_OF(X509) *certs; + + /* Must be set only with TS_VFY_POLICY. */ + ASN1_OBJECT *policy; + + /* Must be set only with TS_VFY_IMPRINT. If md_alg is NULL, + the algorithm from the response is used. */ + X509_ALGOR *md_alg; + unsigned char *imprint; + unsigned imprint_len; + + /* Must be set only with TS_VFY_DATA. */ + BIO *data; + + /* Must be set only with TS_VFY_TSA_NAME. */ + ASN1_INTEGER *nonce; + + /* Must be set only with TS_VFY_TSA_NAME. */ + GENERAL_NAME *tsa_name; + } TS_VERIFY_CTX; + +int TS_RESP_verify_response(TS_VERIFY_CTX *ctx, TS_RESP *response); +int TS_RESP_verify_token(TS_VERIFY_CTX *ctx, PKCS7 *token); + +/* + * Declarations related to response verification context, + * they are defined in ts/ts_verify_ctx.c. + */ + +/* Set all fields to zero. */ +TS_VERIFY_CTX *TS_VERIFY_CTX_new(void); +void TS_VERIFY_CTX_init(TS_VERIFY_CTX *ctx); +void TS_VERIFY_CTX_free(TS_VERIFY_CTX *ctx); +void TS_VERIFY_CTX_cleanup(TS_VERIFY_CTX *ctx); + +/* + * If ctx is NULL, it allocates and returns a new object, otherwise + * it returns ctx. It initialises all the members as follows: + * flags = TS_VFY_ALL_IMPRINT & ~(TS_VFY_TSA_NAME | TS_VFY_SIGNATURE) + * certs = NULL + * store = NULL + * policy = policy from the request or NULL if absent (in this case + * TS_VFY_POLICY is cleared from flags as well) + * md_alg = MD algorithm from request + * imprint, imprint_len = imprint from request + * data = NULL + * nonce, nonce_len = nonce from the request or NULL if absent (in this case + * TS_VFY_NONCE is cleared from flags as well) + * tsa_name = NULL + * Important: after calling this method TS_VFY_SIGNATURE should be added! + */ +TS_VERIFY_CTX *TS_REQ_to_TS_VERIFY_CTX(TS_REQ *req, TS_VERIFY_CTX *ctx); + +/* Function declarations for TS_RESP defined in ts/ts_resp_print.c */ + +int TS_RESP_print_bio(BIO *bio, TS_RESP *a); +int TS_STATUS_INFO_print_bio(BIO *bio, TS_STATUS_INFO *a); +int TS_TST_INFO_print_bio(BIO *bio, TS_TST_INFO *a); + +/* Common utility functions defined in ts/ts_lib.c */ + +int TS_ASN1_INTEGER_print_bio(BIO *bio, const ASN1_INTEGER *num); +int TS_OBJ_print_bio(BIO *bio, const ASN1_OBJECT *obj); +int TS_ext_print_bio(BIO *bio, const STACK_OF(X509_EXTENSION) *extensions); +int TS_X509_ALGOR_print_bio(BIO *bio, const X509_ALGOR *alg); +int TS_MSG_IMPRINT_print_bio(BIO *bio, TS_MSG_IMPRINT *msg); + +/* Function declarations for handling configuration options, + defined in ts/ts_conf.c */ + +X509 *TS_CONF_load_cert(const char *file); +STACK_OF(X509) *TS_CONF_load_certs(const char *file); +EVP_PKEY *TS_CONF_load_key(const char *file, const char *pass); +const char *TS_CONF_get_tsa_section(CONF *conf, const char *section); +int TS_CONF_set_serial(CONF *conf, const char *section, TS_serial_cb cb, + TS_RESP_CTX *ctx); +int TS_CONF_set_crypto_device(CONF *conf, const char *section, + const char *device); +int TS_CONF_set_default_engine(const char *name); +int TS_CONF_set_signer_cert(CONF *conf, const char *section, + const char *cert, TS_RESP_CTX *ctx); +int TS_CONF_set_certs(CONF *conf, const char *section, const char *certs, + TS_RESP_CTX *ctx); +int TS_CONF_set_signer_key(CONF *conf, const char *section, + const char *key, const char *pass, TS_RESP_CTX *ctx); +int TS_CONF_set_def_policy(CONF *conf, const char *section, + const char *policy, TS_RESP_CTX *ctx); +int TS_CONF_set_policies(CONF *conf, const char *section, TS_RESP_CTX *ctx); +int TS_CONF_set_digests(CONF *conf, const char *section, TS_RESP_CTX *ctx); +int TS_CONF_set_accuracy(CONF *conf, const char *section, TS_RESP_CTX *ctx); +int TS_CONF_set_clock_precision_digits(CONF *conf, const char *section, + TS_RESP_CTX *ctx); +int TS_CONF_set_ordering(CONF *conf, const char *section, TS_RESP_CTX *ctx); +int TS_CONF_set_tsa_name(CONF *conf, const char *section, TS_RESP_CTX *ctx); +int TS_CONF_set_ess_cert_id_chain(CONF *conf, const char *section, + TS_RESP_CTX *ctx); + +/* -------------------------------------------------- */ +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_TS_strings(void); + +/* Error codes for the TS functions. */ + +/* Function codes. */ +#define TS_F_D2I_TS_RESP 147 +#define TS_F_DEF_SERIAL_CB 110 +#define TS_F_DEF_TIME_CB 111 +#define TS_F_ESS_ADD_SIGNING_CERT 112 +#define TS_F_ESS_CERT_ID_NEW_INIT 113 +#define TS_F_ESS_SIGNING_CERT_NEW_INIT 114 +#define TS_F_INT_TS_RESP_VERIFY_TOKEN 149 +#define TS_F_PKCS7_TO_TS_TST_INFO 148 +#define TS_F_TS_ACCURACY_SET_MICROS 115 +#define TS_F_TS_ACCURACY_SET_MILLIS 116 +#define TS_F_TS_ACCURACY_SET_SECONDS 117 +#define TS_F_TS_CHECK_IMPRINTS 100 +#define TS_F_TS_CHECK_NONCES 101 +#define TS_F_TS_CHECK_POLICY 102 +#define TS_F_TS_CHECK_SIGNING_CERTS 103 +#define TS_F_TS_CHECK_STATUS_INFO 104 +#define TS_F_TS_COMPUTE_IMPRINT 145 +#define TS_F_TS_CONF_SET_DEFAULT_ENGINE 146 +#define TS_F_TS_GET_STATUS_TEXT 105 +#define TS_F_TS_MSG_IMPRINT_SET_ALGO 118 +#define TS_F_TS_REQ_SET_MSG_IMPRINT 119 +#define TS_F_TS_REQ_SET_NONCE 120 +#define TS_F_TS_REQ_SET_POLICY_ID 121 +#define TS_F_TS_RESP_CREATE_RESPONSE 122 +#define TS_F_TS_RESP_CREATE_TST_INFO 123 +#define TS_F_TS_RESP_CTX_ADD_FAILURE_INFO 124 +#define TS_F_TS_RESP_CTX_ADD_MD 125 +#define TS_F_TS_RESP_CTX_ADD_POLICY 126 +#define TS_F_TS_RESP_CTX_NEW 127 +#define TS_F_TS_RESP_CTX_SET_ACCURACY 128 +#define TS_F_TS_RESP_CTX_SET_CERTS 129 +#define TS_F_TS_RESP_CTX_SET_DEF_POLICY 130 +#define TS_F_TS_RESP_CTX_SET_SIGNER_CERT 131 +#define TS_F_TS_RESP_CTX_SET_STATUS_INFO 132 +#define TS_F_TS_RESP_GET_POLICY 133 +#define TS_F_TS_RESP_SET_GENTIME_WITH_PRECISION 134 +#define TS_F_TS_RESP_SET_STATUS_INFO 135 +#define TS_F_TS_RESP_SET_TST_INFO 150 +#define TS_F_TS_RESP_SIGN 136 +#define TS_F_TS_RESP_VERIFY_SIGNATURE 106 +#define TS_F_TS_RESP_VERIFY_TOKEN 107 +#define TS_F_TS_TST_INFO_SET_ACCURACY 137 +#define TS_F_TS_TST_INFO_SET_MSG_IMPRINT 138 +#define TS_F_TS_TST_INFO_SET_NONCE 139 +#define TS_F_TS_TST_INFO_SET_POLICY_ID 140 +#define TS_F_TS_TST_INFO_SET_SERIAL 141 +#define TS_F_TS_TST_INFO_SET_TIME 142 +#define TS_F_TS_TST_INFO_SET_TSA 143 +#define TS_F_TS_VERIFY 108 +#define TS_F_TS_VERIFY_CERT 109 +#define TS_F_TS_VERIFY_CTX_NEW 144 + +/* Reason codes. */ +#define TS_R_BAD_PKCS7_TYPE 132 +#define TS_R_BAD_TYPE 133 +#define TS_R_CERTIFICATE_VERIFY_ERROR 100 +#define TS_R_COULD_NOT_SET_ENGINE 127 +#define TS_R_COULD_NOT_SET_TIME 115 +#define TS_R_D2I_TS_RESP_INT_FAILED 128 +#define TS_R_DETACHED_CONTENT 134 +#define TS_R_ESS_ADD_SIGNING_CERT_ERROR 116 +#define TS_R_ESS_SIGNING_CERTIFICATE_ERROR 101 +#define TS_R_INVALID_NULL_POINTER 102 +#define TS_R_INVALID_SIGNER_CERTIFICATE_PURPOSE 117 +#define TS_R_MESSAGE_IMPRINT_MISMATCH 103 +#define TS_R_NONCE_MISMATCH 104 +#define TS_R_NONCE_NOT_RETURNED 105 +#define TS_R_NO_CONTENT 106 +#define TS_R_NO_TIME_STAMP_TOKEN 107 +#define TS_R_PKCS7_ADD_SIGNATURE_ERROR 118 +#define TS_R_PKCS7_ADD_SIGNED_ATTR_ERROR 119 +#define TS_R_PKCS7_TO_TS_TST_INFO_FAILED 129 +#define TS_R_POLICY_MISMATCH 108 +#define TS_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 120 +#define TS_R_RESPONSE_SETUP_ERROR 121 +#define TS_R_SIGNATURE_FAILURE 109 +#define TS_R_THERE_MUST_BE_ONE_SIGNER 110 +#define TS_R_TIME_SYSCALL_ERROR 122 +#define TS_R_TOKEN_NOT_PRESENT 130 +#define TS_R_TOKEN_PRESENT 131 +#define TS_R_TSA_NAME_MISMATCH 111 +#define TS_R_TSA_UNTRUSTED 112 +#define TS_R_TST_INFO_SETUP_ERROR 123 +#define TS_R_TS_DATASIGN 124 +#define TS_R_UNACCEPTABLE_POLICY 125 +#define TS_R_UNSUPPORTED_MD_ALGORITHM 126 +#define TS_R_UNSUPPORTED_VERSION 113 +#define TS_R_WRONG_CONTENT_TYPE 114 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/txt_db.h b/Source/Import/OpenSSL/Include/openssl/txt_db.h new file mode 100644 index 0000000..6abe435 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/txt_db.h @@ -0,0 +1,112 @@ +/* crypto/txt_db/txt_db.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_TXT_DB_H +#define HEADER_TXT_DB_H + +#include +#ifndef OPENSSL_NO_BIO +#include +#endif +#include +#include + +#define DB_ERROR_OK 0 +#define DB_ERROR_MALLOC 1 +#define DB_ERROR_INDEX_CLASH 2 +#define DB_ERROR_INDEX_OUT_OF_RANGE 3 +#define DB_ERROR_NO_INDEX 4 +#define DB_ERROR_INSERT_INDEX_CLASH 5 + +#ifdef __cplusplus +extern "C" { +#endif + +typedef OPENSSL_STRING *OPENSSL_PSTRING; +DECLARE_SPECIAL_STACK_OF(OPENSSL_PSTRING, OPENSSL_STRING) + +typedef struct txt_db_st + { + int num_fields; + STACK_OF(OPENSSL_PSTRING) *data; + LHASH_OF(OPENSSL_STRING) **index; + int (**qual)(OPENSSL_STRING *); + long error; + long arg1; + long arg2; + OPENSSL_STRING *arg_row; + } TXT_DB; + +#ifndef OPENSSL_NO_BIO +TXT_DB *TXT_DB_read(BIO *in, int num); +long TXT_DB_write(BIO *out, TXT_DB *db); +#else +TXT_DB *TXT_DB_read(char *in, int num); +long TXT_DB_write(char *out, TXT_DB *db); +#endif +int TXT_DB_create_index(TXT_DB *db,int field,int (*qual)(OPENSSL_STRING *), + LHASH_HASH_FN_TYPE hash, LHASH_COMP_FN_TYPE cmp); +void TXT_DB_free(TXT_DB *db); +OPENSSL_STRING *TXT_DB_get_by_index(TXT_DB *db, int idx, OPENSSL_STRING *value); +int TXT_DB_insert(TXT_DB *db, OPENSSL_STRING *value); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/ui.h b/Source/Import/OpenSSL/Include/openssl/ui.h new file mode 100644 index 0000000..bd78aa4 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ui.h @@ -0,0 +1,383 @@ +/* crypto/ui/ui.h -*- mode:C; c-file-style: "eay" -*- */ +/* Written by Richard Levitte (richard@levitte.org) for the OpenSSL + * project 2001. + */ +/* ==================================================================== + * Copyright (c) 2001 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_UI_H +#define HEADER_UI_H + +#ifndef OPENSSL_NO_DEPRECATED +#include +#endif +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Declared already in ossl_typ.h */ +/* typedef struct ui_st UI; */ +/* typedef struct ui_method_st UI_METHOD; */ + + +/* All the following functions return -1 or NULL on error and in some cases + (UI_process()) -2 if interrupted or in some other way cancelled. + When everything is fine, they return 0, a positive value or a non-NULL + pointer, all depending on their purpose. */ + +/* Creators and destructor. */ +UI *UI_new(void); +UI *UI_new_method(const UI_METHOD *method); +void UI_free(UI *ui); + +/* The following functions are used to add strings to be printed and prompt + strings to prompt for data. The names are UI_{add,dup}__string + and UI_{add,dup}_input_boolean. + + UI_{add,dup}__string have the following meanings: + add add a text or prompt string. The pointers given to these + functions are used verbatim, no copying is done. + dup make a copy of the text or prompt string, then add the copy + to the collection of strings in the user interface. + + The function is a name for the functionality that the given + string shall be used for. It can be one of: + input use the string as data prompt. + verify use the string as verification prompt. This + is used to verify a previous input. + info use the string for informational output. + error use the string for error output. + Honestly, there's currently no difference between info and error for the + moment. + + UI_{add,dup}_input_boolean have the same semantics for "add" and "dup", + and are typically used when one wants to prompt for a yes/no response. + + + All of the functions in this group take a UI and a prompt string. + The string input and verify addition functions also take a flag argument, + a buffer for the result to end up with, a minimum input size and a maximum + input size (the result buffer MUST be large enough to be able to contain + the maximum number of characters). Additionally, the verify addition + functions takes another buffer to compare the result against. + The boolean input functions take an action description string (which should + be safe to ignore if the expected user action is obvious, for example with + a dialog box with an OK button and a Cancel button), a string of acceptable + characters to mean OK and to mean Cancel. The two last strings are checked + to make sure they don't have common characters. Additionally, the same + flag argument as for the string input is taken, as well as a result buffer. + The result buffer is required to be at least one byte long. Depending on + the answer, the first character from the OK or the Cancel character strings + will be stored in the first byte of the result buffer. No NUL will be + added, so the result is *not* a string. + + On success, the all return an index of the added information. That index + is usefull when retrieving results with UI_get0_result(). */ +int UI_add_input_string(UI *ui, const char *prompt, int flags, + char *result_buf, int minsize, int maxsize); +int UI_dup_input_string(UI *ui, const char *prompt, int flags, + char *result_buf, int minsize, int maxsize); +int UI_add_verify_string(UI *ui, const char *prompt, int flags, + char *result_buf, int minsize, int maxsize, const char *test_buf); +int UI_dup_verify_string(UI *ui, const char *prompt, int flags, + char *result_buf, int minsize, int maxsize, const char *test_buf); +int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc, + const char *ok_chars, const char *cancel_chars, + int flags, char *result_buf); +int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc, + const char *ok_chars, const char *cancel_chars, + int flags, char *result_buf); +int UI_add_info_string(UI *ui, const char *text); +int UI_dup_info_string(UI *ui, const char *text); +int UI_add_error_string(UI *ui, const char *text); +int UI_dup_error_string(UI *ui, const char *text); + +/* These are the possible flags. They can be or'ed together. */ +/* Use to have echoing of input */ +#define UI_INPUT_FLAG_ECHO 0x01 +/* Use a default password. Where that password is found is completely + up to the application, it might for example be in the user data set + with UI_add_user_data(). It is not recommended to have more than + one input in each UI being marked with this flag, or the application + might get confused. */ +#define UI_INPUT_FLAG_DEFAULT_PWD 0x02 + +/* The user of these routines may want to define flags of their own. The core + UI won't look at those, but will pass them on to the method routines. They + must use higher bits so they don't get confused with the UI bits above. + UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use. A good + example of use is this: + + #define MY_UI_FLAG1 (0x01 << UI_INPUT_FLAG_USER_BASE) + +*/ +#define UI_INPUT_FLAG_USER_BASE 16 + + +/* The following function helps construct a prompt. object_desc is a + textual short description of the object, for example "pass phrase", + and object_name is the name of the object (might be a card name or + a file name. + The returned string shall always be allocated on the heap with + OPENSSL_malloc(), and need to be free'd with OPENSSL_free(). + + If the ui_method doesn't contain a pointer to a user-defined prompt + constructor, a default string is built, looking like this: + + "Enter {object_desc} for {object_name}:" + + So, if object_desc has the value "pass phrase" and object_name has + the value "foo.key", the resulting string is: + + "Enter pass phrase for foo.key:" +*/ +char *UI_construct_prompt(UI *ui_method, + const char *object_desc, const char *object_name); + + +/* The following function is used to store a pointer to user-specific data. + Any previous such pointer will be returned and replaced. + + For callback purposes, this function makes a lot more sense than using + ex_data, since the latter requires that different parts of OpenSSL or + applications share the same ex_data index. + + Note that the UI_OpenSSL() method completely ignores the user data. + Other methods may not, however. */ +void *UI_add_user_data(UI *ui, void *user_data); +/* We need a user data retrieving function as well. */ +void *UI_get0_user_data(UI *ui); + +/* Return the result associated with a prompt given with the index i. */ +const char *UI_get0_result(UI *ui, int i); + +/* When all strings have been added, process the whole thing. */ +int UI_process(UI *ui); + +/* Give a user interface parametrised control commands. This can be used to + send down an integer, a data pointer or a function pointer, as well as + be used to get information from a UI. */ +int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)(void)); + +/* The commands */ +/* Use UI_CONTROL_PRINT_ERRORS with the value 1 to have UI_process print the + OpenSSL error stack before printing any info or added error messages and + before any prompting. */ +#define UI_CTRL_PRINT_ERRORS 1 +/* Check if a UI_process() is possible to do again with the same instance of + a user interface. This makes UI_ctrl() return 1 if it is redoable, and 0 + if not. */ +#define UI_CTRL_IS_REDOABLE 2 + + +/* Some methods may use extra data */ +#define UI_set_app_data(s,arg) UI_set_ex_data(s,0,arg) +#define UI_get_app_data(s) UI_get_ex_data(s,0) +int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); +int UI_set_ex_data(UI *r,int idx,void *arg); +void *UI_get_ex_data(UI *r, int idx); + +/* Use specific methods instead of the built-in one */ +void UI_set_default_method(const UI_METHOD *meth); +const UI_METHOD *UI_get_default_method(void); +const UI_METHOD *UI_get_method(UI *ui); +const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth); + +/* The method with all the built-in thingies */ +UI_METHOD *UI_OpenSSL(void); + + +/* ---------- For method writers ---------- */ +/* A method contains a number of functions that implement the low level + of the User Interface. The functions are: + + an opener This function starts a session, maybe by opening + a channel to a tty, or by opening a window. + a writer This function is called to write a given string, + maybe to the tty, maybe as a field label in a + window. + a flusher This function is called to flush everything that + has been output so far. It can be used to actually + display a dialog box after it has been built. + a reader This function is called to read a given prompt, + maybe from the tty, maybe from a field in a + window. Note that it's called wth all string + structures, not only the prompt ones, so it must + check such things itself. + a closer This function closes the session, maybe by closing + the channel to the tty, or closing the window. + + All these functions are expected to return: + + 0 on error. + 1 on success. + -1 on out-of-band events, for example if some prompting has + been canceled (by pressing Ctrl-C, for example). This is + only checked when returned by the flusher or the reader. + + The way this is used, the opener is first called, then the writer for all + strings, then the flusher, then the reader for all strings and finally the + closer. Note that if you want to prompt from a terminal or other command + line interface, the best is to have the reader also write the prompts + instead of having the writer do it. If you want to prompt from a dialog + box, the writer can be used to build up the contents of the box, and the + flusher to actually display the box and run the event loop until all data + has been given, after which the reader only grabs the given data and puts + them back into the UI strings. + + All method functions take a UI as argument. Additionally, the writer and + the reader take a UI_STRING. +*/ + +/* The UI_STRING type is the data structure that contains all the needed info + about a string or a prompt, including test data for a verification prompt. +*/ +typedef struct ui_string_st UI_STRING; +DECLARE_STACK_OF(UI_STRING) + +/* The different types of strings that are currently supported. + This is only needed by method authors. */ +enum UI_string_types + { + UIT_NONE=0, + UIT_PROMPT, /* Prompt for a string */ + UIT_VERIFY, /* Prompt for a string and verify */ + UIT_BOOLEAN, /* Prompt for a yes/no response */ + UIT_INFO, /* Send info to the user */ + UIT_ERROR /* Send an error message to the user */ + }; + +/* Create and manipulate methods */ +UI_METHOD *UI_create_method(char *name); +void UI_destroy_method(UI_METHOD *ui_method); +int UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui)); +int UI_method_set_writer(UI_METHOD *method, int (*writer)(UI *ui, UI_STRING *uis)); +int UI_method_set_flusher(UI_METHOD *method, int (*flusher)(UI *ui)); +int UI_method_set_reader(UI_METHOD *method, int (*reader)(UI *ui, UI_STRING *uis)); +int UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui)); +int UI_method_set_prompt_constructor(UI_METHOD *method, char *(*prompt_constructor)(UI* ui, const char* object_desc, const char* object_name)); +int (*UI_method_get_opener(UI_METHOD *method))(UI*); +int (*UI_method_get_writer(UI_METHOD *method))(UI*,UI_STRING*); +int (*UI_method_get_flusher(UI_METHOD *method))(UI*); +int (*UI_method_get_reader(UI_METHOD *method))(UI*,UI_STRING*); +int (*UI_method_get_closer(UI_METHOD *method))(UI*); +char * (*UI_method_get_prompt_constructor(UI_METHOD *method))(UI*, const char*, const char*); + +/* The following functions are helpers for method writers to access relevant + data from a UI_STRING. */ + +/* Return type of the UI_STRING */ +enum UI_string_types UI_get_string_type(UI_STRING *uis); +/* Return input flags of the UI_STRING */ +int UI_get_input_flags(UI_STRING *uis); +/* Return the actual string to output (the prompt, info or error) */ +const char *UI_get0_output_string(UI_STRING *uis); +/* Return the optional action string to output (the boolean promtp instruction) */ +const char *UI_get0_action_string(UI_STRING *uis); +/* Return the result of a prompt */ +const char *UI_get0_result_string(UI_STRING *uis); +/* Return the string to test the result against. Only useful with verifies. */ +const char *UI_get0_test_string(UI_STRING *uis); +/* Return the required minimum size of the result */ +int UI_get_result_minsize(UI_STRING *uis); +/* Return the required maximum size of the result */ +int UI_get_result_maxsize(UI_STRING *uis); +/* Set the result of a UI_STRING. */ +int UI_set_result(UI *ui, UI_STRING *uis, const char *result); + + +/* A couple of popular utility functions */ +int UI_UTIL_read_pw_string(char *buf,int length,const char *prompt,int verify); +int UI_UTIL_read_pw(char *buf,char *buff,int size,const char *prompt,int verify); + + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_UI_strings(void); + +/* Error codes for the UI functions. */ + +/* Function codes. */ +#define UI_F_GENERAL_ALLOCATE_BOOLEAN 108 +#define UI_F_GENERAL_ALLOCATE_PROMPT 109 +#define UI_F_GENERAL_ALLOCATE_STRING 100 +#define UI_F_UI_CTRL 111 +#define UI_F_UI_DUP_ERROR_STRING 101 +#define UI_F_UI_DUP_INFO_STRING 102 +#define UI_F_UI_DUP_INPUT_BOOLEAN 110 +#define UI_F_UI_DUP_INPUT_STRING 103 +#define UI_F_UI_DUP_VERIFY_STRING 106 +#define UI_F_UI_GET0_RESULT 107 +#define UI_F_UI_NEW_METHOD 104 +#define UI_F_UI_SET_RESULT 105 + +/* Reason codes. */ +#define UI_R_COMMON_OK_AND_CANCEL_CHARACTERS 104 +#define UI_R_INDEX_TOO_LARGE 102 +#define UI_R_INDEX_TOO_SMALL 103 +#define UI_R_NO_RESULT_BUFFER 105 +#define UI_R_RESULT_TOO_LARGE 100 +#define UI_R_RESULT_TOO_SMALL 101 +#define UI_R_UNKNOWN_CONTROL_COMMAND 106 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/ui_compat.h b/Source/Import/OpenSSL/Include/openssl/ui_compat.h new file mode 100644 index 0000000..b35c9bb --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/ui_compat.h @@ -0,0 +1,83 @@ +/* crypto/ui/ui.h -*- mode:C; c-file-style: "eay" -*- */ +/* Written by Richard Levitte (richard@levitte.org) for the OpenSSL + * project 2001. + */ +/* ==================================================================== + * Copyright (c) 2001 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + +#ifndef HEADER_UI_COMPAT_H +#define HEADER_UI_COMPAT_H + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* The following functions were previously part of the DES section, + and are provided here for backward compatibility reasons. */ + +#define des_read_pw_string(b,l,p,v) \ + _ossl_old_des_read_pw_string((b),(l),(p),(v)) +#define des_read_pw(b,bf,s,p,v) \ + _ossl_old_des_read_pw((b),(bf),(s),(p),(v)) + +int _ossl_old_des_read_pw_string(char *buf,int length,const char *prompt,int verify); +int _ossl_old_des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify); + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/whrlpool.h b/Source/Import/OpenSSL/Include/openssl/whrlpool.h new file mode 100644 index 0000000..9e01f5b --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/whrlpool.h @@ -0,0 +1,41 @@ +#ifndef HEADER_WHRLPOOL_H +#define HEADER_WHRLPOOL_H + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#define WHIRLPOOL_DIGEST_LENGTH (512/8) +#define WHIRLPOOL_BBLOCK 512 +#define WHIRLPOOL_COUNTER (256/8) + +typedef struct { + union { + unsigned char c[WHIRLPOOL_DIGEST_LENGTH]; + /* double q is here to ensure 64-bit alignment */ + double q[WHIRLPOOL_DIGEST_LENGTH/sizeof(double)]; + } H; + unsigned char data[WHIRLPOOL_BBLOCK/8]; + unsigned int bitoff; + size_t bitlen[WHIRLPOOL_COUNTER/sizeof(size_t)]; + } WHIRLPOOL_CTX; + +#ifndef OPENSSL_NO_WHIRLPOOL +#ifdef OPENSSL_FIPS +int private_WHIRLPOOL_Init(WHIRLPOOL_CTX *c); +#endif +int WHIRLPOOL_Init (WHIRLPOOL_CTX *c); +int WHIRLPOOL_Update (WHIRLPOOL_CTX *c,const void *inp,size_t bytes); +void WHIRLPOOL_BitUpdate(WHIRLPOOL_CTX *c,const void *inp,size_t bits); +int WHIRLPOOL_Final (unsigned char *md,WHIRLPOOL_CTX *c); +unsigned char *WHIRLPOOL(const void *inp,size_t bytes,unsigned char *md); +#endif + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/x509.h b/Source/Import/OpenSSL/Include/openssl/x509.h new file mode 100644 index 0000000..092dd74 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/x509.h @@ -0,0 +1,1297 @@ +/* crypto/x509/x509.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ +/* ==================================================================== + * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. + * ECDH support in OpenSSL originally developed by + * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project. + */ + +#ifndef HEADER_X509_H +#define HEADER_X509_H + +#include +#include +#ifndef OPENSSL_NO_BUFFER +#include +#endif +#ifndef OPENSSL_NO_EVP +#include +#endif +#ifndef OPENSSL_NO_BIO +#include +#endif +#include +#include +#include + +#ifndef OPENSSL_NO_EC +#include +#endif + +#ifndef OPENSSL_NO_ECDSA +#include +#endif + +#ifndef OPENSSL_NO_ECDH +#include +#endif + +#ifndef OPENSSL_NO_DEPRECATED +#ifndef OPENSSL_NO_RSA +#include +#endif +#ifndef OPENSSL_NO_DSA +#include +#endif +#ifndef OPENSSL_NO_DH +#include +#endif +#endif + +#ifndef OPENSSL_NO_SHA +#include +#endif +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef OPENSSL_SYS_WIN32 +/* Under Win32 these are defined in wincrypt.h */ +#undef X509_NAME +#undef X509_CERT_PAIR +#undef X509_EXTENSIONS +#endif + +#define X509_FILETYPE_PEM 1 +#define X509_FILETYPE_ASN1 2 +#define X509_FILETYPE_DEFAULT 3 + +#define X509v3_KU_DIGITAL_SIGNATURE 0x0080 +#define X509v3_KU_NON_REPUDIATION 0x0040 +#define X509v3_KU_KEY_ENCIPHERMENT 0x0020 +#define X509v3_KU_DATA_ENCIPHERMENT 0x0010 +#define X509v3_KU_KEY_AGREEMENT 0x0008 +#define X509v3_KU_KEY_CERT_SIGN 0x0004 +#define X509v3_KU_CRL_SIGN 0x0002 +#define X509v3_KU_ENCIPHER_ONLY 0x0001 +#define X509v3_KU_DECIPHER_ONLY 0x8000 +#define X509v3_KU_UNDEF 0xffff + +typedef struct X509_objects_st + { + int nid; + int (*a2i)(void); + int (*i2a)(void); + } X509_OBJECTS; + +struct X509_algor_st + { + ASN1_OBJECT *algorithm; + ASN1_TYPE *parameter; + } /* X509_ALGOR */; + +DECLARE_ASN1_SET_OF(X509_ALGOR) + +typedef STACK_OF(X509_ALGOR) X509_ALGORS; + +typedef struct X509_val_st + { + ASN1_TIME *notBefore; + ASN1_TIME *notAfter; + } X509_VAL; + +struct X509_pubkey_st + { + X509_ALGOR *algor; + ASN1_BIT_STRING *public_key; + EVP_PKEY *pkey; + }; + +typedef struct X509_sig_st + { + X509_ALGOR *algor; + ASN1_OCTET_STRING *digest; + } X509_SIG; + +typedef struct X509_name_entry_st + { + ASN1_OBJECT *object; + ASN1_STRING *value; + int set; + int size; /* temp variable */ + } X509_NAME_ENTRY; + +DECLARE_STACK_OF(X509_NAME_ENTRY) +DECLARE_ASN1_SET_OF(X509_NAME_ENTRY) + +/* we always keep X509_NAMEs in 2 forms. */ +struct X509_name_st + { + STACK_OF(X509_NAME_ENTRY) *entries; + int modified; /* true if 'bytes' needs to be built */ +#ifndef OPENSSL_NO_BUFFER + BUF_MEM *bytes; +#else + char *bytes; +#endif +/* unsigned long hash; Keep the hash around for lookups */ + unsigned char *canon_enc; + int canon_enclen; + } /* X509_NAME */; + +DECLARE_STACK_OF(X509_NAME) + +#define X509_EX_V_NETSCAPE_HACK 0x8000 +#define X509_EX_V_INIT 0x0001 +typedef struct X509_extension_st + { + ASN1_OBJECT *object; + ASN1_BOOLEAN critical; + ASN1_OCTET_STRING *value; + } X509_EXTENSION; + +typedef STACK_OF(X509_EXTENSION) X509_EXTENSIONS; + +DECLARE_STACK_OF(X509_EXTENSION) +DECLARE_ASN1_SET_OF(X509_EXTENSION) + +/* a sequence of these are used */ +typedef struct x509_attributes_st + { + ASN1_OBJECT *object; + int single; /* 0 for a set, 1 for a single item (which is wrong) */ + union { + char *ptr; +/* 0 */ STACK_OF(ASN1_TYPE) *set; +/* 1 */ ASN1_TYPE *single; + } value; + } X509_ATTRIBUTE; + +DECLARE_STACK_OF(X509_ATTRIBUTE) +DECLARE_ASN1_SET_OF(X509_ATTRIBUTE) + + +typedef struct X509_req_info_st + { + ASN1_ENCODING enc; + ASN1_INTEGER *version; + X509_NAME *subject; + X509_PUBKEY *pubkey; + /* d=2 hl=2 l= 0 cons: cont: 00 */ + STACK_OF(X509_ATTRIBUTE) *attributes; /* [ 0 ] */ + } X509_REQ_INFO; + +typedef struct X509_req_st + { + X509_REQ_INFO *req_info; + X509_ALGOR *sig_alg; + ASN1_BIT_STRING *signature; + int references; + } X509_REQ; + +typedef struct x509_cinf_st + { + ASN1_INTEGER *version; /* [ 0 ] default of v1 */ + ASN1_INTEGER *serialNumber; + X509_ALGOR *signature; + X509_NAME *issuer; + X509_VAL *validity; + X509_NAME *subject; + X509_PUBKEY *key; + ASN1_BIT_STRING *issuerUID; /* [ 1 ] optional in v2 */ + ASN1_BIT_STRING *subjectUID; /* [ 2 ] optional in v2 */ + STACK_OF(X509_EXTENSION) *extensions; /* [ 3 ] optional in v3 */ + ASN1_ENCODING enc; + } X509_CINF; + +/* This stuff is certificate "auxiliary info" + * it contains details which are useful in certificate + * stores and databases. When used this is tagged onto + * the end of the certificate itself + */ + +typedef struct x509_cert_aux_st + { + STACK_OF(ASN1_OBJECT) *trust; /* trusted uses */ + STACK_OF(ASN1_OBJECT) *reject; /* rejected uses */ + ASN1_UTF8STRING *alias; /* "friendly name" */ + ASN1_OCTET_STRING *keyid; /* key id of private key */ + STACK_OF(X509_ALGOR) *other; /* other unspecified info */ + } X509_CERT_AUX; + +struct x509_st + { + X509_CINF *cert_info; + X509_ALGOR *sig_alg; + ASN1_BIT_STRING *signature; + int valid; + int references; + char *name; + CRYPTO_EX_DATA ex_data; + /* These contain copies of various extension values */ + long ex_pathlen; + long ex_pcpathlen; + unsigned long ex_flags; + unsigned long ex_kusage; + unsigned long ex_xkusage; + unsigned long ex_nscert; + ASN1_OCTET_STRING *skid; + AUTHORITY_KEYID *akid; + X509_POLICY_CACHE *policy_cache; + STACK_OF(DIST_POINT) *crldp; + STACK_OF(GENERAL_NAME) *altname; + NAME_CONSTRAINTS *nc; +#ifndef OPENSSL_NO_RFC3779 + STACK_OF(IPAddressFamily) *rfc3779_addr; + struct ASIdentifiers_st *rfc3779_asid; +#endif +#ifndef OPENSSL_NO_SHA + unsigned char sha1_hash[SHA_DIGEST_LENGTH]; +#endif + X509_CERT_AUX *aux; + } /* X509 */; + +DECLARE_STACK_OF(X509) +DECLARE_ASN1_SET_OF(X509) + +/* This is used for a table of trust checking functions */ + +typedef struct x509_trust_st { + int trust; + int flags; + int (*check_trust)(struct x509_trust_st *, X509 *, int); + char *name; + int arg1; + void *arg2; +} X509_TRUST; + +DECLARE_STACK_OF(X509_TRUST) + +typedef struct x509_cert_pair_st { + X509 *forward; + X509 *reverse; +} X509_CERT_PAIR; + +/* standard trust ids */ + +#define X509_TRUST_DEFAULT -1 /* Only valid in purpose settings */ + +#define X509_TRUST_COMPAT 1 +#define X509_TRUST_SSL_CLIENT 2 +#define X509_TRUST_SSL_SERVER 3 +#define X509_TRUST_EMAIL 4 +#define X509_TRUST_OBJECT_SIGN 5 +#define X509_TRUST_OCSP_SIGN 6 +#define X509_TRUST_OCSP_REQUEST 7 +#define X509_TRUST_TSA 8 + +/* Keep these up to date! */ +#define X509_TRUST_MIN 1 +#define X509_TRUST_MAX 8 + + +/* trust_flags values */ +#define X509_TRUST_DYNAMIC 1 +#define X509_TRUST_DYNAMIC_NAME 2 + +/* check_trust return codes */ + +#define X509_TRUST_TRUSTED 1 +#define X509_TRUST_REJECTED 2 +#define X509_TRUST_UNTRUSTED 3 + +/* Flags for X509_print_ex() */ + +#define X509_FLAG_COMPAT 0 +#define X509_FLAG_NO_HEADER 1L +#define X509_FLAG_NO_VERSION (1L << 1) +#define X509_FLAG_NO_SERIAL (1L << 2) +#define X509_FLAG_NO_SIGNAME (1L << 3) +#define X509_FLAG_NO_ISSUER (1L << 4) +#define X509_FLAG_NO_VALIDITY (1L << 5) +#define X509_FLAG_NO_SUBJECT (1L << 6) +#define X509_FLAG_NO_PUBKEY (1L << 7) +#define X509_FLAG_NO_EXTENSIONS (1L << 8) +#define X509_FLAG_NO_SIGDUMP (1L << 9) +#define X509_FLAG_NO_AUX (1L << 10) +#define X509_FLAG_NO_ATTRIBUTES (1L << 11) + +/* Flags specific to X509_NAME_print_ex() */ + +/* The field separator information */ + +#define XN_FLAG_SEP_MASK (0xf << 16) + +#define XN_FLAG_COMPAT 0 /* Traditional SSLeay: use old X509_NAME_print */ +#define XN_FLAG_SEP_COMMA_PLUS (1 << 16) /* RFC2253 ,+ */ +#define XN_FLAG_SEP_CPLUS_SPC (2 << 16) /* ,+ spaced: more readable */ +#define XN_FLAG_SEP_SPLUS_SPC (3 << 16) /* ;+ spaced */ +#define XN_FLAG_SEP_MULTILINE (4 << 16) /* One line per field */ + +#define XN_FLAG_DN_REV (1 << 20) /* Reverse DN order */ + +/* How the field name is shown */ + +#define XN_FLAG_FN_MASK (0x3 << 21) + +#define XN_FLAG_FN_SN 0 /* Object short name */ +#define XN_FLAG_FN_LN (1 << 21) /* Object long name */ +#define XN_FLAG_FN_OID (2 << 21) /* Always use OIDs */ +#define XN_FLAG_FN_NONE (3 << 21) /* No field names */ + +#define XN_FLAG_SPC_EQ (1 << 23) /* Put spaces round '=' */ + +/* This determines if we dump fields we don't recognise: + * RFC2253 requires this. + */ + +#define XN_FLAG_DUMP_UNKNOWN_FIELDS (1 << 24) + +#define XN_FLAG_FN_ALIGN (1 << 25) /* Align field names to 20 characters */ + +/* Complete set of RFC2253 flags */ + +#define XN_FLAG_RFC2253 (ASN1_STRFLGS_RFC2253 | \ + XN_FLAG_SEP_COMMA_PLUS | \ + XN_FLAG_DN_REV | \ + XN_FLAG_FN_SN | \ + XN_FLAG_DUMP_UNKNOWN_FIELDS) + +/* readable oneline form */ + +#define XN_FLAG_ONELINE (ASN1_STRFLGS_RFC2253 | \ + ASN1_STRFLGS_ESC_QUOTE | \ + XN_FLAG_SEP_CPLUS_SPC | \ + XN_FLAG_SPC_EQ | \ + XN_FLAG_FN_SN) + +/* readable multiline form */ + +#define XN_FLAG_MULTILINE (ASN1_STRFLGS_ESC_CTRL | \ + ASN1_STRFLGS_ESC_MSB | \ + XN_FLAG_SEP_MULTILINE | \ + XN_FLAG_SPC_EQ | \ + XN_FLAG_FN_LN | \ + XN_FLAG_FN_ALIGN) + +struct x509_revoked_st + { + ASN1_INTEGER *serialNumber; + ASN1_TIME *revocationDate; + STACK_OF(X509_EXTENSION) /* optional */ *extensions; + /* Set up if indirect CRL */ + STACK_OF(GENERAL_NAME) *issuer; + /* Revocation reason */ + int reason; + int sequence; /* load sequence */ + }; + +DECLARE_STACK_OF(X509_REVOKED) +DECLARE_ASN1_SET_OF(X509_REVOKED) + +typedef struct X509_crl_info_st + { + ASN1_INTEGER *version; + X509_ALGOR *sig_alg; + X509_NAME *issuer; + ASN1_TIME *lastUpdate; + ASN1_TIME *nextUpdate; + STACK_OF(X509_REVOKED) *revoked; + STACK_OF(X509_EXTENSION) /* [0] */ *extensions; + ASN1_ENCODING enc; + } X509_CRL_INFO; + +struct X509_crl_st + { + /* actual signature */ + X509_CRL_INFO *crl; + X509_ALGOR *sig_alg; + ASN1_BIT_STRING *signature; + int references; + int flags; + /* Copies of various extensions */ + AUTHORITY_KEYID *akid; + ISSUING_DIST_POINT *idp; + /* Convenient breakdown of IDP */ + int idp_flags; + int idp_reasons; + /* CRL and base CRL numbers for delta processing */ + ASN1_INTEGER *crl_number; + ASN1_INTEGER *base_crl_number; +#ifndef OPENSSL_NO_SHA + unsigned char sha1_hash[SHA_DIGEST_LENGTH]; +#endif + STACK_OF(GENERAL_NAMES) *issuers; + const X509_CRL_METHOD *meth; + void *meth_data; + } /* X509_CRL */; + +DECLARE_STACK_OF(X509_CRL) +DECLARE_ASN1_SET_OF(X509_CRL) + +typedef struct private_key_st + { + int version; + /* The PKCS#8 data types */ + X509_ALGOR *enc_algor; + ASN1_OCTET_STRING *enc_pkey; /* encrypted pub key */ + + /* When decrypted, the following will not be NULL */ + EVP_PKEY *dec_pkey; + + /* used to encrypt and decrypt */ + int key_length; + char *key_data; + int key_free; /* true if we should auto free key_data */ + + /* expanded version of 'enc_algor' */ + EVP_CIPHER_INFO cipher; + + int references; + } X509_PKEY; + +#ifndef OPENSSL_NO_EVP +typedef struct X509_info_st + { + X509 *x509; + X509_CRL *crl; + X509_PKEY *x_pkey; + + EVP_CIPHER_INFO enc_cipher; + int enc_len; + char *enc_data; + + int references; + } X509_INFO; + +DECLARE_STACK_OF(X509_INFO) +#endif + +/* The next 2 structures and their 8 routines were sent to me by + * Pat Richard and are used to manipulate + * Netscapes spki structures - useful if you are writing a CA web page + */ +typedef struct Netscape_spkac_st + { + X509_PUBKEY *pubkey; + ASN1_IA5STRING *challenge; /* challenge sent in atlas >= PR2 */ + } NETSCAPE_SPKAC; + +typedef struct Netscape_spki_st + { + NETSCAPE_SPKAC *spkac; /* signed public key and challenge */ + X509_ALGOR *sig_algor; + ASN1_BIT_STRING *signature; + } NETSCAPE_SPKI; + +/* Netscape certificate sequence structure */ +typedef struct Netscape_certificate_sequence + { + ASN1_OBJECT *type; + STACK_OF(X509) *certs; + } NETSCAPE_CERT_SEQUENCE; + +/* Unused (and iv length is wrong) +typedef struct CBCParameter_st + { + unsigned char iv[8]; + } CBC_PARAM; +*/ + +/* Password based encryption structure */ + +typedef struct PBEPARAM_st { +ASN1_OCTET_STRING *salt; +ASN1_INTEGER *iter; +} PBEPARAM; + +/* Password based encryption V2 structures */ + +typedef struct PBE2PARAM_st { +X509_ALGOR *keyfunc; +X509_ALGOR *encryption; +} PBE2PARAM; + +typedef struct PBKDF2PARAM_st { +ASN1_TYPE *salt; /* Usually OCTET STRING but could be anything */ +ASN1_INTEGER *iter; +ASN1_INTEGER *keylength; +X509_ALGOR *prf; +} PBKDF2PARAM; + + +/* PKCS#8 private key info structure */ + +struct pkcs8_priv_key_info_st + { + int broken; /* Flag for various broken formats */ +#define PKCS8_OK 0 +#define PKCS8_NO_OCTET 1 +#define PKCS8_EMBEDDED_PARAM 2 +#define PKCS8_NS_DB 3 +#define PKCS8_NEG_PRIVKEY 4 + ASN1_INTEGER *version; + X509_ALGOR *pkeyalg; + ASN1_TYPE *pkey; /* Should be OCTET STRING but some are broken */ + STACK_OF(X509_ATTRIBUTE) *attributes; + }; + +#ifdef __cplusplus +} +#endif + +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#define X509_EXT_PACK_UNKNOWN 1 +#define X509_EXT_PACK_STRING 2 + +#define X509_get_version(x) ASN1_INTEGER_get((x)->cert_info->version) +/* #define X509_get_serialNumber(x) ((x)->cert_info->serialNumber) */ +#define X509_get_notBefore(x) ((x)->cert_info->validity->notBefore) +#define X509_get_notAfter(x) ((x)->cert_info->validity->notAfter) +#define X509_extract_key(x) X509_get_pubkey(x) /*****/ +#define X509_REQ_get_version(x) ASN1_INTEGER_get((x)->req_info->version) +#define X509_REQ_get_subject_name(x) ((x)->req_info->subject) +#define X509_REQ_extract_key(a) X509_REQ_get_pubkey(a) +#define X509_name_cmp(a,b) X509_NAME_cmp((a),(b)) +#define X509_get_signature_type(x) EVP_PKEY_type(OBJ_obj2nid((x)->sig_alg->algorithm)) + +#define X509_CRL_get_version(x) ASN1_INTEGER_get((x)->crl->version) +#define X509_CRL_get_lastUpdate(x) ((x)->crl->lastUpdate) +#define X509_CRL_get_nextUpdate(x) ((x)->crl->nextUpdate) +#define X509_CRL_get_issuer(x) ((x)->crl->issuer) +#define X509_CRL_get_REVOKED(x) ((x)->crl->revoked) + +void X509_CRL_set_default_method(const X509_CRL_METHOD *meth); +X509_CRL_METHOD *X509_CRL_METHOD_new( + int (*crl_init)(X509_CRL *crl), + int (*crl_free)(X509_CRL *crl), + int (*crl_lookup)(X509_CRL *crl, X509_REVOKED **ret, + ASN1_INTEGER *ser, X509_NAME *issuer), + int (*crl_verify)(X509_CRL *crl, EVP_PKEY *pk)); +void X509_CRL_METHOD_free(X509_CRL_METHOD *m); + +void X509_CRL_set_meth_data(X509_CRL *crl, void *dat); +void *X509_CRL_get_meth_data(X509_CRL *crl); + +/* This one is only used so that a binary form can output, as in + * i2d_X509_NAME(X509_get_X509_PUBKEY(x),&buf) */ +#define X509_get_X509_PUBKEY(x) ((x)->cert_info->key) + + +const char *X509_verify_cert_error_string(long n); + +#ifndef OPENSSL_NO_EVP +int X509_verify(X509 *a, EVP_PKEY *r); + +int X509_REQ_verify(X509_REQ *a, EVP_PKEY *r); +int X509_CRL_verify(X509_CRL *a, EVP_PKEY *r); +int NETSCAPE_SPKI_verify(NETSCAPE_SPKI *a, EVP_PKEY *r); + +NETSCAPE_SPKI * NETSCAPE_SPKI_b64_decode(const char *str, int len); +char * NETSCAPE_SPKI_b64_encode(NETSCAPE_SPKI *x); +EVP_PKEY *NETSCAPE_SPKI_get_pubkey(NETSCAPE_SPKI *x); +int NETSCAPE_SPKI_set_pubkey(NETSCAPE_SPKI *x, EVP_PKEY *pkey); + +int NETSCAPE_SPKI_print(BIO *out, NETSCAPE_SPKI *spki); + +int X509_signature_dump(BIO *bp,const ASN1_STRING *sig, int indent); +int X509_signature_print(BIO *bp,X509_ALGOR *alg, ASN1_STRING *sig); + +int X509_sign(X509 *x, EVP_PKEY *pkey, const EVP_MD *md); +int X509_sign_ctx(X509 *x, EVP_MD_CTX *ctx); +int X509_REQ_sign(X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md); +int X509_REQ_sign_ctx(X509_REQ *x, EVP_MD_CTX *ctx); +int X509_CRL_sign(X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md); +int X509_CRL_sign_ctx(X509_CRL *x, EVP_MD_CTX *ctx); +int NETSCAPE_SPKI_sign(NETSCAPE_SPKI *x, EVP_PKEY *pkey, const EVP_MD *md); + +int X509_pubkey_digest(const X509 *data,const EVP_MD *type, + unsigned char *md, unsigned int *len); +int X509_digest(const X509 *data,const EVP_MD *type, + unsigned char *md, unsigned int *len); +int X509_CRL_digest(const X509_CRL *data,const EVP_MD *type, + unsigned char *md, unsigned int *len); +int X509_REQ_digest(const X509_REQ *data,const EVP_MD *type, + unsigned char *md, unsigned int *len); +int X509_NAME_digest(const X509_NAME *data,const EVP_MD *type, + unsigned char *md, unsigned int *len); +#endif + +#ifndef OPENSSL_NO_FP_API +X509 *d2i_X509_fp(FILE *fp, X509 **x509); +int i2d_X509_fp(FILE *fp,X509 *x509); +X509_CRL *d2i_X509_CRL_fp(FILE *fp,X509_CRL **crl); +int i2d_X509_CRL_fp(FILE *fp,X509_CRL *crl); +X509_REQ *d2i_X509_REQ_fp(FILE *fp,X509_REQ **req); +int i2d_X509_REQ_fp(FILE *fp,X509_REQ *req); +#ifndef OPENSSL_NO_RSA +RSA *d2i_RSAPrivateKey_fp(FILE *fp,RSA **rsa); +int i2d_RSAPrivateKey_fp(FILE *fp,RSA *rsa); +RSA *d2i_RSAPublicKey_fp(FILE *fp,RSA **rsa); +int i2d_RSAPublicKey_fp(FILE *fp,RSA *rsa); +RSA *d2i_RSA_PUBKEY_fp(FILE *fp,RSA **rsa); +int i2d_RSA_PUBKEY_fp(FILE *fp,RSA *rsa); +#endif +#ifndef OPENSSL_NO_DSA +DSA *d2i_DSA_PUBKEY_fp(FILE *fp, DSA **dsa); +int i2d_DSA_PUBKEY_fp(FILE *fp, DSA *dsa); +DSA *d2i_DSAPrivateKey_fp(FILE *fp, DSA **dsa); +int i2d_DSAPrivateKey_fp(FILE *fp, DSA *dsa); +#endif +#ifndef OPENSSL_NO_EC +EC_KEY *d2i_EC_PUBKEY_fp(FILE *fp, EC_KEY **eckey); +int i2d_EC_PUBKEY_fp(FILE *fp, EC_KEY *eckey); +EC_KEY *d2i_ECPrivateKey_fp(FILE *fp, EC_KEY **eckey); +int i2d_ECPrivateKey_fp(FILE *fp, EC_KEY *eckey); +#endif +X509_SIG *d2i_PKCS8_fp(FILE *fp,X509_SIG **p8); +int i2d_PKCS8_fp(FILE *fp,X509_SIG *p8); +PKCS8_PRIV_KEY_INFO *d2i_PKCS8_PRIV_KEY_INFO_fp(FILE *fp, + PKCS8_PRIV_KEY_INFO **p8inf); +int i2d_PKCS8_PRIV_KEY_INFO_fp(FILE *fp,PKCS8_PRIV_KEY_INFO *p8inf); +int i2d_PKCS8PrivateKeyInfo_fp(FILE *fp, EVP_PKEY *key); +int i2d_PrivateKey_fp(FILE *fp, EVP_PKEY *pkey); +EVP_PKEY *d2i_PrivateKey_fp(FILE *fp, EVP_PKEY **a); +int i2d_PUBKEY_fp(FILE *fp, EVP_PKEY *pkey); +EVP_PKEY *d2i_PUBKEY_fp(FILE *fp, EVP_PKEY **a); +#endif + +#ifndef OPENSSL_NO_BIO +X509 *d2i_X509_bio(BIO *bp,X509 **x509); +int i2d_X509_bio(BIO *bp,X509 *x509); +X509_CRL *d2i_X509_CRL_bio(BIO *bp,X509_CRL **crl); +int i2d_X509_CRL_bio(BIO *bp,X509_CRL *crl); +X509_REQ *d2i_X509_REQ_bio(BIO *bp,X509_REQ **req); +int i2d_X509_REQ_bio(BIO *bp,X509_REQ *req); +#ifndef OPENSSL_NO_RSA +RSA *d2i_RSAPrivateKey_bio(BIO *bp,RSA **rsa); +int i2d_RSAPrivateKey_bio(BIO *bp,RSA *rsa); +RSA *d2i_RSAPublicKey_bio(BIO *bp,RSA **rsa); +int i2d_RSAPublicKey_bio(BIO *bp,RSA *rsa); +RSA *d2i_RSA_PUBKEY_bio(BIO *bp,RSA **rsa); +int i2d_RSA_PUBKEY_bio(BIO *bp,RSA *rsa); +#endif +#ifndef OPENSSL_NO_DSA +DSA *d2i_DSA_PUBKEY_bio(BIO *bp, DSA **dsa); +int i2d_DSA_PUBKEY_bio(BIO *bp, DSA *dsa); +DSA *d2i_DSAPrivateKey_bio(BIO *bp, DSA **dsa); +int i2d_DSAPrivateKey_bio(BIO *bp, DSA *dsa); +#endif +#ifndef OPENSSL_NO_EC +EC_KEY *d2i_EC_PUBKEY_bio(BIO *bp, EC_KEY **eckey); +int i2d_EC_PUBKEY_bio(BIO *bp, EC_KEY *eckey); +EC_KEY *d2i_ECPrivateKey_bio(BIO *bp, EC_KEY **eckey); +int i2d_ECPrivateKey_bio(BIO *bp, EC_KEY *eckey); +#endif +X509_SIG *d2i_PKCS8_bio(BIO *bp,X509_SIG **p8); +int i2d_PKCS8_bio(BIO *bp,X509_SIG *p8); +PKCS8_PRIV_KEY_INFO *d2i_PKCS8_PRIV_KEY_INFO_bio(BIO *bp, + PKCS8_PRIV_KEY_INFO **p8inf); +int i2d_PKCS8_PRIV_KEY_INFO_bio(BIO *bp,PKCS8_PRIV_KEY_INFO *p8inf); +int i2d_PKCS8PrivateKeyInfo_bio(BIO *bp, EVP_PKEY *key); +int i2d_PrivateKey_bio(BIO *bp, EVP_PKEY *pkey); +EVP_PKEY *d2i_PrivateKey_bio(BIO *bp, EVP_PKEY **a); +int i2d_PUBKEY_bio(BIO *bp, EVP_PKEY *pkey); +EVP_PKEY *d2i_PUBKEY_bio(BIO *bp, EVP_PKEY **a); +#endif + +X509 *X509_dup(X509 *x509); +X509_ATTRIBUTE *X509_ATTRIBUTE_dup(X509_ATTRIBUTE *xa); +X509_EXTENSION *X509_EXTENSION_dup(X509_EXTENSION *ex); +X509_CRL *X509_CRL_dup(X509_CRL *crl); +X509_REQ *X509_REQ_dup(X509_REQ *req); +X509_ALGOR *X509_ALGOR_dup(X509_ALGOR *xn); +int X509_ALGOR_set0(X509_ALGOR *alg, ASN1_OBJECT *aobj, int ptype, void *pval); +void X509_ALGOR_get0(ASN1_OBJECT **paobj, int *pptype, void **ppval, + X509_ALGOR *algor); +void X509_ALGOR_set_md(X509_ALGOR *alg, const EVP_MD *md); + +X509_NAME *X509_NAME_dup(X509_NAME *xn); +X509_NAME_ENTRY *X509_NAME_ENTRY_dup(X509_NAME_ENTRY *ne); + +int X509_cmp_time(const ASN1_TIME *s, time_t *t); +int X509_cmp_current_time(const ASN1_TIME *s); +ASN1_TIME * X509_time_adj(ASN1_TIME *s, long adj, time_t *t); +ASN1_TIME * X509_time_adj_ex(ASN1_TIME *s, + int offset_day, long offset_sec, time_t *t); +ASN1_TIME * X509_gmtime_adj(ASN1_TIME *s, long adj); + +const char * X509_get_default_cert_area(void ); +const char * X509_get_default_cert_dir(void ); +const char * X509_get_default_cert_file(void ); +const char * X509_get_default_cert_dir_env(void ); +const char * X509_get_default_cert_file_env(void ); +const char * X509_get_default_private_dir(void ); + +X509_REQ * X509_to_X509_REQ(X509 *x, EVP_PKEY *pkey, const EVP_MD *md); +X509 * X509_REQ_to_X509(X509_REQ *r, int days,EVP_PKEY *pkey); + +DECLARE_ASN1_FUNCTIONS(X509_ALGOR) +DECLARE_ASN1_ENCODE_FUNCTIONS(X509_ALGORS, X509_ALGORS, X509_ALGORS) +DECLARE_ASN1_FUNCTIONS(X509_VAL) + +DECLARE_ASN1_FUNCTIONS(X509_PUBKEY) + +int X509_PUBKEY_set(X509_PUBKEY **x, EVP_PKEY *pkey); +EVP_PKEY * X509_PUBKEY_get(X509_PUBKEY *key); +int X509_get_pubkey_parameters(EVP_PKEY *pkey, + STACK_OF(X509) *chain); +int i2d_PUBKEY(EVP_PKEY *a,unsigned char **pp); +EVP_PKEY * d2i_PUBKEY(EVP_PKEY **a,const unsigned char **pp, + long length); +#ifndef OPENSSL_NO_RSA +int i2d_RSA_PUBKEY(RSA *a,unsigned char **pp); +RSA * d2i_RSA_PUBKEY(RSA **a,const unsigned char **pp, + long length); +#endif +#ifndef OPENSSL_NO_DSA +int i2d_DSA_PUBKEY(DSA *a,unsigned char **pp); +DSA * d2i_DSA_PUBKEY(DSA **a,const unsigned char **pp, + long length); +#endif +#ifndef OPENSSL_NO_EC +int i2d_EC_PUBKEY(EC_KEY *a, unsigned char **pp); +EC_KEY *d2i_EC_PUBKEY(EC_KEY **a, const unsigned char **pp, + long length); +#endif + +DECLARE_ASN1_FUNCTIONS(X509_SIG) +DECLARE_ASN1_FUNCTIONS(X509_REQ_INFO) +DECLARE_ASN1_FUNCTIONS(X509_REQ) + +DECLARE_ASN1_FUNCTIONS(X509_ATTRIBUTE) +X509_ATTRIBUTE *X509_ATTRIBUTE_create(int nid, int atrtype, void *value); + +DECLARE_ASN1_FUNCTIONS(X509_EXTENSION) +DECLARE_ASN1_ENCODE_FUNCTIONS(X509_EXTENSIONS, X509_EXTENSIONS, X509_EXTENSIONS) + +DECLARE_ASN1_FUNCTIONS(X509_NAME_ENTRY) + +DECLARE_ASN1_FUNCTIONS(X509_NAME) + +int X509_NAME_set(X509_NAME **xn, X509_NAME *name); + +DECLARE_ASN1_FUNCTIONS(X509_CINF) + +DECLARE_ASN1_FUNCTIONS(X509) +DECLARE_ASN1_FUNCTIONS(X509_CERT_AUX) + +DECLARE_ASN1_FUNCTIONS(X509_CERT_PAIR) + +int X509_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); +int X509_set_ex_data(X509 *r, int idx, void *arg); +void *X509_get_ex_data(X509 *r, int idx); +int i2d_X509_AUX(X509 *a,unsigned char **pp); +X509 * d2i_X509_AUX(X509 **a,const unsigned char **pp,long length); + +int X509_alias_set1(X509 *x, unsigned char *name, int len); +int X509_keyid_set1(X509 *x, unsigned char *id, int len); +unsigned char * X509_alias_get0(X509 *x, int *len); +unsigned char * X509_keyid_get0(X509 *x, int *len); +int (*X509_TRUST_set_default(int (*trust)(int , X509 *, int)))(int, X509 *, int); +int X509_TRUST_set(int *t, int trust); +int X509_add1_trust_object(X509 *x, ASN1_OBJECT *obj); +int X509_add1_reject_object(X509 *x, ASN1_OBJECT *obj); +void X509_trust_clear(X509 *x); +void X509_reject_clear(X509 *x); + +DECLARE_ASN1_FUNCTIONS(X509_REVOKED) +DECLARE_ASN1_FUNCTIONS(X509_CRL_INFO) +DECLARE_ASN1_FUNCTIONS(X509_CRL) + +int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev); +int X509_CRL_get0_by_serial(X509_CRL *crl, + X509_REVOKED **ret, ASN1_INTEGER *serial); +int X509_CRL_get0_by_cert(X509_CRL *crl, X509_REVOKED **ret, X509 *x); + +X509_PKEY * X509_PKEY_new(void ); +void X509_PKEY_free(X509_PKEY *a); +int i2d_X509_PKEY(X509_PKEY *a,unsigned char **pp); +X509_PKEY * d2i_X509_PKEY(X509_PKEY **a,const unsigned char **pp,long length); + +DECLARE_ASN1_FUNCTIONS(NETSCAPE_SPKI) +DECLARE_ASN1_FUNCTIONS(NETSCAPE_SPKAC) +DECLARE_ASN1_FUNCTIONS(NETSCAPE_CERT_SEQUENCE) + +#ifndef OPENSSL_NO_EVP +X509_INFO * X509_INFO_new(void); +void X509_INFO_free(X509_INFO *a); +char * X509_NAME_oneline(X509_NAME *a,char *buf,int size); + +int ASN1_verify(i2d_of_void *i2d, X509_ALGOR *algor1, + ASN1_BIT_STRING *signature,char *data,EVP_PKEY *pkey); + +int ASN1_digest(i2d_of_void *i2d,const EVP_MD *type,char *data, + unsigned char *md,unsigned int *len); + +int ASN1_sign(i2d_of_void *i2d, X509_ALGOR *algor1, + X509_ALGOR *algor2, ASN1_BIT_STRING *signature, + char *data,EVP_PKEY *pkey, const EVP_MD *type); + +int ASN1_item_digest(const ASN1_ITEM *it,const EVP_MD *type,void *data, + unsigned char *md,unsigned int *len); + +int ASN1_item_verify(const ASN1_ITEM *it, X509_ALGOR *algor1, + ASN1_BIT_STRING *signature,void *data,EVP_PKEY *pkey); + +int ASN1_item_sign(const ASN1_ITEM *it, X509_ALGOR *algor1, X509_ALGOR *algor2, + ASN1_BIT_STRING *signature, + void *data, EVP_PKEY *pkey, const EVP_MD *type); +int ASN1_item_sign_ctx(const ASN1_ITEM *it, + X509_ALGOR *algor1, X509_ALGOR *algor2, + ASN1_BIT_STRING *signature, void *asn, EVP_MD_CTX *ctx); +#endif + +int X509_set_version(X509 *x,long version); +int X509_set_serialNumber(X509 *x, ASN1_INTEGER *serial); +ASN1_INTEGER * X509_get_serialNumber(X509 *x); +int X509_set_issuer_name(X509 *x, X509_NAME *name); +X509_NAME * X509_get_issuer_name(X509 *a); +int X509_set_subject_name(X509 *x, X509_NAME *name); +X509_NAME * X509_get_subject_name(X509 *a); +int X509_set_notBefore(X509 *x, const ASN1_TIME *tm); +int X509_set_notAfter(X509 *x, const ASN1_TIME *tm); +int X509_set_pubkey(X509 *x, EVP_PKEY *pkey); +EVP_PKEY * X509_get_pubkey(X509 *x); +ASN1_BIT_STRING * X509_get0_pubkey_bitstr(const X509 *x); +int X509_certificate_type(X509 *x,EVP_PKEY *pubkey /* optional */); + +int X509_REQ_set_version(X509_REQ *x,long version); +int X509_REQ_set_subject_name(X509_REQ *req,X509_NAME *name); +int X509_REQ_set_pubkey(X509_REQ *x, EVP_PKEY *pkey); +EVP_PKEY * X509_REQ_get_pubkey(X509_REQ *req); +int X509_REQ_extension_nid(int nid); +int * X509_REQ_get_extension_nids(void); +void X509_REQ_set_extension_nids(int *nids); +STACK_OF(X509_EXTENSION) *X509_REQ_get_extensions(X509_REQ *req); +int X509_REQ_add_extensions_nid(X509_REQ *req, STACK_OF(X509_EXTENSION) *exts, + int nid); +int X509_REQ_add_extensions(X509_REQ *req, STACK_OF(X509_EXTENSION) *exts); +int X509_REQ_get_attr_count(const X509_REQ *req); +int X509_REQ_get_attr_by_NID(const X509_REQ *req, int nid, + int lastpos); +int X509_REQ_get_attr_by_OBJ(const X509_REQ *req, ASN1_OBJECT *obj, + int lastpos); +X509_ATTRIBUTE *X509_REQ_get_attr(const X509_REQ *req, int loc); +X509_ATTRIBUTE *X509_REQ_delete_attr(X509_REQ *req, int loc); +int X509_REQ_add1_attr(X509_REQ *req, X509_ATTRIBUTE *attr); +int X509_REQ_add1_attr_by_OBJ(X509_REQ *req, + const ASN1_OBJECT *obj, int type, + const unsigned char *bytes, int len); +int X509_REQ_add1_attr_by_NID(X509_REQ *req, + int nid, int type, + const unsigned char *bytes, int len); +int X509_REQ_add1_attr_by_txt(X509_REQ *req, + const char *attrname, int type, + const unsigned char *bytes, int len); + +int X509_CRL_set_version(X509_CRL *x, long version); +int X509_CRL_set_issuer_name(X509_CRL *x, X509_NAME *name); +int X509_CRL_set_lastUpdate(X509_CRL *x, const ASN1_TIME *tm); +int X509_CRL_set_nextUpdate(X509_CRL *x, const ASN1_TIME *tm); +int X509_CRL_sort(X509_CRL *crl); + +int X509_REVOKED_set_serialNumber(X509_REVOKED *x, ASN1_INTEGER *serial); +int X509_REVOKED_set_revocationDate(X509_REVOKED *r, ASN1_TIME *tm); + +int X509_REQ_check_private_key(X509_REQ *x509,EVP_PKEY *pkey); + +int X509_check_private_key(X509 *x509,EVP_PKEY *pkey); + +int X509_issuer_and_serial_cmp(const X509 *a, const X509 *b); +unsigned long X509_issuer_and_serial_hash(X509 *a); + +int X509_issuer_name_cmp(const X509 *a, const X509 *b); +unsigned long X509_issuer_name_hash(X509 *a); + +int X509_subject_name_cmp(const X509 *a, const X509 *b); +unsigned long X509_subject_name_hash(X509 *x); + +#ifndef OPENSSL_NO_MD5 +unsigned long X509_issuer_name_hash_old(X509 *a); +unsigned long X509_subject_name_hash_old(X509 *x); +#endif + +int X509_cmp(const X509 *a, const X509 *b); +int X509_NAME_cmp(const X509_NAME *a, const X509_NAME *b); +unsigned long X509_NAME_hash(X509_NAME *x); +unsigned long X509_NAME_hash_old(X509_NAME *x); + +int X509_CRL_cmp(const X509_CRL *a, const X509_CRL *b); +int X509_CRL_match(const X509_CRL *a, const X509_CRL *b); +#ifndef OPENSSL_NO_FP_API +int X509_print_ex_fp(FILE *bp,X509 *x, unsigned long nmflag, unsigned long cflag); +int X509_print_fp(FILE *bp,X509 *x); +int X509_CRL_print_fp(FILE *bp,X509_CRL *x); +int X509_REQ_print_fp(FILE *bp,X509_REQ *req); +int X509_NAME_print_ex_fp(FILE *fp, X509_NAME *nm, int indent, unsigned long flags); +#endif + +#ifndef OPENSSL_NO_BIO +int X509_NAME_print(BIO *bp, X509_NAME *name, int obase); +int X509_NAME_print_ex(BIO *out, X509_NAME *nm, int indent, unsigned long flags); +int X509_print_ex(BIO *bp,X509 *x, unsigned long nmflag, unsigned long cflag); +int X509_print(BIO *bp,X509 *x); +int X509_ocspid_print(BIO *bp,X509 *x); +int X509_CERT_AUX_print(BIO *bp,X509_CERT_AUX *x, int indent); +int X509_CRL_print(BIO *bp,X509_CRL *x); +int X509_REQ_print_ex(BIO *bp, X509_REQ *x, unsigned long nmflag, unsigned long cflag); +int X509_REQ_print(BIO *bp,X509_REQ *req); +#endif + +int X509_NAME_entry_count(X509_NAME *name); +int X509_NAME_get_text_by_NID(X509_NAME *name, int nid, + char *buf,int len); +int X509_NAME_get_text_by_OBJ(X509_NAME *name, ASN1_OBJECT *obj, + char *buf,int len); + +/* NOTE: you should be passsing -1, not 0 as lastpos. The functions that use + * lastpos, search after that position on. */ +int X509_NAME_get_index_by_NID(X509_NAME *name,int nid,int lastpos); +int X509_NAME_get_index_by_OBJ(X509_NAME *name,ASN1_OBJECT *obj, + int lastpos); +X509_NAME_ENTRY *X509_NAME_get_entry(X509_NAME *name, int loc); +X509_NAME_ENTRY *X509_NAME_delete_entry(X509_NAME *name, int loc); +int X509_NAME_add_entry(X509_NAME *name,X509_NAME_ENTRY *ne, + int loc, int set); +int X509_NAME_add_entry_by_OBJ(X509_NAME *name, ASN1_OBJECT *obj, int type, + unsigned char *bytes, int len, int loc, int set); +int X509_NAME_add_entry_by_NID(X509_NAME *name, int nid, int type, + unsigned char *bytes, int len, int loc, int set); +X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_txt(X509_NAME_ENTRY **ne, + const char *field, int type, const unsigned char *bytes, int len); +X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_NID(X509_NAME_ENTRY **ne, int nid, + int type,unsigned char *bytes, int len); +int X509_NAME_add_entry_by_txt(X509_NAME *name, const char *field, int type, + const unsigned char *bytes, int len, int loc, int set); +X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_OBJ(X509_NAME_ENTRY **ne, + ASN1_OBJECT *obj, int type,const unsigned char *bytes, + int len); +int X509_NAME_ENTRY_set_object(X509_NAME_ENTRY *ne, + ASN1_OBJECT *obj); +int X509_NAME_ENTRY_set_data(X509_NAME_ENTRY *ne, int type, + const unsigned char *bytes, int len); +ASN1_OBJECT * X509_NAME_ENTRY_get_object(X509_NAME_ENTRY *ne); +ASN1_STRING * X509_NAME_ENTRY_get_data(X509_NAME_ENTRY *ne); + +int X509v3_get_ext_count(const STACK_OF(X509_EXTENSION) *x); +int X509v3_get_ext_by_NID(const STACK_OF(X509_EXTENSION) *x, + int nid, int lastpos); +int X509v3_get_ext_by_OBJ(const STACK_OF(X509_EXTENSION) *x, + ASN1_OBJECT *obj,int lastpos); +int X509v3_get_ext_by_critical(const STACK_OF(X509_EXTENSION) *x, + int crit, int lastpos); +X509_EXTENSION *X509v3_get_ext(const STACK_OF(X509_EXTENSION) *x, int loc); +X509_EXTENSION *X509v3_delete_ext(STACK_OF(X509_EXTENSION) *x, int loc); +STACK_OF(X509_EXTENSION) *X509v3_add_ext(STACK_OF(X509_EXTENSION) **x, + X509_EXTENSION *ex, int loc); + +int X509_get_ext_count(X509 *x); +int X509_get_ext_by_NID(X509 *x, int nid, int lastpos); +int X509_get_ext_by_OBJ(X509 *x,ASN1_OBJECT *obj,int lastpos); +int X509_get_ext_by_critical(X509 *x, int crit, int lastpos); +X509_EXTENSION *X509_get_ext(X509 *x, int loc); +X509_EXTENSION *X509_delete_ext(X509 *x, int loc); +int X509_add_ext(X509 *x, X509_EXTENSION *ex, int loc); +void * X509_get_ext_d2i(X509 *x, int nid, int *crit, int *idx); +int X509_add1_ext_i2d(X509 *x, int nid, void *value, int crit, + unsigned long flags); + +int X509_CRL_get_ext_count(X509_CRL *x); +int X509_CRL_get_ext_by_NID(X509_CRL *x, int nid, int lastpos); +int X509_CRL_get_ext_by_OBJ(X509_CRL *x,ASN1_OBJECT *obj,int lastpos); +int X509_CRL_get_ext_by_critical(X509_CRL *x, int crit, int lastpos); +X509_EXTENSION *X509_CRL_get_ext(X509_CRL *x, int loc); +X509_EXTENSION *X509_CRL_delete_ext(X509_CRL *x, int loc); +int X509_CRL_add_ext(X509_CRL *x, X509_EXTENSION *ex, int loc); +void * X509_CRL_get_ext_d2i(X509_CRL *x, int nid, int *crit, int *idx); +int X509_CRL_add1_ext_i2d(X509_CRL *x, int nid, void *value, int crit, + unsigned long flags); + +int X509_REVOKED_get_ext_count(X509_REVOKED *x); +int X509_REVOKED_get_ext_by_NID(X509_REVOKED *x, int nid, int lastpos); +int X509_REVOKED_get_ext_by_OBJ(X509_REVOKED *x,ASN1_OBJECT *obj,int lastpos); +int X509_REVOKED_get_ext_by_critical(X509_REVOKED *x, int crit, int lastpos); +X509_EXTENSION *X509_REVOKED_get_ext(X509_REVOKED *x, int loc); +X509_EXTENSION *X509_REVOKED_delete_ext(X509_REVOKED *x, int loc); +int X509_REVOKED_add_ext(X509_REVOKED *x, X509_EXTENSION *ex, int loc); +void * X509_REVOKED_get_ext_d2i(X509_REVOKED *x, int nid, int *crit, int *idx); +int X509_REVOKED_add1_ext_i2d(X509_REVOKED *x, int nid, void *value, int crit, + unsigned long flags); + +X509_EXTENSION *X509_EXTENSION_create_by_NID(X509_EXTENSION **ex, + int nid, int crit, ASN1_OCTET_STRING *data); +X509_EXTENSION *X509_EXTENSION_create_by_OBJ(X509_EXTENSION **ex, + ASN1_OBJECT *obj,int crit,ASN1_OCTET_STRING *data); +int X509_EXTENSION_set_object(X509_EXTENSION *ex,ASN1_OBJECT *obj); +int X509_EXTENSION_set_critical(X509_EXTENSION *ex, int crit); +int X509_EXTENSION_set_data(X509_EXTENSION *ex, + ASN1_OCTET_STRING *data); +ASN1_OBJECT * X509_EXTENSION_get_object(X509_EXTENSION *ex); +ASN1_OCTET_STRING *X509_EXTENSION_get_data(X509_EXTENSION *ne); +int X509_EXTENSION_get_critical(X509_EXTENSION *ex); + +int X509at_get_attr_count(const STACK_OF(X509_ATTRIBUTE) *x); +int X509at_get_attr_by_NID(const STACK_OF(X509_ATTRIBUTE) *x, int nid, + int lastpos); +int X509at_get_attr_by_OBJ(const STACK_OF(X509_ATTRIBUTE) *sk, ASN1_OBJECT *obj, + int lastpos); +X509_ATTRIBUTE *X509at_get_attr(const STACK_OF(X509_ATTRIBUTE) *x, int loc); +X509_ATTRIBUTE *X509at_delete_attr(STACK_OF(X509_ATTRIBUTE) *x, int loc); +STACK_OF(X509_ATTRIBUTE) *X509at_add1_attr(STACK_OF(X509_ATTRIBUTE) **x, + X509_ATTRIBUTE *attr); +STACK_OF(X509_ATTRIBUTE) *X509at_add1_attr_by_OBJ(STACK_OF(X509_ATTRIBUTE) **x, + const ASN1_OBJECT *obj, int type, + const unsigned char *bytes, int len); +STACK_OF(X509_ATTRIBUTE) *X509at_add1_attr_by_NID(STACK_OF(X509_ATTRIBUTE) **x, + int nid, int type, + const unsigned char *bytes, int len); +STACK_OF(X509_ATTRIBUTE) *X509at_add1_attr_by_txt(STACK_OF(X509_ATTRIBUTE) **x, + const char *attrname, int type, + const unsigned char *bytes, int len); +void *X509at_get0_data_by_OBJ(STACK_OF(X509_ATTRIBUTE) *x, + ASN1_OBJECT *obj, int lastpos, int type); +X509_ATTRIBUTE *X509_ATTRIBUTE_create_by_NID(X509_ATTRIBUTE **attr, int nid, + int atrtype, const void *data, int len); +X509_ATTRIBUTE *X509_ATTRIBUTE_create_by_OBJ(X509_ATTRIBUTE **attr, + const ASN1_OBJECT *obj, int atrtype, const void *data, int len); +X509_ATTRIBUTE *X509_ATTRIBUTE_create_by_txt(X509_ATTRIBUTE **attr, + const char *atrname, int type, const unsigned char *bytes, int len); +int X509_ATTRIBUTE_set1_object(X509_ATTRIBUTE *attr, const ASN1_OBJECT *obj); +int X509_ATTRIBUTE_set1_data(X509_ATTRIBUTE *attr, int attrtype, const void *data, int len); +void *X509_ATTRIBUTE_get0_data(X509_ATTRIBUTE *attr, int idx, + int atrtype, void *data); +int X509_ATTRIBUTE_count(X509_ATTRIBUTE *attr); +ASN1_OBJECT *X509_ATTRIBUTE_get0_object(X509_ATTRIBUTE *attr); +ASN1_TYPE *X509_ATTRIBUTE_get0_type(X509_ATTRIBUTE *attr, int idx); + +int EVP_PKEY_get_attr_count(const EVP_PKEY *key); +int EVP_PKEY_get_attr_by_NID(const EVP_PKEY *key, int nid, + int lastpos); +int EVP_PKEY_get_attr_by_OBJ(const EVP_PKEY *key, ASN1_OBJECT *obj, + int lastpos); +X509_ATTRIBUTE *EVP_PKEY_get_attr(const EVP_PKEY *key, int loc); +X509_ATTRIBUTE *EVP_PKEY_delete_attr(EVP_PKEY *key, int loc); +int EVP_PKEY_add1_attr(EVP_PKEY *key, X509_ATTRIBUTE *attr); +int EVP_PKEY_add1_attr_by_OBJ(EVP_PKEY *key, + const ASN1_OBJECT *obj, int type, + const unsigned char *bytes, int len); +int EVP_PKEY_add1_attr_by_NID(EVP_PKEY *key, + int nid, int type, + const unsigned char *bytes, int len); +int EVP_PKEY_add1_attr_by_txt(EVP_PKEY *key, + const char *attrname, int type, + const unsigned char *bytes, int len); + +int X509_verify_cert(X509_STORE_CTX *ctx); + +/* lookup a cert from a X509 STACK */ +X509 *X509_find_by_issuer_and_serial(STACK_OF(X509) *sk,X509_NAME *name, + ASN1_INTEGER *serial); +X509 *X509_find_by_subject(STACK_OF(X509) *sk,X509_NAME *name); + +DECLARE_ASN1_FUNCTIONS(PBEPARAM) +DECLARE_ASN1_FUNCTIONS(PBE2PARAM) +DECLARE_ASN1_FUNCTIONS(PBKDF2PARAM) + +int PKCS5_pbe_set0_algor(X509_ALGOR *algor, int alg, int iter, + const unsigned char *salt, int saltlen); + +X509_ALGOR *PKCS5_pbe_set(int alg, int iter, + const unsigned char *salt, int saltlen); +X509_ALGOR *PKCS5_pbe2_set(const EVP_CIPHER *cipher, int iter, + unsigned char *salt, int saltlen); +X509_ALGOR *PKCS5_pbe2_set_iv(const EVP_CIPHER *cipher, int iter, + unsigned char *salt, int saltlen, + unsigned char *aiv, int prf_nid); + +X509_ALGOR *PKCS5_pbkdf2_set(int iter, unsigned char *salt, int saltlen, + int prf_nid, int keylen); + +/* PKCS#8 utilities */ + +DECLARE_ASN1_FUNCTIONS(PKCS8_PRIV_KEY_INFO) + +EVP_PKEY *EVP_PKCS82PKEY(PKCS8_PRIV_KEY_INFO *p8); +PKCS8_PRIV_KEY_INFO *EVP_PKEY2PKCS8(EVP_PKEY *pkey); +PKCS8_PRIV_KEY_INFO *EVP_PKEY2PKCS8_broken(EVP_PKEY *pkey, int broken); +PKCS8_PRIV_KEY_INFO *PKCS8_set_broken(PKCS8_PRIV_KEY_INFO *p8, int broken); + +int PKCS8_pkey_set0(PKCS8_PRIV_KEY_INFO *priv, ASN1_OBJECT *aobj, + int version, int ptype, void *pval, + unsigned char *penc, int penclen); +int PKCS8_pkey_get0(ASN1_OBJECT **ppkalg, + const unsigned char **pk, int *ppklen, + X509_ALGOR **pa, + PKCS8_PRIV_KEY_INFO *p8); + +int X509_PUBKEY_set0_param(X509_PUBKEY *pub, ASN1_OBJECT *aobj, + int ptype, void *pval, + unsigned char *penc, int penclen); +int X509_PUBKEY_get0_param(ASN1_OBJECT **ppkalg, + const unsigned char **pk, int *ppklen, + X509_ALGOR **pa, + X509_PUBKEY *pub); + +int X509_check_trust(X509 *x, int id, int flags); +int X509_TRUST_get_count(void); +X509_TRUST * X509_TRUST_get0(int idx); +int X509_TRUST_get_by_id(int id); +int X509_TRUST_add(int id, int flags, int (*ck)(X509_TRUST *, X509 *, int), + char *name, int arg1, void *arg2); +void X509_TRUST_cleanup(void); +int X509_TRUST_get_flags(X509_TRUST *xp); +char *X509_TRUST_get0_name(X509_TRUST *xp); +int X509_TRUST_get_trust(X509_TRUST *xp); + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_X509_strings(void); + +/* Error codes for the X509 functions. */ + +/* Function codes. */ +#define X509_F_ADD_CERT_DIR 100 +#define X509_F_BY_FILE_CTRL 101 +#define X509_F_CHECK_POLICY 145 +#define X509_F_DIR_CTRL 102 +#define X509_F_GET_CERT_BY_SUBJECT 103 +#define X509_F_NETSCAPE_SPKI_B64_DECODE 129 +#define X509_F_NETSCAPE_SPKI_B64_ENCODE 130 +#define X509_F_X509AT_ADD1_ATTR 135 +#define X509_F_X509V3_ADD_EXT 104 +#define X509_F_X509_ATTRIBUTE_CREATE_BY_NID 136 +#define X509_F_X509_ATTRIBUTE_CREATE_BY_OBJ 137 +#define X509_F_X509_ATTRIBUTE_CREATE_BY_TXT 140 +#define X509_F_X509_ATTRIBUTE_GET0_DATA 139 +#define X509_F_X509_ATTRIBUTE_SET1_DATA 138 +#define X509_F_X509_CHECK_PRIVATE_KEY 128 +#define X509_F_X509_CRL_PRINT_FP 147 +#define X509_F_X509_EXTENSION_CREATE_BY_NID 108 +#define X509_F_X509_EXTENSION_CREATE_BY_OBJ 109 +#define X509_F_X509_GET_PUBKEY_PARAMETERS 110 +#define X509_F_X509_LOAD_CERT_CRL_FILE 132 +#define X509_F_X509_LOAD_CERT_FILE 111 +#define X509_F_X509_LOAD_CRL_FILE 112 +#define X509_F_X509_NAME_ADD_ENTRY 113 +#define X509_F_X509_NAME_ENTRY_CREATE_BY_NID 114 +#define X509_F_X509_NAME_ENTRY_CREATE_BY_TXT 131 +#define X509_F_X509_NAME_ENTRY_SET_OBJECT 115 +#define X509_F_X509_NAME_ONELINE 116 +#define X509_F_X509_NAME_PRINT 117 +#define X509_F_X509_PRINT_EX_FP 118 +#define X509_F_X509_PUBKEY_GET 119 +#define X509_F_X509_PUBKEY_SET 120 +#define X509_F_X509_REQ_CHECK_PRIVATE_KEY 144 +#define X509_F_X509_REQ_PRINT_EX 121 +#define X509_F_X509_REQ_PRINT_FP 122 +#define X509_F_X509_REQ_TO_X509 123 +#define X509_F_X509_STORE_ADD_CERT 124 +#define X509_F_X509_STORE_ADD_CRL 125 +#define X509_F_X509_STORE_CTX_GET1_ISSUER 146 +#define X509_F_X509_STORE_CTX_INIT 143 +#define X509_F_X509_STORE_CTX_NEW 142 +#define X509_F_X509_STORE_CTX_PURPOSE_INHERIT 134 +#define X509_F_X509_TO_X509_REQ 126 +#define X509_F_X509_TRUST_ADD 133 +#define X509_F_X509_TRUST_SET 141 +#define X509_F_X509_VERIFY_CERT 127 + +/* Reason codes. */ +#define X509_R_BAD_X509_FILETYPE 100 +#define X509_R_BASE64_DECODE_ERROR 118 +#define X509_R_CANT_CHECK_DH_KEY 114 +#define X509_R_CERT_ALREADY_IN_HASH_TABLE 101 +#define X509_R_ERR_ASN1_LIB 102 +#define X509_R_INVALID_DIRECTORY 113 +#define X509_R_INVALID_FIELD_NAME 119 +#define X509_R_INVALID_TRUST 123 +#define X509_R_KEY_TYPE_MISMATCH 115 +#define X509_R_KEY_VALUES_MISMATCH 116 +#define X509_R_LOADING_CERT_DIR 103 +#define X509_R_LOADING_DEFAULTS 104 +#define X509_R_METHOD_NOT_SUPPORTED 124 +#define X509_R_NO_CERT_SET_FOR_US_TO_VERIFY 105 +#define X509_R_PUBLIC_KEY_DECODE_ERROR 125 +#define X509_R_PUBLIC_KEY_ENCODE_ERROR 126 +#define X509_R_SHOULD_RETRY 106 +#define X509_R_UNABLE_TO_FIND_PARAMETERS_IN_CHAIN 107 +#define X509_R_UNABLE_TO_GET_CERTS_PUBLIC_KEY 108 +#define X509_R_UNKNOWN_KEY_TYPE 117 +#define X509_R_UNKNOWN_NID 109 +#define X509_R_UNKNOWN_PURPOSE_ID 121 +#define X509_R_UNKNOWN_TRUST_ID 120 +#define X509_R_UNSUPPORTED_ALGORITHM 111 +#define X509_R_WRONG_LOOKUP_TYPE 112 +#define X509_R_WRONG_TYPE 122 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Include/openssl/x509_vfy.h b/Source/Import/OpenSSL/Include/openssl/x509_vfy.h new file mode 100644 index 0000000..fe09b30 --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/x509_vfy.h @@ -0,0 +1,567 @@ +/* crypto/x509/x509_vfy.h */ +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +#ifndef HEADER_X509_H +#include +/* openssl/x509.h ends up #include-ing this file at about the only + * appropriate moment. */ +#endif + +#ifndef HEADER_X509_VFY_H +#define HEADER_X509_VFY_H + +#include +#ifndef OPENSSL_NO_LHASH +#include +#endif +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#if 0 +/* Outer object */ +typedef struct x509_hash_dir_st + { + int num_dirs; + char **dirs; + int *dirs_type; + int num_dirs_alloced; + } X509_HASH_DIR_CTX; +#endif + +typedef struct x509_file_st + { + int num_paths; /* number of paths to files or directories */ + int num_alloced; + char **paths; /* the list of paths or directories */ + int *path_type; + } X509_CERT_FILE_CTX; + +/*******************************/ +/* +SSL_CTX -> X509_STORE + -> X509_LOOKUP + ->X509_LOOKUP_METHOD + -> X509_LOOKUP + ->X509_LOOKUP_METHOD + +SSL -> X509_STORE_CTX + ->X509_STORE + +The X509_STORE holds the tables etc for verification stuff. +A X509_STORE_CTX is used while validating a single certificate. +The X509_STORE has X509_LOOKUPs for looking up certs. +The X509_STORE then calls a function to actually verify the +certificate chain. +*/ + +#define X509_LU_RETRY -1 +#define X509_LU_FAIL 0 +#define X509_LU_X509 1 +#define X509_LU_CRL 2 +#define X509_LU_PKEY 3 + +typedef struct x509_object_st + { + /* one of the above types */ + int type; + union { + char *ptr; + X509 *x509; + X509_CRL *crl; + EVP_PKEY *pkey; + } data; + } X509_OBJECT; + +typedef struct x509_lookup_st X509_LOOKUP; + +DECLARE_STACK_OF(X509_LOOKUP) +DECLARE_STACK_OF(X509_OBJECT) + +/* This is a static that defines the function interface */ +typedef struct x509_lookup_method_st + { + const char *name; + int (*new_item)(X509_LOOKUP *ctx); + void (*free)(X509_LOOKUP *ctx); + int (*init)(X509_LOOKUP *ctx); + int (*shutdown)(X509_LOOKUP *ctx); + int (*ctrl)(X509_LOOKUP *ctx,int cmd,const char *argc,long argl, + char **ret); + int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name, + X509_OBJECT *ret); + int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name, + ASN1_INTEGER *serial,X509_OBJECT *ret); + int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type, + unsigned char *bytes,int len, + X509_OBJECT *ret); + int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len, + X509_OBJECT *ret); + } X509_LOOKUP_METHOD; + +/* This structure hold all parameters associated with a verify operation + * by including an X509_VERIFY_PARAM structure in related structures the + * parameters used can be customized + */ + +typedef struct X509_VERIFY_PARAM_st + { + char *name; + time_t check_time; /* Time to use */ + unsigned long inh_flags; /* Inheritance flags */ + unsigned long flags; /* Various verify flags */ + int purpose; /* purpose to check untrusted certificates */ + int trust; /* trust setting to check */ + int depth; /* Verify depth */ + STACK_OF(ASN1_OBJECT) *policies; /* Permissible policies */ + } X509_VERIFY_PARAM; + +DECLARE_STACK_OF(X509_VERIFY_PARAM) + +/* This is used to hold everything. It is used for all certificate + * validation. Once we have a certificate chain, the 'verify' + * function is then called to actually check the cert chain. */ +struct x509_store_st + { + /* The following is a cache of trusted certs */ + int cache; /* if true, stash any hits */ + STACK_OF(X509_OBJECT) *objs; /* Cache of all objects */ + + /* These are external lookup methods */ + STACK_OF(X509_LOOKUP) *get_cert_methods; + + X509_VERIFY_PARAM *param; + + /* Callbacks for various operations */ + int (*verify)(X509_STORE_CTX *ctx); /* called to verify a certificate */ + int (*verify_cb)(int ok,X509_STORE_CTX *ctx); /* error callback */ + int (*get_issuer)(X509 **issuer, X509_STORE_CTX *ctx, X509 *x); /* get issuers cert from ctx */ + int (*check_issued)(X509_STORE_CTX *ctx, X509 *x, X509 *issuer); /* check issued */ + int (*check_revocation)(X509_STORE_CTX *ctx); /* Check revocation status of chain */ + int (*get_crl)(X509_STORE_CTX *ctx, X509_CRL **crl, X509 *x); /* retrieve CRL */ + int (*check_crl)(X509_STORE_CTX *ctx, X509_CRL *crl); /* Check CRL validity */ + int (*cert_crl)(X509_STORE_CTX *ctx, X509_CRL *crl, X509 *x); /* Check certificate against CRL */ + STACK_OF(X509) * (*lookup_certs)(X509_STORE_CTX *ctx, X509_NAME *nm); + STACK_OF(X509_CRL) * (*lookup_crls)(X509_STORE_CTX *ctx, X509_NAME *nm); + int (*cleanup)(X509_STORE_CTX *ctx); + + CRYPTO_EX_DATA ex_data; + int references; + } /* X509_STORE */; + +int X509_STORE_set_depth(X509_STORE *store, int depth); + +#define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func)) +#define X509_STORE_set_verify_func(ctx,func) ((ctx)->verify=(func)) + +/* This is the functions plus an instance of the local variables. */ +struct x509_lookup_st + { + int init; /* have we been started */ + int skip; /* don't use us. */ + X509_LOOKUP_METHOD *method; /* the functions */ + char *method_data; /* method data */ + + X509_STORE *store_ctx; /* who owns us */ + } /* X509_LOOKUP */; + +/* This is a used when verifying cert chains. Since the + * gathering of the cert chain can take some time (and have to be + * 'retried', this needs to be kept and passed around. */ +struct x509_store_ctx_st /* X509_STORE_CTX */ + { + X509_STORE *ctx; + int current_method; /* used when looking up certs */ + + /* The following are set by the caller */ + X509 *cert; /* The cert to check */ + STACK_OF(X509) *untrusted; /* chain of X509s - untrusted - passed in */ + STACK_OF(X509_CRL) *crls; /* set of CRLs passed in */ + + X509_VERIFY_PARAM *param; + void *other_ctx; /* Other info for use with get_issuer() */ + + /* Callbacks for various operations */ + int (*verify)(X509_STORE_CTX *ctx); /* called to verify a certificate */ + int (*verify_cb)(int ok,X509_STORE_CTX *ctx); /* error callback */ + int (*get_issuer)(X509 **issuer, X509_STORE_CTX *ctx, X509 *x); /* get issuers cert from ctx */ + int (*check_issued)(X509_STORE_CTX *ctx, X509 *x, X509 *issuer); /* check issued */ + int (*check_revocation)(X509_STORE_CTX *ctx); /* Check revocation status of chain */ + int (*get_crl)(X509_STORE_CTX *ctx, X509_CRL **crl, X509 *x); /* retrieve CRL */ + int (*check_crl)(X509_STORE_CTX *ctx, X509_CRL *crl); /* Check CRL validity */ + int (*cert_crl)(X509_STORE_CTX *ctx, X509_CRL *crl, X509 *x); /* Check certificate against CRL */ + int (*check_policy)(X509_STORE_CTX *ctx); + STACK_OF(X509) * (*lookup_certs)(X509_STORE_CTX *ctx, X509_NAME *nm); + STACK_OF(X509_CRL) * (*lookup_crls)(X509_STORE_CTX *ctx, X509_NAME *nm); + int (*cleanup)(X509_STORE_CTX *ctx); + + /* The following is built up */ + int valid; /* if 0, rebuild chain */ + int last_untrusted; /* index of last untrusted cert */ + STACK_OF(X509) *chain; /* chain of X509s - built up and trusted */ + X509_POLICY_TREE *tree; /* Valid policy tree */ + + int explicit_policy; /* Require explicit policy value */ + + /* When something goes wrong, this is why */ + int error_depth; + int error; + X509 *current_cert; + X509 *current_issuer; /* cert currently being tested as valid issuer */ + X509_CRL *current_crl; /* current CRL */ + + int current_crl_score; /* score of current CRL */ + unsigned int current_reasons; /* Reason mask */ + + X509_STORE_CTX *parent; /* For CRL path validation: parent context */ + + CRYPTO_EX_DATA ex_data; + } /* X509_STORE_CTX */; + +void X509_STORE_CTX_set_depth(X509_STORE_CTX *ctx, int depth); + +#define X509_STORE_CTX_set_app_data(ctx,data) \ + X509_STORE_CTX_set_ex_data(ctx,0,data) +#define X509_STORE_CTX_get_app_data(ctx) \ + X509_STORE_CTX_get_ex_data(ctx,0) + +#define X509_L_FILE_LOAD 1 +#define X509_L_ADD_DIR 2 + +#define X509_LOOKUP_load_file(x,name,type) \ + X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL) + +#define X509_LOOKUP_add_dir(x,name,type) \ + X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL) + +#define X509_V_OK 0 +/* illegal error (for uninitialized values, to avoid X509_V_OK): 1 */ + +#define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT 2 +#define X509_V_ERR_UNABLE_TO_GET_CRL 3 +#define X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE 4 +#define X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE 5 +#define X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY 6 +#define X509_V_ERR_CERT_SIGNATURE_FAILURE 7 +#define X509_V_ERR_CRL_SIGNATURE_FAILURE 8 +#define X509_V_ERR_CERT_NOT_YET_VALID 9 +#define X509_V_ERR_CERT_HAS_EXPIRED 10 +#define X509_V_ERR_CRL_NOT_YET_VALID 11 +#define X509_V_ERR_CRL_HAS_EXPIRED 12 +#define X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD 13 +#define X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD 14 +#define X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD 15 +#define X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD 16 +#define X509_V_ERR_OUT_OF_MEM 17 +#define X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT 18 +#define X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN 19 +#define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY 20 +#define X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE 21 +#define X509_V_ERR_CERT_CHAIN_TOO_LONG 22 +#define X509_V_ERR_CERT_REVOKED 23 +#define X509_V_ERR_INVALID_CA 24 +#define X509_V_ERR_PATH_LENGTH_EXCEEDED 25 +#define X509_V_ERR_INVALID_PURPOSE 26 +#define X509_V_ERR_CERT_UNTRUSTED 27 +#define X509_V_ERR_CERT_REJECTED 28 +/* These are 'informational' when looking for issuer cert */ +#define X509_V_ERR_SUBJECT_ISSUER_MISMATCH 29 +#define X509_V_ERR_AKID_SKID_MISMATCH 30 +#define X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH 31 +#define X509_V_ERR_KEYUSAGE_NO_CERTSIGN 32 + +#define X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER 33 +#define X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION 34 +#define X509_V_ERR_KEYUSAGE_NO_CRL_SIGN 35 +#define X509_V_ERR_UNHANDLED_CRITICAL_CRL_EXTENSION 36 +#define X509_V_ERR_INVALID_NON_CA 37 +#define X509_V_ERR_PROXY_PATH_LENGTH_EXCEEDED 38 +#define X509_V_ERR_KEYUSAGE_NO_DIGITAL_SIGNATURE 39 +#define X509_V_ERR_PROXY_CERTIFICATES_NOT_ALLOWED 40 + +#define X509_V_ERR_INVALID_EXTENSION 41 +#define X509_V_ERR_INVALID_POLICY_EXTENSION 42 +#define X509_V_ERR_NO_EXPLICIT_POLICY 43 +#define X509_V_ERR_DIFFERENT_CRL_SCOPE 44 +#define X509_V_ERR_UNSUPPORTED_EXTENSION_FEATURE 45 + +#define X509_V_ERR_UNNESTED_RESOURCE 46 + +#define X509_V_ERR_PERMITTED_VIOLATION 47 +#define X509_V_ERR_EXCLUDED_VIOLATION 48 +#define X509_V_ERR_SUBTREE_MINMAX 49 +#define X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE 51 +#define X509_V_ERR_UNSUPPORTED_CONSTRAINT_SYNTAX 52 +#define X509_V_ERR_UNSUPPORTED_NAME_SYNTAX 53 +#define X509_V_ERR_CRL_PATH_VALIDATION_ERROR 54 + +/* The application is not happy */ +#define X509_V_ERR_APPLICATION_VERIFICATION 50 + +/* Certificate verify flags */ + +/* Send issuer+subject checks to verify_cb */ +#define X509_V_FLAG_CB_ISSUER_CHECK 0x1 +/* Use check time instead of current time */ +#define X509_V_FLAG_USE_CHECK_TIME 0x2 +/* Lookup CRLs */ +#define X509_V_FLAG_CRL_CHECK 0x4 +/* Lookup CRLs for whole chain */ +#define X509_V_FLAG_CRL_CHECK_ALL 0x8 +/* Ignore unhandled critical extensions */ +#define X509_V_FLAG_IGNORE_CRITICAL 0x10 +/* Disable workarounds for broken certificates */ +#define X509_V_FLAG_X509_STRICT 0x20 +/* Enable proxy certificate validation */ +#define X509_V_FLAG_ALLOW_PROXY_CERTS 0x40 +/* Enable policy checking */ +#define X509_V_FLAG_POLICY_CHECK 0x80 +/* Policy variable require-explicit-policy */ +#define X509_V_FLAG_EXPLICIT_POLICY 0x100 +/* Policy variable inhibit-any-policy */ +#define X509_V_FLAG_INHIBIT_ANY 0x200 +/* Policy variable inhibit-policy-mapping */ +#define X509_V_FLAG_INHIBIT_MAP 0x400 +/* Notify callback that policy is OK */ +#define X509_V_FLAG_NOTIFY_POLICY 0x800 +/* Extended CRL features such as indirect CRLs, alternate CRL signing keys */ +#define X509_V_FLAG_EXTENDED_CRL_SUPPORT 0x1000 +/* Delta CRL support */ +#define X509_V_FLAG_USE_DELTAS 0x2000 +/* Check selfsigned CA signature */ +#define X509_V_FLAG_CHECK_SS_SIGNATURE 0x4000 + + +#define X509_VP_FLAG_DEFAULT 0x1 +#define X509_VP_FLAG_OVERWRITE 0x2 +#define X509_VP_FLAG_RESET_FLAGS 0x4 +#define X509_VP_FLAG_LOCKED 0x8 +#define X509_VP_FLAG_ONCE 0x10 + +/* Internal use: mask of policy related options */ +#define X509_V_FLAG_POLICY_MASK (X509_V_FLAG_POLICY_CHECK \ + | X509_V_FLAG_EXPLICIT_POLICY \ + | X509_V_FLAG_INHIBIT_ANY \ + | X509_V_FLAG_INHIBIT_MAP) + +int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type, + X509_NAME *name); +X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h,int type,X509_NAME *name); +X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h, X509_OBJECT *x); +void X509_OBJECT_up_ref_count(X509_OBJECT *a); +void X509_OBJECT_free_contents(X509_OBJECT *a); +X509_STORE *X509_STORE_new(void ); +void X509_STORE_free(X509_STORE *v); + +STACK_OF(X509)* X509_STORE_get1_certs(X509_STORE_CTX *st, X509_NAME *nm); +STACK_OF(X509_CRL)* X509_STORE_get1_crls(X509_STORE_CTX *st, X509_NAME *nm); +int X509_STORE_set_flags(X509_STORE *ctx, unsigned long flags); +int X509_STORE_set_purpose(X509_STORE *ctx, int purpose); +int X509_STORE_set_trust(X509_STORE *ctx, int trust); +int X509_STORE_set1_param(X509_STORE *ctx, X509_VERIFY_PARAM *pm); + +void X509_STORE_set_verify_cb(X509_STORE *ctx, + int (*verify_cb)(int, X509_STORE_CTX *)); + +X509_STORE_CTX *X509_STORE_CTX_new(void); + +int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x); + +void X509_STORE_CTX_free(X509_STORE_CTX *ctx); +int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store, + X509 *x509, STACK_OF(X509) *chain); +void X509_STORE_CTX_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk); +void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx); + +X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m); + +X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void); +X509_LOOKUP_METHOD *X509_LOOKUP_file(void); + +int X509_STORE_add_cert(X509_STORE *ctx, X509 *x); +int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x); + +int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name, + X509_OBJECT *ret); + +int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc, + long argl, char **ret); + +#ifndef OPENSSL_NO_STDIO +int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type); +int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type); +int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type); +#endif + + +X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method); +void X509_LOOKUP_free(X509_LOOKUP *ctx); +int X509_LOOKUP_init(X509_LOOKUP *ctx); +int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name, + X509_OBJECT *ret); +int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name, + ASN1_INTEGER *serial, X509_OBJECT *ret); +int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type, + unsigned char *bytes, int len, X509_OBJECT *ret); +int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str, + int len, X509_OBJECT *ret); +int X509_LOOKUP_shutdown(X509_LOOKUP *ctx); + +#ifndef OPENSSL_NO_STDIO +int X509_STORE_load_locations (X509_STORE *ctx, + const char *file, const char *dir); +int X509_STORE_set_default_paths(X509_STORE *ctx); +#endif + +int X509_STORE_CTX_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, + CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); +int X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,void *data); +void * X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx); +int X509_STORE_CTX_get_error(X509_STORE_CTX *ctx); +void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s); +int X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx); +X509 * X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx); +X509 *X509_STORE_CTX_get0_current_issuer(X509_STORE_CTX *ctx); +X509_CRL *X509_STORE_CTX_get0_current_crl(X509_STORE_CTX *ctx); +X509_STORE_CTX *X509_STORE_CTX_get0_parent_ctx(X509_STORE_CTX *ctx); +STACK_OF(X509) *X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx); +STACK_OF(X509) *X509_STORE_CTX_get1_chain(X509_STORE_CTX *ctx); +void X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x); +void X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK_OF(X509) *sk); +void X509_STORE_CTX_set0_crls(X509_STORE_CTX *c,STACK_OF(X509_CRL) *sk); +int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose); +int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust); +int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose, + int purpose, int trust); +void X509_STORE_CTX_set_flags(X509_STORE_CTX *ctx, unsigned long flags); +void X509_STORE_CTX_set_time(X509_STORE_CTX *ctx, unsigned long flags, + time_t t); +void X509_STORE_CTX_set_verify_cb(X509_STORE_CTX *ctx, + int (*verify_cb)(int, X509_STORE_CTX *)); + +X509_POLICY_TREE *X509_STORE_CTX_get0_policy_tree(X509_STORE_CTX *ctx); +int X509_STORE_CTX_get_explicit_policy(X509_STORE_CTX *ctx); + +X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(X509_STORE_CTX *ctx); +void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param); +int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name); + +/* X509_VERIFY_PARAM functions */ + +X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void); +void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param); +int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *to, + const X509_VERIFY_PARAM *from); +int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to, + const X509_VERIFY_PARAM *from); +int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name); +int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags); +int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param, + unsigned long flags); +unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param); +int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose); +int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust); +void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth); +void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t); +int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param, + ASN1_OBJECT *policy); +int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param, + STACK_OF(ASN1_OBJECT) *policies); +int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param); + +int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param); +const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name); +void X509_VERIFY_PARAM_table_cleanup(void); + +int X509_policy_check(X509_POLICY_TREE **ptree, int *pexplicit_policy, + STACK_OF(X509) *certs, + STACK_OF(ASN1_OBJECT) *policy_oids, + unsigned int flags); + +void X509_policy_tree_free(X509_POLICY_TREE *tree); + +int X509_policy_tree_level_count(const X509_POLICY_TREE *tree); +X509_POLICY_LEVEL * + X509_policy_tree_get0_level(const X509_POLICY_TREE *tree, int i); + +STACK_OF(X509_POLICY_NODE) * + X509_policy_tree_get0_policies(const X509_POLICY_TREE *tree); + +STACK_OF(X509_POLICY_NODE) * + X509_policy_tree_get0_user_policies(const X509_POLICY_TREE *tree); + +int X509_policy_level_node_count(X509_POLICY_LEVEL *level); + +X509_POLICY_NODE *X509_policy_level_get0_node(X509_POLICY_LEVEL *level, int i); + +const ASN1_OBJECT *X509_policy_node_get0_policy(const X509_POLICY_NODE *node); + +STACK_OF(POLICYQUALINFO) * + X509_policy_node_get0_qualifiers(const X509_POLICY_NODE *node); +const X509_POLICY_NODE * + X509_policy_node_get0_parent(const X509_POLICY_NODE *node); + +#ifdef __cplusplus +} +#endif +#endif + diff --git a/Source/Import/OpenSSL/Include/openssl/x509v3.h b/Source/Import/OpenSSL/Include/openssl/x509v3.h new file mode 100644 index 0000000..b308abe --- /dev/null +++ b/Source/Import/OpenSSL/Include/openssl/x509v3.h @@ -0,0 +1,1007 @@ +/* x509v3.h */ +/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL + * project 1999. + */ +/* ==================================================================== + * Copyright (c) 1999-2004 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * licensing@OpenSSL.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ +#ifndef HEADER_X509V3_H +#define HEADER_X509V3_H + +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Forward reference */ +struct v3_ext_method; +struct v3_ext_ctx; + +/* Useful typedefs */ + +typedef void * (*X509V3_EXT_NEW)(void); +typedef void (*X509V3_EXT_FREE)(void *); +typedef void * (*X509V3_EXT_D2I)(void *, const unsigned char ** , long); +typedef int (*X509V3_EXT_I2D)(void *, unsigned char **); +typedef STACK_OF(CONF_VALUE) * + (*X509V3_EXT_I2V)(const struct v3_ext_method *method, void *ext, + STACK_OF(CONF_VALUE) *extlist); +typedef void * (*X509V3_EXT_V2I)(const struct v3_ext_method *method, + struct v3_ext_ctx *ctx, + STACK_OF(CONF_VALUE) *values); +typedef char * (*X509V3_EXT_I2S)(const struct v3_ext_method *method, void *ext); +typedef void * (*X509V3_EXT_S2I)(const struct v3_ext_method *method, + struct v3_ext_ctx *ctx, const char *str); +typedef int (*X509V3_EXT_I2R)(const struct v3_ext_method *method, void *ext, + BIO *out, int indent); +typedef void * (*X509V3_EXT_R2I)(const struct v3_ext_method *method, + struct v3_ext_ctx *ctx, const char *str); + +/* V3 extension structure */ + +struct v3_ext_method { +int ext_nid; +int ext_flags; +/* If this is set the following four fields are ignored */ +ASN1_ITEM_EXP *it; +/* Old style ASN1 calls */ +X509V3_EXT_NEW ext_new; +X509V3_EXT_FREE ext_free; +X509V3_EXT_D2I d2i; +X509V3_EXT_I2D i2d; + +/* The following pair is used for string extensions */ +X509V3_EXT_I2S i2s; +X509V3_EXT_S2I s2i; + +/* The following pair is used for multi-valued extensions */ +X509V3_EXT_I2V i2v; +X509V3_EXT_V2I v2i; + +/* The following are used for raw extensions */ +X509V3_EXT_I2R i2r; +X509V3_EXT_R2I r2i; + +void *usr_data; /* Any extension specific data */ +}; + +typedef struct X509V3_CONF_METHOD_st { +char * (*get_string)(void *db, char *section, char *value); +STACK_OF(CONF_VALUE) * (*get_section)(void *db, char *section); +void (*free_string)(void *db, char * string); +void (*free_section)(void *db, STACK_OF(CONF_VALUE) *section); +} X509V3_CONF_METHOD; + +/* Context specific info */ +struct v3_ext_ctx { +#define CTX_TEST 0x1 +int flags; +X509 *issuer_cert; +X509 *subject_cert; +X509_REQ *subject_req; +X509_CRL *crl; +X509V3_CONF_METHOD *db_meth; +void *db; +/* Maybe more here */ +}; + +typedef struct v3_ext_method X509V3_EXT_METHOD; + +DECLARE_STACK_OF(X509V3_EXT_METHOD) + +/* ext_flags values */ +#define X509V3_EXT_DYNAMIC 0x1 +#define X509V3_EXT_CTX_DEP 0x2 +#define X509V3_EXT_MULTILINE 0x4 + +typedef BIT_STRING_BITNAME ENUMERATED_NAMES; + +typedef struct BASIC_CONSTRAINTS_st { +int ca; +ASN1_INTEGER *pathlen; +} BASIC_CONSTRAINTS; + + +typedef struct PKEY_USAGE_PERIOD_st { +ASN1_GENERALIZEDTIME *notBefore; +ASN1_GENERALIZEDTIME *notAfter; +} PKEY_USAGE_PERIOD; + +typedef struct otherName_st { +ASN1_OBJECT *type_id; +ASN1_TYPE *value; +} OTHERNAME; + +typedef struct EDIPartyName_st { + ASN1_STRING *nameAssigner; + ASN1_STRING *partyName; +} EDIPARTYNAME; + +typedef struct GENERAL_NAME_st { + +#define GEN_OTHERNAME 0 +#define GEN_EMAIL 1 +#define GEN_DNS 2 +#define GEN_X400 3 +#define GEN_DIRNAME 4 +#define GEN_EDIPARTY 5 +#define GEN_URI 6 +#define GEN_IPADD 7 +#define GEN_RID 8 + +int type; +union { + char *ptr; + OTHERNAME *otherName; /* otherName */ + ASN1_IA5STRING *rfc822Name; + ASN1_IA5STRING *dNSName; + ASN1_TYPE *x400Address; + X509_NAME *directoryName; + EDIPARTYNAME *ediPartyName; + ASN1_IA5STRING *uniformResourceIdentifier; + ASN1_OCTET_STRING *iPAddress; + ASN1_OBJECT *registeredID; + + /* Old names */ + ASN1_OCTET_STRING *ip; /* iPAddress */ + X509_NAME *dirn; /* dirn */ + ASN1_IA5STRING *ia5;/* rfc822Name, dNSName, uniformResourceIdentifier */ + ASN1_OBJECT *rid; /* registeredID */ + ASN1_TYPE *other; /* x400Address */ +} d; +} GENERAL_NAME; + +typedef STACK_OF(GENERAL_NAME) GENERAL_NAMES; + +typedef struct ACCESS_DESCRIPTION_st { + ASN1_OBJECT *method; + GENERAL_NAME *location; +} ACCESS_DESCRIPTION; + +typedef STACK_OF(ACCESS_DESCRIPTION) AUTHORITY_INFO_ACCESS; + +typedef STACK_OF(ASN1_OBJECT) EXTENDED_KEY_USAGE; + +DECLARE_STACK_OF(GENERAL_NAME) +DECLARE_ASN1_SET_OF(GENERAL_NAME) + +DECLARE_STACK_OF(ACCESS_DESCRIPTION) +DECLARE_ASN1_SET_OF(ACCESS_DESCRIPTION) + +typedef struct DIST_POINT_NAME_st { +int type; +union { + GENERAL_NAMES *fullname; + STACK_OF(X509_NAME_ENTRY) *relativename; +} name; +/* If relativename then this contains the full distribution point name */ +X509_NAME *dpname; +} DIST_POINT_NAME; +/* All existing reasons */ +#define CRLDP_ALL_REASONS 0x807f + +#define CRL_REASON_NONE -1 +#define CRL_REASON_UNSPECIFIED 0 +#define CRL_REASON_KEY_COMPROMISE 1 +#define CRL_REASON_CA_COMPROMISE 2 +#define CRL_REASON_AFFILIATION_CHANGED 3 +#define CRL_REASON_SUPERSEDED 4 +#define CRL_REASON_CESSATION_OF_OPERATION 5 +#define CRL_REASON_CERTIFICATE_HOLD 6 +#define CRL_REASON_REMOVE_FROM_CRL 8 +#define CRL_REASON_PRIVILEGE_WITHDRAWN 9 +#define CRL_REASON_AA_COMPROMISE 10 + +struct DIST_POINT_st { +DIST_POINT_NAME *distpoint; +ASN1_BIT_STRING *reasons; +GENERAL_NAMES *CRLissuer; +int dp_reasons; +}; + +typedef STACK_OF(DIST_POINT) CRL_DIST_POINTS; + +DECLARE_STACK_OF(DIST_POINT) +DECLARE_ASN1_SET_OF(DIST_POINT) + +struct AUTHORITY_KEYID_st { +ASN1_OCTET_STRING *keyid; +GENERAL_NAMES *issuer; +ASN1_INTEGER *serial; +}; + +/* Strong extranet structures */ + +typedef struct SXNET_ID_st { + ASN1_INTEGER *zone; + ASN1_OCTET_STRING *user; +} SXNETID; + +DECLARE_STACK_OF(SXNETID) +DECLARE_ASN1_SET_OF(SXNETID) + +typedef struct SXNET_st { + ASN1_INTEGER *version; + STACK_OF(SXNETID) *ids; +} SXNET; + +typedef struct NOTICEREF_st { + ASN1_STRING *organization; + STACK_OF(ASN1_INTEGER) *noticenos; +} NOTICEREF; + +typedef struct USERNOTICE_st { + NOTICEREF *noticeref; + ASN1_STRING *exptext; +} USERNOTICE; + +typedef struct POLICYQUALINFO_st { + ASN1_OBJECT *pqualid; + union { + ASN1_IA5STRING *cpsuri; + USERNOTICE *usernotice; + ASN1_TYPE *other; + } d; +} POLICYQUALINFO; + +DECLARE_STACK_OF(POLICYQUALINFO) +DECLARE_ASN1_SET_OF(POLICYQUALINFO) + +typedef struct POLICYINFO_st { + ASN1_OBJECT *policyid; + STACK_OF(POLICYQUALINFO) *qualifiers; +} POLICYINFO; + +typedef STACK_OF(POLICYINFO) CERTIFICATEPOLICIES; + +DECLARE_STACK_OF(POLICYINFO) +DECLARE_ASN1_SET_OF(POLICYINFO) + +typedef struct POLICY_MAPPING_st { + ASN1_OBJECT *issuerDomainPolicy; + ASN1_OBJECT *subjectDomainPolicy; +} POLICY_MAPPING; + +DECLARE_STACK_OF(POLICY_MAPPING) + +typedef STACK_OF(POLICY_MAPPING) POLICY_MAPPINGS; + +typedef struct GENERAL_SUBTREE_st { + GENERAL_NAME *base; + ASN1_INTEGER *minimum; + ASN1_INTEGER *maximum; +} GENERAL_SUBTREE; + +DECLARE_STACK_OF(GENERAL_SUBTREE) + +struct NAME_CONSTRAINTS_st { + STACK_OF(GENERAL_SUBTREE) *permittedSubtrees; + STACK_OF(GENERAL_SUBTREE) *excludedSubtrees; +}; + +typedef struct POLICY_CONSTRAINTS_st { + ASN1_INTEGER *requireExplicitPolicy; + ASN1_INTEGER *inhibitPolicyMapping; +} POLICY_CONSTRAINTS; + +/* Proxy certificate structures, see RFC 3820 */ +typedef struct PROXY_POLICY_st + { + ASN1_OBJECT *policyLanguage; + ASN1_OCTET_STRING *policy; + } PROXY_POLICY; + +typedef struct PROXY_CERT_INFO_EXTENSION_st + { + ASN1_INTEGER *pcPathLengthConstraint; + PROXY_POLICY *proxyPolicy; + } PROXY_CERT_INFO_EXTENSION; + +DECLARE_ASN1_FUNCTIONS(PROXY_POLICY) +DECLARE_ASN1_FUNCTIONS(PROXY_CERT_INFO_EXTENSION) + +struct ISSUING_DIST_POINT_st + { + DIST_POINT_NAME *distpoint; + int onlyuser; + int onlyCA; + ASN1_BIT_STRING *onlysomereasons; + int indirectCRL; + int onlyattr; + }; + +/* Values in idp_flags field */ +/* IDP present */ +#define IDP_PRESENT 0x1 +/* IDP values inconsistent */ +#define IDP_INVALID 0x2 +/* onlyuser true */ +#define IDP_ONLYUSER 0x4 +/* onlyCA true */ +#define IDP_ONLYCA 0x8 +/* onlyattr true */ +#define IDP_ONLYATTR 0x10 +/* indirectCRL true */ +#define IDP_INDIRECT 0x20 +/* onlysomereasons present */ +#define IDP_REASONS 0x40 + +#define X509V3_conf_err(val) ERR_add_error_data(6, "section:", val->section, \ +",name:", val->name, ",value:", val->value); + +#define X509V3_set_ctx_test(ctx) \ + X509V3_set_ctx(ctx, NULL, NULL, NULL, NULL, CTX_TEST) +#define X509V3_set_ctx_nodb(ctx) (ctx)->db = NULL; + +#define EXT_BITSTRING(nid, table) { nid, 0, ASN1_ITEM_ref(ASN1_BIT_STRING), \ + 0,0,0,0, \ + 0,0, \ + (X509V3_EXT_I2V)i2v_ASN1_BIT_STRING, \ + (X509V3_EXT_V2I)v2i_ASN1_BIT_STRING, \ + NULL, NULL, \ + table} + +#define EXT_IA5STRING(nid) { nid, 0, ASN1_ITEM_ref(ASN1_IA5STRING), \ + 0,0,0,0, \ + (X509V3_EXT_I2S)i2s_ASN1_IA5STRING, \ + (X509V3_EXT_S2I)s2i_ASN1_IA5STRING, \ + 0,0,0,0, \ + NULL} + +#define EXT_END { -1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} + + +/* X509_PURPOSE stuff */ + +#define EXFLAG_BCONS 0x1 +#define EXFLAG_KUSAGE 0x2 +#define EXFLAG_XKUSAGE 0x4 +#define EXFLAG_NSCERT 0x8 + +#define EXFLAG_CA 0x10 +/* Really self issued not necessarily self signed */ +#define EXFLAG_SI 0x20 +#define EXFLAG_SS 0x20 +#define EXFLAG_V1 0x40 +#define EXFLAG_INVALID 0x80 +#define EXFLAG_SET 0x100 +#define EXFLAG_CRITICAL 0x200 +#define EXFLAG_PROXY 0x400 + +#define EXFLAG_INVALID_POLICY 0x800 +#define EXFLAG_FRESHEST 0x1000 + +#define KU_DIGITAL_SIGNATURE 0x0080 +#define KU_NON_REPUDIATION 0x0040 +#define KU_KEY_ENCIPHERMENT 0x0020 +#define KU_DATA_ENCIPHERMENT 0x0010 +#define KU_KEY_AGREEMENT 0x0008 +#define KU_KEY_CERT_SIGN 0x0004 +#define KU_CRL_SIGN 0x0002 +#define KU_ENCIPHER_ONLY 0x0001 +#define KU_DECIPHER_ONLY 0x8000 + +#define NS_SSL_CLIENT 0x80 +#define NS_SSL_SERVER 0x40 +#define NS_SMIME 0x20 +#define NS_OBJSIGN 0x10 +#define NS_SSL_CA 0x04 +#define NS_SMIME_CA 0x02 +#define NS_OBJSIGN_CA 0x01 +#define NS_ANY_CA (NS_SSL_CA|NS_SMIME_CA|NS_OBJSIGN_CA) + +#define XKU_SSL_SERVER 0x1 +#define XKU_SSL_CLIENT 0x2 +#define XKU_SMIME 0x4 +#define XKU_CODE_SIGN 0x8 +#define XKU_SGC 0x10 +#define XKU_OCSP_SIGN 0x20 +#define XKU_TIMESTAMP 0x40 +#define XKU_DVCS 0x80 + +#define X509_PURPOSE_DYNAMIC 0x1 +#define X509_PURPOSE_DYNAMIC_NAME 0x2 + +typedef struct x509_purpose_st { + int purpose; + int trust; /* Default trust ID */ + int flags; + int (*check_purpose)(const struct x509_purpose_st *, + const X509 *, int); + char *name; + char *sname; + void *usr_data; +} X509_PURPOSE; + +#define X509_PURPOSE_SSL_CLIENT 1 +#define X509_PURPOSE_SSL_SERVER 2 +#define X509_PURPOSE_NS_SSL_SERVER 3 +#define X509_PURPOSE_SMIME_SIGN 4 +#define X509_PURPOSE_SMIME_ENCRYPT 5 +#define X509_PURPOSE_CRL_SIGN 6 +#define X509_PURPOSE_ANY 7 +#define X509_PURPOSE_OCSP_HELPER 8 +#define X509_PURPOSE_TIMESTAMP_SIGN 9 + +#define X509_PURPOSE_MIN 1 +#define X509_PURPOSE_MAX 9 + +/* Flags for X509V3_EXT_print() */ + +#define X509V3_EXT_UNKNOWN_MASK (0xfL << 16) +/* Return error for unknown extensions */ +#define X509V3_EXT_DEFAULT 0 +/* Print error for unknown extensions */ +#define X509V3_EXT_ERROR_UNKNOWN (1L << 16) +/* ASN1 parse unknown extensions */ +#define X509V3_EXT_PARSE_UNKNOWN (2L << 16) +/* BIO_dump unknown extensions */ +#define X509V3_EXT_DUMP_UNKNOWN (3L << 16) + +/* Flags for X509V3_add1_i2d */ + +#define X509V3_ADD_OP_MASK 0xfL +#define X509V3_ADD_DEFAULT 0L +#define X509V3_ADD_APPEND 1L +#define X509V3_ADD_REPLACE 2L +#define X509V3_ADD_REPLACE_EXISTING 3L +#define X509V3_ADD_KEEP_EXISTING 4L +#define X509V3_ADD_DELETE 5L +#define X509V3_ADD_SILENT 0x10 + +DECLARE_STACK_OF(X509_PURPOSE) + +DECLARE_ASN1_FUNCTIONS(BASIC_CONSTRAINTS) + +DECLARE_ASN1_FUNCTIONS(SXNET) +DECLARE_ASN1_FUNCTIONS(SXNETID) + +int SXNET_add_id_asc(SXNET **psx, char *zone, char *user, int userlen); +int SXNET_add_id_ulong(SXNET **psx, unsigned long lzone, char *user, int userlen); +int SXNET_add_id_INTEGER(SXNET **psx, ASN1_INTEGER *izone, char *user, int userlen); + +ASN1_OCTET_STRING *SXNET_get_id_asc(SXNET *sx, char *zone); +ASN1_OCTET_STRING *SXNET_get_id_ulong(SXNET *sx, unsigned long lzone); +ASN1_OCTET_STRING *SXNET_get_id_INTEGER(SXNET *sx, ASN1_INTEGER *zone); + +DECLARE_ASN1_FUNCTIONS(AUTHORITY_KEYID) + +DECLARE_ASN1_FUNCTIONS(PKEY_USAGE_PERIOD) + +DECLARE_ASN1_FUNCTIONS(GENERAL_NAME) +GENERAL_NAME *GENERAL_NAME_dup(GENERAL_NAME *a); +int GENERAL_NAME_cmp(GENERAL_NAME *a, GENERAL_NAME *b); + + + +ASN1_BIT_STRING *v2i_ASN1_BIT_STRING(X509V3_EXT_METHOD *method, + X509V3_CTX *ctx, STACK_OF(CONF_VALUE) *nval); +STACK_OF(CONF_VALUE) *i2v_ASN1_BIT_STRING(X509V3_EXT_METHOD *method, + ASN1_BIT_STRING *bits, + STACK_OF(CONF_VALUE) *extlist); + +STACK_OF(CONF_VALUE) *i2v_GENERAL_NAME(X509V3_EXT_METHOD *method, GENERAL_NAME *gen, STACK_OF(CONF_VALUE) *ret); +int GENERAL_NAME_print(BIO *out, GENERAL_NAME *gen); + +DECLARE_ASN1_FUNCTIONS(GENERAL_NAMES) + +STACK_OF(CONF_VALUE) *i2v_GENERAL_NAMES(X509V3_EXT_METHOD *method, + GENERAL_NAMES *gen, STACK_OF(CONF_VALUE) *extlist); +GENERAL_NAMES *v2i_GENERAL_NAMES(const X509V3_EXT_METHOD *method, + X509V3_CTX *ctx, STACK_OF(CONF_VALUE) *nval); + +DECLARE_ASN1_FUNCTIONS(OTHERNAME) +DECLARE_ASN1_FUNCTIONS(EDIPARTYNAME) +int OTHERNAME_cmp(OTHERNAME *a, OTHERNAME *b); +void GENERAL_NAME_set0_value(GENERAL_NAME *a, int type, void *value); +void *GENERAL_NAME_get0_value(GENERAL_NAME *a, int *ptype); +int GENERAL_NAME_set0_othername(GENERAL_NAME *gen, + ASN1_OBJECT *oid, ASN1_TYPE *value); +int GENERAL_NAME_get0_otherName(GENERAL_NAME *gen, + ASN1_OBJECT **poid, ASN1_TYPE **pvalue); + +char *i2s_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method, ASN1_OCTET_STRING *ia5); +ASN1_OCTET_STRING *s2i_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, char *str); + +DECLARE_ASN1_FUNCTIONS(EXTENDED_KEY_USAGE) +int i2a_ACCESS_DESCRIPTION(BIO *bp, ACCESS_DESCRIPTION* a); + +DECLARE_ASN1_FUNCTIONS(CERTIFICATEPOLICIES) +DECLARE_ASN1_FUNCTIONS(POLICYINFO) +DECLARE_ASN1_FUNCTIONS(POLICYQUALINFO) +DECLARE_ASN1_FUNCTIONS(USERNOTICE) +DECLARE_ASN1_FUNCTIONS(NOTICEREF) + +DECLARE_ASN1_FUNCTIONS(CRL_DIST_POINTS) +DECLARE_ASN1_FUNCTIONS(DIST_POINT) +DECLARE_ASN1_FUNCTIONS(DIST_POINT_NAME) +DECLARE_ASN1_FUNCTIONS(ISSUING_DIST_POINT) + +int DIST_POINT_set_dpname(DIST_POINT_NAME *dpn, X509_NAME *iname); + +int NAME_CONSTRAINTS_check(X509 *x, NAME_CONSTRAINTS *nc); + +DECLARE_ASN1_FUNCTIONS(ACCESS_DESCRIPTION) +DECLARE_ASN1_FUNCTIONS(AUTHORITY_INFO_ACCESS) + +DECLARE_ASN1_ITEM(POLICY_MAPPING) +DECLARE_ASN1_ALLOC_FUNCTIONS(POLICY_MAPPING) +DECLARE_ASN1_ITEM(POLICY_MAPPINGS) + +DECLARE_ASN1_ITEM(GENERAL_SUBTREE) +DECLARE_ASN1_ALLOC_FUNCTIONS(GENERAL_SUBTREE) + +DECLARE_ASN1_ITEM(NAME_CONSTRAINTS) +DECLARE_ASN1_ALLOC_FUNCTIONS(NAME_CONSTRAINTS) + +DECLARE_ASN1_ALLOC_FUNCTIONS(POLICY_CONSTRAINTS) +DECLARE_ASN1_ITEM(POLICY_CONSTRAINTS) + +GENERAL_NAME *a2i_GENERAL_NAME(GENERAL_NAME *out, + const X509V3_EXT_METHOD *method, X509V3_CTX *ctx, + int gen_type, char *value, int is_nc); + +#ifdef HEADER_CONF_H +GENERAL_NAME *v2i_GENERAL_NAME(const X509V3_EXT_METHOD *method, X509V3_CTX *ctx, + CONF_VALUE *cnf); +GENERAL_NAME *v2i_GENERAL_NAME_ex(GENERAL_NAME *out, + const X509V3_EXT_METHOD *method, + X509V3_CTX *ctx, CONF_VALUE *cnf, int is_nc); +void X509V3_conf_free(CONF_VALUE *val); + +X509_EXTENSION *X509V3_EXT_nconf_nid(CONF *conf, X509V3_CTX *ctx, int ext_nid, char *value); +X509_EXTENSION *X509V3_EXT_nconf(CONF *conf, X509V3_CTX *ctx, char *name, char *value); +int X509V3_EXT_add_nconf_sk(CONF *conf, X509V3_CTX *ctx, char *section, STACK_OF(X509_EXTENSION) **sk); +int X509V3_EXT_add_nconf(CONF *conf, X509V3_CTX *ctx, char *section, X509 *cert); +int X509V3_EXT_REQ_add_nconf(CONF *conf, X509V3_CTX *ctx, char *section, X509_REQ *req); +int X509V3_EXT_CRL_add_nconf(CONF *conf, X509V3_CTX *ctx, char *section, X509_CRL *crl); + +X509_EXTENSION *X509V3_EXT_conf_nid(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx, + int ext_nid, char *value); +X509_EXTENSION *X509V3_EXT_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx, + char *name, char *value); +int X509V3_EXT_add_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx, + char *section, X509 *cert); +int X509V3_EXT_REQ_add_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx, + char *section, X509_REQ *req); +int X509V3_EXT_CRL_add_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx, + char *section, X509_CRL *crl); + +int X509V3_add_value_bool_nf(char *name, int asn1_bool, + STACK_OF(CONF_VALUE) **extlist); +int X509V3_get_value_bool(CONF_VALUE *value, int *asn1_bool); +int X509V3_get_value_int(CONF_VALUE *value, ASN1_INTEGER **aint); +void X509V3_set_nconf(X509V3_CTX *ctx, CONF *conf); +void X509V3_set_conf_lhash(X509V3_CTX *ctx, LHASH_OF(CONF_VALUE) *lhash); +#endif + +char * X509V3_get_string(X509V3_CTX *ctx, char *name, char *section); +STACK_OF(CONF_VALUE) * X509V3_get_section(X509V3_CTX *ctx, char *section); +void X509V3_string_free(X509V3_CTX *ctx, char *str); +void X509V3_section_free( X509V3_CTX *ctx, STACK_OF(CONF_VALUE) *section); +void X509V3_set_ctx(X509V3_CTX *ctx, X509 *issuer, X509 *subject, + X509_REQ *req, X509_CRL *crl, int flags); + +int X509V3_add_value(const char *name, const char *value, + STACK_OF(CONF_VALUE) **extlist); +int X509V3_add_value_uchar(const char *name, const unsigned char *value, + STACK_OF(CONF_VALUE) **extlist); +int X509V3_add_value_bool(const char *name, int asn1_bool, + STACK_OF(CONF_VALUE) **extlist); +int X509V3_add_value_int(const char *name, ASN1_INTEGER *aint, + STACK_OF(CONF_VALUE) **extlist); +char * i2s_ASN1_INTEGER(X509V3_EXT_METHOD *meth, ASN1_INTEGER *aint); +ASN1_INTEGER * s2i_ASN1_INTEGER(X509V3_EXT_METHOD *meth, char *value); +char * i2s_ASN1_ENUMERATED(X509V3_EXT_METHOD *meth, ASN1_ENUMERATED *aint); +char * i2s_ASN1_ENUMERATED_TABLE(X509V3_EXT_METHOD *meth, ASN1_ENUMERATED *aint); +int X509V3_EXT_add(X509V3_EXT_METHOD *ext); +int X509V3_EXT_add_list(X509V3_EXT_METHOD *extlist); +int X509V3_EXT_add_alias(int nid_to, int nid_from); +void X509V3_EXT_cleanup(void); + +const X509V3_EXT_METHOD *X509V3_EXT_get(X509_EXTENSION *ext); +const X509V3_EXT_METHOD *X509V3_EXT_get_nid(int nid); +int X509V3_add_standard_extensions(void); +STACK_OF(CONF_VALUE) *X509V3_parse_list(const char *line); +void *X509V3_EXT_d2i(X509_EXTENSION *ext); +void *X509V3_get_d2i(STACK_OF(X509_EXTENSION) *x, int nid, int *crit, int *idx); + + +X509_EXTENSION *X509V3_EXT_i2d(int ext_nid, int crit, void *ext_struc); +int X509V3_add1_i2d(STACK_OF(X509_EXTENSION) **x, int nid, void *value, int crit, unsigned long flags); + +char *hex_to_string(const unsigned char *buffer, long len); +unsigned char *string_to_hex(const char *str, long *len); +int name_cmp(const char *name, const char *cmp); + +void X509V3_EXT_val_prn(BIO *out, STACK_OF(CONF_VALUE) *val, int indent, + int ml); +int X509V3_EXT_print(BIO *out, X509_EXTENSION *ext, unsigned long flag, int indent); +int X509V3_EXT_print_fp(FILE *out, X509_EXTENSION *ext, int flag, int indent); + +int X509V3_extensions_print(BIO *out, char *title, STACK_OF(X509_EXTENSION) *exts, unsigned long flag, int indent); + +int X509_check_ca(X509 *x); +int X509_check_purpose(X509 *x, int id, int ca); +int X509_supported_extension(X509_EXTENSION *ex); +int X509_PURPOSE_set(int *p, int purpose); +int X509_check_issued(X509 *issuer, X509 *subject); +int X509_check_akid(X509 *issuer, AUTHORITY_KEYID *akid); +int X509_PURPOSE_get_count(void); +X509_PURPOSE * X509_PURPOSE_get0(int idx); +int X509_PURPOSE_get_by_sname(char *sname); +int X509_PURPOSE_get_by_id(int id); +int X509_PURPOSE_add(int id, int trust, int flags, + int (*ck)(const X509_PURPOSE *, const X509 *, int), + char *name, char *sname, void *arg); +char *X509_PURPOSE_get0_name(X509_PURPOSE *xp); +char *X509_PURPOSE_get0_sname(X509_PURPOSE *xp); +int X509_PURPOSE_get_trust(X509_PURPOSE *xp); +void X509_PURPOSE_cleanup(void); +int X509_PURPOSE_get_id(X509_PURPOSE *); + +STACK_OF(OPENSSL_STRING) *X509_get1_email(X509 *x); +STACK_OF(OPENSSL_STRING) *X509_REQ_get1_email(X509_REQ *x); +void X509_email_free(STACK_OF(OPENSSL_STRING) *sk); +STACK_OF(OPENSSL_STRING) *X509_get1_ocsp(X509 *x); + +ASN1_OCTET_STRING *a2i_IPADDRESS(const char *ipasc); +ASN1_OCTET_STRING *a2i_IPADDRESS_NC(const char *ipasc); +int a2i_ipadd(unsigned char *ipout, const char *ipasc); +int X509V3_NAME_from_section(X509_NAME *nm, STACK_OF(CONF_VALUE)*dn_sk, + unsigned long chtype); + +void X509_POLICY_NODE_print(BIO *out, X509_POLICY_NODE *node, int indent); +DECLARE_STACK_OF(X509_POLICY_NODE) + +#ifndef OPENSSL_NO_RFC3779 + +typedef struct ASRange_st { + ASN1_INTEGER *min, *max; +} ASRange; + +#define ASIdOrRange_id 0 +#define ASIdOrRange_range 1 + +typedef struct ASIdOrRange_st { + int type; + union { + ASN1_INTEGER *id; + ASRange *range; + } u; +} ASIdOrRange; + +typedef STACK_OF(ASIdOrRange) ASIdOrRanges; +DECLARE_STACK_OF(ASIdOrRange) + +#define ASIdentifierChoice_inherit 0 +#define ASIdentifierChoice_asIdsOrRanges 1 + +typedef struct ASIdentifierChoice_st { + int type; + union { + ASN1_NULL *inherit; + ASIdOrRanges *asIdsOrRanges; + } u; +} ASIdentifierChoice; + +typedef struct ASIdentifiers_st { + ASIdentifierChoice *asnum, *rdi; +} ASIdentifiers; + +DECLARE_ASN1_FUNCTIONS(ASRange) +DECLARE_ASN1_FUNCTIONS(ASIdOrRange) +DECLARE_ASN1_FUNCTIONS(ASIdentifierChoice) +DECLARE_ASN1_FUNCTIONS(ASIdentifiers) + + +typedef struct IPAddressRange_st { + ASN1_BIT_STRING *min, *max; +} IPAddressRange; + +#define IPAddressOrRange_addressPrefix 0 +#define IPAddressOrRange_addressRange 1 + +typedef struct IPAddressOrRange_st { + int type; + union { + ASN1_BIT_STRING *addressPrefix; + IPAddressRange *addressRange; + } u; +} IPAddressOrRange; + +typedef STACK_OF(IPAddressOrRange) IPAddressOrRanges; +DECLARE_STACK_OF(IPAddressOrRange) + +#define IPAddressChoice_inherit 0 +#define IPAddressChoice_addressesOrRanges 1 + +typedef struct IPAddressChoice_st { + int type; + union { + ASN1_NULL *inherit; + IPAddressOrRanges *addressesOrRanges; + } u; +} IPAddressChoice; + +typedef struct IPAddressFamily_st { + ASN1_OCTET_STRING *addressFamily; + IPAddressChoice *ipAddressChoice; +} IPAddressFamily; + +typedef STACK_OF(IPAddressFamily) IPAddrBlocks; +DECLARE_STACK_OF(IPAddressFamily) + +DECLARE_ASN1_FUNCTIONS(IPAddressRange) +DECLARE_ASN1_FUNCTIONS(IPAddressOrRange) +DECLARE_ASN1_FUNCTIONS(IPAddressChoice) +DECLARE_ASN1_FUNCTIONS(IPAddressFamily) + +/* + * API tag for elements of the ASIdentifer SEQUENCE. + */ +#define V3_ASID_ASNUM 0 +#define V3_ASID_RDI 1 + +/* + * AFI values, assigned by IANA. It'd be nice to make the AFI + * handling code totally generic, but there are too many little things + * that would need to be defined for other address families for it to + * be worth the trouble. + */ +#define IANA_AFI_IPV4 1 +#define IANA_AFI_IPV6 2 + +/* + * Utilities to construct and extract values from RFC3779 extensions, + * since some of the encodings (particularly for IP address prefixes + * and ranges) are a bit tedious to work with directly. + */ +int v3_asid_add_inherit(ASIdentifiers *asid, int which); +int v3_asid_add_id_or_range(ASIdentifiers *asid, int which, + ASN1_INTEGER *min, ASN1_INTEGER *max); +int v3_addr_add_inherit(IPAddrBlocks *addr, + const unsigned afi, const unsigned *safi); +int v3_addr_add_prefix(IPAddrBlocks *addr, + const unsigned afi, const unsigned *safi, + unsigned char *a, const int prefixlen); +int v3_addr_add_range(IPAddrBlocks *addr, + const unsigned afi, const unsigned *safi, + unsigned char *min, unsigned char *max); +unsigned v3_addr_get_afi(const IPAddressFamily *f); +int v3_addr_get_range(IPAddressOrRange *aor, const unsigned afi, + unsigned char *min, unsigned char *max, + const int length); + +/* + * Canonical forms. + */ +int v3_asid_is_canonical(ASIdentifiers *asid); +int v3_addr_is_canonical(IPAddrBlocks *addr); +int v3_asid_canonize(ASIdentifiers *asid); +int v3_addr_canonize(IPAddrBlocks *addr); + +/* + * Tests for inheritance and containment. + */ +int v3_asid_inherits(ASIdentifiers *asid); +int v3_addr_inherits(IPAddrBlocks *addr); +int v3_asid_subset(ASIdentifiers *a, ASIdentifiers *b); +int v3_addr_subset(IPAddrBlocks *a, IPAddrBlocks *b); + +/* + * Check whether RFC 3779 extensions nest properly in chains. + */ +int v3_asid_validate_path(X509_STORE_CTX *); +int v3_addr_validate_path(X509_STORE_CTX *); +int v3_asid_validate_resource_set(STACK_OF(X509) *chain, + ASIdentifiers *ext, + int allow_inheritance); +int v3_addr_validate_resource_set(STACK_OF(X509) *chain, + IPAddrBlocks *ext, + int allow_inheritance); + +#endif /* OPENSSL_NO_RFC3779 */ + +/* BEGIN ERROR CODES */ +/* The following lines are auto generated by the script mkerr.pl. Any changes + * made after this point may be overwritten when the script is next run. + */ +void ERR_load_X509V3_strings(void); + +/* Error codes for the X509V3 functions. */ + +/* Function codes. */ +#define X509V3_F_A2I_GENERAL_NAME 164 +#define X509V3_F_ASIDENTIFIERCHOICE_CANONIZE 161 +#define X509V3_F_ASIDENTIFIERCHOICE_IS_CANONICAL 162 +#define X509V3_F_COPY_EMAIL 122 +#define X509V3_F_COPY_ISSUER 123 +#define X509V3_F_DO_DIRNAME 144 +#define X509V3_F_DO_EXT_CONF 124 +#define X509V3_F_DO_EXT_I2D 135 +#define X509V3_F_DO_EXT_NCONF 151 +#define X509V3_F_DO_I2V_NAME_CONSTRAINTS 148 +#define X509V3_F_GNAMES_FROM_SECTNAME 156 +#define X509V3_F_HEX_TO_STRING 111 +#define X509V3_F_I2S_ASN1_ENUMERATED 121 +#define X509V3_F_I2S_ASN1_IA5STRING 149 +#define X509V3_F_I2S_ASN1_INTEGER 120 +#define X509V3_F_I2V_AUTHORITY_INFO_ACCESS 138 +#define X509V3_F_NOTICE_SECTION 132 +#define X509V3_F_NREF_NOS 133 +#define X509V3_F_POLICY_SECTION 131 +#define X509V3_F_PROCESS_PCI_VALUE 150 +#define X509V3_F_R2I_CERTPOL 130 +#define X509V3_F_R2I_PCI 155 +#define X509V3_F_S2I_ASN1_IA5STRING 100 +#define X509V3_F_S2I_ASN1_INTEGER 108 +#define X509V3_F_S2I_ASN1_OCTET_STRING 112 +#define X509V3_F_S2I_ASN1_SKEY_ID 114 +#define X509V3_F_S2I_SKEY_ID 115 +#define X509V3_F_SET_DIST_POINT_NAME 158 +#define X509V3_F_STRING_TO_HEX 113 +#define X509V3_F_SXNET_ADD_ID_ASC 125 +#define X509V3_F_SXNET_ADD_ID_INTEGER 126 +#define X509V3_F_SXNET_ADD_ID_ULONG 127 +#define X509V3_F_SXNET_GET_ID_ASC 128 +#define X509V3_F_SXNET_GET_ID_ULONG 129 +#define X509V3_F_V2I_ASIDENTIFIERS 163 +#define X509V3_F_V2I_ASN1_BIT_STRING 101 +#define X509V3_F_V2I_AUTHORITY_INFO_ACCESS 139 +#define X509V3_F_V2I_AUTHORITY_KEYID 119 +#define X509V3_F_V2I_BASIC_CONSTRAINTS 102 +#define X509V3_F_V2I_CRLD 134 +#define X509V3_F_V2I_EXTENDED_KEY_USAGE 103 +#define X509V3_F_V2I_GENERAL_NAMES 118 +#define X509V3_F_V2I_GENERAL_NAME_EX 117 +#define X509V3_F_V2I_IDP 157 +#define X509V3_F_V2I_IPADDRBLOCKS 159 +#define X509V3_F_V2I_ISSUER_ALT 153 +#define X509V3_F_V2I_NAME_CONSTRAINTS 147 +#define X509V3_F_V2I_POLICY_CONSTRAINTS 146 +#define X509V3_F_V2I_POLICY_MAPPINGS 145 +#define X509V3_F_V2I_SUBJECT_ALT 154 +#define X509V3_F_V3_ADDR_VALIDATE_PATH_INTERNAL 160 +#define X509V3_F_V3_GENERIC_EXTENSION 116 +#define X509V3_F_X509V3_ADD1_I2D 140 +#define X509V3_F_X509V3_ADD_VALUE 105 +#define X509V3_F_X509V3_EXT_ADD 104 +#define X509V3_F_X509V3_EXT_ADD_ALIAS 106 +#define X509V3_F_X509V3_EXT_CONF 107 +#define X509V3_F_X509V3_EXT_I2D 136 +#define X509V3_F_X509V3_EXT_NCONF 152 +#define X509V3_F_X509V3_GET_SECTION 142 +#define X509V3_F_X509V3_GET_STRING 143 +#define X509V3_F_X509V3_GET_VALUE_BOOL 110 +#define X509V3_F_X509V3_PARSE_LIST 109 +#define X509V3_F_X509_PURPOSE_ADD 137 +#define X509V3_F_X509_PURPOSE_SET 141 + +/* Reason codes. */ +#define X509V3_R_BAD_IP_ADDRESS 118 +#define X509V3_R_BAD_OBJECT 119 +#define X509V3_R_BN_DEC2BN_ERROR 100 +#define X509V3_R_BN_TO_ASN1_INTEGER_ERROR 101 +#define X509V3_R_DIRNAME_ERROR 149 +#define X509V3_R_DISTPOINT_ALREADY_SET 160 +#define X509V3_R_DUPLICATE_ZONE_ID 133 +#define X509V3_R_ERROR_CONVERTING_ZONE 131 +#define X509V3_R_ERROR_CREATING_EXTENSION 144 +#define X509V3_R_ERROR_IN_EXTENSION 128 +#define X509V3_R_EXPECTED_A_SECTION_NAME 137 +#define X509V3_R_EXTENSION_EXISTS 145 +#define X509V3_R_EXTENSION_NAME_ERROR 115 +#define X509V3_R_EXTENSION_NOT_FOUND 102 +#define X509V3_R_EXTENSION_SETTING_NOT_SUPPORTED 103 +#define X509V3_R_EXTENSION_VALUE_ERROR 116 +#define X509V3_R_ILLEGAL_EMPTY_EXTENSION 151 +#define X509V3_R_ILLEGAL_HEX_DIGIT 113 +#define X509V3_R_INCORRECT_POLICY_SYNTAX_TAG 152 +#define X509V3_R_INVALID_MULTIPLE_RDNS 161 +#define X509V3_R_INVALID_ASNUMBER 162 +#define X509V3_R_INVALID_ASRANGE 163 +#define X509V3_R_INVALID_BOOLEAN_STRING 104 +#define X509V3_R_INVALID_EXTENSION_STRING 105 +#define X509V3_R_INVALID_INHERITANCE 165 +#define X509V3_R_INVALID_IPADDRESS 166 +#define X509V3_R_INVALID_NAME 106 +#define X509V3_R_INVALID_NULL_ARGUMENT 107 +#define X509V3_R_INVALID_NULL_NAME 108 +#define X509V3_R_INVALID_NULL_VALUE 109 +#define X509V3_R_INVALID_NUMBER 140 +#define X509V3_R_INVALID_NUMBERS 141 +#define X509V3_R_INVALID_OBJECT_IDENTIFIER 110 +#define X509V3_R_INVALID_OPTION 138 +#define X509V3_R_INVALID_POLICY_IDENTIFIER 134 +#define X509V3_R_INVALID_PROXY_POLICY_SETTING 153 +#define X509V3_R_INVALID_PURPOSE 146 +#define X509V3_R_INVALID_SAFI 164 +#define X509V3_R_INVALID_SECTION 135 +#define X509V3_R_INVALID_SYNTAX 143 +#define X509V3_R_ISSUER_DECODE_ERROR 126 +#define X509V3_R_MISSING_VALUE 124 +#define X509V3_R_NEED_ORGANIZATION_AND_NUMBERS 142 +#define X509V3_R_NO_CONFIG_DATABASE 136 +#define X509V3_R_NO_ISSUER_CERTIFICATE 121 +#define X509V3_R_NO_ISSUER_DETAILS 127 +#define X509V3_R_NO_POLICY_IDENTIFIER 139 +#define X509V3_R_NO_PROXY_CERT_POLICY_LANGUAGE_DEFINED 154 +#define X509V3_R_NO_PUBLIC_KEY 114 +#define X509V3_R_NO_SUBJECT_DETAILS 125 +#define X509V3_R_ODD_NUMBER_OF_DIGITS 112 +#define X509V3_R_OPERATION_NOT_DEFINED 148 +#define X509V3_R_OTHERNAME_ERROR 147 +#define X509V3_R_POLICY_LANGUAGE_ALREADY_DEFINED 155 +#define X509V3_R_POLICY_PATH_LENGTH 156 +#define X509V3_R_POLICY_PATH_LENGTH_ALREADY_DEFINED 157 +#define X509V3_R_POLICY_SYNTAX_NOT_CURRENTLY_SUPPORTED 158 +#define X509V3_R_POLICY_WHEN_PROXY_LANGUAGE_REQUIRES_NO_POLICY 159 +#define X509V3_R_SECTION_NOT_FOUND 150 +#define X509V3_R_UNABLE_TO_GET_ISSUER_DETAILS 122 +#define X509V3_R_UNABLE_TO_GET_ISSUER_KEYID 123 +#define X509V3_R_UNKNOWN_BIT_STRING_ARGUMENT 111 +#define X509V3_R_UNKNOWN_EXTENSION 129 +#define X509V3_R_UNKNOWN_EXTENSION_NAME 130 +#define X509V3_R_UNKNOWN_OPTION 120 +#define X509V3_R_UNSUPPORTED_OPTION 117 +#define X509V3_R_UNSUPPORTED_TYPE 167 +#define X509V3_R_USER_TOO_LONG 132 + +#ifdef __cplusplus +} +#endif +#endif diff --git a/Source/Import/OpenSSL/Prebuild/Linux/amd64/libcrypto.a b/Source/Import/OpenSSL/Prebuild/Linux/amd64/libcrypto.a new file mode 100644 index 0000000..a024a33 Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Linux/amd64/libcrypto.a differ diff --git a/Source/Import/OpenSSL/Prebuild/Linux/amd64/libcrypto.so b/Source/Import/OpenSSL/Prebuild/Linux/amd64/libcrypto.so new file mode 100644 index 0000000..9a1053e Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Linux/amd64/libcrypto.so differ diff --git a/Source/Import/OpenSSL/Prebuild/Linux/amd64/libssl.a b/Source/Import/OpenSSL/Prebuild/Linux/amd64/libssl.a new file mode 100644 index 0000000..f8a79a7 Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Linux/amd64/libssl.a differ diff --git a/Source/Import/OpenSSL/Prebuild/Linux/amd64/libssl.so b/Source/Import/OpenSSL/Prebuild/Linux/amd64/libssl.so new file mode 100644 index 0000000..96336bc Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Linux/amd64/libssl.so differ diff --git a/Source/Import/OpenSSL/Prebuild/Linux/i386/libcrypto.a b/Source/Import/OpenSSL/Prebuild/Linux/i386/libcrypto.a new file mode 100644 index 0000000..0da3757 Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Linux/i386/libcrypto.a differ diff --git a/Source/Import/OpenSSL/Prebuild/Linux/i386/libcrypto.so b/Source/Import/OpenSSL/Prebuild/Linux/i386/libcrypto.so new file mode 100644 index 0000000..98f0349 Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Linux/i386/libcrypto.so differ diff --git a/Source/Import/OpenSSL/Prebuild/Linux/i386/libssl.a b/Source/Import/OpenSSL/Prebuild/Linux/i386/libssl.a new file mode 100644 index 0000000..d693ca7 Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Linux/i386/libssl.a differ diff --git a/Source/Import/OpenSSL/Prebuild/Linux/i386/libssl.so b/Source/Import/OpenSSL/Prebuild/Linux/i386/libssl.so new file mode 100644 index 0000000..b429499 Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Linux/i386/libssl.so differ diff --git a/Source/Import/OpenSSL/Prebuild/Win/amd64/libcrypto.a b/Source/Import/OpenSSL/Prebuild/Win/amd64/libcrypto.a new file mode 100644 index 0000000..923fde4 Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Win/amd64/libcrypto.a differ diff --git a/Source/Import/OpenSSL/Prebuild/Win/amd64/libssl.a b/Source/Import/OpenSSL/Prebuild/Win/amd64/libssl.a new file mode 100644 index 0000000..923fde4 Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Win/amd64/libssl.a differ diff --git a/Source/Import/OpenSSL/Prebuild/Win/i386/libcrypto.a b/Source/Import/OpenSSL/Prebuild/Win/i386/libcrypto.a new file mode 100644 index 0000000..b3e18e9 Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Win/i386/libcrypto.a differ diff --git a/Source/Import/OpenSSL/Prebuild/Win/i386/libeay32.dll b/Source/Import/OpenSSL/Prebuild/Win/i386/libeay32.dll new file mode 100644 index 0000000..629b80d Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Win/i386/libeay32.dll differ diff --git a/Source/Import/OpenSSL/Prebuild/Win/i386/libssl.a b/Source/Import/OpenSSL/Prebuild/Win/i386/libssl.a new file mode 100644 index 0000000..5154f16 Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Win/i386/libssl.a differ diff --git a/Source/Import/OpenSSL/Prebuild/Win/i386/ssleay32.dll b/Source/Import/OpenSSL/Prebuild/Win/i386/ssleay32.dll new file mode 100644 index 0000000..eb576bc Binary files /dev/null and b/Source/Import/OpenSSL/Prebuild/Win/i386/ssleay32.dll differ diff --git a/Source/Import/OpenSSL/qcbuild.src b/Source/Import/OpenSSL/qcbuild.src new file mode 100644 index 0000000..9c01c53 --- /dev/null +++ b/Source/Import/OpenSSL/qcbuild.src @@ -0,0 +1,69 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY + +TITLE = OpenSSL +VERSION = 1.0.1g + +# +# Headers. +# + +ISRC = Include/openssl + +# +# List of prebuild libraries to copy into Build dir. +# $(ARCH) keywords will be set to i386 or amd64 depending on +# detected/set target. +# + +.section Linux + PREBUILD_LIBS = Prebuild/Linux/$(ARCH)/libcrypto.a + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libssl.a + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libcrypto.so + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libssl.so +.endsection + +.section MinGW + PREBUILD_LIBS = Prebuild/Win/amd64/libcrypto.a + PREBUILD_LIBS += Prebuild/Win/amd64/libssl.a +# PREBUILD_LIBS += Prebuild/Win/amd64/libeay32.dll +# PREBUILD_LIBS += Prebuild/Win/amd64/ssleay32.dll +.endsection + +# +# Info about license and auhtors. +# + +LICENSE = BSD +AUTHOR = The OpenSSL Project, http://www.openssl.org +COPYRIGHT = Copyright (c) 1998-2011 The OpenSSL Project + +# +# Description, purpose. +# + +PURPOSE = Low level encryption and autentication functions. +DESC = Prebuild only. diff --git a/Source/Import/ZLib/Example/Main.cpp b/Source/Import/ZLib/Example/Main.cpp new file mode 100644 index 0000000..3ad0801 --- /dev/null +++ b/Source/Import/ZLib/Example/Main.cpp @@ -0,0 +1,162 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include +#include + +#define THUNK_SIZE (1024 * 64) + +using namespace Tegenaria; + +int main(int argc, char **argv) +{ + char source[THUNK_SIZE] = {0}; + char dest[THUNK_SIZE] = {0}; + + int sourceSize = 0; + int destSize = 0; + int readed = 1; + + FILE *finp = NULL; + FILE *fout = NULL; + + // + // Check args. + // + + if (argc < 4) + { + fprintf(stderr, "Usage is:\n" + " Compress: %s -c \n" + " Decompress: %s -d \n", + argv[0], argv[0]); + + return -1; + } + + // + // Open input and ouput files. + // + + finp = fopen(argv[2], "rb"); + fout = fopen(argv[3], "wb"); + + FAILEX(finp == NULL, "ERROR: Cannot open [%s] file.\n", argv[2]); + FAILEX(fout == NULL, "ERROR: Cannot create [%s] file.\n", argv[3]); + + // + // Compress mode. + // + + if (strcmp(argv[1], "-c") == 0) + { + // + // Compress file by thunks. + // + + DBG_INFO("Compressing file %s into %s...\n", argv[2], argv[3]); + + while(readed > 0) + { + // + // Read up to THUNK_SIZE from uncompressed file. + // + + readed = fread(source, 1, sizeof(source), finp); + + // + // Compress thunk. + // + + sourceSize = readed; + destSize = sizeof(dest); + + compress((Bytef *) dest, (uLongf *) &destSize, + (Bytef *) source, (uLong) sourceSize); + + // + // Write thunk to file. + // + + fwrite(&destSize, 1, sizeof(destSize), fout); + fwrite(dest, 1, destSize, fout); + } + } + + // + // Decompress mode. + // + + else + { + while(readed > 0) + { + // + // Read from compressed file. + // + + readed = fread(&sourceSize, sizeof(sourceSize), 1, finp); + + if (readed > 0) + { + readed = fread(source, sourceSize, 1, finp); + + // + // Decompress thunk. + // + + destSize = sizeof(dest); + + uncompress((Bytef *) dest, (uLongf *) &destSize, + (Bytef *) source, (uLong) sourceSize); + + // + // Write uncompressed data thunk to file. + // + + fwrite(dest, 1, destSize, fout); + } + } + } + + // + // Clean up. + // + + fail: + + if (finp) + { + fclose(finp); + } + + if (fout) + { + fclose(fout); + } + + return 0; +} diff --git a/Source/Import/ZLib/Example/qcbuild.src b/Source/Import/ZLib/Example/qcbuild.src new file mode 100644 index 0000000..1c966b6 --- /dev/null +++ b/Source/Import/ZLib/Example/qcbuild.src @@ -0,0 +1,33 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = ZLib-example +AUTHOR = Sylwester Wysocki +PURPOSE = Show how to compress/uncompress raw buffers via ZLib. + +CXXSRC = Main.cpp + +DEPENDS = ZLib LibDebug +LIBS = -lz -ldebug diff --git a/Source/Import/ZLib/Prebuild/Linux/amd64/libz.a b/Source/Import/ZLib/Prebuild/Linux/amd64/libz.a new file mode 100644 index 0000000..053c265 Binary files /dev/null and b/Source/Import/ZLib/Prebuild/Linux/amd64/libz.a differ diff --git a/Source/Import/ZLib/Prebuild/Linux/amd64/libz.so b/Source/Import/ZLib/Prebuild/Linux/amd64/libz.so new file mode 100644 index 0000000..2bfad1b --- /dev/null +++ b/Source/Import/ZLib/Prebuild/Linux/amd64/libz.so @@ -0,0 +1 @@ +libz.so.1.2.8 \ No newline at end of file diff --git a/Source/Import/ZLib/Prebuild/Linux/amd64/libz.so.1 b/Source/Import/ZLib/Prebuild/Linux/amd64/libz.so.1 new file mode 100644 index 0000000..2bfad1b --- /dev/null +++ b/Source/Import/ZLib/Prebuild/Linux/amd64/libz.so.1 @@ -0,0 +1 @@ +libz.so.1.2.8 \ No newline at end of file diff --git a/Source/Import/ZLib/Prebuild/Linux/amd64/libz.so.1.2.8 b/Source/Import/ZLib/Prebuild/Linux/amd64/libz.so.1.2.8 new file mode 100644 index 0000000..39f4af7 Binary files /dev/null and b/Source/Import/ZLib/Prebuild/Linux/amd64/libz.so.1.2.8 differ diff --git a/Source/Import/ZLib/Prebuild/Linux/i386/libz.a b/Source/Import/ZLib/Prebuild/Linux/i386/libz.a new file mode 100644 index 0000000..653dff6 Binary files /dev/null and b/Source/Import/ZLib/Prebuild/Linux/i386/libz.a differ diff --git a/Source/Import/ZLib/Prebuild/Linux/i386/libz.so b/Source/Import/ZLib/Prebuild/Linux/i386/libz.so new file mode 100644 index 0000000..2bfad1b --- /dev/null +++ b/Source/Import/ZLib/Prebuild/Linux/i386/libz.so @@ -0,0 +1 @@ +libz.so.1.2.8 \ No newline at end of file diff --git a/Source/Import/ZLib/Prebuild/Linux/i386/libz.so.1 b/Source/Import/ZLib/Prebuild/Linux/i386/libz.so.1 new file mode 100644 index 0000000..2bfad1b --- /dev/null +++ b/Source/Import/ZLib/Prebuild/Linux/i386/libz.so.1 @@ -0,0 +1 @@ +libz.so.1.2.8 \ No newline at end of file diff --git a/Source/Import/ZLib/Prebuild/Linux/i386/libz.so.1.2.8 b/Source/Import/ZLib/Prebuild/Linux/i386/libz.so.1.2.8 new file mode 100644 index 0000000..83d7930 Binary files /dev/null and b/Source/Import/ZLib/Prebuild/Linux/i386/libz.so.1.2.8 differ diff --git a/Source/Import/ZLib/Prebuild/Windows/libz.a b/Source/Import/ZLib/Prebuild/Windows/libz.a new file mode 100644 index 0000000..b93f246 Binary files /dev/null and b/Source/Import/ZLib/Prebuild/Windows/libz.a differ diff --git a/Source/Import/ZLib/Prebuild/Windows/z.dll b/Source/Import/ZLib/Prebuild/Windows/z.dll new file mode 100644 index 0000000..d948931 Binary files /dev/null and b/Source/Import/ZLib/Prebuild/Windows/z.dll differ diff --git a/Source/Import/ZLib/Prebuild/Windows/zlib1.dll b/Source/Import/ZLib/Prebuild/Windows/zlib1.dll new file mode 100644 index 0000000..d948931 Binary files /dev/null and b/Source/Import/ZLib/Prebuild/Windows/zlib1.dll differ diff --git a/Source/Import/ZLib/qcbuild.src b/Source/Import/ZLib/qcbuild.src new file mode 100644 index 0000000..f6d9d18 --- /dev/null +++ b/Source/Import/ZLib/qcbuild.src @@ -0,0 +1,54 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = ZLib +PURPOSE = Compression library. +COPYRIGHT = Copyright (C) 1995-2004 Jean-loup Gailly and Mark Adler +AUTHOR = Jean-loup Gailly (compression) and Mark Adler (decompression) +DESC = Prebuild only. Needed by libnice. +LICENSE = zlib license, http://en.wikipedia.org/wiki/Zlib_license + +ISRC = zlib.h zconf.h + +# +# Windows only prebuild. +# + +.section MinGW + PREBUILD_LIBS = Prebuild/Windows/libz.a + PREBUILD_LIBS += Prebuild/Windows/zlib1.dll + PREBUILD_LIBS += Prebuild/Windows/z.dll +.endsection + +# +# Linux only prebuild. +# + +.section Linux + PREBUILD_LIBS = Prebuild/Linux/$(ARCH)/libz.a + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libz.so + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libz.so.1 + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libz.so.1.2.8 +.endsection diff --git a/Source/Import/ZLib/zconf.h b/Source/Import/ZLib/zconf.h new file mode 100644 index 0000000..9987a77 --- /dev/null +++ b/Source/Import/ZLib/zconf.h @@ -0,0 +1,511 @@ +/* zconf.h -- configuration of the zlib compression library + * Copyright (C) 1995-2013 Jean-loup Gailly. + * For conditions of distribution and use, see copyright notice in zlib.h + */ + +/* @(#) $Id$ */ + +#ifndef ZCONF_H +#define ZCONF_H + +/* + * If you *really* need a unique prefix for all types and library functions, + * compile with -DZ_PREFIX. The "standard" zlib should be compiled without it. + * Even better than compiling with -DZ_PREFIX would be to use configure to set + * this permanently in zconf.h using "./configure --zprefix". + */ +#ifdef Z_PREFIX /* may be set to #if 1 by ./configure */ +# define Z_PREFIX_SET + +/* all linked symbols */ +# define _dist_code z__dist_code +# define _length_code z__length_code +# define _tr_align z__tr_align +# define _tr_flush_bits z__tr_flush_bits +# define _tr_flush_block z__tr_flush_block +# define _tr_init z__tr_init +# define _tr_stored_block z__tr_stored_block +# define _tr_tally z__tr_tally +# define adler32 z_adler32 +# define adler32_combine z_adler32_combine +# define adler32_combine64 z_adler32_combine64 +# ifndef Z_SOLO +# define compress z_compress +# define compress2 z_compress2 +# define compressBound z_compressBound +# endif +# define crc32 z_crc32 +# define crc32_combine z_crc32_combine +# define crc32_combine64 z_crc32_combine64 +# define deflate z_deflate +# define deflateBound z_deflateBound +# define deflateCopy z_deflateCopy +# define deflateEnd z_deflateEnd +# define deflateInit2_ z_deflateInit2_ +# define deflateInit_ z_deflateInit_ +# define deflateParams z_deflateParams +# define deflatePending z_deflatePending +# define deflatePrime z_deflatePrime +# define deflateReset z_deflateReset +# define deflateResetKeep z_deflateResetKeep +# define deflateSetDictionary z_deflateSetDictionary +# define deflateSetHeader z_deflateSetHeader +# define deflateTune z_deflateTune +# define deflate_copyright z_deflate_copyright +# define get_crc_table z_get_crc_table +# ifndef Z_SOLO +# define gz_error z_gz_error +# define gz_intmax z_gz_intmax +# define gz_strwinerror z_gz_strwinerror +# define gzbuffer z_gzbuffer +# define gzclearerr z_gzclearerr +# define gzclose z_gzclose +# define gzclose_r z_gzclose_r +# define gzclose_w z_gzclose_w +# define gzdirect z_gzdirect +# define gzdopen z_gzdopen +# define gzeof z_gzeof +# define gzerror z_gzerror +# define gzflush z_gzflush +# define gzgetc z_gzgetc +# define gzgetc_ z_gzgetc_ +# define gzgets z_gzgets +# define gzoffset z_gzoffset +# define gzoffset64 z_gzoffset64 +# define gzopen z_gzopen +# define gzopen64 z_gzopen64 +# ifdef _WIN32 +# define gzopen_w z_gzopen_w +# endif +# define gzprintf z_gzprintf +# define gzvprintf z_gzvprintf +# define gzputc z_gzputc +# define gzputs z_gzputs +# define gzread z_gzread +# define gzrewind z_gzrewind +# define gzseek z_gzseek +# define gzseek64 z_gzseek64 +# define gzsetparams z_gzsetparams +# define gztell z_gztell +# define gztell64 z_gztell64 +# define gzungetc z_gzungetc +# define gzwrite z_gzwrite +# endif +# define inflate z_inflate +# define inflateBack z_inflateBack +# define inflateBackEnd z_inflateBackEnd +# define inflateBackInit_ z_inflateBackInit_ +# define inflateCopy z_inflateCopy +# define inflateEnd z_inflateEnd +# define inflateGetHeader z_inflateGetHeader +# define inflateInit2_ z_inflateInit2_ +# define inflateInit_ z_inflateInit_ +# define inflateMark z_inflateMark +# define inflatePrime z_inflatePrime +# define inflateReset z_inflateReset +# define inflateReset2 z_inflateReset2 +# define inflateSetDictionary z_inflateSetDictionary +# define inflateGetDictionary z_inflateGetDictionary +# define inflateSync z_inflateSync +# define inflateSyncPoint z_inflateSyncPoint +# define inflateUndermine z_inflateUndermine +# define inflateResetKeep z_inflateResetKeep +# define inflate_copyright z_inflate_copyright +# define inflate_fast z_inflate_fast +# define inflate_table z_inflate_table +# ifndef Z_SOLO +# define uncompress z_uncompress +# endif +# define zError z_zError +# ifndef Z_SOLO +# define zcalloc z_zcalloc +# define zcfree z_zcfree +# endif +# define zlibCompileFlags z_zlibCompileFlags +# define zlibVersion z_zlibVersion + +/* all zlib typedefs in zlib.h and zconf.h */ +# define Byte z_Byte +# define Bytef z_Bytef +# define alloc_func z_alloc_func +# define charf z_charf +# define free_func z_free_func +# ifndef Z_SOLO +# define gzFile z_gzFile +# endif +# define gz_header z_gz_header +# define gz_headerp z_gz_headerp +# define in_func z_in_func +# define intf z_intf +# define out_func z_out_func +# define uInt z_uInt +# define uIntf z_uIntf +# define uLong z_uLong +# define uLongf z_uLongf +# define voidp z_voidp +# define voidpc z_voidpc +# define voidpf z_voidpf + +/* all zlib structs in zlib.h and zconf.h */ +# define gz_header_s z_gz_header_s +# define internal_state z_internal_state + +#endif + +#if defined(__MSDOS__) && !defined(MSDOS) +# define MSDOS +#endif +#if (defined(OS_2) || defined(__OS2__)) && !defined(OS2) +# define OS2 +#endif +#if defined(_WINDOWS) && !defined(WINDOWS) +# define WINDOWS +#endif +#if defined(_WIN32) || defined(_WIN32_WCE) || defined(__WIN32__) +# ifndef WIN32 +# define WIN32 +# endif +#endif +#if (defined(MSDOS) || defined(OS2) || defined(WINDOWS)) && !defined(WIN32) +# if !defined(__GNUC__) && !defined(__FLAT__) && !defined(__386__) +# ifndef SYS16BIT +# define SYS16BIT +# endif +# endif +#endif + +/* + * Compile with -DMAXSEG_64K if the alloc function cannot allocate more + * than 64k bytes at a time (needed on systems with 16-bit int). + */ +#ifdef SYS16BIT +# define MAXSEG_64K +#endif +#ifdef MSDOS +# define UNALIGNED_OK +#endif + +#ifdef __STDC_VERSION__ +# ifndef STDC +# define STDC +# endif +# if __STDC_VERSION__ >= 199901L +# ifndef STDC99 +# define STDC99 +# endif +# endif +#endif +#if !defined(STDC) && (defined(__STDC__) || defined(__cplusplus)) +# define STDC +#endif +#if !defined(STDC) && (defined(__GNUC__) || defined(__BORLANDC__)) +# define STDC +#endif +#if !defined(STDC) && (defined(MSDOS) || defined(WINDOWS) || defined(WIN32)) +# define STDC +#endif +#if !defined(STDC) && (defined(OS2) || defined(__HOS_AIX__)) +# define STDC +#endif + +#if defined(__OS400__) && !defined(STDC) /* iSeries (formerly AS/400). */ +# define STDC +#endif + +#ifndef STDC +# ifndef const /* cannot use !defined(STDC) && !defined(const) on Mac */ +# define const /* note: need a more gentle solution here */ +# endif +#endif + +#if defined(ZLIB_CONST) && !defined(z_const) +# define z_const const +#else +# define z_const +#endif + +/* Some Mac compilers merge all .h files incorrectly: */ +#if defined(__MWERKS__)||defined(applec)||defined(THINK_C)||defined(__SC__) +# define NO_DUMMY_DECL +#endif + +/* Maximum value for memLevel in deflateInit2 */ +#ifndef MAX_MEM_LEVEL +# ifdef MAXSEG_64K +# define MAX_MEM_LEVEL 8 +# else +# define MAX_MEM_LEVEL 9 +# endif +#endif + +/* Maximum value for windowBits in deflateInit2 and inflateInit2. + * WARNING: reducing MAX_WBITS makes minigzip unable to extract .gz files + * created by gzip. (Files created by minigzip can still be extracted by + * gzip.) + */ +#ifndef MAX_WBITS +# define MAX_WBITS 15 /* 32K LZ77 window */ +#endif + +/* The memory requirements for deflate are (in bytes): + (1 << (windowBits+2)) + (1 << (memLevel+9)) + that is: 128K for windowBits=15 + 128K for memLevel = 8 (default values) + plus a few kilobytes for small objects. For example, if you want to reduce + the default memory requirements from 256K to 128K, compile with + make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7" + Of course this will generally degrade compression (there's no free lunch). + + The memory requirements for inflate are (in bytes) 1 << windowBits + that is, 32K for windowBits=15 (default value) plus a few kilobytes + for small objects. +*/ + + /* Type declarations */ + +#ifndef OF /* function prototypes */ +# ifdef STDC +# define OF(args) args +# else +# define OF(args) () +# endif +#endif + +#ifndef Z_ARG /* function prototypes for stdarg */ +# if defined(STDC) || defined(Z_HAVE_STDARG_H) +# define Z_ARG(args) args +# else +# define Z_ARG(args) () +# endif +#endif + +/* The following definitions for FAR are needed only for MSDOS mixed + * model programming (small or medium model with some far allocations). + * This was tested only with MSC; for other MSDOS compilers you may have + * to define NO_MEMCPY in zutil.h. If you don't need the mixed model, + * just define FAR to be empty. + */ +#ifdef SYS16BIT +# if defined(M_I86SM) || defined(M_I86MM) + /* MSC small or medium model */ +# define SMALL_MEDIUM +# ifdef _MSC_VER +# define FAR _far +# else +# define FAR far +# endif +# endif +# if (defined(__SMALL__) || defined(__MEDIUM__)) + /* Turbo C small or medium model */ +# define SMALL_MEDIUM +# ifdef __BORLANDC__ +# define FAR _far +# else +# define FAR far +# endif +# endif +#endif + +#if defined(WINDOWS) || defined(WIN32) + /* If building or using zlib as a DLL, define ZLIB_DLL. + * This is not mandatory, but it offers a little performance increase. + */ +# ifdef ZLIB_DLL +# if defined(WIN32) && (!defined(__BORLANDC__) || (__BORLANDC__ >= 0x500)) +# ifdef ZLIB_INTERNAL +# define ZEXTERN extern __declspec(dllexport) +# else +# define ZEXTERN extern __declspec(dllimport) +# endif +# endif +# endif /* ZLIB_DLL */ + /* If building or using zlib with the WINAPI/WINAPIV calling convention, + * define ZLIB_WINAPI. + * Caution: the standard ZLIB1.DLL is NOT compiled using ZLIB_WINAPI. + */ +# ifdef ZLIB_WINAPI +# ifdef FAR +# undef FAR +# endif +# include + /* No need for _export, use ZLIB.DEF instead. */ + /* For complete Windows compatibility, use WINAPI, not __stdcall. */ +# define ZEXPORT WINAPI +# ifdef WIN32 +# define ZEXPORTVA WINAPIV +# else +# define ZEXPORTVA FAR CDECL +# endif +# endif +#endif + +#if defined (__BEOS__) +# ifdef ZLIB_DLL +# ifdef ZLIB_INTERNAL +# define ZEXPORT __declspec(dllexport) +# define ZEXPORTVA __declspec(dllexport) +# else +# define ZEXPORT __declspec(dllimport) +# define ZEXPORTVA __declspec(dllimport) +# endif +# endif +#endif + +#ifndef ZEXTERN +# define ZEXTERN extern +#endif +#ifndef ZEXPORT +# define ZEXPORT +#endif +#ifndef ZEXPORTVA +# define ZEXPORTVA +#endif + +#ifndef FAR +# define FAR +#endif + +#if !defined(__MACTYPES__) +typedef unsigned char Byte; /* 8 bits */ +#endif +typedef unsigned int uInt; /* 16 bits or more */ +typedef unsigned long uLong; /* 32 bits or more */ + +#ifdef SMALL_MEDIUM + /* Borland C/C++ and some old MSC versions ignore FAR inside typedef */ +# define Bytef Byte FAR +#else + typedef Byte FAR Bytef; +#endif +typedef char FAR charf; +typedef int FAR intf; +typedef uInt FAR uIntf; +typedef uLong FAR uLongf; + +#ifdef STDC + typedef void const *voidpc; + typedef void FAR *voidpf; + typedef void *voidp; +#else + typedef Byte const *voidpc; + typedef Byte FAR *voidpf; + typedef Byte *voidp; +#endif + +#if !defined(Z_U4) && !defined(Z_SOLO) && defined(STDC) +# include +# if (UINT_MAX == 0xffffffffUL) +# define Z_U4 unsigned +# elif (ULONG_MAX == 0xffffffffUL) +# define Z_U4 unsigned long +# elif (USHRT_MAX == 0xffffffffUL) +# define Z_U4 unsigned short +# endif +#endif + +#ifdef Z_U4 + typedef Z_U4 z_crc_t; +#else + typedef unsigned long z_crc_t; +#endif + +#ifdef HAVE_UNISTD_H /* may be set to #if 1 by ./configure */ +# define Z_HAVE_UNISTD_H +#endif + +#ifdef HAVE_STDARG_H /* may be set to #if 1 by ./configure */ +# define Z_HAVE_STDARG_H +#endif + +#ifdef STDC +# ifndef Z_SOLO +# include /* for off_t */ +# endif +#endif + +#if defined(STDC) || defined(Z_HAVE_STDARG_H) +# ifndef Z_SOLO +# include /* for va_list */ +# endif +#endif + +#ifdef _WIN32 +# ifndef Z_SOLO +# include /* for wchar_t */ +# endif +#endif + +/* a little trick to accommodate both "#define _LARGEFILE64_SOURCE" and + * "#define _LARGEFILE64_SOURCE 1" as requesting 64-bit operations, (even + * though the former does not conform to the LFS document), but considering + * both "#undef _LARGEFILE64_SOURCE" and "#define _LARGEFILE64_SOURCE 0" as + * equivalently requesting no 64-bit operations + */ +#if defined(_LARGEFILE64_SOURCE) && -_LARGEFILE64_SOURCE - -1 == 1 +# undef _LARGEFILE64_SOURCE +#endif + +#if defined(__WATCOMC__) && !defined(Z_HAVE_UNISTD_H) +# define Z_HAVE_UNISTD_H +#endif +#ifndef Z_SOLO +# if defined(Z_HAVE_UNISTD_H) || defined(_LARGEFILE64_SOURCE) +# include /* for SEEK_*, off_t, and _LFS64_LARGEFILE */ +# ifdef VMS +# include /* for off_t */ +# endif +# ifndef z_off_t +# define z_off_t off_t +# endif +# endif +#endif + +#if defined(_LFS64_LARGEFILE) && _LFS64_LARGEFILE-0 +# define Z_LFS64 +#endif + +#if defined(_LARGEFILE64_SOURCE) && defined(Z_LFS64) +# define Z_LARGE64 +#endif + +#if defined(_FILE_OFFSET_BITS) && _FILE_OFFSET_BITS-0 == 64 && defined(Z_LFS64) +# define Z_WANT64 +#endif + +#if !defined(SEEK_SET) && !defined(Z_SOLO) +# define SEEK_SET 0 /* Seek from beginning of file. */ +# define SEEK_CUR 1 /* Seek from current position. */ +# define SEEK_END 2 /* Set file pointer to EOF plus "offset" */ +#endif + +#ifndef z_off_t +# define z_off_t long +#endif + +#if !defined(_WIN32) && defined(Z_LARGE64) +# define z_off64_t off64_t +#else +# if defined(_WIN32) && !defined(__GNUC__) && !defined(Z_SOLO) +# define z_off64_t __int64 +# else +# define z_off64_t z_off_t +# endif +#endif + +/* MVS linker does not support external names larger than 8 bytes */ +#if defined(__MVS__) + #pragma map(deflateInit_,"DEIN") + #pragma map(deflateInit2_,"DEIN2") + #pragma map(deflateEnd,"DEEND") + #pragma map(deflateBound,"DEBND") + #pragma map(inflateInit_,"ININ") + #pragma map(inflateInit2_,"ININ2") + #pragma map(inflateEnd,"INEND") + #pragma map(inflateSync,"INSY") + #pragma map(inflateSetDictionary,"INSEDI") + #pragma map(compressBound,"CMBND") + #pragma map(inflate_table,"INTABL") + #pragma map(inflate_fast,"INFA") + #pragma map(inflate_copyright,"INCOPY") +#endif + +#endif /* ZCONF_H */ diff --git a/Source/Import/ZLib/zlib.h b/Source/Import/ZLib/zlib.h new file mode 100644 index 0000000..3e0c767 --- /dev/null +++ b/Source/Import/ZLib/zlib.h @@ -0,0 +1,1768 @@ +/* zlib.h -- interface of the 'zlib' general purpose compression library + version 1.2.8, April 28th, 2013 + + Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. + 3. This notice may not be removed or altered from any source distribution. + + Jean-loup Gailly Mark Adler + jloup@gzip.org madler@alumni.caltech.edu + + + The data format used by the zlib library is described by RFCs (Request for + Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950 + (zlib format), rfc1951 (deflate format) and rfc1952 (gzip format). +*/ + +#ifndef ZLIB_H +#define ZLIB_H + +#include "zconf.h" + +#ifdef __cplusplus +extern "C" { +#endif + +#define ZLIB_VERSION "1.2.8" +#define ZLIB_VERNUM 0x1280 +#define ZLIB_VER_MAJOR 1 +#define ZLIB_VER_MINOR 2 +#define ZLIB_VER_REVISION 8 +#define ZLIB_VER_SUBREVISION 0 + +/* + The 'zlib' compression library provides in-memory compression and + decompression functions, including integrity checks of the uncompressed data. + This version of the library supports only one compression method (deflation) + but other algorithms will be added later and will have the same stream + interface. + + Compression can be done in a single step if the buffers are large enough, + or can be done by repeated calls of the compression function. In the latter + case, the application must provide more input and/or consume the output + (providing more output space) before each call. + + The compressed data format used by default by the in-memory functions is + the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped + around a deflate stream, which is itself documented in RFC 1951. + + The library also supports reading and writing files in gzip (.gz) format + with an interface similar to that of stdio using the functions that start + with "gz". The gzip format is different from the zlib format. gzip is a + gzip wrapper, documented in RFC 1952, wrapped around a deflate stream. + + This library can optionally read and write gzip streams in memory as well. + + The zlib format was designed to be compact and fast for use in memory + and on communications channels. The gzip format was designed for single- + file compression on file systems, has a larger header than zlib to maintain + directory information, and uses a different, slower check method than zlib. + + The library does not install any signal handler. The decoder checks + the consistency of the compressed data, so the library should never crash + even in case of corrupted input. +*/ + +typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); +typedef void (*free_func) OF((voidpf opaque, voidpf address)); + +struct internal_state; + +typedef struct z_stream_s { + z_const Bytef *next_in; /* next input byte */ + uInt avail_in; /* number of bytes available at next_in */ + uLong total_in; /* total number of input bytes read so far */ + + Bytef *next_out; /* next output byte should be put there */ + uInt avail_out; /* remaining free space at next_out */ + uLong total_out; /* total number of bytes output so far */ + + z_const char *msg; /* last error message, NULL if no error */ + struct internal_state FAR *state; /* not visible by applications */ + + alloc_func zalloc; /* used to allocate the internal state */ + free_func zfree; /* used to free the internal state */ + voidpf opaque; /* private data object passed to zalloc and zfree */ + + int data_type; /* best guess about the data type: binary or text */ + uLong adler; /* adler32 value of the uncompressed data */ + uLong reserved; /* reserved for future use */ +} z_stream; + +typedef z_stream FAR *z_streamp; + +/* + gzip header information passed to and from zlib routines. See RFC 1952 + for more details on the meanings of these fields. +*/ +typedef struct gz_header_s { + int text; /* true if compressed data believed to be text */ + uLong time; /* modification time */ + int xflags; /* extra flags (not used when writing a gzip file) */ + int os; /* operating system */ + Bytef *extra; /* pointer to extra field or Z_NULL if none */ + uInt extra_len; /* extra field length (valid if extra != Z_NULL) */ + uInt extra_max; /* space at extra (only when reading header) */ + Bytef *name; /* pointer to zero-terminated file name or Z_NULL */ + uInt name_max; /* space at name (only when reading header) */ + Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */ + uInt comm_max; /* space at comment (only when reading header) */ + int hcrc; /* true if there was or will be a header crc */ + int done; /* true when done reading gzip header (not used + when writing a gzip file) */ +} gz_header; + +typedef gz_header FAR *gz_headerp; + +/* + The application must update next_in and avail_in when avail_in has dropped + to zero. It must update next_out and avail_out when avail_out has dropped + to zero. The application must initialize zalloc, zfree and opaque before + calling the init function. All other fields are set by the compression + library and must not be updated by the application. + + The opaque value provided by the application will be passed as the first + parameter for calls of zalloc and zfree. This can be useful for custom + memory management. The compression library attaches no meaning to the + opaque value. + + zalloc must return Z_NULL if there is not enough memory for the object. + If zlib is used in a multi-threaded application, zalloc and zfree must be + thread safe. + + On 16-bit systems, the functions zalloc and zfree must be able to allocate + exactly 65536 bytes, but will not be required to allocate more than this if + the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers + returned by zalloc for objects of exactly 65536 bytes *must* have their + offset normalized to zero. The default allocation function provided by this + library ensures this (see zutil.c). To reduce memory requirements and avoid + any allocation of 64K objects, at the expense of compression ratio, compile + the library with -DMAX_WBITS=14 (see zconf.h). + + The fields total_in and total_out can be used for statistics or progress + reports. After compression, total_in holds the total size of the + uncompressed data and may be saved for use in the decompressor (particularly + if the decompressor wants to decompress everything in a single step). +*/ + + /* constants */ + +#define Z_NO_FLUSH 0 +#define Z_PARTIAL_FLUSH 1 +#define Z_SYNC_FLUSH 2 +#define Z_FULL_FLUSH 3 +#define Z_FINISH 4 +#define Z_BLOCK 5 +#define Z_TREES 6 +/* Allowed flush values; see deflate() and inflate() below for details */ + +#define Z_OK 0 +#define Z_STREAM_END 1 +#define Z_NEED_DICT 2 +#define Z_ERRNO (-1) +#define Z_STREAM_ERROR (-2) +#define Z_DATA_ERROR (-3) +#define Z_MEM_ERROR (-4) +#define Z_BUF_ERROR (-5) +#define Z_VERSION_ERROR (-6) +/* Return codes for the compression/decompression functions. Negative values + * are errors, positive values are used for special but normal events. + */ + +#define Z_NO_COMPRESSION 0 +#define Z_BEST_SPEED 1 +#define Z_BEST_COMPRESSION 9 +#define Z_DEFAULT_COMPRESSION (-1) +/* compression levels */ + +#define Z_FILTERED 1 +#define Z_HUFFMAN_ONLY 2 +#define Z_RLE 3 +#define Z_FIXED 4 +#define Z_DEFAULT_STRATEGY 0 +/* compression strategy; see deflateInit2() below for details */ + +#define Z_BINARY 0 +#define Z_TEXT 1 +#define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */ +#define Z_UNKNOWN 2 +/* Possible values of the data_type field (though see inflate()) */ + +#define Z_DEFLATED 8 +/* The deflate compression method (the only one supported in this version) */ + +#define Z_NULL 0 /* for initializing zalloc, zfree, opaque */ + +#define zlib_version zlibVersion() +/* for compatibility with versions < 1.0.2 */ + + + /* basic functions */ + +ZEXTERN const char * ZEXPORT zlibVersion OF((void)); +/* The application can compare zlibVersion and ZLIB_VERSION for consistency. + If the first character differs, the library code actually used is not + compatible with the zlib.h header file used by the application. This check + is automatically made by deflateInit and inflateInit. + */ + +/* +ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level)); + + Initializes the internal stream state for compression. The fields + zalloc, zfree and opaque must be initialized before by the caller. If + zalloc and zfree are set to Z_NULL, deflateInit updates them to use default + allocation functions. + + The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9: + 1 gives best speed, 9 gives best compression, 0 gives no compression at all + (the input data is simply copied a block at a time). Z_DEFAULT_COMPRESSION + requests a default compromise between speed and compression (currently + equivalent to level 6). + + deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough + memory, Z_STREAM_ERROR if level is not a valid compression level, or + Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible + with the version assumed by the caller (ZLIB_VERSION). msg is set to null + if there is no error message. deflateInit does not perform any compression: + this will be done by deflate(). +*/ + + +ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush)); +/* + deflate compresses as much data as possible, and stops when the input + buffer becomes empty or the output buffer becomes full. It may introduce + some output latency (reading input without producing any output) except when + forced to flush. + + The detailed semantics are as follows. deflate performs one or both of the + following actions: + + - Compress more input starting at next_in and update next_in and avail_in + accordingly. If not all input can be processed (because there is not + enough room in the output buffer), next_in and avail_in are updated and + processing will resume at this point for the next call of deflate(). + + - Provide more output starting at next_out and update next_out and avail_out + accordingly. This action is forced if the parameter flush is non zero. + Forcing flush frequently degrades the compression ratio, so this parameter + should be set only when necessary (in interactive applications). Some + output may be provided even if flush is not set. + + Before the call of deflate(), the application should ensure that at least + one of the actions is possible, by providing more input and/or consuming more + output, and updating avail_in or avail_out accordingly; avail_out should + never be zero before the call. The application can consume the compressed + output when it wants, for example when the output buffer is full (avail_out + == 0), or after each call of deflate(). If deflate returns Z_OK and with + zero avail_out, it must be called again after making room in the output + buffer because there might be more output pending. + + Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to + decide how much data to accumulate before producing output, in order to + maximize compression. + + If the parameter flush is set to Z_SYNC_FLUSH, all pending output is + flushed to the output buffer and the output is aligned on a byte boundary, so + that the decompressor can get all input data available so far. (In + particular avail_in is zero after the call if enough output space has been + provided before the call.) Flushing may degrade compression for some + compression algorithms and so it should be used only when necessary. This + completes the current deflate block and follows it with an empty stored block + that is three bits plus filler bits to the next byte, followed by four bytes + (00 00 ff ff). + + If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the + output buffer, but the output is not aligned to a byte boundary. All of the + input data so far will be available to the decompressor, as for Z_SYNC_FLUSH. + This completes the current deflate block and follows it with an empty fixed + codes block that is 10 bits long. This assures that enough bytes are output + in order for the decompressor to finish the block before the empty fixed code + block. + + If flush is set to Z_BLOCK, a deflate block is completed and emitted, as + for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to + seven bits of the current block are held to be written as the next byte after + the next deflate block is completed. In this case, the decompressor may not + be provided enough bits at this point in order to complete decompression of + the data provided so far to the compressor. It may need to wait for the next + block to be emitted. This is for advanced applications that need to control + the emission of deflate blocks. + + If flush is set to Z_FULL_FLUSH, all output is flushed as with + Z_SYNC_FLUSH, and the compression state is reset so that decompression can + restart from this point if previous compressed data has been damaged or if + random access is desired. Using Z_FULL_FLUSH too often can seriously degrade + compression. + + If deflate returns with avail_out == 0, this function must be called again + with the same value of the flush parameter and more output space (updated + avail_out), until the flush is complete (deflate returns with non-zero + avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that + avail_out is greater than six to avoid repeated flush markers due to + avail_out == 0 on return. + + If the parameter flush is set to Z_FINISH, pending input is processed, + pending output is flushed and deflate returns with Z_STREAM_END if there was + enough output space; if deflate returns with Z_OK, this function must be + called again with Z_FINISH and more output space (updated avail_out) but no + more input data, until it returns with Z_STREAM_END or an error. After + deflate has returned Z_STREAM_END, the only possible operations on the stream + are deflateReset or deflateEnd. + + Z_FINISH can be used immediately after deflateInit if all the compression + is to be done in a single step. In this case, avail_out must be at least the + value returned by deflateBound (see below). Then deflate is guaranteed to + return Z_STREAM_END. If not enough output space is provided, deflate will + not return Z_STREAM_END, and it must be called again as described above. + + deflate() sets strm->adler to the adler32 checksum of all input read + so far (that is, total_in bytes). + + deflate() may update strm->data_type if it can make a good guess about + the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered + binary. This field is only for information purposes and does not affect the + compression algorithm in any manner. + + deflate() returns Z_OK if some progress has been made (more input + processed or more output produced), Z_STREAM_END if all input has been + consumed and all output has been produced (only when flush is set to + Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example + if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible + (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not + fatal, and deflate() can be called again with more input and more output + space to continue compressing. +*/ + + +ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm)); +/* + All dynamically allocated data structures for this stream are freed. + This function discards any unprocessed input and does not flush any pending + output. + + deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the + stream state was inconsistent, Z_DATA_ERROR if the stream was freed + prematurely (some input or output was discarded). In the error case, msg + may be set but then points to a static string (which must not be + deallocated). +*/ + + +/* +ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm)); + + Initializes the internal stream state for decompression. The fields + next_in, avail_in, zalloc, zfree and opaque must be initialized before by + the caller. If next_in is not Z_NULL and avail_in is large enough (the + exact value depends on the compression method), inflateInit determines the + compression method from the zlib header and allocates all data structures + accordingly; otherwise the allocation will be deferred to the first call of + inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to + use default allocation functions. + + inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough + memory, Z_VERSION_ERROR if the zlib library version is incompatible with the + version assumed by the caller, or Z_STREAM_ERROR if the parameters are + invalid, such as a null pointer to the structure. msg is set to null if + there is no error message. inflateInit does not perform any decompression + apart from possibly reading the zlib header if present: actual decompression + will be done by inflate(). (So next_in and avail_in may be modified, but + next_out and avail_out are unused and unchanged.) The current implementation + of inflateInit() does not process any header information -- that is deferred + until inflate() is called. +*/ + + +ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush)); +/* + inflate decompresses as much data as possible, and stops when the input + buffer becomes empty or the output buffer becomes full. It may introduce + some output latency (reading input without producing any output) except when + forced to flush. + + The detailed semantics are as follows. inflate performs one or both of the + following actions: + + - Decompress more input starting at next_in and update next_in and avail_in + accordingly. If not all input can be processed (because there is not + enough room in the output buffer), next_in is updated and processing will + resume at this point for the next call of inflate(). + + - Provide more output starting at next_out and update next_out and avail_out + accordingly. inflate() provides as much output as possible, until there is + no more input data or no more space in the output buffer (see below about + the flush parameter). + + Before the call of inflate(), the application should ensure that at least + one of the actions is possible, by providing more input and/or consuming more + output, and updating the next_* and avail_* values accordingly. The + application can consume the uncompressed output when it wants, for example + when the output buffer is full (avail_out == 0), or after each call of + inflate(). If inflate returns Z_OK and with zero avail_out, it must be + called again after making room in the output buffer because there might be + more output pending. + + The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH, + Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much + output as possible to the output buffer. Z_BLOCK requests that inflate() + stop if and when it gets to the next deflate block boundary. When decoding + the zlib or gzip format, this will cause inflate() to return immediately + after the header and before the first block. When doing a raw inflate, + inflate() will go ahead and process the first block, and will return when it + gets to the end of that block, or when it runs out of data. + + The Z_BLOCK option assists in appending to or combining deflate streams. + Also to assist in this, on return inflate() will set strm->data_type to the + number of unused bits in the last byte taken from strm->next_in, plus 64 if + inflate() is currently decoding the last block in the deflate stream, plus + 128 if inflate() returned immediately after decoding an end-of-block code or + decoding the complete header up to just before the first byte of the deflate + stream. The end-of-block will not be indicated until all of the uncompressed + data from that block has been written to strm->next_out. The number of + unused bits may in general be greater than seven, except when bit 7 of + data_type is set, in which case the number of unused bits will be less than + eight. data_type is set as noted here every time inflate() returns for all + flush options, and so can be used to determine the amount of currently + consumed input in bits. + + The Z_TREES option behaves as Z_BLOCK does, but it also returns when the + end of each deflate block header is reached, before any actual data in that + block is decoded. This allows the caller to determine the length of the + deflate block header for later use in random access within a deflate block. + 256 is added to the value of strm->data_type when inflate() returns + immediately after reaching the end of the deflate block header. + + inflate() should normally be called until it returns Z_STREAM_END or an + error. However if all decompression is to be performed in a single step (a + single call of inflate), the parameter flush should be set to Z_FINISH. In + this case all pending input is processed and all pending output is flushed; + avail_out must be large enough to hold all of the uncompressed data for the + operation to complete. (The size of the uncompressed data may have been + saved by the compressor for this purpose.) The use of Z_FINISH is not + required to perform an inflation in one step. However it may be used to + inform inflate that a faster approach can be used for the single inflate() + call. Z_FINISH also informs inflate to not maintain a sliding window if the + stream completes, which reduces inflate's memory footprint. If the stream + does not complete, either because not all of the stream is provided or not + enough output space is provided, then a sliding window will be allocated and + inflate() can be called again to continue the operation as if Z_NO_FLUSH had + been used. + + In this implementation, inflate() always flushes as much output as + possible to the output buffer, and always uses the faster approach on the + first call. So the effects of the flush parameter in this implementation are + on the return value of inflate() as noted below, when inflate() returns early + when Z_BLOCK or Z_TREES is used, and when inflate() avoids the allocation of + memory for a sliding window when Z_FINISH is used. + + If a preset dictionary is needed after this call (see inflateSetDictionary + below), inflate sets strm->adler to the Adler-32 checksum of the dictionary + chosen by the compressor and returns Z_NEED_DICT; otherwise it sets + strm->adler to the Adler-32 checksum of all output produced so far (that is, + total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described + below. At the end of the stream, inflate() checks that its computed adler32 + checksum is equal to that saved by the compressor and returns Z_STREAM_END + only if the checksum is correct. + + inflate() can decompress and check either zlib-wrapped or gzip-wrapped + deflate data. The header type is detected automatically, if requested when + initializing with inflateInit2(). Any information contained in the gzip + header is not retained, so applications that need that information should + instead use raw inflate, see inflateInit2() below, or inflateBack() and + perform their own processing of the gzip header and trailer. When processing + gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output + producted so far. The CRC-32 is checked against the gzip trailer. + + inflate() returns Z_OK if some progress has been made (more input processed + or more output produced), Z_STREAM_END if the end of the compressed data has + been reached and all uncompressed output has been produced, Z_NEED_DICT if a + preset dictionary is needed at this point, Z_DATA_ERROR if the input data was + corrupted (input stream not conforming to the zlib format or incorrect check + value), Z_STREAM_ERROR if the stream structure was inconsistent (for example + next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory, + Z_BUF_ERROR if no progress is possible or if there was not enough room in the + output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and + inflate() can be called again with more input and more output space to + continue decompressing. If Z_DATA_ERROR is returned, the application may + then call inflateSync() to look for a good compression block if a partial + recovery of the data is desired. +*/ + + +ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm)); +/* + All dynamically allocated data structures for this stream are freed. + This function discards any unprocessed input and does not flush any pending + output. + + inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state + was inconsistent. In the error case, msg may be set but then points to a + static string (which must not be deallocated). +*/ + + + /* Advanced functions */ + +/* + The following functions are needed only in some special applications. +*/ + +/* +ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm, + int level, + int method, + int windowBits, + int memLevel, + int strategy)); + + This is another version of deflateInit with more compression options. The + fields next_in, zalloc, zfree and opaque must be initialized before by the + caller. + + The method parameter is the compression method. It must be Z_DEFLATED in + this version of the library. + + The windowBits parameter is the base two logarithm of the window size + (the size of the history buffer). It should be in the range 8..15 for this + version of the library. Larger values of this parameter result in better + compression at the expense of memory usage. The default value is 15 if + deflateInit is used instead. + + windowBits can also be -8..-15 for raw deflate. In this case, -windowBits + determines the window size. deflate() will then generate raw deflate data + with no zlib header or trailer, and will not compute an adler32 check value. + + windowBits can also be greater than 15 for optional gzip encoding. Add + 16 to windowBits to write a simple gzip header and trailer around the + compressed data instead of a zlib wrapper. The gzip header will have no + file name, no extra data, no comment, no modification time (set to zero), no + header crc, and the operating system will be set to 255 (unknown). If a + gzip stream is being written, strm->adler is a crc32 instead of an adler32. + + The memLevel parameter specifies how much memory should be allocated + for the internal compression state. memLevel=1 uses minimum memory but is + slow and reduces compression ratio; memLevel=9 uses maximum memory for + optimal speed. The default value is 8. See zconf.h for total memory usage + as a function of windowBits and memLevel. + + The strategy parameter is used to tune the compression algorithm. Use the + value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a + filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no + string match), or Z_RLE to limit match distances to one (run-length + encoding). Filtered data consists mostly of small values with a somewhat + random distribution. In this case, the compression algorithm is tuned to + compress them better. The effect of Z_FILTERED is to force more Huffman + coding and less string matching; it is somewhat intermediate between + Z_DEFAULT_STRATEGY and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as + fast as Z_HUFFMAN_ONLY, but give better compression for PNG image data. The + strategy parameter only affects the compression ratio but not the + correctness of the compressed output even if it is not set appropriately. + Z_FIXED prevents the use of dynamic Huffman codes, allowing for a simpler + decoder for special applications. + + deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough + memory, Z_STREAM_ERROR if any parameter is invalid (such as an invalid + method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is + incompatible with the version assumed by the caller (ZLIB_VERSION). msg is + set to null if there is no error message. deflateInit2 does not perform any + compression: this will be done by deflate(). +*/ + +ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm, + const Bytef *dictionary, + uInt dictLength)); +/* + Initializes the compression dictionary from the given byte sequence + without producing any compressed output. When using the zlib format, this + function must be called immediately after deflateInit, deflateInit2 or + deflateReset, and before any call of deflate. When doing raw deflate, this + function must be called either before any call of deflate, or immediately + after the completion of a deflate block, i.e. after all input has been + consumed and all output has been delivered when using any of the flush + options Z_BLOCK, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, or Z_FULL_FLUSH. The + compressor and decompressor must use exactly the same dictionary (see + inflateSetDictionary). + + The dictionary should consist of strings (byte sequences) that are likely + to be encountered later in the data to be compressed, with the most commonly + used strings preferably put towards the end of the dictionary. Using a + dictionary is most useful when the data to be compressed is short and can be + predicted with good accuracy; the data can then be compressed better than + with the default empty dictionary. + + Depending on the size of the compression data structures selected by + deflateInit or deflateInit2, a part of the dictionary may in effect be + discarded, for example if the dictionary is larger than the window size + provided in deflateInit or deflateInit2. Thus the strings most likely to be + useful should be put at the end of the dictionary, not at the front. In + addition, the current implementation of deflate will use at most the window + size minus 262 bytes of the provided dictionary. + + Upon return of this function, strm->adler is set to the adler32 value + of the dictionary; the decompressor may later use this value to determine + which dictionary has been used by the compressor. (The adler32 value + applies to the whole dictionary even if only a subset of the dictionary is + actually used by the compressor.) If a raw deflate was requested, then the + adler32 value is not computed and strm->adler is not set. + + deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a + parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is + inconsistent (for example if deflate has already been called for this stream + or if not at a block boundary for raw deflate). deflateSetDictionary does + not perform any compression: this will be done by deflate(). +*/ + +ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest, + z_streamp source)); +/* + Sets the destination stream as a complete copy of the source stream. + + This function can be useful when several compression strategies will be + tried, for example when there are several ways of pre-processing the input + data with a filter. The streams that will be discarded should then be freed + by calling deflateEnd. Note that deflateCopy duplicates the internal + compression state which can be quite large, so this strategy is slow and can + consume lots of memory. + + deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not + enough memory, Z_STREAM_ERROR if the source stream state was inconsistent + (such as zalloc being Z_NULL). msg is left unchanged in both source and + destination. +*/ + +ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm)); +/* + This function is equivalent to deflateEnd followed by deflateInit, + but does not free and reallocate all the internal compression state. The + stream will keep the same compression level and any other attributes that + may have been set by deflateInit2. + + deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source + stream state was inconsistent (such as zalloc or state being Z_NULL). +*/ + +ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm, + int level, + int strategy)); +/* + Dynamically update the compression level and compression strategy. The + interpretation of level and strategy is as in deflateInit2. This can be + used to switch between compression and straight copy of the input data, or + to switch to a different kind of input data requiring a different strategy. + If the compression level is changed, the input available so far is + compressed with the old level (and may be flushed); the new level will take + effect only at the next call of deflate(). + + Before the call of deflateParams, the stream state must be set as for + a call of deflate(), since the currently available input may have to be + compressed and flushed. In particular, strm->avail_out must be non-zero. + + deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source + stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if + strm->avail_out was zero. +*/ + +ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm, + int good_length, + int max_lazy, + int nice_length, + int max_chain)); +/* + Fine tune deflate's internal compression parameters. This should only be + used by someone who understands the algorithm used by zlib's deflate for + searching for the best matching string, and even then only by the most + fanatic optimizer trying to squeeze out the last compressed bit for their + specific input data. Read the deflate.c source code for the meaning of the + max_lazy, good_length, nice_length, and max_chain parameters. + + deflateTune() can be called after deflateInit() or deflateInit2(), and + returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream. + */ + +ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm, + uLong sourceLen)); +/* + deflateBound() returns an upper bound on the compressed size after + deflation of sourceLen bytes. It must be called after deflateInit() or + deflateInit2(), and after deflateSetHeader(), if used. This would be used + to allocate an output buffer for deflation in a single pass, and so would be + called before deflate(). If that first deflate() call is provided the + sourceLen input bytes, an output buffer allocated to the size returned by + deflateBound(), and the flush value Z_FINISH, then deflate() is guaranteed + to return Z_STREAM_END. Note that it is possible for the compressed size to + be larger than the value returned by deflateBound() if flush options other + than Z_FINISH or Z_NO_FLUSH are used. +*/ + +ZEXTERN int ZEXPORT deflatePending OF((z_streamp strm, + unsigned *pending, + int *bits)); +/* + deflatePending() returns the number of bytes and bits of output that have + been generated, but not yet provided in the available output. The bytes not + provided would be due to the available output space having being consumed. + The number of bits of output not provided are between 0 and 7, where they + await more bits to join them in order to fill out a full byte. If pending + or bits are Z_NULL, then those values are not set. + + deflatePending returns Z_OK if success, or Z_STREAM_ERROR if the source + stream state was inconsistent. + */ + +ZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm, + int bits, + int value)); +/* + deflatePrime() inserts bits in the deflate output stream. The intent + is that this function is used to start off the deflate output with the bits + leftover from a previous deflate stream when appending to it. As such, this + function can only be used for raw deflate, and must be used before the first + deflate() call after a deflateInit2() or deflateReset(). bits must be less + than or equal to 16, and that many of the least significant bits of value + will be inserted in the output. + + deflatePrime returns Z_OK if success, Z_BUF_ERROR if there was not enough + room in the internal buffer to insert the bits, or Z_STREAM_ERROR if the + source stream state was inconsistent. +*/ + +ZEXTERN int ZEXPORT deflateSetHeader OF((z_streamp strm, + gz_headerp head)); +/* + deflateSetHeader() provides gzip header information for when a gzip + stream is requested by deflateInit2(). deflateSetHeader() may be called + after deflateInit2() or deflateReset() and before the first call of + deflate(). The text, time, os, extra field, name, and comment information + in the provided gz_header structure are written to the gzip header (xflag is + ignored -- the extra flags are set according to the compression level). The + caller must assure that, if not Z_NULL, name and comment are terminated with + a zero byte, and that if extra is not Z_NULL, that extra_len bytes are + available there. If hcrc is true, a gzip header crc is included. Note that + the current versions of the command-line version of gzip (up through version + 1.3.x) do not support header crc's, and will report that it is a "multi-part + gzip file" and give up. + + If deflateSetHeader is not used, the default gzip header has text false, + the time set to zero, and os set to 255, with no extra, name, or comment + fields. The gzip header is returned to the default state by deflateReset(). + + deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source + stream state was inconsistent. +*/ + +/* +ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm, + int windowBits)); + + This is another version of inflateInit with an extra parameter. The + fields next_in, avail_in, zalloc, zfree and opaque must be initialized + before by the caller. + + The windowBits parameter is the base two logarithm of the maximum window + size (the size of the history buffer). It should be in the range 8..15 for + this version of the library. The default value is 15 if inflateInit is used + instead. windowBits must be greater than or equal to the windowBits value + provided to deflateInit2() while compressing, or it must be equal to 15 if + deflateInit2() was not used. If a compressed stream with a larger window + size is given as input, inflate() will return with the error code + Z_DATA_ERROR instead of trying to allocate a larger window. + + windowBits can also be zero to request that inflate use the window size in + the zlib header of the compressed stream. + + windowBits can also be -8..-15 for raw inflate. In this case, -windowBits + determines the window size. inflate() will then process raw deflate data, + not looking for a zlib or gzip header, not generating a check value, and not + looking for any check values for comparison at the end of the stream. This + is for use with other formats that use the deflate compressed data format + such as zip. Those formats provide their own check values. If a custom + format is developed using the raw deflate format for compressed data, it is + recommended that a check value such as an adler32 or a crc32 be applied to + the uncompressed data as is done in the zlib, gzip, and zip formats. For + most applications, the zlib format should be used as is. Note that comments + above on the use in deflateInit2() applies to the magnitude of windowBits. + + windowBits can also be greater than 15 for optional gzip decoding. Add + 32 to windowBits to enable zlib and gzip decoding with automatic header + detection, or add 16 to decode only the gzip format (the zlib format will + return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a + crc32 instead of an adler32. + + inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough + memory, Z_VERSION_ERROR if the zlib library version is incompatible with the + version assumed by the caller, or Z_STREAM_ERROR if the parameters are + invalid, such as a null pointer to the structure. msg is set to null if + there is no error message. inflateInit2 does not perform any decompression + apart from possibly reading the zlib header if present: actual decompression + will be done by inflate(). (So next_in and avail_in may be modified, but + next_out and avail_out are unused and unchanged.) The current implementation + of inflateInit2() does not process any header information -- that is + deferred until inflate() is called. +*/ + +ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm, + const Bytef *dictionary, + uInt dictLength)); +/* + Initializes the decompression dictionary from the given uncompressed byte + sequence. This function must be called immediately after a call of inflate, + if that call returned Z_NEED_DICT. The dictionary chosen by the compressor + can be determined from the adler32 value returned by that call of inflate. + The compressor and decompressor must use exactly the same dictionary (see + deflateSetDictionary). For raw inflate, this function can be called at any + time to set the dictionary. If the provided dictionary is smaller than the + window and there is already data in the window, then the provided dictionary + will amend what's there. The application must insure that the dictionary + that was used for compression is provided. + + inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a + parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is + inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the + expected one (incorrect adler32 value). inflateSetDictionary does not + perform any decompression: this will be done by subsequent calls of + inflate(). +*/ + +ZEXTERN int ZEXPORT inflateGetDictionary OF((z_streamp strm, + Bytef *dictionary, + uInt *dictLength)); +/* + Returns the sliding dictionary being maintained by inflate. dictLength is + set to the number of bytes in the dictionary, and that many bytes are copied + to dictionary. dictionary must have enough space, where 32768 bytes is + always enough. If inflateGetDictionary() is called with dictionary equal to + Z_NULL, then only the dictionary length is returned, and nothing is copied. + Similary, if dictLength is Z_NULL, then it is not set. + + inflateGetDictionary returns Z_OK on success, or Z_STREAM_ERROR if the + stream state is inconsistent. +*/ + +ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm)); +/* + Skips invalid compressed data until a possible full flush point (see above + for the description of deflate with Z_FULL_FLUSH) can be found, or until all + available input is skipped. No output is provided. + + inflateSync searches for a 00 00 FF FF pattern in the compressed data. + All full flush points have this pattern, but not all occurrences of this + pattern are full flush points. + + inflateSync returns Z_OK if a possible full flush point has been found, + Z_BUF_ERROR if no more input was provided, Z_DATA_ERROR if no flush point + has been found, or Z_STREAM_ERROR if the stream structure was inconsistent. + In the success case, the application may save the current current value of + total_in which indicates where valid compressed data was found. In the + error case, the application may repeatedly call inflateSync, providing more + input each time, until success or end of the input data. +*/ + +ZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest, + z_streamp source)); +/* + Sets the destination stream as a complete copy of the source stream. + + This function can be useful when randomly accessing a large stream. The + first pass through the stream can periodically record the inflate state, + allowing restarting inflate at those points when randomly accessing the + stream. + + inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not + enough memory, Z_STREAM_ERROR if the source stream state was inconsistent + (such as zalloc being Z_NULL). msg is left unchanged in both source and + destination. +*/ + +ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm)); +/* + This function is equivalent to inflateEnd followed by inflateInit, + but does not free and reallocate all the internal decompression state. The + stream will keep attributes that may have been set by inflateInit2. + + inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source + stream state was inconsistent (such as zalloc or state being Z_NULL). +*/ + +ZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm, + int windowBits)); +/* + This function is the same as inflateReset, but it also permits changing + the wrap and window size requests. The windowBits parameter is interpreted + the same as it is for inflateInit2. + + inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source + stream state was inconsistent (such as zalloc or state being Z_NULL), or if + the windowBits parameter is invalid. +*/ + +ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm, + int bits, + int value)); +/* + This function inserts bits in the inflate input stream. The intent is + that this function is used to start inflating at a bit position in the + middle of a byte. The provided bits will be used before any bytes are used + from next_in. This function should only be used with raw inflate, and + should be used before the first inflate() call after inflateInit2() or + inflateReset(). bits must be less than or equal to 16, and that many of the + least significant bits of value will be inserted in the input. + + If bits is negative, then the input stream bit buffer is emptied. Then + inflatePrime() can be called again to put bits in the buffer. This is used + to clear out bits leftover after feeding inflate a block description prior + to feeding inflate codes. + + inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source + stream state was inconsistent. +*/ + +ZEXTERN long ZEXPORT inflateMark OF((z_streamp strm)); +/* + This function returns two values, one in the lower 16 bits of the return + value, and the other in the remaining upper bits, obtained by shifting the + return value down 16 bits. If the upper value is -1 and the lower value is + zero, then inflate() is currently decoding information outside of a block. + If the upper value is -1 and the lower value is non-zero, then inflate is in + the middle of a stored block, with the lower value equaling the number of + bytes from the input remaining to copy. If the upper value is not -1, then + it is the number of bits back from the current bit position in the input of + the code (literal or length/distance pair) currently being processed. In + that case the lower value is the number of bytes already emitted for that + code. + + A code is being processed if inflate is waiting for more input to complete + decoding of the code, or if it has completed decoding but is waiting for + more output space to write the literal or match data. + + inflateMark() is used to mark locations in the input data for random + access, which may be at bit positions, and to note those cases where the + output of a code may span boundaries of random access blocks. The current + location in the input stream can be determined from avail_in and data_type + as noted in the description for the Z_BLOCK flush parameter for inflate. + + inflateMark returns the value noted above or -1 << 16 if the provided + source stream state was inconsistent. +*/ + +ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm, + gz_headerp head)); +/* + inflateGetHeader() requests that gzip header information be stored in the + provided gz_header structure. inflateGetHeader() may be called after + inflateInit2() or inflateReset(), and before the first call of inflate(). + As inflate() processes the gzip stream, head->done is zero until the header + is completed, at which time head->done is set to one. If a zlib stream is + being decoded, then head->done is set to -1 to indicate that there will be + no gzip header information forthcoming. Note that Z_BLOCK or Z_TREES can be + used to force inflate() to return immediately after header processing is + complete and before any actual data is decompressed. + + The text, time, xflags, and os fields are filled in with the gzip header + contents. hcrc is set to true if there is a header CRC. (The header CRC + was valid if done is set to one.) If extra is not Z_NULL, then extra_max + contains the maximum number of bytes to write to extra. Once done is true, + extra_len contains the actual extra field length, and extra contains the + extra field, or that field truncated if extra_max is less than extra_len. + If name is not Z_NULL, then up to name_max characters are written there, + terminated with a zero unless the length is greater than name_max. If + comment is not Z_NULL, then up to comm_max characters are written there, + terminated with a zero unless the length is greater than comm_max. When any + of extra, name, or comment are not Z_NULL and the respective field is not + present in the header, then that field is set to Z_NULL to signal its + absence. This allows the use of deflateSetHeader() with the returned + structure to duplicate the header. However if those fields are set to + allocated memory, then the application will need to save those pointers + elsewhere so that they can be eventually freed. + + If inflateGetHeader is not used, then the header information is simply + discarded. The header is always checked for validity, including the header + CRC if present. inflateReset() will reset the process to discard the header + information. The application would need to call inflateGetHeader() again to + retrieve the header from the next gzip stream. + + inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source + stream state was inconsistent. +*/ + +/* +ZEXTERN int ZEXPORT inflateBackInit OF((z_streamp strm, int windowBits, + unsigned char FAR *window)); + + Initialize the internal stream state for decompression using inflateBack() + calls. The fields zalloc, zfree and opaque in strm must be initialized + before the call. If zalloc and zfree are Z_NULL, then the default library- + derived memory allocation routines are used. windowBits is the base two + logarithm of the window size, in the range 8..15. window is a caller + supplied buffer of that size. Except for special applications where it is + assured that deflate was used with small window sizes, windowBits must be 15 + and a 32K byte window must be supplied to be able to decompress general + deflate streams. + + See inflateBack() for the usage of these routines. + + inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of + the parameters are invalid, Z_MEM_ERROR if the internal state could not be + allocated, or Z_VERSION_ERROR if the version of the library does not match + the version of the header file. +*/ + +typedef unsigned (*in_func) OF((void FAR *, + z_const unsigned char FAR * FAR *)); +typedef int (*out_func) OF((void FAR *, unsigned char FAR *, unsigned)); + +ZEXTERN int ZEXPORT inflateBack OF((z_streamp strm, + in_func in, void FAR *in_desc, + out_func out, void FAR *out_desc)); +/* + inflateBack() does a raw inflate with a single call using a call-back + interface for input and output. This is potentially more efficient than + inflate() for file i/o applications, in that it avoids copying between the + output and the sliding window by simply making the window itself the output + buffer. inflate() can be faster on modern CPUs when used with large + buffers. inflateBack() trusts the application to not change the output + buffer passed by the output function, at least until inflateBack() returns. + + inflateBackInit() must be called first to allocate the internal state + and to initialize the state with the user-provided window buffer. + inflateBack() may then be used multiple times to inflate a complete, raw + deflate stream with each call. inflateBackEnd() is then called to free the + allocated state. + + A raw deflate stream is one with no zlib or gzip header or trailer. + This routine would normally be used in a utility that reads zip or gzip + files and writes out uncompressed files. The utility would decode the + header and process the trailer on its own, hence this routine expects only + the raw deflate stream to decompress. This is different from the normal + behavior of inflate(), which expects either a zlib or gzip header and + trailer around the deflate stream. + + inflateBack() uses two subroutines supplied by the caller that are then + called by inflateBack() for input and output. inflateBack() calls those + routines until it reads a complete deflate stream and writes out all of the + uncompressed data, or until it encounters an error. The function's + parameters and return types are defined above in the in_func and out_func + typedefs. inflateBack() will call in(in_desc, &buf) which should return the + number of bytes of provided input, and a pointer to that input in buf. If + there is no input available, in() must return zero--buf is ignored in that + case--and inflateBack() will return a buffer error. inflateBack() will call + out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out() + should return zero on success, or non-zero on failure. If out() returns + non-zero, inflateBack() will return with an error. Neither in() nor out() + are permitted to change the contents of the window provided to + inflateBackInit(), which is also the buffer that out() uses to write from. + The length written by out() will be at most the window size. Any non-zero + amount of input may be provided by in(). + + For convenience, inflateBack() can be provided input on the first call by + setting strm->next_in and strm->avail_in. If that input is exhausted, then + in() will be called. Therefore strm->next_in must be initialized before + calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called + immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in + must also be initialized, and then if strm->avail_in is not zero, input will + initially be taken from strm->next_in[0 .. strm->avail_in - 1]. + + The in_desc and out_desc parameters of inflateBack() is passed as the + first parameter of in() and out() respectively when they are called. These + descriptors can be optionally used to pass any information that the caller- + supplied in() and out() functions need to do their job. + + On return, inflateBack() will set strm->next_in and strm->avail_in to + pass back any unused input that was provided by the last in() call. The + return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR + if in() or out() returned an error, Z_DATA_ERROR if there was a format error + in the deflate stream (in which case strm->msg is set to indicate the nature + of the error), or Z_STREAM_ERROR if the stream was not properly initialized. + In the case of Z_BUF_ERROR, an input or output error can be distinguished + using strm->next_in which will be Z_NULL only if in() returned an error. If + strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning + non-zero. (in() will always be called before out(), so strm->next_in is + assured to be defined if out() returns non-zero.) Note that inflateBack() + cannot return Z_OK. +*/ + +ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm)); +/* + All memory allocated by inflateBackInit() is freed. + + inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream + state was inconsistent. +*/ + +ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void)); +/* Return flags indicating compile-time options. + + Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other: + 1.0: size of uInt + 3.2: size of uLong + 5.4: size of voidpf (pointer) + 7.6: size of z_off_t + + Compiler, assembler, and debug options: + 8: DEBUG + 9: ASMV or ASMINF -- use ASM code + 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention + 11: 0 (reserved) + + One-time table building (smaller code, but not thread-safe if true): + 12: BUILDFIXED -- build static block decoding tables when needed + 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed + 14,15: 0 (reserved) + + Library content (indicates missing functionality): + 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking + deflate code when not needed) + 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect + and decode gzip streams (to avoid linking crc code) + 18-19: 0 (reserved) + + Operation variations (changes in library functionality): + 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate + 21: FASTEST -- deflate algorithm with only one, lowest compression level + 22,23: 0 (reserved) + + The sprintf variant used by gzprintf (zero is best): + 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format + 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure! + 26: 0 = returns value, 1 = void -- 1 means inferred string length returned + + Remainder: + 27-31: 0 (reserved) + */ + +#ifndef Z_SOLO + + /* utility functions */ + +/* + The following utility functions are implemented on top of the basic + stream-oriented functions. To simplify the interface, some default options + are assumed (compression level and memory usage, standard memory allocation + functions). The source code of these utility functions can be modified if + you need special options. +*/ + +ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen, + const Bytef *source, uLong sourceLen)); +/* + Compresses the source buffer into the destination buffer. sourceLen is + the byte length of the source buffer. Upon entry, destLen is the total size + of the destination buffer, which must be at least the value returned by + compressBound(sourceLen). Upon exit, destLen is the actual size of the + compressed buffer. + + compress returns Z_OK if success, Z_MEM_ERROR if there was not + enough memory, Z_BUF_ERROR if there was not enough room in the output + buffer. +*/ + +ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen, + const Bytef *source, uLong sourceLen, + int level)); +/* + Compresses the source buffer into the destination buffer. The level + parameter has the same meaning as in deflateInit. sourceLen is the byte + length of the source buffer. Upon entry, destLen is the total size of the + destination buffer, which must be at least the value returned by + compressBound(sourceLen). Upon exit, destLen is the actual size of the + compressed buffer. + + compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough + memory, Z_BUF_ERROR if there was not enough room in the output buffer, + Z_STREAM_ERROR if the level parameter is invalid. +*/ + +ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen)); +/* + compressBound() returns an upper bound on the compressed size after + compress() or compress2() on sourceLen bytes. It would be used before a + compress() or compress2() call to allocate the destination buffer. +*/ + +ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen, + const Bytef *source, uLong sourceLen)); +/* + Decompresses the source buffer into the destination buffer. sourceLen is + the byte length of the source buffer. Upon entry, destLen is the total size + of the destination buffer, which must be large enough to hold the entire + uncompressed data. (The size of the uncompressed data must have been saved + previously by the compressor and transmitted to the decompressor by some + mechanism outside the scope of this compression library.) Upon exit, destLen + is the actual size of the uncompressed buffer. + + uncompress returns Z_OK if success, Z_MEM_ERROR if there was not + enough memory, Z_BUF_ERROR if there was not enough room in the output + buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. In + the case where there is not enough room, uncompress() will fill the output + buffer with the uncompressed data up to that point. +*/ + + /* gzip file access functions */ + +/* + This library supports reading and writing files in gzip (.gz) format with + an interface similar to that of stdio, using the functions that start with + "gz". The gzip format is different from the zlib format. gzip is a gzip + wrapper, documented in RFC 1952, wrapped around a deflate stream. +*/ + +typedef struct gzFile_s *gzFile; /* semi-opaque gzip file descriptor */ + +/* +ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode)); + + Opens a gzip (.gz) file for reading or writing. The mode parameter is as + in fopen ("rb" or "wb") but can also include a compression level ("wb9") or + a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman-only + compression as in "wb1h", 'R' for run-length encoding as in "wb1R", or 'F' + for fixed code compression as in "wb9F". (See the description of + deflateInit2 for more information about the strategy parameter.) 'T' will + request transparent writing or appending with no compression and not using + the gzip format. + + "a" can be used instead of "w" to request that the gzip stream that will + be written be appended to the file. "+" will result in an error, since + reading and writing to the same gzip file is not supported. The addition of + "x" when writing will create the file exclusively, which fails if the file + already exists. On systems that support it, the addition of "e" when + reading or writing will set the flag to close the file on an execve() call. + + These functions, as well as gzip, will read and decode a sequence of gzip + streams in a file. The append function of gzopen() can be used to create + such a file. (Also see gzflush() for another way to do this.) When + appending, gzopen does not test whether the file begins with a gzip stream, + nor does it look for the end of the gzip streams to begin appending. gzopen + will simply append a gzip stream to the existing file. + + gzopen can be used to read a file which is not in gzip format; in this + case gzread will directly read from the file without decompression. When + reading, this will be detected automatically by looking for the magic two- + byte gzip header. + + gzopen returns NULL if the file could not be opened, if there was + insufficient memory to allocate the gzFile state, or if an invalid mode was + specified (an 'r', 'w', or 'a' was not provided, or '+' was provided). + errno can be checked to determine if the reason gzopen failed was that the + file could not be opened. +*/ + +ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode)); +/* + gzdopen associates a gzFile with the file descriptor fd. File descriptors + are obtained from calls like open, dup, creat, pipe or fileno (if the file + has been previously opened with fopen). The mode parameter is as in gzopen. + + The next call of gzclose on the returned gzFile will also close the file + descriptor fd, just like fclose(fdopen(fd, mode)) closes the file descriptor + fd. If you want to keep fd open, use fd = dup(fd_keep); gz = gzdopen(fd, + mode);. The duplicated descriptor should be saved to avoid a leak, since + gzdopen does not close fd if it fails. If you are using fileno() to get the + file descriptor from a FILE *, then you will have to use dup() to avoid + double-close()ing the file descriptor. Both gzclose() and fclose() will + close the associated file descriptor, so they need to have different file + descriptors. + + gzdopen returns NULL if there was insufficient memory to allocate the + gzFile state, if an invalid mode was specified (an 'r', 'w', or 'a' was not + provided, or '+' was provided), or if fd is -1. The file descriptor is not + used until the next gz* read, write, seek, or close operation, so gzdopen + will not detect if fd is invalid (unless fd is -1). +*/ + +ZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size)); +/* + Set the internal buffer size used by this library's functions. The + default buffer size is 8192 bytes. This function must be called after + gzopen() or gzdopen(), and before any other calls that read or write the + file. The buffer memory allocation is always deferred to the first read or + write. Two buffers are allocated, either both of the specified size when + writing, or one of the specified size and the other twice that size when + reading. A larger buffer size of, for example, 64K or 128K bytes will + noticeably increase the speed of decompression (reading). + + The new buffer size also affects the maximum length for gzprintf(). + + gzbuffer() returns 0 on success, or -1 on failure, such as being called + too late. +*/ + +ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy)); +/* + Dynamically update the compression level or strategy. See the description + of deflateInit2 for the meaning of these parameters. + + gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not + opened for writing. +*/ + +ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len)); +/* + Reads the given number of uncompressed bytes from the compressed file. If + the input file is not in gzip format, gzread copies the given number of + bytes into the buffer directly from the file. + + After reaching the end of a gzip stream in the input, gzread will continue + to read, looking for another gzip stream. Any number of gzip streams may be + concatenated in the input file, and will all be decompressed by gzread(). + If something other than a gzip stream is encountered after a gzip stream, + that remaining trailing garbage is ignored (and no error is returned). + + gzread can be used to read a gzip file that is being concurrently written. + Upon reaching the end of the input, gzread will return with the available + data. If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then + gzclearerr can be used to clear the end of file indicator in order to permit + gzread to be tried again. Z_OK indicates that a gzip stream was completed + on the last gzread. Z_BUF_ERROR indicates that the input file ended in the + middle of a gzip stream. Note that gzread does not return -1 in the event + of an incomplete gzip stream. This error is deferred until gzclose(), which + will return Z_BUF_ERROR if the last gzread ended in the middle of a gzip + stream. Alternatively, gzerror can be used before gzclose to detect this + case. + + gzread returns the number of uncompressed bytes actually read, less than + len for end of file, or -1 for error. +*/ + +ZEXTERN int ZEXPORT gzwrite OF((gzFile file, + voidpc buf, unsigned len)); +/* + Writes the given number of uncompressed bytes into the compressed file. + gzwrite returns the number of uncompressed bytes written or 0 in case of + error. +*/ + +ZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile file, const char *format, ...)); +/* + Converts, formats, and writes the arguments to the compressed file under + control of the format string, as in fprintf. gzprintf returns the number of + uncompressed bytes actually written, or 0 in case of error. The number of + uncompressed bytes written is limited to 8191, or one less than the buffer + size given to gzbuffer(). The caller should assure that this limit is not + exceeded. If it is exceeded, then gzprintf() will return an error (0) with + nothing written. In this case, there may also be a buffer overflow with + unpredictable consequences, which is possible only if zlib was compiled with + the insecure functions sprintf() or vsprintf() because the secure snprintf() + or vsnprintf() functions were not available. This can be determined using + zlibCompileFlags(). +*/ + +ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s)); +/* + Writes the given null-terminated string to the compressed file, excluding + the terminating null character. + + gzputs returns the number of characters written, or -1 in case of error. +*/ + +ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len)); +/* + Reads bytes from the compressed file until len-1 characters are read, or a + newline character is read and transferred to buf, or an end-of-file + condition is encountered. If any characters are read or if len == 1, the + string is terminated with a null character. If no characters are read due + to an end-of-file or len < 1, then the buffer is left untouched. + + gzgets returns buf which is a null-terminated string, or it returns NULL + for end-of-file or in case of error. If there was an error, the contents at + buf are indeterminate. +*/ + +ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c)); +/* + Writes c, converted to an unsigned char, into the compressed file. gzputc + returns the value that was written, or -1 in case of error. +*/ + +ZEXTERN int ZEXPORT gzgetc OF((gzFile file)); +/* + Reads one byte from the compressed file. gzgetc returns this byte or -1 + in case of end of file or error. This is implemented as a macro for speed. + As such, it does not do all of the checking the other functions do. I.e. + it does not check to see if file is NULL, nor whether the structure file + points to has been clobbered or not. +*/ + +ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file)); +/* + Push one character back onto the stream to be read as the first character + on the next read. At least one character of push-back is allowed. + gzungetc() returns the character pushed, or -1 on failure. gzungetc() will + fail if c is -1, and may fail if a character has been pushed but not read + yet. If gzungetc is used immediately after gzopen or gzdopen, at least the + output buffer size of pushed characters is allowed. (See gzbuffer above.) + The pushed character will be discarded if the stream is repositioned with + gzseek() or gzrewind(). +*/ + +ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush)); +/* + Flushes all pending output into the compressed file. The parameter flush + is as in the deflate() function. The return value is the zlib error number + (see function gzerror below). gzflush is only permitted when writing. + + If the flush parameter is Z_FINISH, the remaining data is written and the + gzip stream is completed in the output. If gzwrite() is called again, a new + gzip stream will be started in the output. gzread() is able to read such + concatented gzip streams. + + gzflush should be called only when strictly necessary because it will + degrade compression if called too often. +*/ + +/* +ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file, + z_off_t offset, int whence)); + + Sets the starting position for the next gzread or gzwrite on the given + compressed file. The offset represents a number of bytes in the + uncompressed data stream. The whence parameter is defined as in lseek(2); + the value SEEK_END is not supported. + + If the file is opened for reading, this function is emulated but can be + extremely slow. If the file is opened for writing, only forward seeks are + supported; gzseek then compresses a sequence of zeroes up to the new + starting position. + + gzseek returns the resulting offset location as measured in bytes from + the beginning of the uncompressed stream, or -1 in case of error, in + particular if the file is opened for writing and the new starting position + would be before the current position. +*/ + +ZEXTERN int ZEXPORT gzrewind OF((gzFile file)); +/* + Rewinds the given file. This function is supported only for reading. + + gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET) +*/ + +/* +ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file)); + + Returns the starting position for the next gzread or gzwrite on the given + compressed file. This position represents a number of bytes in the + uncompressed data stream, and is zero when starting, even if appending or + reading a gzip stream from the middle of a file using gzdopen(). + + gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR) +*/ + +/* +ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile file)); + + Returns the current offset in the file being read or written. This offset + includes the count of bytes that precede the gzip stream, for example when + appending or when using gzdopen() for reading. When reading, the offset + does not include as yet unused buffered input. This information can be used + for a progress indicator. On error, gzoffset() returns -1. +*/ + +ZEXTERN int ZEXPORT gzeof OF((gzFile file)); +/* + Returns true (1) if the end-of-file indicator has been set while reading, + false (0) otherwise. Note that the end-of-file indicator is set only if the + read tried to go past the end of the input, but came up short. Therefore, + just like feof(), gzeof() may return false even if there is no more data to + read, in the event that the last read request was for the exact number of + bytes remaining in the input file. This will happen if the input file size + is an exact multiple of the buffer size. + + If gzeof() returns true, then the read functions will return no more data, + unless the end-of-file indicator is reset by gzclearerr() and the input file + has grown since the previous end of file was detected. +*/ + +ZEXTERN int ZEXPORT gzdirect OF((gzFile file)); +/* + Returns true (1) if file is being copied directly while reading, or false + (0) if file is a gzip stream being decompressed. + + If the input file is empty, gzdirect() will return true, since the input + does not contain a gzip stream. + + If gzdirect() is used immediately after gzopen() or gzdopen() it will + cause buffers to be allocated to allow reading the file to determine if it + is a gzip file. Therefore if gzbuffer() is used, it should be called before + gzdirect(). + + When writing, gzdirect() returns true (1) if transparent writing was + requested ("wT" for the gzopen() mode), or false (0) otherwise. (Note: + gzdirect() is not needed when writing. Transparent writing must be + explicitly requested, so the application already knows the answer. When + linking statically, using gzdirect() will include all of the zlib code for + gzip file reading and decompression, which may not be desired.) +*/ + +ZEXTERN int ZEXPORT gzclose OF((gzFile file)); +/* + Flushes all pending output if necessary, closes the compressed file and + deallocates the (de)compression state. Note that once file is closed, you + cannot call gzerror with file, since its structures have been deallocated. + gzclose must not be called more than once on the same file, just as free + must not be called more than once on the same allocation. + + gzclose will return Z_STREAM_ERROR if file is not valid, Z_ERRNO on a + file operation error, Z_MEM_ERROR if out of memory, Z_BUF_ERROR if the + last read ended in the middle of a gzip stream, or Z_OK on success. +*/ + +ZEXTERN int ZEXPORT gzclose_r OF((gzFile file)); +ZEXTERN int ZEXPORT gzclose_w OF((gzFile file)); +/* + Same as gzclose(), but gzclose_r() is only for use when reading, and + gzclose_w() is only for use when writing or appending. The advantage to + using these instead of gzclose() is that they avoid linking in zlib + compression or decompression code that is not used when only reading or only + writing respectively. If gzclose() is used, then both compression and + decompression code will be included the application when linking to a static + zlib library. +*/ + +ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum)); +/* + Returns the error message for the last error which occurred on the given + compressed file. errnum is set to zlib error number. If an error occurred + in the file system and not in the compression library, errnum is set to + Z_ERRNO and the application may consult errno to get the exact error code. + + The application must not modify the returned string. Future calls to + this function may invalidate the previously returned string. If file is + closed, then the string previously returned by gzerror will no longer be + available. + + gzerror() should be used to distinguish errors from end-of-file for those + functions above that do not distinguish those cases in their return values. +*/ + +ZEXTERN void ZEXPORT gzclearerr OF((gzFile file)); +/* + Clears the error and end-of-file flags for file. This is analogous to the + clearerr() function in stdio. This is useful for continuing to read a gzip + file that is being written concurrently. +*/ + +#endif /* !Z_SOLO */ + + /* checksum functions */ + +/* + These functions are not related to compression but are exported + anyway because they might be useful in applications using the compression + library. +*/ + +ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len)); +/* + Update a running Adler-32 checksum with the bytes buf[0..len-1] and + return the updated checksum. If buf is Z_NULL, this function returns the + required initial value for the checksum. + + An Adler-32 checksum is almost as reliable as a CRC32 but can be computed + much faster. + + Usage example: + + uLong adler = adler32(0L, Z_NULL, 0); + + while (read_buffer(buffer, length) != EOF) { + adler = adler32(adler, buffer, length); + } + if (adler != original_adler) error(); +*/ + +/* +ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2, + z_off_t len2)); + + Combine two Adler-32 checksums into one. For two sequences of bytes, seq1 + and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for + each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of + seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. Note + that the z_off_t type (like off_t) is a signed integer. If len2 is + negative, the result has no meaning or utility. +*/ + +ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len)); +/* + Update a running CRC-32 with the bytes buf[0..len-1] and return the + updated CRC-32. If buf is Z_NULL, this function returns the required + initial value for the crc. Pre- and post-conditioning (one's complement) is + performed within this function so it shouldn't be done by the application. + + Usage example: + + uLong crc = crc32(0L, Z_NULL, 0); + + while (read_buffer(buffer, length) != EOF) { + crc = crc32(crc, buffer, length); + } + if (crc != original_crc) error(); +*/ + +/* +ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2)); + + Combine two CRC-32 check values into one. For two sequences of bytes, + seq1 and seq2 with lengths len1 and len2, CRC-32 check values were + calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32 + check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and + len2. +*/ + + + /* various hacks, don't look :) */ + +/* deflateInit and inflateInit are macros to allow checking the zlib version + * and the compiler's view of z_stream: + */ +ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level, + const char *version, int stream_size)); +ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm, + const char *version, int stream_size)); +ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method, + int windowBits, int memLevel, + int strategy, const char *version, + int stream_size)); +ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits, + const char *version, int stream_size)); +ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits, + unsigned char FAR *window, + const char *version, + int stream_size)); +#define deflateInit(strm, level) \ + deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream)) +#define inflateInit(strm) \ + inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream)) +#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \ + deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\ + (strategy), ZLIB_VERSION, (int)sizeof(z_stream)) +#define inflateInit2(strm, windowBits) \ + inflateInit2_((strm), (windowBits), ZLIB_VERSION, \ + (int)sizeof(z_stream)) +#define inflateBackInit(strm, windowBits, window) \ + inflateBackInit_((strm), (windowBits), (window), \ + ZLIB_VERSION, (int)sizeof(z_stream)) + +#ifndef Z_SOLO + +/* gzgetc() macro and its supporting function and exposed data structure. Note + * that the real internal state is much larger than the exposed structure. + * This abbreviated structure exposes just enough for the gzgetc() macro. The + * user should not mess with these exposed elements, since their names or + * behavior could change in the future, perhaps even capriciously. They can + * only be used by the gzgetc() macro. You have been warned. + */ +struct gzFile_s { + unsigned have; + unsigned char *next; + z_off64_t pos; +}; +ZEXTERN int ZEXPORT gzgetc_ OF((gzFile file)); /* backward compatibility */ +#ifdef Z_PREFIX_SET +# undef z_gzgetc +# define z_gzgetc(g) \ + ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g)) +#else +# define gzgetc(g) \ + ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g)) +#endif + +/* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or + * change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if + * both are true, the application gets the *64 functions, and the regular + * functions are changed to 64 bits) -- in case these are set on systems + * without large file support, _LFS64_LARGEFILE must also be true + */ +#ifdef Z_LARGE64 + ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *)); + ZEXTERN z_off64_t ZEXPORT gzseek64 OF((gzFile, z_off64_t, int)); + ZEXTERN z_off64_t ZEXPORT gztell64 OF((gzFile)); + ZEXTERN z_off64_t ZEXPORT gzoffset64 OF((gzFile)); + ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off64_t)); + ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off64_t)); +#endif + +#if !defined(ZLIB_INTERNAL) && defined(Z_WANT64) +# ifdef Z_PREFIX_SET +# define z_gzopen z_gzopen64 +# define z_gzseek z_gzseek64 +# define z_gztell z_gztell64 +# define z_gzoffset z_gzoffset64 +# define z_adler32_combine z_adler32_combine64 +# define z_crc32_combine z_crc32_combine64 +# else +# define gzopen gzopen64 +# define gzseek gzseek64 +# define gztell gztell64 +# define gzoffset gzoffset64 +# define adler32_combine adler32_combine64 +# define crc32_combine crc32_combine64 +# endif +# ifndef Z_LARGE64 + ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *)); + ZEXTERN z_off_t ZEXPORT gzseek64 OF((gzFile, z_off_t, int)); + ZEXTERN z_off_t ZEXPORT gztell64 OF((gzFile)); + ZEXTERN z_off_t ZEXPORT gzoffset64 OF((gzFile)); + ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t)); + ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t)); +# endif +#else + ZEXTERN gzFile ZEXPORT gzopen OF((const char *, const char *)); + ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile, z_off_t, int)); + ZEXTERN z_off_t ZEXPORT gztell OF((gzFile)); + ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile)); + ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t)); + ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t)); +#endif + +#else /* Z_SOLO */ + + ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t)); + ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t)); + +#endif /* !Z_SOLO */ + +/* hack for buggy compilers */ +#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL) + struct internal_state {int dummy;}; +#endif + +/* undocumented functions */ +ZEXTERN const char * ZEXPORT zError OF((int)); +ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp)); +ZEXTERN const z_crc_t FAR * ZEXPORT get_crc_table OF((void)); +ZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int)); +ZEXTERN int ZEXPORT inflateResetKeep OF((z_streamp)); +ZEXTERN int ZEXPORT deflateResetKeep OF((z_streamp)); +#if defined(_WIN32) && !defined(Z_SOLO) +ZEXTERN gzFile ZEXPORT gzopen_w OF((const wchar_t *path, + const char *mode)); +#endif +#if defined(STDC) || defined(Z_HAVE_STDARG_H) +# ifndef Z_SOLO +ZEXTERN int ZEXPORTVA gzvprintf Z_ARG((gzFile file, + const char *format, + va_list va)); +# endif +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* ZLIB_H */ diff --git a/Source/Import/libcurl/Prebuild/Win/i386/libcurl-4.dll b/Source/Import/libcurl/Prebuild/Win/i386/libcurl-4.dll new file mode 100644 index 0000000..d0b863e Binary files /dev/null and b/Source/Import/libcurl/Prebuild/Win/i386/libcurl-4.dll differ diff --git a/Source/Import/libcurl/Prebuild/Win/i386/libcurl.a b/Source/Import/libcurl/Prebuild/Win/i386/libcurl.a new file mode 100644 index 0000000..8f33985 Binary files /dev/null and b/Source/Import/libcurl/Prebuild/Win/i386/libcurl.a differ diff --git a/Source/Import/libcurl/curl/curl.h b/Source/Import/libcurl/curl/curl.h new file mode 100644 index 0000000..2cad282 --- /dev/null +++ b/Source/Import/libcurl/curl/curl.h @@ -0,0 +1,2231 @@ +#ifndef __CURL_CURL_H +#define __CURL_CURL_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) 1998 - 2012, Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at http://curl.haxx.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + ***************************************************************************/ + +/* + * If you have libcurl problems, all docs and details are found here: + * http://curl.haxx.se/libcurl/ + * + * curl-library mailing list subscription and unsubscription web interface: + * http://cool.haxx.se/mailman/listinfo/curl-library/ + */ + +#include "curlver.h" /* libcurl version defines */ +#include "curlbuild.h" /* libcurl build definitions */ +#include "curlrules.h" /* libcurl rules enforcement */ + +/* + * Define WIN32 when build target is Win32 API + */ + +#if (defined(_WIN32) || defined(__WIN32__)) && \ + !defined(WIN32) && !defined(__SYMBIAN32__) +#define WIN32 +#endif + +#include +#include + +#if defined(__FreeBSD__) && (__FreeBSD__ >= 2) +/* Needed for __FreeBSD_version symbol definition */ +#include +#endif + +/* The include stuff here below is mainly for time_t! */ +#include +#include + +#if defined(WIN32) && !defined(_WIN32_WCE) && !defined(__CYGWIN__) +#if !(defined(_WINSOCKAPI_) || defined(_WINSOCK_H) || defined(__LWIP_OPT_H__)) +/* The check above prevents the winsock2 inclusion if winsock.h already was + included, since they can't co-exist without problems */ +#include +#include +#endif +#endif + +/* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish + libc5-based Linux systems. Only include it on systems that are known to + require it! */ +#if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \ + defined(__minix) || defined(__SYMBIAN32__) || defined(__INTEGRITY) || \ + defined(ANDROID) || defined(__ANDROID__) || \ + (defined(__FreeBSD_version) && (__FreeBSD_version < 800000)) +#include +#endif + +#if !defined(WIN32) && !defined(_WIN32_WCE) +#include +#endif + +#if !defined(WIN32) && !defined(__WATCOMC__) && !defined(__VXWORKS__) +#include +#endif + +#ifdef __BEOS__ +#include +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +typedef void CURL; + +/* + * Decorate exportable functions for Win32 and Symbian OS DLL linking. + * This avoids using a .def file for building libcurl.dll. + */ +#if (defined(WIN32) || defined(_WIN32) || defined(__SYMBIAN32__)) && \ + !defined(CURL_STATICLIB) +#if defined(BUILDING_LIBCURL) +#define CURL_EXTERN __declspec(dllexport) +#else +#define CURL_EXTERN __declspec(dllimport) +#endif +#else + +#ifdef CURL_HIDDEN_SYMBOLS +/* + * This definition is used to make external definitions visible in the + * shared library when symbols are hidden by default. It makes no + * difference when compiling applications whether this is set or not, + * only when compiling the library. + */ +#define CURL_EXTERN CURL_EXTERN_SYMBOL +#else +#define CURL_EXTERN +#endif +#endif + +#ifndef curl_socket_typedef +/* socket typedef */ +#if defined(WIN32) && !defined(__LWIP_OPT_H__) +typedef SOCKET curl_socket_t; +#define CURL_SOCKET_BAD INVALID_SOCKET +#else +typedef int curl_socket_t; +#define CURL_SOCKET_BAD -1 +#endif +#define curl_socket_typedef +#endif /* curl_socket_typedef */ + +struct curl_httppost { + struct curl_httppost *next; /* next entry in the list */ + char *name; /* pointer to allocated name */ + long namelength; /* length of name length */ + char *contents; /* pointer to allocated data contents */ + long contentslength; /* length of contents field */ + char *buffer; /* pointer to allocated buffer contents */ + long bufferlength; /* length of buffer field */ + char *contenttype; /* Content-Type */ + struct curl_slist* contentheader; /* list of extra headers for this form */ + struct curl_httppost *more; /* if one field name has more than one + file, this link should link to following + files */ + long flags; /* as defined below */ +#define HTTPPOST_FILENAME (1<<0) /* specified content is a file name */ +#define HTTPPOST_READFILE (1<<1) /* specified content is a file name */ +#define HTTPPOST_PTRNAME (1<<2) /* name is only stored pointer + do not free in formfree */ +#define HTTPPOST_PTRCONTENTS (1<<3) /* contents is only stored pointer + do not free in formfree */ +#define HTTPPOST_BUFFER (1<<4) /* upload file from buffer */ +#define HTTPPOST_PTRBUFFER (1<<5) /* upload file from pointer contents */ +#define HTTPPOST_CALLBACK (1<<6) /* upload file contents by using the + regular read callback to get the data + and pass the given pointer as custom + pointer */ + + char *showfilename; /* The file name to show. If not set, the + actual file name will be used (if this + is a file part) */ + void *userp; /* custom pointer used for + HTTPPOST_CALLBACK posts */ +}; + +typedef int (*curl_progress_callback)(void *clientp, + double dltotal, + double dlnow, + double ultotal, + double ulnow); + +#ifndef CURL_MAX_WRITE_SIZE + /* Tests have proven that 20K is a very bad buffer size for uploads on + Windows, while 16K for some odd reason performed a lot better. + We do the ifndef check to allow this value to easier be changed at build + time for those who feel adventurous. The practical minimum is about + 400 bytes since libcurl uses a buffer of this size as a scratch area + (unrelated to network send operations). */ +#define CURL_MAX_WRITE_SIZE 16384 +#endif + +#ifndef CURL_MAX_HTTP_HEADER +/* The only reason to have a max limit for this is to avoid the risk of a bad + server feeding libcurl with a never-ending header that will cause reallocs + infinitely */ +#define CURL_MAX_HTTP_HEADER (100*1024) +#endif + +/* This is a magic return code for the write callback that, when returned, + will signal libcurl to pause receiving on the current transfer. */ +#define CURL_WRITEFUNC_PAUSE 0x10000001 + +typedef size_t (*curl_write_callback)(char *buffer, + size_t size, + size_t nitems, + void *outstream); + + + +/* enumeration of file types */ +typedef enum { + CURLFILETYPE_FILE = 0, + CURLFILETYPE_DIRECTORY, + CURLFILETYPE_SYMLINK, + CURLFILETYPE_DEVICE_BLOCK, + CURLFILETYPE_DEVICE_CHAR, + CURLFILETYPE_NAMEDPIPE, + CURLFILETYPE_SOCKET, + CURLFILETYPE_DOOR, /* is possible only on Sun Solaris now */ + + CURLFILETYPE_UNKNOWN /* should never occur */ +} curlfiletype; + +#define CURLFINFOFLAG_KNOWN_FILENAME (1<<0) +#define CURLFINFOFLAG_KNOWN_FILETYPE (1<<1) +#define CURLFINFOFLAG_KNOWN_TIME (1<<2) +#define CURLFINFOFLAG_KNOWN_PERM (1<<3) +#define CURLFINFOFLAG_KNOWN_UID (1<<4) +#define CURLFINFOFLAG_KNOWN_GID (1<<5) +#define CURLFINFOFLAG_KNOWN_SIZE (1<<6) +#define CURLFINFOFLAG_KNOWN_HLINKCOUNT (1<<7) + +/* Content of this structure depends on information which is known and is + achievable (e.g. by FTP LIST parsing). Please see the url_easy_setopt(3) man + page for callbacks returning this structure -- some fields are mandatory, + some others are optional. The FLAG field has special meaning. */ +struct curl_fileinfo { + char *filename; + curlfiletype filetype; + time_t time; + unsigned int perm; + int uid; + int gid; + curl_off_t size; + long int hardlinks; + + struct { + /* If some of these fields is not NULL, it is a pointer to b_data. */ + char *time; + char *perm; + char *user; + char *group; + char *target; /* pointer to the target filename of a symlink */ + } strings; + + unsigned int flags; + + /* used internally */ + char * b_data; + size_t b_size; + size_t b_used; +}; + +/* return codes for CURLOPT_CHUNK_BGN_FUNCTION */ +#define CURL_CHUNK_BGN_FUNC_OK 0 +#define CURL_CHUNK_BGN_FUNC_FAIL 1 /* tell the lib to end the task */ +#define CURL_CHUNK_BGN_FUNC_SKIP 2 /* skip this chunk over */ + +/* if splitting of data transfer is enabled, this callback is called before + download of an individual chunk started. Note that parameter "remains" works + only for FTP wildcard downloading (for now), otherwise is not used */ +typedef long (*curl_chunk_bgn_callback)(const void *transfer_info, + void *ptr, + int remains); + +/* return codes for CURLOPT_CHUNK_END_FUNCTION */ +#define CURL_CHUNK_END_FUNC_OK 0 +#define CURL_CHUNK_END_FUNC_FAIL 1 /* tell the lib to end the task */ + +/* If splitting of data transfer is enabled this callback is called after + download of an individual chunk finished. + Note! After this callback was set then it have to be called FOR ALL chunks. + Even if downloading of this chunk was skipped in CHUNK_BGN_FUNC. + This is the reason why we don't need "transfer_info" parameter in this + callback and we are not interested in "remains" parameter too. */ +typedef long (*curl_chunk_end_callback)(void *ptr); + +/* return codes for FNMATCHFUNCTION */ +#define CURL_FNMATCHFUNC_MATCH 0 /* string corresponds to the pattern */ +#define CURL_FNMATCHFUNC_NOMATCH 1 /* pattern doesn't match the string */ +#define CURL_FNMATCHFUNC_FAIL 2 /* an error occurred */ + +/* callback type for wildcard downloading pattern matching. If the + string matches the pattern, return CURL_FNMATCHFUNC_MATCH value, etc. */ +typedef int (*curl_fnmatch_callback)(void *ptr, + const char *pattern, + const char *string); + +/* These are the return codes for the seek callbacks */ +#define CURL_SEEKFUNC_OK 0 +#define CURL_SEEKFUNC_FAIL 1 /* fail the entire transfer */ +#define CURL_SEEKFUNC_CANTSEEK 2 /* tell libcurl seeking can't be done, so + libcurl might try other means instead */ +typedef int (*curl_seek_callback)(void *instream, + curl_off_t offset, + int origin); /* 'whence' */ + +/* This is a return code for the read callback that, when returned, will + signal libcurl to immediately abort the current transfer. */ +#define CURL_READFUNC_ABORT 0x10000000 +/* This is a return code for the read callback that, when returned, will + signal libcurl to pause sending data on the current transfer. */ +#define CURL_READFUNC_PAUSE 0x10000001 + +typedef size_t (*curl_read_callback)(char *buffer, + size_t size, + size_t nitems, + void *instream); + +typedef enum { + CURLSOCKTYPE_IPCXN, /* socket created for a specific IP connection */ + CURLSOCKTYPE_LAST /* never use */ +} curlsocktype; + +/* The return code from the sockopt_callback can signal information back + to libcurl: */ +#define CURL_SOCKOPT_OK 0 +#define CURL_SOCKOPT_ERROR 1 /* causes libcurl to abort and return + CURLE_ABORTED_BY_CALLBACK */ +#define CURL_SOCKOPT_ALREADY_CONNECTED 2 + +typedef int (*curl_sockopt_callback)(void *clientp, + curl_socket_t curlfd, + curlsocktype purpose); + +struct curl_sockaddr { + int family; + int socktype; + int protocol; + unsigned int addrlen; /* addrlen was a socklen_t type before 7.18.0 but it + turned really ugly and painful on the systems that + lack this type */ + struct sockaddr addr; +}; + +typedef curl_socket_t +(*curl_opensocket_callback)(void *clientp, + curlsocktype purpose, + struct curl_sockaddr *address); + +typedef int +(*curl_closesocket_callback)(void *clientp, curl_socket_t item); + +typedef enum { + CURLIOE_OK, /* I/O operation successful */ + CURLIOE_UNKNOWNCMD, /* command was unknown to callback */ + CURLIOE_FAILRESTART, /* failed to restart the read */ + CURLIOE_LAST /* never use */ +} curlioerr; + +typedef enum { + CURLIOCMD_NOP, /* no operation */ + CURLIOCMD_RESTARTREAD, /* restart the read stream from start */ + CURLIOCMD_LAST /* never use */ +} curliocmd; + +typedef curlioerr (*curl_ioctl_callback)(CURL *handle, + int cmd, + void *clientp); + +/* + * The following typedef's are signatures of malloc, free, realloc, strdup and + * calloc respectively. Function pointers of these types can be passed to the + * curl_global_init_mem() function to set user defined memory management + * callback routines. + */ +typedef void *(*curl_malloc_callback)(size_t size); +typedef void (*curl_free_callback)(void *ptr); +typedef void *(*curl_realloc_callback)(void *ptr, size_t size); +typedef char *(*curl_strdup_callback)(const char *str); +typedef void *(*curl_calloc_callback)(size_t nmemb, size_t size); + +/* the kind of data that is passed to information_callback*/ +typedef enum { + CURLINFO_TEXT = 0, + CURLINFO_HEADER_IN, /* 1 */ + CURLINFO_HEADER_OUT, /* 2 */ + CURLINFO_DATA_IN, /* 3 */ + CURLINFO_DATA_OUT, /* 4 */ + CURLINFO_SSL_DATA_IN, /* 5 */ + CURLINFO_SSL_DATA_OUT, /* 6 */ + CURLINFO_END +} curl_infotype; + +typedef int (*curl_debug_callback) + (CURL *handle, /* the handle/transfer this concerns */ + curl_infotype type, /* what kind of data */ + char *data, /* points to the data */ + size_t size, /* size of the data pointed to */ + void *userptr); /* whatever the user please */ + +/* All possible error codes from all sorts of curl functions. Future versions + may return other values, stay prepared. + + Always add new return codes last. Never *EVER* remove any. The return + codes must remain the same! + */ + +typedef enum { + CURLE_OK = 0, + CURLE_UNSUPPORTED_PROTOCOL, /* 1 */ + CURLE_FAILED_INIT, /* 2 */ + CURLE_URL_MALFORMAT, /* 3 */ + CURLE_NOT_BUILT_IN, /* 4 - [was obsoleted in August 2007 for + 7.17.0, reused in April 2011 for 7.21.5] */ + CURLE_COULDNT_RESOLVE_PROXY, /* 5 */ + CURLE_COULDNT_RESOLVE_HOST, /* 6 */ + CURLE_COULDNT_CONNECT, /* 7 */ + CURLE_FTP_WEIRD_SERVER_REPLY, /* 8 */ + CURLE_REMOTE_ACCESS_DENIED, /* 9 a service was denied by the server + due to lack of access - when login fails + this is not returned. */ + CURLE_FTP_ACCEPT_FAILED, /* 10 - [was obsoleted in April 2006 for + 7.15.4, reused in Dec 2011 for 7.24.0]*/ + CURLE_FTP_WEIRD_PASS_REPLY, /* 11 */ + CURLE_FTP_ACCEPT_TIMEOUT, /* 12 - timeout occurred accepting server + [was obsoleted in August 2007 for 7.17.0, + reused in Dec 2011 for 7.24.0]*/ + CURLE_FTP_WEIRD_PASV_REPLY, /* 13 */ + CURLE_FTP_WEIRD_227_FORMAT, /* 14 */ + CURLE_FTP_CANT_GET_HOST, /* 15 */ + CURLE_OBSOLETE16, /* 16 - NOT USED */ + CURLE_FTP_COULDNT_SET_TYPE, /* 17 */ + CURLE_PARTIAL_FILE, /* 18 */ + CURLE_FTP_COULDNT_RETR_FILE, /* 19 */ + CURLE_OBSOLETE20, /* 20 - NOT USED */ + CURLE_QUOTE_ERROR, /* 21 - quote command failure */ + CURLE_HTTP_RETURNED_ERROR, /* 22 */ + CURLE_WRITE_ERROR, /* 23 */ + CURLE_OBSOLETE24, /* 24 - NOT USED */ + CURLE_UPLOAD_FAILED, /* 25 - failed upload "command" */ + CURLE_READ_ERROR, /* 26 - couldn't open/read from file */ + CURLE_OUT_OF_MEMORY, /* 27 */ + /* Note: CURLE_OUT_OF_MEMORY may sometimes indicate a conversion error + instead of a memory allocation error if CURL_DOES_CONVERSIONS + is defined + */ + CURLE_OPERATION_TIMEDOUT, /* 28 - the timeout time was reached */ + CURLE_OBSOLETE29, /* 29 - NOT USED */ + CURLE_FTP_PORT_FAILED, /* 30 - FTP PORT operation failed */ + CURLE_FTP_COULDNT_USE_REST, /* 31 - the REST command failed */ + CURLE_OBSOLETE32, /* 32 - NOT USED */ + CURLE_RANGE_ERROR, /* 33 - RANGE "command" didn't work */ + CURLE_HTTP_POST_ERROR, /* 34 */ + CURLE_SSL_CONNECT_ERROR, /* 35 - wrong when connecting with SSL */ + CURLE_BAD_DOWNLOAD_RESUME, /* 36 - couldn't resume download */ + CURLE_FILE_COULDNT_READ_FILE, /* 37 */ + CURLE_LDAP_CANNOT_BIND, /* 38 */ + CURLE_LDAP_SEARCH_FAILED, /* 39 */ + CURLE_OBSOLETE40, /* 40 - NOT USED */ + CURLE_FUNCTION_NOT_FOUND, /* 41 */ + CURLE_ABORTED_BY_CALLBACK, /* 42 */ + CURLE_BAD_FUNCTION_ARGUMENT, /* 43 */ + CURLE_OBSOLETE44, /* 44 - NOT USED */ + CURLE_INTERFACE_FAILED, /* 45 - CURLOPT_INTERFACE failed */ + CURLE_OBSOLETE46, /* 46 - NOT USED */ + CURLE_TOO_MANY_REDIRECTS , /* 47 - catch endless re-direct loops */ + CURLE_UNKNOWN_OPTION, /* 48 - User specified an unknown option */ + CURLE_TELNET_OPTION_SYNTAX , /* 49 - Malformed telnet option */ + CURLE_OBSOLETE50, /* 50 - NOT USED */ + CURLE_PEER_FAILED_VERIFICATION, /* 51 - peer's certificate or fingerprint + wasn't verified fine */ + CURLE_GOT_NOTHING, /* 52 - when this is a specific error */ + CURLE_SSL_ENGINE_NOTFOUND, /* 53 - SSL crypto engine not found */ + CURLE_SSL_ENGINE_SETFAILED, /* 54 - can not set SSL crypto engine as + default */ + CURLE_SEND_ERROR, /* 55 - failed sending network data */ + CURLE_RECV_ERROR, /* 56 - failure in receiving network data */ + CURLE_OBSOLETE57, /* 57 - NOT IN USE */ + CURLE_SSL_CERTPROBLEM, /* 58 - problem with the local certificate */ + CURLE_SSL_CIPHER, /* 59 - couldn't use specified cipher */ + CURLE_SSL_CACERT, /* 60 - problem with the CA cert (path?) */ + CURLE_BAD_CONTENT_ENCODING, /* 61 - Unrecognized/bad encoding */ + CURLE_LDAP_INVALID_URL, /* 62 - Invalid LDAP URL */ + CURLE_FILESIZE_EXCEEDED, /* 63 - Maximum file size exceeded */ + CURLE_USE_SSL_FAILED, /* 64 - Requested FTP SSL level failed */ + CURLE_SEND_FAIL_REWIND, /* 65 - Sending the data requires a rewind + that failed */ + CURLE_SSL_ENGINE_INITFAILED, /* 66 - failed to initialise ENGINE */ + CURLE_LOGIN_DENIED, /* 67 - user, password or similar was not + accepted and we failed to login */ + CURLE_TFTP_NOTFOUND, /* 68 - file not found on server */ + CURLE_TFTP_PERM, /* 69 - permission problem on server */ + CURLE_REMOTE_DISK_FULL, /* 70 - out of disk space on server */ + CURLE_TFTP_ILLEGAL, /* 71 - Illegal TFTP operation */ + CURLE_TFTP_UNKNOWNID, /* 72 - Unknown transfer ID */ + CURLE_REMOTE_FILE_EXISTS, /* 73 - File already exists */ + CURLE_TFTP_NOSUCHUSER, /* 74 - No such user */ + CURLE_CONV_FAILED, /* 75 - conversion failed */ + CURLE_CONV_REQD, /* 76 - caller must register conversion + callbacks using curl_easy_setopt options + CURLOPT_CONV_FROM_NETWORK_FUNCTION, + CURLOPT_CONV_TO_NETWORK_FUNCTION, and + CURLOPT_CONV_FROM_UTF8_FUNCTION */ + CURLE_SSL_CACERT_BADFILE, /* 77 - could not load CACERT file, missing + or wrong format */ + CURLE_REMOTE_FILE_NOT_FOUND, /* 78 - remote file not found */ + CURLE_SSH, /* 79 - error from the SSH layer, somewhat + generic so the error message will be of + interest when this has happened */ + + CURLE_SSL_SHUTDOWN_FAILED, /* 80 - Failed to shut down the SSL + connection */ + CURLE_AGAIN, /* 81 - socket is not ready for send/recv, + wait till it's ready and try again (Added + in 7.18.2) */ + CURLE_SSL_CRL_BADFILE, /* 82 - could not load CRL file, missing or + wrong format (Added in 7.19.0) */ + CURLE_SSL_ISSUER_ERROR, /* 83 - Issuer check failed. (Added in + 7.19.0) */ + CURLE_FTP_PRET_FAILED, /* 84 - a PRET command failed */ + CURLE_RTSP_CSEQ_ERROR, /* 85 - mismatch of RTSP CSeq numbers */ + CURLE_RTSP_SESSION_ERROR, /* 86 - mismatch of RTSP Session Ids */ + CURLE_FTP_BAD_FILE_LIST, /* 87 - unable to parse FTP file list */ + CURLE_CHUNK_FAILED, /* 88 - chunk callback reported error */ + CURL_LAST /* never use! */ +} CURLcode; + +#ifndef CURL_NO_OLDIES /* define this to test if your app builds with all + the obsolete stuff removed! */ + +/* Previously obsoletes error codes re-used in 7.24.0 */ +#define CURLE_OBSOLETE10 CURLE_FTP_ACCEPT_FAILED +#define CURLE_OBSOLETE12 CURLE_FTP_ACCEPT_TIMEOUT + +/* compatibility with older names */ +#define CURLOPT_ENCODING CURLOPT_ACCEPT_ENCODING + +/* The following were added in 7.21.5, April 2011 */ +#define CURLE_UNKNOWN_TELNET_OPTION CURLE_UNKNOWN_OPTION + +/* The following were added in 7.17.1 */ +/* These are scheduled to disappear by 2009 */ +#define CURLE_SSL_PEER_CERTIFICATE CURLE_PEER_FAILED_VERIFICATION + +/* The following were added in 7.17.0 */ +/* These are scheduled to disappear by 2009 */ +#define CURLE_OBSOLETE CURLE_OBSOLETE50 /* no one should be using this! */ +#define CURLE_BAD_PASSWORD_ENTERED CURLE_OBSOLETE46 +#define CURLE_BAD_CALLING_ORDER CURLE_OBSOLETE44 +#define CURLE_FTP_USER_PASSWORD_INCORRECT CURLE_OBSOLETE10 +#define CURLE_FTP_CANT_RECONNECT CURLE_OBSOLETE16 +#define CURLE_FTP_COULDNT_GET_SIZE CURLE_OBSOLETE32 +#define CURLE_FTP_COULDNT_SET_ASCII CURLE_OBSOLETE29 +#define CURLE_FTP_WEIRD_USER_REPLY CURLE_OBSOLETE12 +#define CURLE_FTP_WRITE_ERROR CURLE_OBSOLETE20 +#define CURLE_LIBRARY_NOT_FOUND CURLE_OBSOLETE40 +#define CURLE_MALFORMAT_USER CURLE_OBSOLETE24 +#define CURLE_SHARE_IN_USE CURLE_OBSOLETE57 +#define CURLE_URL_MALFORMAT_USER CURLE_NOT_BUILT_IN + +#define CURLE_FTP_ACCESS_DENIED CURLE_REMOTE_ACCESS_DENIED +#define CURLE_FTP_COULDNT_SET_BINARY CURLE_FTP_COULDNT_SET_TYPE +#define CURLE_FTP_QUOTE_ERROR CURLE_QUOTE_ERROR +#define CURLE_TFTP_DISKFULL CURLE_REMOTE_DISK_FULL +#define CURLE_TFTP_EXISTS CURLE_REMOTE_FILE_EXISTS +#define CURLE_HTTP_RANGE_ERROR CURLE_RANGE_ERROR +#define CURLE_FTP_SSL_FAILED CURLE_USE_SSL_FAILED + +/* The following were added earlier */ + +#define CURLE_OPERATION_TIMEOUTED CURLE_OPERATION_TIMEDOUT + +#define CURLE_HTTP_NOT_FOUND CURLE_HTTP_RETURNED_ERROR +#define CURLE_HTTP_PORT_FAILED CURLE_INTERFACE_FAILED +#define CURLE_FTP_COULDNT_STOR_FILE CURLE_UPLOAD_FAILED + +#define CURLE_FTP_PARTIAL_FILE CURLE_PARTIAL_FILE +#define CURLE_FTP_BAD_DOWNLOAD_RESUME CURLE_BAD_DOWNLOAD_RESUME + +/* This was the error code 50 in 7.7.3 and a few earlier versions, this + is no longer used by libcurl but is instead #defined here only to not + make programs break */ +#define CURLE_ALREADY_COMPLETE 99999 + +#endif /*!CURL_NO_OLDIES*/ + +/* This prototype applies to all conversion callbacks */ +typedef CURLcode (*curl_conv_callback)(char *buffer, size_t length); + +typedef CURLcode (*curl_ssl_ctx_callback)(CURL *curl, /* easy handle */ + void *ssl_ctx, /* actually an + OpenSSL SSL_CTX */ + void *userptr); + +typedef enum { + CURLPROXY_HTTP = 0, /* added in 7.10, new in 7.19.4 default is to use + CONNECT HTTP/1.1 */ + CURLPROXY_HTTP_1_0 = 1, /* added in 7.19.4, force to use CONNECT + HTTP/1.0 */ + CURLPROXY_SOCKS4 = 4, /* support added in 7.15.2, enum existed already + in 7.10 */ + CURLPROXY_SOCKS5 = 5, /* added in 7.10 */ + CURLPROXY_SOCKS4A = 6, /* added in 7.18.0 */ + CURLPROXY_SOCKS5_HOSTNAME = 7 /* Use the SOCKS5 protocol but pass along the + host name rather than the IP address. added + in 7.18.0 */ +} curl_proxytype; /* this enum was added in 7.10 */ + +/* + * Bitmasks for CURLOPT_HTTPAUTH and CURLOPT_PROXYAUTH options: + * + * CURLAUTH_NONE - No HTTP authentication + * CURLAUTH_BASIC - HTTP Basic authentication (default) + * CURLAUTH_DIGEST - HTTP Digest authentication + * CURLAUTH_GSSNEGOTIATE - HTTP GSS-Negotiate authentication + * CURLAUTH_NTLM - HTTP NTLM authentication + * CURLAUTH_DIGEST_IE - HTTP Digest authentication with IE flavour + * CURLAUTH_NTLM_WB - HTTP NTLM authentication delegated to winbind helper + * CURLAUTH_ONLY - Use together with a single other type to force no + * authentication or just that single type + * CURLAUTH_ANY - All fine types set + * CURLAUTH_ANYSAFE - All fine types except Basic + */ + +#define CURLAUTH_NONE ((unsigned long)0) +#define CURLAUTH_BASIC (((unsigned long)1)<<0) +#define CURLAUTH_DIGEST (((unsigned long)1)<<1) +#define CURLAUTH_GSSNEGOTIATE (((unsigned long)1)<<2) +#define CURLAUTH_NTLM (((unsigned long)1)<<3) +#define CURLAUTH_DIGEST_IE (((unsigned long)1)<<4) +#define CURLAUTH_NTLM_WB (((unsigned long)1)<<5) +#define CURLAUTH_ONLY (((unsigned long)1)<<31) +#define CURLAUTH_ANY (~CURLAUTH_DIGEST_IE) +#define CURLAUTH_ANYSAFE (~(CURLAUTH_BASIC|CURLAUTH_DIGEST_IE)) + +#define CURLSSH_AUTH_ANY ~0 /* all types supported by the server */ +#define CURLSSH_AUTH_NONE 0 /* none allowed, silly but complete */ +#define CURLSSH_AUTH_PUBLICKEY (1<<0) /* public/private key files */ +#define CURLSSH_AUTH_PASSWORD (1<<1) /* password */ +#define CURLSSH_AUTH_HOST (1<<2) /* host key files */ +#define CURLSSH_AUTH_KEYBOARD (1<<3) /* keyboard interactive */ +#define CURLSSH_AUTH_DEFAULT CURLSSH_AUTH_ANY + +#define CURLGSSAPI_DELEGATION_NONE 0 /* no delegation (default) */ +#define CURLGSSAPI_DELEGATION_POLICY_FLAG (1<<0) /* if permitted by policy */ +#define CURLGSSAPI_DELEGATION_FLAG (1<<1) /* delegate always */ + +#define CURL_ERROR_SIZE 256 + +struct curl_khkey { + const char *key; /* points to a zero-terminated string encoded with base64 + if len is zero, otherwise to the "raw" data */ + size_t len; + enum type { + CURLKHTYPE_UNKNOWN, + CURLKHTYPE_RSA1, + CURLKHTYPE_RSA, + CURLKHTYPE_DSS + } keytype; +}; + +/* this is the set of return values expected from the curl_sshkeycallback + callback */ +enum curl_khstat { + CURLKHSTAT_FINE_ADD_TO_FILE, + CURLKHSTAT_FINE, + CURLKHSTAT_REJECT, /* reject the connection, return an error */ + CURLKHSTAT_DEFER, /* do not accept it, but we can't answer right now so + this causes a CURLE_DEFER error but otherwise the + connection will be left intact etc */ + CURLKHSTAT_LAST /* not for use, only a marker for last-in-list */ +}; + +/* this is the set of status codes pass in to the callback */ +enum curl_khmatch { + CURLKHMATCH_OK, /* match */ + CURLKHMATCH_MISMATCH, /* host found, key mismatch! */ + CURLKHMATCH_MISSING, /* no matching host/key found */ + CURLKHMATCH_LAST /* not for use, only a marker for last-in-list */ +}; + +typedef int + (*curl_sshkeycallback) (CURL *easy, /* easy handle */ + const struct curl_khkey *knownkey, /* known */ + const struct curl_khkey *foundkey, /* found */ + enum curl_khmatch, /* libcurl's view on the keys */ + void *clientp); /* custom pointer passed from app */ + +/* parameter for the CURLOPT_USE_SSL option */ +typedef enum { + CURLUSESSL_NONE, /* do not attempt to use SSL */ + CURLUSESSL_TRY, /* try using SSL, proceed anyway otherwise */ + CURLUSESSL_CONTROL, /* SSL for the control connection or fail */ + CURLUSESSL_ALL, /* SSL for all communication or fail */ + CURLUSESSL_LAST /* not an option, never use */ +} curl_usessl; + +/* Definition of bits for the CURLOPT_SSL_OPTIONS argument: */ + +/* - ALLOW_BEAST tells libcurl to allow the BEAST SSL vulnerability in the + name of improving interoperability with older servers. Some SSL libraries + have introduced work-arounds for this flaw but those work-arounds sometimes + make the SSL communication fail. To regain functionality with those broken + servers, a user can this way allow the vulnerability back. */ +#define CURLSSLOPT_ALLOW_BEAST (1<<0) + +#ifndef CURL_NO_OLDIES /* define this to test if your app builds with all + the obsolete stuff removed! */ + +/* Backwards compatibility with older names */ +/* These are scheduled to disappear by 2009 */ + +#define CURLFTPSSL_NONE CURLUSESSL_NONE +#define CURLFTPSSL_TRY CURLUSESSL_TRY +#define CURLFTPSSL_CONTROL CURLUSESSL_CONTROL +#define CURLFTPSSL_ALL CURLUSESSL_ALL +#define CURLFTPSSL_LAST CURLUSESSL_LAST +#define curl_ftpssl curl_usessl +#endif /*!CURL_NO_OLDIES*/ + +/* parameter for the CURLOPT_FTP_SSL_CCC option */ +typedef enum { + CURLFTPSSL_CCC_NONE, /* do not send CCC */ + CURLFTPSSL_CCC_PASSIVE, /* Let the server initiate the shutdown */ + CURLFTPSSL_CCC_ACTIVE, /* Initiate the shutdown */ + CURLFTPSSL_CCC_LAST /* not an option, never use */ +} curl_ftpccc; + +/* parameter for the CURLOPT_FTPSSLAUTH option */ +typedef enum { + CURLFTPAUTH_DEFAULT, /* let libcurl decide */ + CURLFTPAUTH_SSL, /* use "AUTH SSL" */ + CURLFTPAUTH_TLS, /* use "AUTH TLS" */ + CURLFTPAUTH_LAST /* not an option, never use */ +} curl_ftpauth; + +/* parameter for the CURLOPT_FTP_CREATE_MISSING_DIRS option */ +typedef enum { + CURLFTP_CREATE_DIR_NONE, /* do NOT create missing dirs! */ + CURLFTP_CREATE_DIR, /* (FTP/SFTP) if CWD fails, try MKD and then CWD + again if MKD succeeded, for SFTP this does + similar magic */ + CURLFTP_CREATE_DIR_RETRY, /* (FTP only) if CWD fails, try MKD and then CWD + again even if MKD failed! */ + CURLFTP_CREATE_DIR_LAST /* not an option, never use */ +} curl_ftpcreatedir; + +/* parameter for the CURLOPT_FTP_FILEMETHOD option */ +typedef enum { + CURLFTPMETHOD_DEFAULT, /* let libcurl pick */ + CURLFTPMETHOD_MULTICWD, /* single CWD operation for each path part */ + CURLFTPMETHOD_NOCWD, /* no CWD at all */ + CURLFTPMETHOD_SINGLECWD, /* one CWD to full dir, then work on file */ + CURLFTPMETHOD_LAST /* not an option, never use */ +} curl_ftpmethod; + +/* CURLPROTO_ defines are for the CURLOPT_*PROTOCOLS options */ +#define CURLPROTO_HTTP (1<<0) +#define CURLPROTO_HTTPS (1<<1) +#define CURLPROTO_FTP (1<<2) +#define CURLPROTO_FTPS (1<<3) +#define CURLPROTO_SCP (1<<4) +#define CURLPROTO_SFTP (1<<5) +#define CURLPROTO_TELNET (1<<6) +#define CURLPROTO_LDAP (1<<7) +#define CURLPROTO_LDAPS (1<<8) +#define CURLPROTO_DICT (1<<9) +#define CURLPROTO_FILE (1<<10) +#define CURLPROTO_TFTP (1<<11) +#define CURLPROTO_IMAP (1<<12) +#define CURLPROTO_IMAPS (1<<13) +#define CURLPROTO_POP3 (1<<14) +#define CURLPROTO_POP3S (1<<15) +#define CURLPROTO_SMTP (1<<16) +#define CURLPROTO_SMTPS (1<<17) +#define CURLPROTO_RTSP (1<<18) +#define CURLPROTO_RTMP (1<<19) +#define CURLPROTO_RTMPT (1<<20) +#define CURLPROTO_RTMPE (1<<21) +#define CURLPROTO_RTMPTE (1<<22) +#define CURLPROTO_RTMPS (1<<23) +#define CURLPROTO_RTMPTS (1<<24) +#define CURLPROTO_GOPHER (1<<25) +#define CURLPROTO_ALL (~0) /* enable everything */ + +/* long may be 32 or 64 bits, but we should never depend on anything else + but 32 */ +#define CURLOPTTYPE_LONG 0 +#define CURLOPTTYPE_OBJECTPOINT 10000 +#define CURLOPTTYPE_FUNCTIONPOINT 20000 +#define CURLOPTTYPE_OFF_T 30000 + +/* name is uppercase CURLOPT_, + type is one of the defined CURLOPTTYPE_ + number is unique identifier */ +#ifdef CINIT +#undef CINIT +#endif + +#ifdef CURL_ISOCPP +#define CINIT(na,t,nu) CURLOPT_ ## na = CURLOPTTYPE_ ## t + nu +#else +/* The macro "##" is ISO C, we assume pre-ISO C doesn't support it. */ +#define LONG CURLOPTTYPE_LONG +#define OBJECTPOINT CURLOPTTYPE_OBJECTPOINT +#define FUNCTIONPOINT CURLOPTTYPE_FUNCTIONPOINT +#define OFF_T CURLOPTTYPE_OFF_T +#define CINIT(name,type,number) CURLOPT_/**/name = type + number +#endif + +/* + * This macro-mania below setups the CURLOPT_[what] enum, to be used with + * curl_easy_setopt(). The first argument in the CINIT() macro is the [what] + * word. + */ + +typedef enum { + /* This is the FILE * or void * the regular output should be written to. */ + CINIT(FILE, OBJECTPOINT, 1), + + /* The full URL to get/put */ + CINIT(URL, OBJECTPOINT, 2), + + /* Port number to connect to, if other than default. */ + CINIT(PORT, LONG, 3), + + /* Name of proxy to use. */ + CINIT(PROXY, OBJECTPOINT, 4), + + /* "name:password" to use when fetching. */ + CINIT(USERPWD, OBJECTPOINT, 5), + + /* "name:password" to use with proxy. */ + CINIT(PROXYUSERPWD, OBJECTPOINT, 6), + + /* Range to get, specified as an ASCII string. */ + CINIT(RANGE, OBJECTPOINT, 7), + + /* not used */ + + /* Specified file stream to upload from (use as input): */ + CINIT(INFILE, OBJECTPOINT, 9), + + /* Buffer to receive error messages in, must be at least CURL_ERROR_SIZE + * bytes big. If this is not used, error messages go to stderr instead: */ + CINIT(ERRORBUFFER, OBJECTPOINT, 10), + + /* Function that will be called to store the output (instead of fwrite). The + * parameters will use fwrite() syntax, make sure to follow them. */ + CINIT(WRITEFUNCTION, FUNCTIONPOINT, 11), + + /* Function that will be called to read the input (instead of fread). The + * parameters will use fread() syntax, make sure to follow them. */ + CINIT(READFUNCTION, FUNCTIONPOINT, 12), + + /* Time-out the read operation after this amount of seconds */ + CINIT(TIMEOUT, LONG, 13), + + /* If the CURLOPT_INFILE is used, this can be used to inform libcurl about + * how large the file being sent really is. That allows better error + * checking and better verifies that the upload was successful. -1 means + * unknown size. + * + * For large file support, there is also a _LARGE version of the key + * which takes an off_t type, allowing platforms with larger off_t + * sizes to handle larger files. See below for INFILESIZE_LARGE. + */ + CINIT(INFILESIZE, LONG, 14), + + /* POST static input fields. */ + CINIT(POSTFIELDS, OBJECTPOINT, 15), + + /* Set the referrer page (needed by some CGIs) */ + CINIT(REFERER, OBJECTPOINT, 16), + + /* Set the FTP PORT string (interface name, named or numerical IP address) + Use i.e '-' to use default address. */ + CINIT(FTPPORT, OBJECTPOINT, 17), + + /* Set the User-Agent string (examined by some CGIs) */ + CINIT(USERAGENT, OBJECTPOINT, 18), + + /* If the download receives less than "low speed limit" bytes/second + * during "low speed time" seconds, the operations is aborted. + * You could i.e if you have a pretty high speed connection, abort if + * it is less than 2000 bytes/sec during 20 seconds. + */ + + /* Set the "low speed limit" */ + CINIT(LOW_SPEED_LIMIT, LONG, 19), + + /* Set the "low speed time" */ + CINIT(LOW_SPEED_TIME, LONG, 20), + + /* Set the continuation offset. + * + * Note there is also a _LARGE version of this key which uses + * off_t types, allowing for large file offsets on platforms which + * use larger-than-32-bit off_t's. Look below for RESUME_FROM_LARGE. + */ + CINIT(RESUME_FROM, LONG, 21), + + /* Set cookie in request: */ + CINIT(COOKIE, OBJECTPOINT, 22), + + /* This points to a linked list of headers, struct curl_slist kind */ + CINIT(HTTPHEADER, OBJECTPOINT, 23), + + /* This points to a linked list of post entries, struct curl_httppost */ + CINIT(HTTPPOST, OBJECTPOINT, 24), + + /* name of the file keeping your private SSL-certificate */ + CINIT(SSLCERT, OBJECTPOINT, 25), + + /* password for the SSL or SSH private key */ + CINIT(KEYPASSWD, OBJECTPOINT, 26), + + /* send TYPE parameter? */ + CINIT(CRLF, LONG, 27), + + /* send linked-list of QUOTE commands */ + CINIT(QUOTE, OBJECTPOINT, 28), + + /* send FILE * or void * to store headers to, if you use a callback it + is simply passed to the callback unmodified */ + CINIT(WRITEHEADER, OBJECTPOINT, 29), + + /* point to a file to read the initial cookies from, also enables + "cookie awareness" */ + CINIT(COOKIEFILE, OBJECTPOINT, 31), + + /* What version to specifically try to use. + See CURL_SSLVERSION defines below. */ + CINIT(SSLVERSION, LONG, 32), + + /* What kind of HTTP time condition to use, see defines */ + CINIT(TIMECONDITION, LONG, 33), + + /* Time to use with the above condition. Specified in number of seconds + since 1 Jan 1970 */ + CINIT(TIMEVALUE, LONG, 34), + + /* 35 = OBSOLETE */ + + /* Custom request, for customizing the get command like + HTTP: DELETE, TRACE and others + FTP: to use a different list command + */ + CINIT(CUSTOMREQUEST, OBJECTPOINT, 36), + + /* HTTP request, for odd commands like DELETE, TRACE and others */ + CINIT(STDERR, OBJECTPOINT, 37), + + /* 38 is not used */ + + /* send linked-list of post-transfer QUOTE commands */ + CINIT(POSTQUOTE, OBJECTPOINT, 39), + + CINIT(WRITEINFO, OBJECTPOINT, 40), /* DEPRECATED, do not use! */ + + CINIT(VERBOSE, LONG, 41), /* talk a lot */ + CINIT(HEADER, LONG, 42), /* throw the header out too */ + CINIT(NOPROGRESS, LONG, 43), /* shut off the progress meter */ + CINIT(NOBODY, LONG, 44), /* use HEAD to get http document */ + CINIT(FAILONERROR, LONG, 45), /* no output on http error codes >= 300 */ + CINIT(UPLOAD, LONG, 46), /* this is an upload */ + CINIT(POST, LONG, 47), /* HTTP POST method */ + CINIT(DIRLISTONLY, LONG, 48), /* bare names when listing directories */ + + CINIT(APPEND, LONG, 50), /* Append instead of overwrite on upload! */ + + /* Specify whether to read the user+password from the .netrc or the URL. + * This must be one of the CURL_NETRC_* enums below. */ + CINIT(NETRC, LONG, 51), + + CINIT(FOLLOWLOCATION, LONG, 52), /* use Location: Luke! */ + + CINIT(TRANSFERTEXT, LONG, 53), /* transfer data in text/ASCII format */ + CINIT(PUT, LONG, 54), /* HTTP PUT */ + + /* 55 = OBSOLETE */ + + /* Function that will be called instead of the internal progress display + * function. This function should be defined as the curl_progress_callback + * prototype defines. */ + CINIT(PROGRESSFUNCTION, FUNCTIONPOINT, 56), + + /* Data passed to the progress callback */ + CINIT(PROGRESSDATA, OBJECTPOINT, 57), + + /* We want the referrer field set automatically when following locations */ + CINIT(AUTOREFERER, LONG, 58), + + /* Port of the proxy, can be set in the proxy string as well with: + "[host]:[port]" */ + CINIT(PROXYPORT, LONG, 59), + + /* size of the POST input data, if strlen() is not good to use */ + CINIT(POSTFIELDSIZE, LONG, 60), + + /* tunnel non-http operations through a HTTP proxy */ + CINIT(HTTPPROXYTUNNEL, LONG, 61), + + /* Set the interface string to use as outgoing network interface */ + CINIT(INTERFACE, OBJECTPOINT, 62), + + /* Set the krb4/5 security level, this also enables krb4/5 awareness. This + * is a string, 'clear', 'safe', 'confidential' or 'private'. If the string + * is set but doesn't match one of these, 'private' will be used. */ + CINIT(KRBLEVEL, OBJECTPOINT, 63), + + /* Set if we should verify the peer in ssl handshake, set 1 to verify. */ + CINIT(SSL_VERIFYPEER, LONG, 64), + + /* The CApath or CAfile used to validate the peer certificate + this option is used only if SSL_VERIFYPEER is true */ + CINIT(CAINFO, OBJECTPOINT, 65), + + /* 66 = OBSOLETE */ + /* 67 = OBSOLETE */ + + /* Maximum number of http redirects to follow */ + CINIT(MAXREDIRS, LONG, 68), + + /* Pass a long set to 1 to get the date of the requested document (if + possible)! Pass a zero to shut it off. */ + CINIT(FILETIME, LONG, 69), + + /* This points to a linked list of telnet options */ + CINIT(TELNETOPTIONS, OBJECTPOINT, 70), + + /* Max amount of cached alive connections */ + CINIT(MAXCONNECTS, LONG, 71), + + CINIT(CLOSEPOLICY, LONG, 72), /* DEPRECATED, do not use! */ + + /* 73 = OBSOLETE */ + + /* Set to explicitly use a new connection for the upcoming transfer. + Do not use this unless you're absolutely sure of this, as it makes the + operation slower and is less friendly for the network. */ + CINIT(FRESH_CONNECT, LONG, 74), + + /* Set to explicitly forbid the upcoming transfer's connection to be re-used + when done. Do not use this unless you're absolutely sure of this, as it + makes the operation slower and is less friendly for the network. */ + CINIT(FORBID_REUSE, LONG, 75), + + /* Set to a file name that contains random data for libcurl to use to + seed the random engine when doing SSL connects. */ + CINIT(RANDOM_FILE, OBJECTPOINT, 76), + + /* Set to the Entropy Gathering Daemon socket pathname */ + CINIT(EGDSOCKET, OBJECTPOINT, 77), + + /* Time-out connect operations after this amount of seconds, if connects + are OK within this time, then fine... This only aborts the connect + phase. [Only works on unix-style/SIGALRM operating systems] */ + CINIT(CONNECTTIMEOUT, LONG, 78), + + /* Function that will be called to store headers (instead of fwrite). The + * parameters will use fwrite() syntax, make sure to follow them. */ + CINIT(HEADERFUNCTION, FUNCTIONPOINT, 79), + + /* Set this to force the HTTP request to get back to GET. Only really usable + if POST, PUT or a custom request have been used first. + */ + CINIT(HTTPGET, LONG, 80), + + /* Set if we should verify the Common name from the peer certificate in ssl + * handshake, set 1 to check existence, 2 to ensure that it matches the + * provided hostname. */ + CINIT(SSL_VERIFYHOST, LONG, 81), + + /* Specify which file name to write all known cookies in after completed + operation. Set file name to "-" (dash) to make it go to stdout. */ + CINIT(COOKIEJAR, OBJECTPOINT, 82), + + /* Specify which SSL ciphers to use */ + CINIT(SSL_CIPHER_LIST, OBJECTPOINT, 83), + + /* Specify which HTTP version to use! This must be set to one of the + CURL_HTTP_VERSION* enums set below. */ + CINIT(HTTP_VERSION, LONG, 84), + + /* Specifically switch on or off the FTP engine's use of the EPSV command. By + default, that one will always be attempted before the more traditional + PASV command. */ + CINIT(FTP_USE_EPSV, LONG, 85), + + /* type of the file keeping your SSL-certificate ("DER", "PEM", "ENG") */ + CINIT(SSLCERTTYPE, OBJECTPOINT, 86), + + /* name of the file keeping your private SSL-key */ + CINIT(SSLKEY, OBJECTPOINT, 87), + + /* type of the file keeping your private SSL-key ("DER", "PEM", "ENG") */ + CINIT(SSLKEYTYPE, OBJECTPOINT, 88), + + /* crypto engine for the SSL-sub system */ + CINIT(SSLENGINE, OBJECTPOINT, 89), + + /* set the crypto engine for the SSL-sub system as default + the param has no meaning... + */ + CINIT(SSLENGINE_DEFAULT, LONG, 90), + + /* Non-zero value means to use the global dns cache */ + CINIT(DNS_USE_GLOBAL_CACHE, LONG, 91), /* DEPRECATED, do not use! */ + + /* DNS cache timeout */ + CINIT(DNS_CACHE_TIMEOUT, LONG, 92), + + /* send linked-list of pre-transfer QUOTE commands */ + CINIT(PREQUOTE, OBJECTPOINT, 93), + + /* set the debug function */ + CINIT(DEBUGFUNCTION, FUNCTIONPOINT, 94), + + /* set the data for the debug function */ + CINIT(DEBUGDATA, OBJECTPOINT, 95), + + /* mark this as start of a cookie session */ + CINIT(COOKIESESSION, LONG, 96), + + /* The CApath directory used to validate the peer certificate + this option is used only if SSL_VERIFYPEER is true */ + CINIT(CAPATH, OBJECTPOINT, 97), + + /* Instruct libcurl to use a smaller receive buffer */ + CINIT(BUFFERSIZE, LONG, 98), + + /* Instruct libcurl to not use any signal/alarm handlers, even when using + timeouts. This option is useful for multi-threaded applications. + See libcurl-the-guide for more background information. */ + CINIT(NOSIGNAL, LONG, 99), + + /* Provide a CURLShare for mutexing non-ts data */ + CINIT(SHARE, OBJECTPOINT, 100), + + /* indicates type of proxy. accepted values are CURLPROXY_HTTP (default), + CURLPROXY_SOCKS4, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5. */ + CINIT(PROXYTYPE, LONG, 101), + + /* Set the Accept-Encoding string. Use this to tell a server you would like + the response to be compressed. Before 7.21.6, this was known as + CURLOPT_ENCODING */ + CINIT(ACCEPT_ENCODING, OBJECTPOINT, 102), + + /* Set pointer to private data */ + CINIT(PRIVATE, OBJECTPOINT, 103), + + /* Set aliases for HTTP 200 in the HTTP Response header */ + CINIT(HTTP200ALIASES, OBJECTPOINT, 104), + + /* Continue to send authentication (user+password) when following locations, + even when hostname changed. This can potentially send off the name + and password to whatever host the server decides. */ + CINIT(UNRESTRICTED_AUTH, LONG, 105), + + /* Specifically switch on or off the FTP engine's use of the EPRT command ( + it also disables the LPRT attempt). By default, those ones will always be + attempted before the good old traditional PORT command. */ + CINIT(FTP_USE_EPRT, LONG, 106), + + /* Set this to a bitmask value to enable the particular authentications + methods you like. Use this in combination with CURLOPT_USERPWD. + Note that setting multiple bits may cause extra network round-trips. */ + CINIT(HTTPAUTH, LONG, 107), + + /* Set the ssl context callback function, currently only for OpenSSL ssl_ctx + in second argument. The function must be matching the + curl_ssl_ctx_callback proto. */ + CINIT(SSL_CTX_FUNCTION, FUNCTIONPOINT, 108), + + /* Set the userdata for the ssl context callback function's third + argument */ + CINIT(SSL_CTX_DATA, OBJECTPOINT, 109), + + /* FTP Option that causes missing dirs to be created on the remote server. + In 7.19.4 we introduced the convenience enums for this option using the + CURLFTP_CREATE_DIR prefix. + */ + CINIT(FTP_CREATE_MISSING_DIRS, LONG, 110), + + /* Set this to a bitmask value to enable the particular authentications + methods you like. Use this in combination with CURLOPT_PROXYUSERPWD. + Note that setting multiple bits may cause extra network round-trips. */ + CINIT(PROXYAUTH, LONG, 111), + + /* FTP option that changes the timeout, in seconds, associated with + getting a response. This is different from transfer timeout time and + essentially places a demand on the FTP server to acknowledge commands + in a timely manner. */ + CINIT(FTP_RESPONSE_TIMEOUT, LONG, 112), +#define CURLOPT_SERVER_RESPONSE_TIMEOUT CURLOPT_FTP_RESPONSE_TIMEOUT + + /* Set this option to one of the CURL_IPRESOLVE_* defines (see below) to + tell libcurl to resolve names to those IP versions only. This only has + affect on systems with support for more than one, i.e IPv4 _and_ IPv6. */ + CINIT(IPRESOLVE, LONG, 113), + + /* Set this option to limit the size of a file that will be downloaded from + an HTTP or FTP server. + + Note there is also _LARGE version which adds large file support for + platforms which have larger off_t sizes. See MAXFILESIZE_LARGE below. */ + CINIT(MAXFILESIZE, LONG, 114), + + /* See the comment for INFILESIZE above, but in short, specifies + * the size of the file being uploaded. -1 means unknown. + */ + CINIT(INFILESIZE_LARGE, OFF_T, 115), + + /* Sets the continuation offset. There is also a LONG version of this; + * look above for RESUME_FROM. + */ + CINIT(RESUME_FROM_LARGE, OFF_T, 116), + + /* Sets the maximum size of data that will be downloaded from + * an HTTP or FTP server. See MAXFILESIZE above for the LONG version. + */ + CINIT(MAXFILESIZE_LARGE, OFF_T, 117), + + /* Set this option to the file name of your .netrc file you want libcurl + to parse (using the CURLOPT_NETRC option). If not set, libcurl will do + a poor attempt to find the user's home directory and check for a .netrc + file in there. */ + CINIT(NETRC_FILE, OBJECTPOINT, 118), + + /* Enable SSL/TLS for FTP, pick one of: + CURLFTPSSL_TRY - try using SSL, proceed anyway otherwise + CURLFTPSSL_CONTROL - SSL for the control connection or fail + CURLFTPSSL_ALL - SSL for all communication or fail + */ + CINIT(USE_SSL, LONG, 119), + + /* The _LARGE version of the standard POSTFIELDSIZE option */ + CINIT(POSTFIELDSIZE_LARGE, OFF_T, 120), + + /* Enable/disable the TCP Nagle algorithm */ + CINIT(TCP_NODELAY, LONG, 121), + + /* 122 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ + /* 123 OBSOLETE. Gone in 7.16.0 */ + /* 124 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ + /* 125 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ + /* 126 OBSOLETE, used in 7.12.3. Gone in 7.13.0 */ + /* 127 OBSOLETE. Gone in 7.16.0 */ + /* 128 OBSOLETE. Gone in 7.16.0 */ + + /* When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option + can be used to change libcurl's default action which is to first try + "AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK + response has been received. + + Available parameters are: + CURLFTPAUTH_DEFAULT - let libcurl decide + CURLFTPAUTH_SSL - try "AUTH SSL" first, then TLS + CURLFTPAUTH_TLS - try "AUTH TLS" first, then SSL + */ + CINIT(FTPSSLAUTH, LONG, 129), + + CINIT(IOCTLFUNCTION, FUNCTIONPOINT, 130), + CINIT(IOCTLDATA, OBJECTPOINT, 131), + + /* 132 OBSOLETE. Gone in 7.16.0 */ + /* 133 OBSOLETE. Gone in 7.16.0 */ + + /* zero terminated string for pass on to the FTP server when asked for + "account" info */ + CINIT(FTP_ACCOUNT, OBJECTPOINT, 134), + + /* feed cookies into cookie engine */ + CINIT(COOKIELIST, OBJECTPOINT, 135), + + /* ignore Content-Length */ + CINIT(IGNORE_CONTENT_LENGTH, LONG, 136), + + /* Set to non-zero to skip the IP address received in a 227 PASV FTP server + response. Typically used for FTP-SSL purposes but is not restricted to + that. libcurl will then instead use the same IP address it used for the + control connection. */ + CINIT(FTP_SKIP_PASV_IP, LONG, 137), + + /* Select "file method" to use when doing FTP, see the curl_ftpmethod + above. */ + CINIT(FTP_FILEMETHOD, LONG, 138), + + /* Local port number to bind the socket to */ + CINIT(LOCALPORT, LONG, 139), + + /* Number of ports to try, including the first one set with LOCALPORT. + Thus, setting it to 1 will make no additional attempts but the first. + */ + CINIT(LOCALPORTRANGE, LONG, 140), + + /* no transfer, set up connection and let application use the socket by + extracting it with CURLINFO_LASTSOCKET */ + CINIT(CONNECT_ONLY, LONG, 141), + + /* Function that will be called to convert from the + network encoding (instead of using the iconv calls in libcurl) */ + CINIT(CONV_FROM_NETWORK_FUNCTION, FUNCTIONPOINT, 142), + + /* Function that will be called to convert to the + network encoding (instead of using the iconv calls in libcurl) */ + CINIT(CONV_TO_NETWORK_FUNCTION, FUNCTIONPOINT, 143), + + /* Function that will be called to convert from UTF8 + (instead of using the iconv calls in libcurl) + Note that this is used only for SSL certificate processing */ + CINIT(CONV_FROM_UTF8_FUNCTION, FUNCTIONPOINT, 144), + + /* if the connection proceeds too quickly then need to slow it down */ + /* limit-rate: maximum number of bytes per second to send or receive */ + CINIT(MAX_SEND_SPEED_LARGE, OFF_T, 145), + CINIT(MAX_RECV_SPEED_LARGE, OFF_T, 146), + + /* Pointer to command string to send if USER/PASS fails. */ + CINIT(FTP_ALTERNATIVE_TO_USER, OBJECTPOINT, 147), + + /* callback function for setting socket options */ + CINIT(SOCKOPTFUNCTION, FUNCTIONPOINT, 148), + CINIT(SOCKOPTDATA, OBJECTPOINT, 149), + + /* set to 0 to disable session ID re-use for this transfer, default is + enabled (== 1) */ + CINIT(SSL_SESSIONID_CACHE, LONG, 150), + + /* allowed SSH authentication methods */ + CINIT(SSH_AUTH_TYPES, LONG, 151), + + /* Used by scp/sftp to do public/private key authentication */ + CINIT(SSH_PUBLIC_KEYFILE, OBJECTPOINT, 152), + CINIT(SSH_PRIVATE_KEYFILE, OBJECTPOINT, 153), + + /* Send CCC (Clear Command Channel) after authentication */ + CINIT(FTP_SSL_CCC, LONG, 154), + + /* Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution */ + CINIT(TIMEOUT_MS, LONG, 155), + CINIT(CONNECTTIMEOUT_MS, LONG, 156), + + /* set to zero to disable the libcurl's decoding and thus pass the raw body + data to the application even when it is encoded/compressed */ + CINIT(HTTP_TRANSFER_DECODING, LONG, 157), + CINIT(HTTP_CONTENT_DECODING, LONG, 158), + + /* Permission used when creating new files and directories on the remote + server for protocols that support it, SFTP/SCP/FILE */ + CINIT(NEW_FILE_PERMS, LONG, 159), + CINIT(NEW_DIRECTORY_PERMS, LONG, 160), + + /* Set the behaviour of POST when redirecting. Values must be set to one + of CURL_REDIR* defines below. This used to be called CURLOPT_POST301 */ + CINIT(POSTREDIR, LONG, 161), + + /* used by scp/sftp to verify the host's public key */ + CINIT(SSH_HOST_PUBLIC_KEY_MD5, OBJECTPOINT, 162), + + /* Callback function for opening socket (instead of socket(2)). Optionally, + callback is able change the address or refuse to connect returning + CURL_SOCKET_BAD. The callback should have type + curl_opensocket_callback */ + CINIT(OPENSOCKETFUNCTION, FUNCTIONPOINT, 163), + CINIT(OPENSOCKETDATA, OBJECTPOINT, 164), + + /* POST volatile input fields. */ + CINIT(COPYPOSTFIELDS, OBJECTPOINT, 165), + + /* set transfer mode (;type=) when doing FTP via an HTTP proxy */ + CINIT(PROXY_TRANSFER_MODE, LONG, 166), + + /* Callback function for seeking in the input stream */ + CINIT(SEEKFUNCTION, FUNCTIONPOINT, 167), + CINIT(SEEKDATA, OBJECTPOINT, 168), + + /* CRL file */ + CINIT(CRLFILE, OBJECTPOINT, 169), + + /* Issuer certificate */ + CINIT(ISSUERCERT, OBJECTPOINT, 170), + + /* (IPv6) Address scope */ + CINIT(ADDRESS_SCOPE, LONG, 171), + + /* Collect certificate chain info and allow it to get retrievable with + CURLINFO_CERTINFO after the transfer is complete. (Unfortunately) only + working with OpenSSL-powered builds. */ + CINIT(CERTINFO, LONG, 172), + + /* "name" and "pwd" to use when fetching. */ + CINIT(USERNAME, OBJECTPOINT, 173), + CINIT(PASSWORD, OBJECTPOINT, 174), + + /* "name" and "pwd" to use with Proxy when fetching. */ + CINIT(PROXYUSERNAME, OBJECTPOINT, 175), + CINIT(PROXYPASSWORD, OBJECTPOINT, 176), + + /* Comma separated list of hostnames defining no-proxy zones. These should + match both hostnames directly, and hostnames within a domain. For + example, local.com will match local.com and www.local.com, but NOT + notlocal.com or www.notlocal.com. For compatibility with other + implementations of this, .local.com will be considered to be the same as + local.com. A single * is the only valid wildcard, and effectively + disables the use of proxy. */ + CINIT(NOPROXY, OBJECTPOINT, 177), + + /* block size for TFTP transfers */ + CINIT(TFTP_BLKSIZE, LONG, 178), + + /* Socks Service */ + CINIT(SOCKS5_GSSAPI_SERVICE, OBJECTPOINT, 179), + + /* Socks Service */ + CINIT(SOCKS5_GSSAPI_NEC, LONG, 180), + + /* set the bitmask for the protocols that are allowed to be used for the + transfer, which thus helps the app which takes URLs from users or other + external inputs and want to restrict what protocol(s) to deal + with. Defaults to CURLPROTO_ALL. */ + CINIT(PROTOCOLS, LONG, 181), + + /* set the bitmask for the protocols that libcurl is allowed to follow to, + as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs + to be set in both bitmasks to be allowed to get redirected to. Defaults + to all protocols except FILE and SCP. */ + CINIT(REDIR_PROTOCOLS, LONG, 182), + + /* set the SSH knownhost file name to use */ + CINIT(SSH_KNOWNHOSTS, OBJECTPOINT, 183), + + /* set the SSH host key callback, must point to a curl_sshkeycallback + function */ + CINIT(SSH_KEYFUNCTION, FUNCTIONPOINT, 184), + + /* set the SSH host key callback custom pointer */ + CINIT(SSH_KEYDATA, OBJECTPOINT, 185), + + /* set the SMTP mail originator */ + CINIT(MAIL_FROM, OBJECTPOINT, 186), + + /* set the SMTP mail receiver(s) */ + CINIT(MAIL_RCPT, OBJECTPOINT, 187), + + /* FTP: send PRET before PASV */ + CINIT(FTP_USE_PRET, LONG, 188), + + /* RTSP request method (OPTIONS, SETUP, PLAY, etc...) */ + CINIT(RTSP_REQUEST, LONG, 189), + + /* The RTSP session identifier */ + CINIT(RTSP_SESSION_ID, OBJECTPOINT, 190), + + /* The RTSP stream URI */ + CINIT(RTSP_STREAM_URI, OBJECTPOINT, 191), + + /* The Transport: header to use in RTSP requests */ + CINIT(RTSP_TRANSPORT, OBJECTPOINT, 192), + + /* Manually initialize the client RTSP CSeq for this handle */ + CINIT(RTSP_CLIENT_CSEQ, LONG, 193), + + /* Manually initialize the server RTSP CSeq for this handle */ + CINIT(RTSP_SERVER_CSEQ, LONG, 194), + + /* The stream to pass to INTERLEAVEFUNCTION. */ + CINIT(INTERLEAVEDATA, OBJECTPOINT, 195), + + /* Let the application define a custom write method for RTP data */ + CINIT(INTERLEAVEFUNCTION, FUNCTIONPOINT, 196), + + /* Turn on wildcard matching */ + CINIT(WILDCARDMATCH, LONG, 197), + + /* Directory matching callback called before downloading of an + individual file (chunk) started */ + CINIT(CHUNK_BGN_FUNCTION, FUNCTIONPOINT, 198), + + /* Directory matching callback called after the file (chunk) + was downloaded, or skipped */ + CINIT(CHUNK_END_FUNCTION, FUNCTIONPOINT, 199), + + /* Change match (fnmatch-like) callback for wildcard matching */ + CINIT(FNMATCH_FUNCTION, FUNCTIONPOINT, 200), + + /* Let the application define custom chunk data pointer */ + CINIT(CHUNK_DATA, OBJECTPOINT, 201), + + /* FNMATCH_FUNCTION user pointer */ + CINIT(FNMATCH_DATA, OBJECTPOINT, 202), + + /* send linked-list of name:port:address sets */ + CINIT(RESOLVE, OBJECTPOINT, 203), + + /* Set a username for authenticated TLS */ + CINIT(TLSAUTH_USERNAME, OBJECTPOINT, 204), + + /* Set a password for authenticated TLS */ + CINIT(TLSAUTH_PASSWORD, OBJECTPOINT, 205), + + /* Set authentication type for authenticated TLS */ + CINIT(TLSAUTH_TYPE, OBJECTPOINT, 206), + + /* Set to 1 to enable the "TE:" header in HTTP requests to ask for + compressed transfer-encoded responses. Set to 0 to disable the use of TE: + in outgoing requests. The current default is 0, but it might change in a + future libcurl release. + + libcurl will ask for the compressed methods it knows of, and if that + isn't any, it will not ask for transfer-encoding at all even if this + option is set to 1. + + */ + CINIT(TRANSFER_ENCODING, LONG, 207), + + /* Callback function for closing socket (instead of close(2)). The callback + should have type curl_closesocket_callback */ + CINIT(CLOSESOCKETFUNCTION, FUNCTIONPOINT, 208), + CINIT(CLOSESOCKETDATA, OBJECTPOINT, 209), + + /* allow GSSAPI credential delegation */ + CINIT(GSSAPI_DELEGATION, LONG, 210), + + /* Set the name servers to use for DNS resolution */ + CINIT(DNS_SERVERS, OBJECTPOINT, 211), + + /* Time-out accept operations (currently for FTP only) after this amount + of miliseconds. */ + CINIT(ACCEPTTIMEOUT_MS, LONG, 212), + + /* Set TCP keepalive */ + CINIT(TCP_KEEPALIVE, LONG, 213), + + /* non-universal keepalive knobs (Linux, AIX, HP-UX, more) */ + CINIT(TCP_KEEPIDLE, LONG, 214), + CINIT(TCP_KEEPINTVL, LONG, 215), + + /* Enable/disable specific SSL features with a bitmask, see CURLSSLOPT_* */ + CINIT(SSL_OPTIONS, LONG, 216), + + /* set the SMTP auth originator */ + CINIT(MAIL_AUTH, OBJECTPOINT, 217), + + CURLOPT_LASTENTRY /* the last unused */ +} CURLoption; + +#ifndef CURL_NO_OLDIES /* define this to test if your app builds with all + the obsolete stuff removed! */ + +/* Backwards compatibility with older names */ +/* These are scheduled to disappear by 2011 */ + +/* This was added in version 7.19.1 */ +#define CURLOPT_POST301 CURLOPT_POSTREDIR + +/* These are scheduled to disappear by 2009 */ + +/* The following were added in 7.17.0 */ +#define CURLOPT_SSLKEYPASSWD CURLOPT_KEYPASSWD +#define CURLOPT_FTPAPPEND CURLOPT_APPEND +#define CURLOPT_FTPLISTONLY CURLOPT_DIRLISTONLY +#define CURLOPT_FTP_SSL CURLOPT_USE_SSL + +/* The following were added earlier */ + +#define CURLOPT_SSLCERTPASSWD CURLOPT_KEYPASSWD +#define CURLOPT_KRB4LEVEL CURLOPT_KRBLEVEL + +#else +/* This is set if CURL_NO_OLDIES is defined at compile-time */ +#undef CURLOPT_DNS_USE_GLOBAL_CACHE /* soon obsolete */ +#endif + + + /* Below here follows defines for the CURLOPT_IPRESOLVE option. If a host + name resolves addresses using more than one IP protocol version, this + option might be handy to force libcurl to use a specific IP version. */ +#define CURL_IPRESOLVE_WHATEVER 0 /* default, resolves addresses to all IP + versions that your system allows */ +#define CURL_IPRESOLVE_V4 1 /* resolve to ipv4 addresses */ +#define CURL_IPRESOLVE_V6 2 /* resolve to ipv6 addresses */ + + /* three convenient "aliases" that follow the name scheme better */ +#define CURLOPT_WRITEDATA CURLOPT_FILE +#define CURLOPT_READDATA CURLOPT_INFILE +#define CURLOPT_HEADERDATA CURLOPT_WRITEHEADER +#define CURLOPT_RTSPHEADER CURLOPT_HTTPHEADER + + /* These enums are for use with the CURLOPT_HTTP_VERSION option. */ +enum { + CURL_HTTP_VERSION_NONE, /* setting this means we don't care, and that we'd + like the library to choose the best possible + for us! */ + CURL_HTTP_VERSION_1_0, /* please use HTTP 1.0 in the request */ + CURL_HTTP_VERSION_1_1, /* please use HTTP 1.1 in the request */ + + CURL_HTTP_VERSION_LAST /* *ILLEGAL* http version */ +}; + +/* + * Public API enums for RTSP requests + */ +enum { + CURL_RTSPREQ_NONE, /* first in list */ + CURL_RTSPREQ_OPTIONS, + CURL_RTSPREQ_DESCRIBE, + CURL_RTSPREQ_ANNOUNCE, + CURL_RTSPREQ_SETUP, + CURL_RTSPREQ_PLAY, + CURL_RTSPREQ_PAUSE, + CURL_RTSPREQ_TEARDOWN, + CURL_RTSPREQ_GET_PARAMETER, + CURL_RTSPREQ_SET_PARAMETER, + CURL_RTSPREQ_RECORD, + CURL_RTSPREQ_RECEIVE, + CURL_RTSPREQ_LAST /* last in list */ +}; + + /* These enums are for use with the CURLOPT_NETRC option. */ +enum CURL_NETRC_OPTION { + CURL_NETRC_IGNORED, /* The .netrc will never be read. + * This is the default. */ + CURL_NETRC_OPTIONAL, /* A user:password in the URL will be preferred + * to one in the .netrc. */ + CURL_NETRC_REQUIRED, /* A user:password in the URL will be ignored. + * Unless one is set programmatically, the .netrc + * will be queried. */ + CURL_NETRC_LAST +}; + +enum { + CURL_SSLVERSION_DEFAULT, + CURL_SSLVERSION_TLSv1, + CURL_SSLVERSION_SSLv2, + CURL_SSLVERSION_SSLv3, + + CURL_SSLVERSION_LAST /* never use, keep last */ +}; + +enum CURL_TLSAUTH { + CURL_TLSAUTH_NONE, + CURL_TLSAUTH_SRP, + CURL_TLSAUTH_LAST /* never use, keep last */ +}; + +/* symbols to use with CURLOPT_POSTREDIR. + CURL_REDIR_POST_301, CURL_REDIR_POST_302 and CURL_REDIR_POST_303 + can be bitwise ORed so that CURL_REDIR_POST_301 | CURL_REDIR_POST_302 + | CURL_REDIR_POST_303 == CURL_REDIR_POST_ALL */ + +#define CURL_REDIR_GET_ALL 0 +#define CURL_REDIR_POST_301 1 +#define CURL_REDIR_POST_302 2 +#define CURL_REDIR_POST_303 4 +#define CURL_REDIR_POST_ALL \ + (CURL_REDIR_POST_301|CURL_REDIR_POST_302|CURL_REDIR_POST_303) + +typedef enum { + CURL_TIMECOND_NONE, + + CURL_TIMECOND_IFMODSINCE, + CURL_TIMECOND_IFUNMODSINCE, + CURL_TIMECOND_LASTMOD, + + CURL_TIMECOND_LAST +} curl_TimeCond; + + +/* curl_strequal() and curl_strnequal() are subject for removal in a future + libcurl, see lib/README.curlx for details */ +CURL_EXTERN int (curl_strequal)(const char *s1, const char *s2); +CURL_EXTERN int (curl_strnequal)(const char *s1, const char *s2, size_t n); + +/* name is uppercase CURLFORM_ */ +#ifdef CFINIT +#undef CFINIT +#endif + +#ifdef CURL_ISOCPP +#define CFINIT(name) CURLFORM_ ## name +#else +/* The macro "##" is ISO C, we assume pre-ISO C doesn't support it. */ +#define CFINIT(name) CURLFORM_/**/name +#endif + +typedef enum { + CFINIT(NOTHING), /********* the first one is unused ************/ + + /* */ + CFINIT(COPYNAME), + CFINIT(PTRNAME), + CFINIT(NAMELENGTH), + CFINIT(COPYCONTENTS), + CFINIT(PTRCONTENTS), + CFINIT(CONTENTSLENGTH), + CFINIT(FILECONTENT), + CFINIT(ARRAY), + CFINIT(OBSOLETE), + CFINIT(FILE), + + CFINIT(BUFFER), + CFINIT(BUFFERPTR), + CFINIT(BUFFERLENGTH), + + CFINIT(CONTENTTYPE), + CFINIT(CONTENTHEADER), + CFINIT(FILENAME), + CFINIT(END), + CFINIT(OBSOLETE2), + + CFINIT(STREAM), + + CURLFORM_LASTENTRY /* the last unused */ +} CURLformoption; + +#undef CFINIT /* done */ + +/* structure to be used as parameter for CURLFORM_ARRAY */ +struct curl_forms { + CURLformoption option; + const char *value; +}; + +/* use this for multipart formpost building */ +/* Returns code for curl_formadd() + * + * Returns: + * CURL_FORMADD_OK on success + * CURL_FORMADD_MEMORY if the FormInfo allocation fails + * CURL_FORMADD_OPTION_TWICE if one option is given twice for one Form + * CURL_FORMADD_NULL if a null pointer was given for a char + * CURL_FORMADD_MEMORY if the allocation of a FormInfo struct failed + * CURL_FORMADD_UNKNOWN_OPTION if an unknown option was used + * CURL_FORMADD_INCOMPLETE if the some FormInfo is not complete (or error) + * CURL_FORMADD_MEMORY if a curl_httppost struct cannot be allocated + * CURL_FORMADD_MEMORY if some allocation for string copying failed. + * CURL_FORMADD_ILLEGAL_ARRAY if an illegal option is used in an array + * + ***************************************************************************/ +typedef enum { + CURL_FORMADD_OK, /* first, no error */ + + CURL_FORMADD_MEMORY, + CURL_FORMADD_OPTION_TWICE, + CURL_FORMADD_NULL, + CURL_FORMADD_UNKNOWN_OPTION, + CURL_FORMADD_INCOMPLETE, + CURL_FORMADD_ILLEGAL_ARRAY, + CURL_FORMADD_DISABLED, /* libcurl was built with this disabled */ + + CURL_FORMADD_LAST /* last */ +} CURLFORMcode; + +/* + * NAME curl_formadd() + * + * DESCRIPTION + * + * Pretty advanced function for building multi-part formposts. Each invoke + * adds one part that together construct a full post. Then use + * CURLOPT_HTTPPOST to send it off to libcurl. + */ +CURL_EXTERN CURLFORMcode curl_formadd(struct curl_httppost **httppost, + struct curl_httppost **last_post, + ...); + +/* + * callback function for curl_formget() + * The void *arg pointer will be the one passed as second argument to + * curl_formget(). + * The character buffer passed to it must not be freed. + * Should return the buffer length passed to it as the argument "len" on + * success. + */ +typedef size_t (*curl_formget_callback)(void *arg, const char *buf, + size_t len); + +/* + * NAME curl_formget() + * + * DESCRIPTION + * + * Serialize a curl_httppost struct built with curl_formadd(). + * Accepts a void pointer as second argument which will be passed to + * the curl_formget_callback function. + * Returns 0 on success. + */ +CURL_EXTERN int curl_formget(struct curl_httppost *form, void *arg, + curl_formget_callback append); +/* + * NAME curl_formfree() + * + * DESCRIPTION + * + * Free a multipart formpost previously built with curl_formadd(). + */ +CURL_EXTERN void curl_formfree(struct curl_httppost *form); + +/* + * NAME curl_getenv() + * + * DESCRIPTION + * + * Returns a malloc()'ed string that MUST be curl_free()ed after usage is + * complete. DEPRECATED - see lib/README.curlx + */ +CURL_EXTERN char *curl_getenv(const char *variable); + +/* + * NAME curl_version() + * + * DESCRIPTION + * + * Returns a static ascii string of the libcurl version. + */ +CURL_EXTERN char *curl_version(void); + +/* + * NAME curl_easy_escape() + * + * DESCRIPTION + * + * Escapes URL strings (converts all letters consider illegal in URLs to their + * %XX versions). This function returns a new allocated string or NULL if an + * error occurred. + */ +CURL_EXTERN char *curl_easy_escape(CURL *handle, + const char *string, + int length); + +/* the previous version: */ +CURL_EXTERN char *curl_escape(const char *string, + int length); + + +/* + * NAME curl_easy_unescape() + * + * DESCRIPTION + * + * Unescapes URL encoding in strings (converts all %XX codes to their 8bit + * versions). This function returns a new allocated string or NULL if an error + * occurred. + * Conversion Note: On non-ASCII platforms the ASCII %XX codes are + * converted into the host encoding. + */ +CURL_EXTERN char *curl_easy_unescape(CURL *handle, + const char *string, + int length, + int *outlength); + +/* the previous version */ +CURL_EXTERN char *curl_unescape(const char *string, + int length); + +/* + * NAME curl_free() + * + * DESCRIPTION + * + * Provided for de-allocation in the same translation unit that did the + * allocation. Added in libcurl 7.10 + */ +CURL_EXTERN void curl_free(void *p); + +/* + * NAME curl_global_init() + * + * DESCRIPTION + * + * curl_global_init() should be invoked exactly once for each application that + * uses libcurl and before any call of other libcurl functions. + * + * This function is not thread-safe! + */ +CURL_EXTERN CURLcode curl_global_init(long flags); + +/* + * NAME curl_global_init_mem() + * + * DESCRIPTION + * + * curl_global_init() or curl_global_init_mem() should be invoked exactly once + * for each application that uses libcurl. This function can be used to + * initialize libcurl and set user defined memory management callback + * functions. Users can implement memory management routines to check for + * memory leaks, check for mis-use of the curl library etc. User registered + * callback routines with be invoked by this library instead of the system + * memory management routines like malloc, free etc. + */ +CURL_EXTERN CURLcode curl_global_init_mem(long flags, + curl_malloc_callback m, + curl_free_callback f, + curl_realloc_callback r, + curl_strdup_callback s, + curl_calloc_callback c); + +/* + * NAME curl_global_cleanup() + * + * DESCRIPTION + * + * curl_global_cleanup() should be invoked exactly once for each application + * that uses libcurl + */ +CURL_EXTERN void curl_global_cleanup(void); + +/* linked-list structure for the CURLOPT_QUOTE option (and other) */ +struct curl_slist { + char *data; + struct curl_slist *next; +}; + +/* + * NAME curl_slist_append() + * + * DESCRIPTION + * + * Appends a string to a linked list. If no list exists, it will be created + * first. Returns the new list, after appending. + */ +CURL_EXTERN struct curl_slist *curl_slist_append(struct curl_slist *, + const char *); + +/* + * NAME curl_slist_free_all() + * + * DESCRIPTION + * + * free a previously built curl_slist. + */ +CURL_EXTERN void curl_slist_free_all(struct curl_slist *); + +/* + * NAME curl_getdate() + * + * DESCRIPTION + * + * Returns the time, in seconds since 1 Jan 1970 of the time string given in + * the first argument. The time argument in the second parameter is unused + * and should be set to NULL. + */ +CURL_EXTERN time_t curl_getdate(const char *p, const time_t *unused); + +/* info about the certificate chain, only for OpenSSL builds. Asked + for with CURLOPT_CERTINFO / CURLINFO_CERTINFO */ +struct curl_certinfo { + int num_of_certs; /* number of certificates with information */ + struct curl_slist **certinfo; /* for each index in this array, there's a + linked list with textual information in the + format "name: value" */ +}; + +#define CURLINFO_STRING 0x100000 +#define CURLINFO_LONG 0x200000 +#define CURLINFO_DOUBLE 0x300000 +#define CURLINFO_SLIST 0x400000 +#define CURLINFO_MASK 0x0fffff +#define CURLINFO_TYPEMASK 0xf00000 + +typedef enum { + CURLINFO_NONE, /* first, never use this */ + CURLINFO_EFFECTIVE_URL = CURLINFO_STRING + 1, + CURLINFO_RESPONSE_CODE = CURLINFO_LONG + 2, + CURLINFO_TOTAL_TIME = CURLINFO_DOUBLE + 3, + CURLINFO_NAMELOOKUP_TIME = CURLINFO_DOUBLE + 4, + CURLINFO_CONNECT_TIME = CURLINFO_DOUBLE + 5, + CURLINFO_PRETRANSFER_TIME = CURLINFO_DOUBLE + 6, + CURLINFO_SIZE_UPLOAD = CURLINFO_DOUBLE + 7, + CURLINFO_SIZE_DOWNLOAD = CURLINFO_DOUBLE + 8, + CURLINFO_SPEED_DOWNLOAD = CURLINFO_DOUBLE + 9, + CURLINFO_SPEED_UPLOAD = CURLINFO_DOUBLE + 10, + CURLINFO_HEADER_SIZE = CURLINFO_LONG + 11, + CURLINFO_REQUEST_SIZE = CURLINFO_LONG + 12, + CURLINFO_SSL_VERIFYRESULT = CURLINFO_LONG + 13, + CURLINFO_FILETIME = CURLINFO_LONG + 14, + CURLINFO_CONTENT_LENGTH_DOWNLOAD = CURLINFO_DOUBLE + 15, + CURLINFO_CONTENT_LENGTH_UPLOAD = CURLINFO_DOUBLE + 16, + CURLINFO_STARTTRANSFER_TIME = CURLINFO_DOUBLE + 17, + CURLINFO_CONTENT_TYPE = CURLINFO_STRING + 18, + CURLINFO_REDIRECT_TIME = CURLINFO_DOUBLE + 19, + CURLINFO_REDIRECT_COUNT = CURLINFO_LONG + 20, + CURLINFO_PRIVATE = CURLINFO_STRING + 21, + CURLINFO_HTTP_CONNECTCODE = CURLINFO_LONG + 22, + CURLINFO_HTTPAUTH_AVAIL = CURLINFO_LONG + 23, + CURLINFO_PROXYAUTH_AVAIL = CURLINFO_LONG + 24, + CURLINFO_OS_ERRNO = CURLINFO_LONG + 25, + CURLINFO_NUM_CONNECTS = CURLINFO_LONG + 26, + CURLINFO_SSL_ENGINES = CURLINFO_SLIST + 27, + CURLINFO_COOKIELIST = CURLINFO_SLIST + 28, + CURLINFO_LASTSOCKET = CURLINFO_LONG + 29, + CURLINFO_FTP_ENTRY_PATH = CURLINFO_STRING + 30, + CURLINFO_REDIRECT_URL = CURLINFO_STRING + 31, + CURLINFO_PRIMARY_IP = CURLINFO_STRING + 32, + CURLINFO_APPCONNECT_TIME = CURLINFO_DOUBLE + 33, + CURLINFO_CERTINFO = CURLINFO_SLIST + 34, + CURLINFO_CONDITION_UNMET = CURLINFO_LONG + 35, + CURLINFO_RTSP_SESSION_ID = CURLINFO_STRING + 36, + CURLINFO_RTSP_CLIENT_CSEQ = CURLINFO_LONG + 37, + CURLINFO_RTSP_SERVER_CSEQ = CURLINFO_LONG + 38, + CURLINFO_RTSP_CSEQ_RECV = CURLINFO_LONG + 39, + CURLINFO_PRIMARY_PORT = CURLINFO_LONG + 40, + CURLINFO_LOCAL_IP = CURLINFO_STRING + 41, + CURLINFO_LOCAL_PORT = CURLINFO_LONG + 42, + /* Fill in new entries below here! */ + + CURLINFO_LASTONE = 42 +} CURLINFO; + +/* CURLINFO_RESPONSE_CODE is the new name for the option previously known as + CURLINFO_HTTP_CODE */ +#define CURLINFO_HTTP_CODE CURLINFO_RESPONSE_CODE + +typedef enum { + CURLCLOSEPOLICY_NONE, /* first, never use this */ + + CURLCLOSEPOLICY_OLDEST, + CURLCLOSEPOLICY_LEAST_RECENTLY_USED, + CURLCLOSEPOLICY_LEAST_TRAFFIC, + CURLCLOSEPOLICY_SLOWEST, + CURLCLOSEPOLICY_CALLBACK, + + CURLCLOSEPOLICY_LAST /* last, never use this */ +} curl_closepolicy; + +#define CURL_GLOBAL_SSL (1<<0) +#define CURL_GLOBAL_WIN32 (1<<1) +#define CURL_GLOBAL_ALL (CURL_GLOBAL_SSL|CURL_GLOBAL_WIN32) +#define CURL_GLOBAL_NOTHING 0 +#define CURL_GLOBAL_DEFAULT CURL_GLOBAL_ALL + + +/***************************************************************************** + * Setup defines, protos etc for the sharing stuff. + */ + +/* Different data locks for a single share */ +typedef enum { + CURL_LOCK_DATA_NONE = 0, + /* CURL_LOCK_DATA_SHARE is used internally to say that + * the locking is just made to change the internal state of the share + * itself. + */ + CURL_LOCK_DATA_SHARE, + CURL_LOCK_DATA_COOKIE, + CURL_LOCK_DATA_DNS, + CURL_LOCK_DATA_SSL_SESSION, + CURL_LOCK_DATA_CONNECT, + CURL_LOCK_DATA_LAST +} curl_lock_data; + +/* Different lock access types */ +typedef enum { + CURL_LOCK_ACCESS_NONE = 0, /* unspecified action */ + CURL_LOCK_ACCESS_SHARED = 1, /* for read perhaps */ + CURL_LOCK_ACCESS_SINGLE = 2, /* for write perhaps */ + CURL_LOCK_ACCESS_LAST /* never use */ +} curl_lock_access; + +typedef void (*curl_lock_function)(CURL *handle, + curl_lock_data data, + curl_lock_access locktype, + void *userptr); +typedef void (*curl_unlock_function)(CURL *handle, + curl_lock_data data, + void *userptr); + +typedef void CURLSH; + +typedef enum { + CURLSHE_OK, /* all is fine */ + CURLSHE_BAD_OPTION, /* 1 */ + CURLSHE_IN_USE, /* 2 */ + CURLSHE_INVALID, /* 3 */ + CURLSHE_NOMEM, /* 4 out of memory */ + CURLSHE_NOT_BUILT_IN, /* 5 feature not present in lib */ + CURLSHE_LAST /* never use */ +} CURLSHcode; + +typedef enum { + CURLSHOPT_NONE, /* don't use */ + CURLSHOPT_SHARE, /* specify a data type to share */ + CURLSHOPT_UNSHARE, /* specify which data type to stop sharing */ + CURLSHOPT_LOCKFUNC, /* pass in a 'curl_lock_function' pointer */ + CURLSHOPT_UNLOCKFUNC, /* pass in a 'curl_unlock_function' pointer */ + CURLSHOPT_USERDATA, /* pass in a user data pointer used in the lock/unlock + callback functions */ + CURLSHOPT_LAST /* never use */ +} CURLSHoption; + +CURL_EXTERN CURLSH *curl_share_init(void); +CURL_EXTERN CURLSHcode curl_share_setopt(CURLSH *, CURLSHoption option, ...); +CURL_EXTERN CURLSHcode curl_share_cleanup(CURLSH *); + +/**************************************************************************** + * Structures for querying information about the curl library at runtime. + */ + +typedef enum { + CURLVERSION_FIRST, + CURLVERSION_SECOND, + CURLVERSION_THIRD, + CURLVERSION_FOURTH, + CURLVERSION_LAST /* never actually use this */ +} CURLversion; + +/* The 'CURLVERSION_NOW' is the symbolic name meant to be used by + basically all programs ever that want to get version information. It is + meant to be a built-in version number for what kind of struct the caller + expects. If the struct ever changes, we redefine the NOW to another enum + from above. */ +#define CURLVERSION_NOW CURLVERSION_FOURTH + +typedef struct { + CURLversion age; /* age of the returned struct */ + const char *version; /* LIBCURL_VERSION */ + unsigned int version_num; /* LIBCURL_VERSION_NUM */ + const char *host; /* OS/host/cpu/machine when configured */ + int features; /* bitmask, see defines below */ + const char *ssl_version; /* human readable string */ + long ssl_version_num; /* not used anymore, always 0 */ + const char *libz_version; /* human readable string */ + /* protocols is terminated by an entry with a NULL protoname */ + const char * const *protocols; + + /* The fields below this were added in CURLVERSION_SECOND */ + const char *ares; + int ares_num; + + /* This field was added in CURLVERSION_THIRD */ + const char *libidn; + + /* These field were added in CURLVERSION_FOURTH */ + + /* Same as '_libiconv_version' if built with HAVE_ICONV */ + int iconv_ver_num; + + const char *libssh_version; /* human readable string */ + +} curl_version_info_data; + +#define CURL_VERSION_IPV6 (1<<0) /* IPv6-enabled */ +#define CURL_VERSION_KERBEROS4 (1<<1) /* kerberos auth is supported */ +#define CURL_VERSION_SSL (1<<2) /* SSL options are present */ +#define CURL_VERSION_LIBZ (1<<3) /* libz features are present */ +#define CURL_VERSION_NTLM (1<<4) /* NTLM auth is supported */ +#define CURL_VERSION_GSSNEGOTIATE (1<<5) /* Negotiate auth support */ +#define CURL_VERSION_DEBUG (1<<6) /* built with debug capabilities */ +#define CURL_VERSION_ASYNCHDNS (1<<7) /* asynchronous dns resolves */ +#define CURL_VERSION_SPNEGO (1<<8) /* SPNEGO auth */ +#define CURL_VERSION_LARGEFILE (1<<9) /* supports files bigger than 2GB */ +#define CURL_VERSION_IDN (1<<10) /* International Domain Names support */ +#define CURL_VERSION_SSPI (1<<11) /* SSPI is supported */ +#define CURL_VERSION_CONV (1<<12) /* character conversions supported */ +#define CURL_VERSION_CURLDEBUG (1<<13) /* debug memory tracking supported */ +#define CURL_VERSION_TLSAUTH_SRP (1<<14) /* TLS-SRP auth is supported */ +#define CURL_VERSION_NTLM_WB (1<<15) /* NTLM delegating to winbind helper */ + + /* + * NAME curl_version_info() + * + * DESCRIPTION + * + * This function returns a pointer to a static copy of the version info + * struct. See above. + */ +CURL_EXTERN curl_version_info_data *curl_version_info(CURLversion); + +/* + * NAME curl_easy_strerror() + * + * DESCRIPTION + * + * The curl_easy_strerror function may be used to turn a CURLcode value + * into the equivalent human readable error string. This is useful + * for printing meaningful error messages. + */ +CURL_EXTERN const char *curl_easy_strerror(CURLcode); + +/* + * NAME curl_share_strerror() + * + * DESCRIPTION + * + * The curl_share_strerror function may be used to turn a CURLSHcode value + * into the equivalent human readable error string. This is useful + * for printing meaningful error messages. + */ +CURL_EXTERN const char *curl_share_strerror(CURLSHcode); + +/* + * NAME curl_easy_pause() + * + * DESCRIPTION + * + * The curl_easy_pause function pauses or unpauses transfers. Select the new + * state by setting the bitmask, use the convenience defines below. + * + */ +CURL_EXTERN CURLcode curl_easy_pause(CURL *handle, int bitmask); + +#define CURLPAUSE_RECV (1<<0) +#define CURLPAUSE_RECV_CONT (0) + +#define CURLPAUSE_SEND (1<<2) +#define CURLPAUSE_SEND_CONT (0) + +#define CURLPAUSE_ALL (CURLPAUSE_RECV|CURLPAUSE_SEND) +#define CURLPAUSE_CONT (CURLPAUSE_RECV_CONT|CURLPAUSE_SEND_CONT) + +#ifdef __cplusplus +} +#endif + +/* unfortunately, the easy.h and multi.h include files need options and info + stuff before they can be included! */ +#include "easy.h" /* nothing in curl is fun without the easy stuff */ +#include "multi.h" + +/* the typechecker doesn't work in C++ (yet) */ +#if defined(__GNUC__) && defined(__GNUC_MINOR__) && \ + ((__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && \ + !defined(__cplusplus) && !defined(CURL_DISABLE_TYPECHECK) +#include "typecheck-gcc.h" +#else +#if defined(__STDC__) && (__STDC__ >= 1) +/* This preprocessor magic that replaces a call with the exact same call is + only done to make sure application authors pass exactly three arguments + to these functions. */ +#define curl_easy_setopt(handle,opt,param) curl_easy_setopt(handle,opt,param) +#define curl_easy_getinfo(handle,info,arg) curl_easy_getinfo(handle,info,arg) +#define curl_share_setopt(share,opt,param) curl_share_setopt(share,opt,param) +#define curl_multi_setopt(handle,opt,param) curl_multi_setopt(handle,opt,param) +#endif /* __STDC__ >= 1 */ +#endif /* gcc >= 4.3 && !__cplusplus */ + +#endif /* __CURL_CURL_H */ diff --git a/Source/Import/libcurl/curl/curlbuild.h b/Source/Import/libcurl/curl/curlbuild.h new file mode 100644 index 0000000..4d95a4a --- /dev/null +++ b/Source/Import/libcurl/curl/curlbuild.h @@ -0,0 +1,191 @@ +/* include/curl/curlbuild.h. Generated from curlbuild.h.in by configure. */ +#ifndef __CURL_CURLBUILD_H +#define __CURL_CURLBUILD_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) 1998 - 2011, Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at http://curl.haxx.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + ***************************************************************************/ + +/* ================================================================ */ +/* NOTES FOR CONFIGURE CAPABLE SYSTEMS */ +/* ================================================================ */ + +/* + * NOTE 1: + * ------- + * + * Nothing in this file is intended to be modified or adjusted by the + * curl library user nor by the curl library builder. + * + * If you think that something actually needs to be changed, adjusted + * or fixed in this file, then, report it on the libcurl development + * mailing list: http://cool.haxx.se/mailman/listinfo/curl-library/ + * + * This header file shall only export symbols which are 'curl' or 'CURL' + * prefixed, otherwise public name space would be polluted. + * + * NOTE 2: + * ------- + * + * Right now you might be staring at file include/curl/curlbuild.h.in or + * at file include/curl/curlbuild.h, this is due to the following reason: + * + * On systems capable of running the configure script, the configure process + * will overwrite the distributed include/curl/curlbuild.h file with one that + * is suitable and specific to the library being configured and built, which + * is generated from the include/curl/curlbuild.h.in template file. + * + */ + +/* ================================================================ */ +/* DEFINITION OF THESE SYMBOLS SHALL NOT TAKE PLACE ANYWHERE ELSE */ +/* ================================================================ */ + +#ifdef CURL_SIZEOF_LONG +#error "CURL_SIZEOF_LONG shall not be defined except in curlbuild.h" + Error Compilation_aborted_CURL_SIZEOF_LONG_already_defined +#endif + +#ifdef CURL_TYPEOF_CURL_SOCKLEN_T +#error "CURL_TYPEOF_CURL_SOCKLEN_T shall not be defined except in curlbuild.h" + Error Compilation_aborted_CURL_TYPEOF_CURL_SOCKLEN_T_already_defined +#endif + +#ifdef CURL_SIZEOF_CURL_SOCKLEN_T +#error "CURL_SIZEOF_CURL_SOCKLEN_T shall not be defined except in curlbuild.h" + Error Compilation_aborted_CURL_SIZEOF_CURL_SOCKLEN_T_already_defined +#endif + +#ifdef CURL_TYPEOF_CURL_OFF_T +#error "CURL_TYPEOF_CURL_OFF_T shall not be defined except in curlbuild.h" + Error Compilation_aborted_CURL_TYPEOF_CURL_OFF_T_already_defined +#endif + +#ifdef CURL_FORMAT_CURL_OFF_T +#error "CURL_FORMAT_CURL_OFF_T shall not be defined except in curlbuild.h" + Error Compilation_aborted_CURL_FORMAT_CURL_OFF_T_already_defined +#endif + +#ifdef CURL_FORMAT_CURL_OFF_TU +#error "CURL_FORMAT_CURL_OFF_TU shall not be defined except in curlbuild.h" + Error Compilation_aborted_CURL_FORMAT_CURL_OFF_TU_already_defined +#endif + +#ifdef CURL_FORMAT_OFF_T +#error "CURL_FORMAT_OFF_T shall not be defined except in curlbuild.h" + Error Compilation_aborted_CURL_FORMAT_OFF_T_already_defined +#endif + +#ifdef CURL_SIZEOF_CURL_OFF_T +#error "CURL_SIZEOF_CURL_OFF_T shall not be defined except in curlbuild.h" + Error Compilation_aborted_CURL_SIZEOF_CURL_OFF_T_already_defined +#endif + +#ifdef CURL_SUFFIX_CURL_OFF_T +#error "CURL_SUFFIX_CURL_OFF_T shall not be defined except in curlbuild.h" + Error Compilation_aborted_CURL_SUFFIX_CURL_OFF_T_already_defined +#endif + +#ifdef CURL_SUFFIX_CURL_OFF_TU +#error "CURL_SUFFIX_CURL_OFF_TU shall not be defined except in curlbuild.h" + Error Compilation_aborted_CURL_SUFFIX_CURL_OFF_TU_already_defined +#endif + +/* ================================================================ */ +/* EXTERNAL INTERFACE SETTINGS FOR CONFIGURE CAPABLE SYSTEMS ONLY */ +/* ================================================================ */ + +/* Configure process defines this to 1 when it finds out that system */ +/* header file ws2tcpip.h must be included by the external interface. */ +#define CURL_PULL_WS2TCPIP_H 1 +#ifdef CURL_PULL_WS2TCPIP_H +# ifndef WIN32_LEAN_AND_MEAN +# define WIN32_LEAN_AND_MEAN 1 +# endif +# include +# include +# include +#endif + +/* Configure process defines this to 1 when it finds out that system */ +/* header file sys/types.h must be included by the external interface. */ +#define CURL_PULL_SYS_TYPES_H 1 +#ifdef CURL_PULL_SYS_TYPES_H +# include +#endif + +/* Configure process defines this to 1 when it finds out that system */ +/* header file stdint.h must be included by the external interface. */ +#define CURL_PULL_STDINT_H 1 +#ifdef CURL_PULL_STDINT_H +# include +#endif + +/* Configure process defines this to 1 when it finds out that system */ +/* header file inttypes.h must be included by the external interface. */ +#define CURL_PULL_INTTYPES_H 1 +#ifdef CURL_PULL_INTTYPES_H +# include +#endif + +/* Configure process defines this to 1 when it finds out that system */ +/* header file sys/socket.h must be included by the external interface. */ +/* #undef CURL_PULL_SYS_SOCKET_H */ +#ifdef CURL_PULL_SYS_SOCKET_H +# include +#endif + +/* The size of `long', as computed by sizeof. */ +#define CURL_SIZEOF_LONG 4 + +/* Integral data type used for curl_socklen_t. */ +#define CURL_TYPEOF_CURL_SOCKLEN_T socklen_t + +/* The size of `curl_socklen_t', as computed by sizeof. */ +#define CURL_SIZEOF_CURL_SOCKLEN_T 4 + +/* Data type definition of curl_socklen_t. */ +typedef CURL_TYPEOF_CURL_SOCKLEN_T curl_socklen_t; + +/* Signed integral data type used for curl_off_t. */ +#define CURL_TYPEOF_CURL_OFF_T int64_t + +/* Data type definition of curl_off_t. */ +typedef CURL_TYPEOF_CURL_OFF_T curl_off_t; + +/* curl_off_t formatting string directive without "%" conversion specifier. */ +#define CURL_FORMAT_CURL_OFF_T "I64d" + +/* unsigned curl_off_t formatting string without "%" conversion specifier. */ +#define CURL_FORMAT_CURL_OFF_TU "I64u" + +/* curl_off_t formatting string directive with "%" conversion specifier. */ +#define CURL_FORMAT_OFF_T "%I64d" + +/* The size of `curl_off_t', as computed by sizeof. */ +#define CURL_SIZEOF_CURL_OFF_T 8 + +/* curl_off_t constant suffix. */ +#define CURL_SUFFIX_CURL_OFF_T LL + +/* unsigned curl_off_t constant suffix. */ +#define CURL_SUFFIX_CURL_OFF_TU ULL + +#endif /* __CURL_CURLBUILD_H */ diff --git a/Source/Import/libcurl/curl/curlrules.h b/Source/Import/libcurl/curl/curlrules.h new file mode 100644 index 0000000..cbc12fd --- /dev/null +++ b/Source/Import/libcurl/curl/curlrules.h @@ -0,0 +1,261 @@ +#ifndef __CURL_CURLRULES_H +#define __CURL_CURLRULES_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) 1998 - 2011, Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at http://curl.haxx.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + ***************************************************************************/ + +/* ================================================================ */ +/* COMPILE TIME SANITY CHECKS */ +/* ================================================================ */ + +/* + * NOTE 1: + * ------- + * + * All checks done in this file are intentionally placed in a public + * header file which is pulled by curl/curl.h when an application is + * being built using an already built libcurl library. Additionally + * this file is also included and used when building the library. + * + * If compilation fails on this file it is certainly sure that the + * problem is elsewhere. It could be a problem in the curlbuild.h + * header file, or simply that you are using different compilation + * settings than those used to build the library. + * + * Nothing in this file is intended to be modified or adjusted by the + * curl library user nor by the curl library builder. + * + * Do not deactivate any check, these are done to make sure that the + * library is properly built and used. + * + * You can find further help on the libcurl development mailing list: + * http://cool.haxx.se/mailman/listinfo/curl-library/ + * + * NOTE 2 + * ------ + * + * Some of the following compile time checks are based on the fact + * that the dimension of a constant array can not be a negative one. + * In this way if the compile time verification fails, the compilation + * will fail issuing an error. The error description wording is compiler + * dependent but it will be quite similar to one of the following: + * + * "negative subscript or subscript is too large" + * "array must have at least one element" + * "-1 is an illegal array size" + * "size of array is negative" + * + * If you are building an application which tries to use an already + * built libcurl library and you are getting this kind of errors on + * this file, it is a clear indication that there is a mismatch between + * how the library was built and how you are trying to use it for your + * application. Your already compiled or binary library provider is the + * only one who can give you the details you need to properly use it. + */ + +/* + * Verify that some macros are actually defined. + */ + +#ifndef CURL_SIZEOF_LONG +# error "CURL_SIZEOF_LONG definition is missing!" + Error Compilation_aborted_CURL_SIZEOF_LONG_is_missing +#endif + +#ifndef CURL_TYPEOF_CURL_SOCKLEN_T +# error "CURL_TYPEOF_CURL_SOCKLEN_T definition is missing!" + Error Compilation_aborted_CURL_TYPEOF_CURL_SOCKLEN_T_is_missing +#endif + +#ifndef CURL_SIZEOF_CURL_SOCKLEN_T +# error "CURL_SIZEOF_CURL_SOCKLEN_T definition is missing!" + Error Compilation_aborted_CURL_SIZEOF_CURL_SOCKLEN_T_is_missing +#endif + +#ifndef CURL_TYPEOF_CURL_OFF_T +# error "CURL_TYPEOF_CURL_OFF_T definition is missing!" + Error Compilation_aborted_CURL_TYPEOF_CURL_OFF_T_is_missing +#endif + +#ifndef CURL_FORMAT_CURL_OFF_T +# error "CURL_FORMAT_CURL_OFF_T definition is missing!" + Error Compilation_aborted_CURL_FORMAT_CURL_OFF_T_is_missing +#endif + +#ifndef CURL_FORMAT_CURL_OFF_TU +# error "CURL_FORMAT_CURL_OFF_TU definition is missing!" + Error Compilation_aborted_CURL_FORMAT_CURL_OFF_TU_is_missing +#endif + +#ifndef CURL_FORMAT_OFF_T +# error "CURL_FORMAT_OFF_T definition is missing!" + Error Compilation_aborted_CURL_FORMAT_OFF_T_is_missing +#endif + +#ifndef CURL_SIZEOF_CURL_OFF_T +# error "CURL_SIZEOF_CURL_OFF_T definition is missing!" + Error Compilation_aborted_CURL_SIZEOF_CURL_OFF_T_is_missing +#endif + +#ifndef CURL_SUFFIX_CURL_OFF_T +# error "CURL_SUFFIX_CURL_OFF_T definition is missing!" + Error Compilation_aborted_CURL_SUFFIX_CURL_OFF_T_is_missing +#endif + +#ifndef CURL_SUFFIX_CURL_OFF_TU +# error "CURL_SUFFIX_CURL_OFF_TU definition is missing!" + Error Compilation_aborted_CURL_SUFFIX_CURL_OFF_TU_is_missing +#endif + +/* + * Macros private to this header file. + */ + +#define CurlchkszEQ(t, s) sizeof(t) == s ? 1 : -1 + +#define CurlchkszGE(t1, t2) sizeof(t1) >= sizeof(t2) ? 1 : -1 + +/* + * Verify that the size previously defined and expected for long + * is the same as the one reported by sizeof() at compile time. + */ + +typedef char + __curl_rule_01__ + [CurlchkszEQ(long, CURL_SIZEOF_LONG)]; + +/* + * Verify that the size previously defined and expected for + * curl_off_t is actually the the same as the one reported + * by sizeof() at compile time. + */ + +typedef char + __curl_rule_02__ + [CurlchkszEQ(curl_off_t, CURL_SIZEOF_CURL_OFF_T)]; + +/* + * Verify at compile time that the size of curl_off_t as reported + * by sizeof() is greater or equal than the one reported for long + * for the current compilation. + */ + +typedef char + __curl_rule_03__ + [CurlchkszGE(curl_off_t, long)]; + +/* + * Verify that the size previously defined and expected for + * curl_socklen_t is actually the the same as the one reported + * by sizeof() at compile time. + */ + +typedef char + __curl_rule_04__ + [CurlchkszEQ(curl_socklen_t, CURL_SIZEOF_CURL_SOCKLEN_T)]; + +/* + * Verify at compile time that the size of curl_socklen_t as reported + * by sizeof() is greater or equal than the one reported for int for + * the current compilation. + */ + +typedef char + __curl_rule_05__ + [CurlchkszGE(curl_socklen_t, int)]; + +/* ================================================================ */ +/* EXTERNALLY AND INTERNALLY VISIBLE DEFINITIONS */ +/* ================================================================ */ + +/* + * CURL_ISOCPP and CURL_OFF_T_C definitions are done here in order to allow + * these to be visible and exported by the external libcurl interface API, + * while also making them visible to the library internals, simply including + * setup.h, without actually needing to include curl.h internally. + * If some day this section would grow big enough, all this should be moved + * to its own header file. + */ + +/* + * Figure out if we can use the ## preprocessor operator, which is supported + * by ISO/ANSI C and C++. Some compilers support it without setting __STDC__ + * or __cplusplus so we need to carefully check for them too. + */ + +#if defined(__STDC__) || defined(_MSC_VER) || defined(__cplusplus) || \ + defined(__HP_aCC) || defined(__BORLANDC__) || defined(__LCC__) || \ + defined(__POCC__) || defined(__SALFORDC__) || defined(__HIGHC__) || \ + defined(__ILEC400__) + /* This compiler is believed to have an ISO compatible preprocessor */ +#define CURL_ISOCPP +#else + /* This compiler is believed NOT to have an ISO compatible preprocessor */ +#undef CURL_ISOCPP +#endif + +/* + * Macros for minimum-width signed and unsigned curl_off_t integer constants. + */ + +#if defined(__BORLANDC__) && (__BORLANDC__ == 0x0551) +# define __CURL_OFF_T_C_HLPR2(x) x +# define __CURL_OFF_T_C_HLPR1(x) __CURL_OFF_T_C_HLPR2(x) +# define CURL_OFF_T_C(Val) __CURL_OFF_T_C_HLPR1(Val) ## \ + __CURL_OFF_T_C_HLPR1(CURL_SUFFIX_CURL_OFF_T) +# define CURL_OFF_TU_C(Val) __CURL_OFF_T_C_HLPR1(Val) ## \ + __CURL_OFF_T_C_HLPR1(CURL_SUFFIX_CURL_OFF_TU) +#else +# ifdef CURL_ISOCPP +# define __CURL_OFF_T_C_HLPR2(Val,Suffix) Val ## Suffix +# else +# define __CURL_OFF_T_C_HLPR2(Val,Suffix) Val/**/Suffix +# endif +# define __CURL_OFF_T_C_HLPR1(Val,Suffix) __CURL_OFF_T_C_HLPR2(Val,Suffix) +# define CURL_OFF_T_C(Val) __CURL_OFF_T_C_HLPR1(Val,CURL_SUFFIX_CURL_OFF_T) +# define CURL_OFF_TU_C(Val) __CURL_OFF_T_C_HLPR1(Val,CURL_SUFFIX_CURL_OFF_TU) +#endif + +/* + * Get rid of macros private to this header file. + */ + +#undef CurlchkszEQ +#undef CurlchkszGE + +/* + * Get rid of macros not intended to exist beyond this point. + */ + +#undef CURL_PULL_WS2TCPIP_H +#undef CURL_PULL_SYS_TYPES_H +#undef CURL_PULL_SYS_SOCKET_H +#undef CURL_PULL_STDINT_H +#undef CURL_PULL_INTTYPES_H + +#undef CURL_TYPEOF_CURL_SOCKLEN_T +#undef CURL_TYPEOF_CURL_OFF_T + +#ifdef CURL_NO_OLDIES +#undef CURL_FORMAT_OFF_T /* not required since 7.19.0 - obsoleted in 7.20.0 */ +#endif + +#endif /* __CURL_CURLRULES_H */ diff --git a/Source/Import/libcurl/curl/curlver.h b/Source/Import/libcurl/curl/curlver.h new file mode 100644 index 0000000..28ea98b --- /dev/null +++ b/Source/Import/libcurl/curl/curlver.h @@ -0,0 +1,69 @@ +#ifndef __CURL_CURLVER_H +#define __CURL_CURLVER_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) 1998 - 2012, Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at http://curl.haxx.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + ***************************************************************************/ + +/* This header file contains nothing but libcurl version info, generated by + a script at release-time. This was made its own header file in 7.11.2 */ + +/* This is the global package copyright */ +#define LIBCURL_COPYRIGHT "1996 - 2012 Daniel Stenberg, ." + +/* This is the version number of the libcurl package from which this header + file origins: */ +#define LIBCURL_VERSION "7.27.0" + +/* The numeric version number is also available "in parts" by using these + defines: */ +#define LIBCURL_VERSION_MAJOR 7 +#define LIBCURL_VERSION_MINOR 27 +#define LIBCURL_VERSION_PATCH 0 + +/* This is the numeric version of the libcurl version number, meant for easier + parsing and comparions by programs. The LIBCURL_VERSION_NUM define will + always follow this syntax: + + 0xXXYYZZ + + Where XX, YY and ZZ are the main version, release and patch numbers in + hexadecimal (using 8 bits each). All three numbers are always represented + using two digits. 1.2 would appear as "0x010200" while version 9.11.7 + appears as "0x090b07". + + This 6-digit (24 bits) hexadecimal number does not show pre-release number, + and it is always a greater number in a more recent release. It makes + comparisons with greater than and less than work. +*/ +#define LIBCURL_VERSION_NUM 0x071b00 + +/* + * This is the date and time when the full source package was created. The + * timestamp is not stored in git, as the timestamp is properly set in the + * tarballs by the maketgz script. + * + * The format of the date should follow this template: + * + * "Mon Feb 12 11:35:33 UTC 2007" + */ +#define LIBCURL_TIMESTAMP "Fri Jul 27 21:11:53 UTC 2012" + +#endif /* __CURL_CURLVER_H */ diff --git a/Source/Import/libcurl/curl/easy.h b/Source/Import/libcurl/curl/easy.h new file mode 100644 index 0000000..c1e3e76 --- /dev/null +++ b/Source/Import/libcurl/curl/easy.h @@ -0,0 +1,102 @@ +#ifndef __CURL_EASY_H +#define __CURL_EASY_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) 1998 - 2008, Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at http://curl.haxx.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + ***************************************************************************/ +#ifdef __cplusplus +extern "C" { +#endif + +CURL_EXTERN CURL *curl_easy_init(void); +CURL_EXTERN CURLcode curl_easy_setopt(CURL *curl, CURLoption option, ...); +CURL_EXTERN CURLcode curl_easy_perform(CURL *curl); +CURL_EXTERN void curl_easy_cleanup(CURL *curl); + +/* + * NAME curl_easy_getinfo() + * + * DESCRIPTION + * + * Request internal information from the curl session with this function. The + * third argument MUST be a pointer to a long, a pointer to a char * or a + * pointer to a double (as the documentation describes elsewhere). The data + * pointed to will be filled in accordingly and can be relied upon only if the + * function returns CURLE_OK. This function is intended to get used *AFTER* a + * performed transfer, all results from this function are undefined until the + * transfer is completed. + */ +CURL_EXTERN CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ...); + + +/* + * NAME curl_easy_duphandle() + * + * DESCRIPTION + * + * Creates a new curl session handle with the same options set for the handle + * passed in. Duplicating a handle could only be a matter of cloning data and + * options, internal state info and things like persistent connections cannot + * be transferred. It is useful in multithreaded applications when you can run + * curl_easy_duphandle() for each new thread to avoid a series of identical + * curl_easy_setopt() invokes in every thread. + */ +CURL_EXTERN CURL* curl_easy_duphandle(CURL *curl); + +/* + * NAME curl_easy_reset() + * + * DESCRIPTION + * + * Re-initializes a CURL handle to the default values. This puts back the + * handle to the same state as it was in when it was just created. + * + * It does keep: live connections, the Session ID cache, the DNS cache and the + * cookies. + */ +CURL_EXTERN void curl_easy_reset(CURL *curl); + +/* + * NAME curl_easy_recv() + * + * DESCRIPTION + * + * Receives data from the connected socket. Use after successful + * curl_easy_perform() with CURLOPT_CONNECT_ONLY option. + */ +CURL_EXTERN CURLcode curl_easy_recv(CURL *curl, void *buffer, size_t buflen, + size_t *n); + +/* + * NAME curl_easy_send() + * + * DESCRIPTION + * + * Sends data over the connected socket. Use after successful + * curl_easy_perform() with CURLOPT_CONNECT_ONLY option. + */ +CURL_EXTERN CURLcode curl_easy_send(CURL *curl, const void *buffer, + size_t buflen, size_t *n); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/libcurl/curl/mprintf.h b/Source/Import/libcurl/curl/mprintf.h new file mode 100644 index 0000000..de7dd2f --- /dev/null +++ b/Source/Import/libcurl/curl/mprintf.h @@ -0,0 +1,81 @@ +#ifndef __CURL_MPRINTF_H +#define __CURL_MPRINTF_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) 1998 - 2006, Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at http://curl.haxx.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + ***************************************************************************/ + +#include +#include /* needed for FILE */ + +#include "curl.h" + +#ifdef __cplusplus +extern "C" { +#endif + +CURL_EXTERN int curl_mprintf(const char *format, ...); +CURL_EXTERN int curl_mfprintf(FILE *fd, const char *format, ...); +CURL_EXTERN int curl_msprintf(char *buffer, const char *format, ...); +CURL_EXTERN int curl_msnprintf(char *buffer, size_t maxlength, + const char *format, ...); +CURL_EXTERN int curl_mvprintf(const char *format, va_list args); +CURL_EXTERN int curl_mvfprintf(FILE *fd, const char *format, va_list args); +CURL_EXTERN int curl_mvsprintf(char *buffer, const char *format, va_list args); +CURL_EXTERN int curl_mvsnprintf(char *buffer, size_t maxlength, + const char *format, va_list args); +CURL_EXTERN char *curl_maprintf(const char *format, ...); +CURL_EXTERN char *curl_mvaprintf(const char *format, va_list args); + +#ifdef _MPRINTF_REPLACE +# undef printf +# undef fprintf +# undef sprintf +# undef vsprintf +# undef snprintf +# undef vprintf +# undef vfprintf +# undef vsnprintf +# undef aprintf +# undef vaprintf +# define printf curl_mprintf +# define fprintf curl_mfprintf +#ifdef CURLDEBUG +/* When built with CURLDEBUG we define away the sprintf() functions since we + don't want internal code to be using them */ +# define sprintf sprintf_was_used +# define vsprintf vsprintf_was_used +#else +# define sprintf curl_msprintf +# define vsprintf curl_mvsprintf +#endif +# define snprintf curl_msnprintf +# define vprintf curl_mvprintf +# define vfprintf curl_mvfprintf +# define vsnprintf curl_mvsnprintf +# define aprintf curl_maprintf +# define vaprintf curl_mvaprintf +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* __CURL_MPRINTF_H */ diff --git a/Source/Import/libcurl/curl/multi.h b/Source/Import/libcurl/curl/multi.h new file mode 100644 index 0000000..f965666 --- /dev/null +++ b/Source/Import/libcurl/curl/multi.h @@ -0,0 +1,345 @@ +#ifndef __CURL_MULTI_H +#define __CURL_MULTI_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) 1998 - 2007, Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at http://curl.haxx.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + ***************************************************************************/ +/* + This is an "external" header file. Don't give away any internals here! + + GOALS + + o Enable a "pull" interface. The application that uses libcurl decides where + and when to ask libcurl to get/send data. + + o Enable multiple simultaneous transfers in the same thread without making it + complicated for the application. + + o Enable the application to select() on its own file descriptors and curl's + file descriptors simultaneous easily. + +*/ + +/* + * This header file should not really need to include "curl.h" since curl.h + * itself includes this file and we expect user applications to do #include + * without the need for especially including multi.h. + * + * For some reason we added this include here at one point, and rather than to + * break existing (wrongly written) libcurl applications, we leave it as-is + * but with this warning attached. + */ +#include "curl.h" + +#ifdef __cplusplus +extern "C" { +#endif + +typedef void CURLM; + +typedef enum { + CURLM_CALL_MULTI_PERFORM = -1, /* please call curl_multi_perform() or + curl_multi_socket*() soon */ + CURLM_OK, + CURLM_BAD_HANDLE, /* the passed-in handle is not a valid CURLM handle */ + CURLM_BAD_EASY_HANDLE, /* an easy handle was not good/valid */ + CURLM_OUT_OF_MEMORY, /* if you ever get this, you're in deep sh*t */ + CURLM_INTERNAL_ERROR, /* this is a libcurl bug */ + CURLM_BAD_SOCKET, /* the passed in socket argument did not match */ + CURLM_UNKNOWN_OPTION, /* curl_multi_setopt() with unsupported option */ + CURLM_LAST +} CURLMcode; + +/* just to make code nicer when using curl_multi_socket() you can now check + for CURLM_CALL_MULTI_SOCKET too in the same style it works for + curl_multi_perform() and CURLM_CALL_MULTI_PERFORM */ +#define CURLM_CALL_MULTI_SOCKET CURLM_CALL_MULTI_PERFORM + +typedef enum { + CURLMSG_NONE, /* first, not used */ + CURLMSG_DONE, /* This easy handle has completed. 'result' contains + the CURLcode of the transfer */ + CURLMSG_LAST /* last, not used */ +} CURLMSG; + +struct CURLMsg { + CURLMSG msg; /* what this message means */ + CURL *easy_handle; /* the handle it concerns */ + union { + void *whatever; /* message-specific data */ + CURLcode result; /* return code for transfer */ + } data; +}; +typedef struct CURLMsg CURLMsg; + +/* + * Name: curl_multi_init() + * + * Desc: inititalize multi-style curl usage + * + * Returns: a new CURLM handle to use in all 'curl_multi' functions. + */ +CURL_EXTERN CURLM *curl_multi_init(void); + +/* + * Name: curl_multi_add_handle() + * + * Desc: add a standard curl handle to the multi stack + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_add_handle(CURLM *multi_handle, + CURL *curl_handle); + + /* + * Name: curl_multi_remove_handle() + * + * Desc: removes a curl handle from the multi stack again + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_remove_handle(CURLM *multi_handle, + CURL *curl_handle); + + /* + * Name: curl_multi_fdset() + * + * Desc: Ask curl for its fd_set sets. The app can use these to select() or + * poll() on. We want curl_multi_perform() called as soon as one of + * them are ready. + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_fdset(CURLM *multi_handle, + fd_set *read_fd_set, + fd_set *write_fd_set, + fd_set *exc_fd_set, + int *max_fd); + + /* + * Name: curl_multi_perform() + * + * Desc: When the app thinks there's data available for curl it calls this + * function to read/write whatever there is right now. This returns + * as soon as the reads and writes are done. This function does not + * require that there actually is data available for reading or that + * data can be written, it can be called just in case. It returns + * the number of handles that still transfer data in the second + * argument's integer-pointer. + * + * Returns: CURLMcode type, general multi error code. *NOTE* that this only + * returns errors etc regarding the whole multi stack. There might + * still have occurred problems on invidual transfers even when this + * returns OK. + */ +CURL_EXTERN CURLMcode curl_multi_perform(CURLM *multi_handle, + int *running_handles); + + /* + * Name: curl_multi_cleanup() + * + * Desc: Cleans up and removes a whole multi stack. It does not free or + * touch any individual easy handles in any way. We need to define + * in what state those handles will be if this function is called + * in the middle of a transfer. + * + * Returns: CURLMcode type, general multi error code. + */ +CURL_EXTERN CURLMcode curl_multi_cleanup(CURLM *multi_handle); + +/* + * Name: curl_multi_info_read() + * + * Desc: Ask the multi handle if there's any messages/informationals from + * the individual transfers. Messages include informationals such as + * error code from the transfer or just the fact that a transfer is + * completed. More details on these should be written down as well. + * + * Repeated calls to this function will return a new struct each + * time, until a special "end of msgs" struct is returned as a signal + * that there is no more to get at this point. + * + * The data the returned pointer points to will not survive calling + * curl_multi_cleanup(). + * + * The 'CURLMsg' struct is meant to be very simple and only contain + * very basic informations. If more involved information is wanted, + * we will provide the particular "transfer handle" in that struct + * and that should/could/would be used in subsequent + * curl_easy_getinfo() calls (or similar). The point being that we + * must never expose complex structs to applications, as then we'll + * undoubtably get backwards compatibility problems in the future. + * + * Returns: A pointer to a filled-in struct, or NULL if it failed or ran out + * of structs. It also writes the number of messages left in the + * queue (after this read) in the integer the second argument points + * to. + */ +CURL_EXTERN CURLMsg *curl_multi_info_read(CURLM *multi_handle, + int *msgs_in_queue); + +/* + * Name: curl_multi_strerror() + * + * Desc: The curl_multi_strerror function may be used to turn a CURLMcode + * value into the equivalent human readable error string. This is + * useful for printing meaningful error messages. + * + * Returns: A pointer to a zero-terminated error message. + */ +CURL_EXTERN const char *curl_multi_strerror(CURLMcode); + +/* + * Name: curl_multi_socket() and + * curl_multi_socket_all() + * + * Desc: An alternative version of curl_multi_perform() that allows the + * application to pass in one of the file descriptors that have been + * detected to have "action" on them and let libcurl perform. + * See man page for details. + */ +#define CURL_POLL_NONE 0 +#define CURL_POLL_IN 1 +#define CURL_POLL_OUT 2 +#define CURL_POLL_INOUT 3 +#define CURL_POLL_REMOVE 4 + +#define CURL_SOCKET_TIMEOUT CURL_SOCKET_BAD + +#define CURL_CSELECT_IN 0x01 +#define CURL_CSELECT_OUT 0x02 +#define CURL_CSELECT_ERR 0x04 + +typedef int (*curl_socket_callback)(CURL *easy, /* easy handle */ + curl_socket_t s, /* socket */ + int what, /* see above */ + void *userp, /* private callback + pointer */ + void *socketp); /* private socket + pointer */ +/* + * Name: curl_multi_timer_callback + * + * Desc: Called by libcurl whenever the library detects a change in the + * maximum number of milliseconds the app is allowed to wait before + * curl_multi_socket() or curl_multi_perform() must be called + * (to allow libcurl's timed events to take place). + * + * Returns: The callback should return zero. + */ +typedef int (*curl_multi_timer_callback)(CURLM *multi, /* multi handle */ + long timeout_ms, /* see above */ + void *userp); /* private callback + pointer */ + +CURL_EXTERN CURLMcode curl_multi_socket(CURLM *multi_handle, curl_socket_t s, + int *running_handles); + +CURL_EXTERN CURLMcode curl_multi_socket_action(CURLM *multi_handle, + curl_socket_t s, + int ev_bitmask, + int *running_handles); + +CURL_EXTERN CURLMcode curl_multi_socket_all(CURLM *multi_handle, + int *running_handles); + +#ifndef CURL_ALLOW_OLD_MULTI_SOCKET +/* This macro below was added in 7.16.3 to push users who recompile to use + the new curl_multi_socket_action() instead of the old curl_multi_socket() +*/ +#define curl_multi_socket(x,y,z) curl_multi_socket_action(x,y,0,z) +#endif + +/* + * Name: curl_multi_timeout() + * + * Desc: Returns the maximum number of milliseconds the app is allowed to + * wait before curl_multi_socket() or curl_multi_perform() must be + * called (to allow libcurl's timed events to take place). + * + * Returns: CURLM error code. + */ +CURL_EXTERN CURLMcode curl_multi_timeout(CURLM *multi_handle, + long *milliseconds); + +#undef CINIT /* re-using the same name as in curl.h */ + +#ifdef CURL_ISOCPP +#define CINIT(name,type,num) CURLMOPT_ ## name = CURLOPTTYPE_ ## type + num +#else +/* The macro "##" is ISO C, we assume pre-ISO C doesn't support it. */ +#define LONG CURLOPTTYPE_LONG +#define OBJECTPOINT CURLOPTTYPE_OBJECTPOINT +#define FUNCTIONPOINT CURLOPTTYPE_FUNCTIONPOINT +#define OFF_T CURLOPTTYPE_OFF_T +#define CINIT(name,type,number) CURLMOPT_/**/name = type + number +#endif + +typedef enum { + /* This is the socket callback function pointer */ + CINIT(SOCKETFUNCTION, FUNCTIONPOINT, 1), + + /* This is the argument passed to the socket callback */ + CINIT(SOCKETDATA, OBJECTPOINT, 2), + + /* set to 1 to enable pipelining for this multi handle */ + CINIT(PIPELINING, LONG, 3), + + /* This is the timer callback function pointer */ + CINIT(TIMERFUNCTION, FUNCTIONPOINT, 4), + + /* This is the argument passed to the timer callback */ + CINIT(TIMERDATA, OBJECTPOINT, 5), + + /* maximum number of entries in the connection cache */ + CINIT(MAXCONNECTS, LONG, 6), + + CURLMOPT_LASTENTRY /* the last unused */ +} CURLMoption; + + +/* + * Name: curl_multi_setopt() + * + * Desc: Sets options for the multi handle. + * + * Returns: CURLM error code. + */ +CURL_EXTERN CURLMcode curl_multi_setopt(CURLM *multi_handle, + CURLMoption option, ...); + + +/* + * Name: curl_multi_assign() + * + * Desc: This function sets an association in the multi handle between the + * given socket and a private pointer of the application. This is + * (only) useful for curl_multi_socket uses. + * + * Returns: CURLM error code. + */ +CURL_EXTERN CURLMcode curl_multi_assign(CURLM *multi_handle, + curl_socket_t sockfd, void *sockp); + +#ifdef __cplusplus +} /* end of extern "C" */ +#endif + +#endif diff --git a/Source/Import/libcurl/curl/stdcheaders.h b/Source/Import/libcurl/curl/stdcheaders.h new file mode 100644 index 0000000..ad82ef6 --- /dev/null +++ b/Source/Import/libcurl/curl/stdcheaders.h @@ -0,0 +1,33 @@ +#ifndef __STDC_HEADERS_H +#define __STDC_HEADERS_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) 1998 - 2010, Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at http://curl.haxx.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + ***************************************************************************/ + +#include + +size_t fread (void *, size_t, size_t, FILE *); +size_t fwrite (const void *, size_t, size_t, FILE *); + +int strcasecmp(const char *, const char *); +int strncasecmp(const char *, const char *, size_t); + +#endif /* __STDC_HEADERS_H */ diff --git a/Source/Import/libcurl/curl/typecheck-gcc.h b/Source/Import/libcurl/curl/typecheck-gcc.h new file mode 100644 index 0000000..f8917e8 --- /dev/null +++ b/Source/Import/libcurl/curl/typecheck-gcc.h @@ -0,0 +1,604 @@ +#ifndef __CURL_TYPECHECK_GCC_H +#define __CURL_TYPECHECK_GCC_H +/*************************************************************************** + * _ _ ____ _ + * Project ___| | | | _ \| | + * / __| | | | |_) | | + * | (__| |_| | _ <| |___ + * \___|\___/|_| \_\_____| + * + * Copyright (C) 1998 - 2012, Daniel Stenberg, , et al. + * + * This software is licensed as described in the file COPYING, which + * you should have received as part of this distribution. The terms + * are also available at http://curl.haxx.se/docs/copyright.html. + * + * You may opt to use, copy, modify, merge, publish, distribute and/or sell + * copies of the Software, and permit persons to whom the Software is + * furnished to do so, under the terms of the COPYING file. + * + * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY + * KIND, either express or implied. + * + ***************************************************************************/ + +/* wraps curl_easy_setopt() with typechecking */ + +/* To add a new kind of warning, add an + * if(_curl_is_sometype_option(_curl_opt)) + * if(!_curl_is_sometype(value)) + * _curl_easy_setopt_err_sometype(); + * block and define _curl_is_sometype_option, _curl_is_sometype and + * _curl_easy_setopt_err_sometype below + * + * NOTE: We use two nested 'if' statements here instead of the && operator, in + * order to work around gcc bug #32061. It affects only gcc 4.3.x/4.4.x + * when compiling with -Wlogical-op. + * + * To add an option that uses the same type as an existing option, you'll just + * need to extend the appropriate _curl_*_option macro + */ +#define curl_easy_setopt(handle, option, value) \ +__extension__ ({ \ + __typeof__ (option) _curl_opt = option; \ + if(__builtin_constant_p(_curl_opt)) { \ + if(_curl_is_long_option(_curl_opt)) \ + if(!_curl_is_long(value)) \ + _curl_easy_setopt_err_long(); \ + if(_curl_is_off_t_option(_curl_opt)) \ + if(!_curl_is_off_t(value)) \ + _curl_easy_setopt_err_curl_off_t(); \ + if(_curl_is_string_option(_curl_opt)) \ + if(!_curl_is_string(value)) \ + _curl_easy_setopt_err_string(); \ + if(_curl_is_write_cb_option(_curl_opt)) \ + if(!_curl_is_write_cb(value)) \ + _curl_easy_setopt_err_write_callback(); \ + if((_curl_opt) == CURLOPT_READFUNCTION) \ + if(!_curl_is_read_cb(value)) \ + _curl_easy_setopt_err_read_cb(); \ + if((_curl_opt) == CURLOPT_IOCTLFUNCTION) \ + if(!_curl_is_ioctl_cb(value)) \ + _curl_easy_setopt_err_ioctl_cb(); \ + if((_curl_opt) == CURLOPT_SOCKOPTFUNCTION) \ + if(!_curl_is_sockopt_cb(value)) \ + _curl_easy_setopt_err_sockopt_cb(); \ + if((_curl_opt) == CURLOPT_OPENSOCKETFUNCTION) \ + if(!_curl_is_opensocket_cb(value)) \ + _curl_easy_setopt_err_opensocket_cb(); \ + if((_curl_opt) == CURLOPT_PROGRESSFUNCTION) \ + if(!_curl_is_progress_cb(value)) \ + _curl_easy_setopt_err_progress_cb(); \ + if((_curl_opt) == CURLOPT_DEBUGFUNCTION) \ + if(!_curl_is_debug_cb(value)) \ + _curl_easy_setopt_err_debug_cb(); \ + if((_curl_opt) == CURLOPT_SSL_CTX_FUNCTION) \ + if(!_curl_is_ssl_ctx_cb(value)) \ + _curl_easy_setopt_err_ssl_ctx_cb(); \ + if(_curl_is_conv_cb_option(_curl_opt)) \ + if(!_curl_is_conv_cb(value)) \ + _curl_easy_setopt_err_conv_cb(); \ + if((_curl_opt) == CURLOPT_SEEKFUNCTION) \ + if(!_curl_is_seek_cb(value)) \ + _curl_easy_setopt_err_seek_cb(); \ + if(_curl_is_cb_data_option(_curl_opt)) \ + if(!_curl_is_cb_data(value)) \ + _curl_easy_setopt_err_cb_data(); \ + if((_curl_opt) == CURLOPT_ERRORBUFFER) \ + if(!_curl_is_error_buffer(value)) \ + _curl_easy_setopt_err_error_buffer(); \ + if((_curl_opt) == CURLOPT_STDERR) \ + if(!_curl_is_FILE(value)) \ + _curl_easy_setopt_err_FILE(); \ + if(_curl_is_postfields_option(_curl_opt)) \ + if(!_curl_is_postfields(value)) \ + _curl_easy_setopt_err_postfields(); \ + if((_curl_opt) == CURLOPT_HTTPPOST) \ + if(!_curl_is_arr((value), struct curl_httppost)) \ + _curl_easy_setopt_err_curl_httpost(); \ + if(_curl_is_slist_option(_curl_opt)) \ + if(!_curl_is_arr((value), struct curl_slist)) \ + _curl_easy_setopt_err_curl_slist(); \ + if((_curl_opt) == CURLOPT_SHARE) \ + if(!_curl_is_ptr((value), CURLSH)) \ + _curl_easy_setopt_err_CURLSH(); \ + } \ + curl_easy_setopt(handle, _curl_opt, value); \ +}) + +/* wraps curl_easy_getinfo() with typechecking */ +/* FIXME: don't allow const pointers */ +#define curl_easy_getinfo(handle, info, arg) \ +__extension__ ({ \ + __typeof__ (info) _curl_info = info; \ + if(__builtin_constant_p(_curl_info)) { \ + if(_curl_is_string_info(_curl_info)) \ + if(!_curl_is_arr((arg), char *)) \ + _curl_easy_getinfo_err_string(); \ + if(_curl_is_long_info(_curl_info)) \ + if(!_curl_is_arr((arg), long)) \ + _curl_easy_getinfo_err_long(); \ + if(_curl_is_double_info(_curl_info)) \ + if(!_curl_is_arr((arg), double)) \ + _curl_easy_getinfo_err_double(); \ + if(_curl_is_slist_info(_curl_info)) \ + if(!_curl_is_arr((arg), struct curl_slist *)) \ + _curl_easy_getinfo_err_curl_slist(); \ + } \ + curl_easy_getinfo(handle, _curl_info, arg); \ +}) + +/* TODO: typechecking for curl_share_setopt() and curl_multi_setopt(), + * for now just make sure that the functions are called with three + * arguments + */ +#define curl_share_setopt(share,opt,param) curl_share_setopt(share,opt,param) +#define curl_multi_setopt(handle,opt,param) curl_multi_setopt(handle,opt,param) + + +/* the actual warnings, triggered by calling the _curl_easy_setopt_err* + * functions */ + +/* To define a new warning, use _CURL_WARNING(identifier, "message") */ +#define _CURL_WARNING(id, message) \ + static void __attribute__((__warning__(message))) \ + __attribute__((__unused__)) __attribute__((__noinline__)) \ + id(void) { __asm__(""); } + +_CURL_WARNING(_curl_easy_setopt_err_long, + "curl_easy_setopt expects a long argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_curl_off_t, + "curl_easy_setopt expects a curl_off_t argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_string, + "curl_easy_setopt expects a " + "string (char* or char[]) argument for this option" + ) +_CURL_WARNING(_curl_easy_setopt_err_write_callback, + "curl_easy_setopt expects a curl_write_callback argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_read_cb, + "curl_easy_setopt expects a curl_read_callback argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_ioctl_cb, + "curl_easy_setopt expects a curl_ioctl_callback argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_sockopt_cb, + "curl_easy_setopt expects a curl_sockopt_callback argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_opensocket_cb, + "curl_easy_setopt expects a " + "curl_opensocket_callback argument for this option" + ) +_CURL_WARNING(_curl_easy_setopt_err_progress_cb, + "curl_easy_setopt expects a curl_progress_callback argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_debug_cb, + "curl_easy_setopt expects a curl_debug_callback argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_ssl_ctx_cb, + "curl_easy_setopt expects a curl_ssl_ctx_callback argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_conv_cb, + "curl_easy_setopt expects a curl_conv_callback argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_seek_cb, + "curl_easy_setopt expects a curl_seek_callback argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_cb_data, + "curl_easy_setopt expects a " + "private data pointer as argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_error_buffer, + "curl_easy_setopt expects a " + "char buffer of CURL_ERROR_SIZE as argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_FILE, + "curl_easy_setopt expects a FILE* argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_postfields, + "curl_easy_setopt expects a void* or char* argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_curl_httpost, + "curl_easy_setopt expects a struct curl_httppost* argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_curl_slist, + "curl_easy_setopt expects a struct curl_slist* argument for this option") +_CURL_WARNING(_curl_easy_setopt_err_CURLSH, + "curl_easy_setopt expects a CURLSH* argument for this option") + +_CURL_WARNING(_curl_easy_getinfo_err_string, + "curl_easy_getinfo expects a pointer to char * for this info") +_CURL_WARNING(_curl_easy_getinfo_err_long, + "curl_easy_getinfo expects a pointer to long for this info") +_CURL_WARNING(_curl_easy_getinfo_err_double, + "curl_easy_getinfo expects a pointer to double for this info") +_CURL_WARNING(_curl_easy_getinfo_err_curl_slist, + "curl_easy_getinfo expects a pointer to struct curl_slist * for this info") + +/* groups of curl_easy_setops options that take the same type of argument */ + +/* To add a new option to one of the groups, just add + * (option) == CURLOPT_SOMETHING + * to the or-expression. If the option takes a long or curl_off_t, you don't + * have to do anything + */ + +/* evaluates to true if option takes a long argument */ +#define _curl_is_long_option(option) \ + (0 < (option) && (option) < CURLOPTTYPE_OBJECTPOINT) + +#define _curl_is_off_t_option(option) \ + ((option) > CURLOPTTYPE_OFF_T) + +/* evaluates to true if option takes a char* argument */ +#define _curl_is_string_option(option) \ + ((option) == CURLOPT_URL || \ + (option) == CURLOPT_PROXY || \ + (option) == CURLOPT_INTERFACE || \ + (option) == CURLOPT_NETRC_FILE || \ + (option) == CURLOPT_USERPWD || \ + (option) == CURLOPT_USERNAME || \ + (option) == CURLOPT_PASSWORD || \ + (option) == CURLOPT_PROXYUSERPWD || \ + (option) == CURLOPT_PROXYUSERNAME || \ + (option) == CURLOPT_PROXYPASSWORD || \ + (option) == CURLOPT_NOPROXY || \ + (option) == CURLOPT_ACCEPT_ENCODING || \ + (option) == CURLOPT_REFERER || \ + (option) == CURLOPT_USERAGENT || \ + (option) == CURLOPT_COOKIE || \ + (option) == CURLOPT_COOKIEFILE || \ + (option) == CURLOPT_COOKIEJAR || \ + (option) == CURLOPT_COOKIELIST || \ + (option) == CURLOPT_FTPPORT || \ + (option) == CURLOPT_FTP_ALTERNATIVE_TO_USER || \ + (option) == CURLOPT_FTP_ACCOUNT || \ + (option) == CURLOPT_RANGE || \ + (option) == CURLOPT_CUSTOMREQUEST || \ + (option) == CURLOPT_SSLCERT || \ + (option) == CURLOPT_SSLCERTTYPE || \ + (option) == CURLOPT_SSLKEY || \ + (option) == CURLOPT_SSLKEYTYPE || \ + (option) == CURLOPT_KEYPASSWD || \ + (option) == CURLOPT_SSLENGINE || \ + (option) == CURLOPT_CAINFO || \ + (option) == CURLOPT_CAPATH || \ + (option) == CURLOPT_RANDOM_FILE || \ + (option) == CURLOPT_EGDSOCKET || \ + (option) == CURLOPT_SSL_CIPHER_LIST || \ + (option) == CURLOPT_KRBLEVEL || \ + (option) == CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 || \ + (option) == CURLOPT_SSH_PUBLIC_KEYFILE || \ + (option) == CURLOPT_SSH_PRIVATE_KEYFILE || \ + (option) == CURLOPT_CRLFILE || \ + (option) == CURLOPT_ISSUERCERT || \ + (option) == CURLOPT_SOCKS5_GSSAPI_SERVICE || \ + (option) == CURLOPT_SSH_KNOWNHOSTS || \ + (option) == CURLOPT_MAIL_FROM || \ + (option) == CURLOPT_RTSP_SESSION_ID || \ + (option) == CURLOPT_RTSP_STREAM_URI || \ + (option) == CURLOPT_RTSP_TRANSPORT || \ + 0) + +/* evaluates to true if option takes a curl_write_callback argument */ +#define _curl_is_write_cb_option(option) \ + ((option) == CURLOPT_HEADERFUNCTION || \ + (option) == CURLOPT_WRITEFUNCTION) + +/* evaluates to true if option takes a curl_conv_callback argument */ +#define _curl_is_conv_cb_option(option) \ + ((option) == CURLOPT_CONV_TO_NETWORK_FUNCTION || \ + (option) == CURLOPT_CONV_FROM_NETWORK_FUNCTION || \ + (option) == CURLOPT_CONV_FROM_UTF8_FUNCTION) + +/* evaluates to true if option takes a data argument to pass to a callback */ +#define _curl_is_cb_data_option(option) \ + ((option) == CURLOPT_WRITEDATA || \ + (option) == CURLOPT_READDATA || \ + (option) == CURLOPT_IOCTLDATA || \ + (option) == CURLOPT_SOCKOPTDATA || \ + (option) == CURLOPT_OPENSOCKETDATA || \ + (option) == CURLOPT_PROGRESSDATA || \ + (option) == CURLOPT_WRITEHEADER || \ + (option) == CURLOPT_DEBUGDATA || \ + (option) == CURLOPT_SSL_CTX_DATA || \ + (option) == CURLOPT_SEEKDATA || \ + (option) == CURLOPT_PRIVATE || \ + (option) == CURLOPT_SSH_KEYDATA || \ + (option) == CURLOPT_INTERLEAVEDATA || \ + (option) == CURLOPT_CHUNK_DATA || \ + (option) == CURLOPT_FNMATCH_DATA || \ + 0) + +/* evaluates to true if option takes a POST data argument (void* or char*) */ +#define _curl_is_postfields_option(option) \ + ((option) == CURLOPT_POSTFIELDS || \ + (option) == CURLOPT_COPYPOSTFIELDS || \ + 0) + +/* evaluates to true if option takes a struct curl_slist * argument */ +#define _curl_is_slist_option(option) \ + ((option) == CURLOPT_HTTPHEADER || \ + (option) == CURLOPT_HTTP200ALIASES || \ + (option) == CURLOPT_QUOTE || \ + (option) == CURLOPT_POSTQUOTE || \ + (option) == CURLOPT_PREQUOTE || \ + (option) == CURLOPT_TELNETOPTIONS || \ + (option) == CURLOPT_MAIL_RCPT || \ + 0) + +/* groups of curl_easy_getinfo infos that take the same type of argument */ + +/* evaluates to true if info expects a pointer to char * argument */ +#define _curl_is_string_info(info) \ + (CURLINFO_STRING < (info) && (info) < CURLINFO_LONG) + +/* evaluates to true if info expects a pointer to long argument */ +#define _curl_is_long_info(info) \ + (CURLINFO_LONG < (info) && (info) < CURLINFO_DOUBLE) + +/* evaluates to true if info expects a pointer to double argument */ +#define _curl_is_double_info(info) \ + (CURLINFO_DOUBLE < (info) && (info) < CURLINFO_SLIST) + +/* true if info expects a pointer to struct curl_slist * argument */ +#define _curl_is_slist_info(info) \ + (CURLINFO_SLIST < (info)) + + +/* typecheck helpers -- check whether given expression has requested type*/ + +/* For pointers, you can use the _curl_is_ptr/_curl_is_arr macros, + * otherwise define a new macro. Search for __builtin_types_compatible_p + * in the GCC manual. + * NOTE: these macros MUST NOT EVALUATE their arguments! The argument is + * the actual expression passed to the curl_easy_setopt macro. This + * means that you can only apply the sizeof and __typeof__ operators, no + * == or whatsoever. + */ + +/* XXX: should evaluate to true iff expr is a pointer */ +#define _curl_is_any_ptr(expr) \ + (sizeof(expr) == sizeof(void*)) + +/* evaluates to true if expr is NULL */ +/* XXX: must not evaluate expr, so this check is not accurate */ +#define _curl_is_NULL(expr) \ + (__builtin_types_compatible_p(__typeof__(expr), __typeof__(NULL))) + +/* evaluates to true if expr is type*, const type* or NULL */ +#define _curl_is_ptr(expr, type) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), type *) || \ + __builtin_types_compatible_p(__typeof__(expr), const type *)) + +/* evaluates to true if expr is one of type[], type*, NULL or const type* */ +#define _curl_is_arr(expr, type) \ + (_curl_is_ptr((expr), type) || \ + __builtin_types_compatible_p(__typeof__(expr), type [])) + +/* evaluates to true if expr is a string */ +#define _curl_is_string(expr) \ + (_curl_is_arr((expr), char) || \ + _curl_is_arr((expr), signed char) || \ + _curl_is_arr((expr), unsigned char)) + +/* evaluates to true if expr is a long (no matter the signedness) + * XXX: for now, int is also accepted (and therefore short and char, which + * are promoted to int when passed to a variadic function) */ +#define _curl_is_long(expr) \ + (__builtin_types_compatible_p(__typeof__(expr), long) || \ + __builtin_types_compatible_p(__typeof__(expr), signed long) || \ + __builtin_types_compatible_p(__typeof__(expr), unsigned long) || \ + __builtin_types_compatible_p(__typeof__(expr), int) || \ + __builtin_types_compatible_p(__typeof__(expr), signed int) || \ + __builtin_types_compatible_p(__typeof__(expr), unsigned int) || \ + __builtin_types_compatible_p(__typeof__(expr), short) || \ + __builtin_types_compatible_p(__typeof__(expr), signed short) || \ + __builtin_types_compatible_p(__typeof__(expr), unsigned short) || \ + __builtin_types_compatible_p(__typeof__(expr), char) || \ + __builtin_types_compatible_p(__typeof__(expr), signed char) || \ + __builtin_types_compatible_p(__typeof__(expr), unsigned char)) + +/* evaluates to true if expr is of type curl_off_t */ +#define _curl_is_off_t(expr) \ + (__builtin_types_compatible_p(__typeof__(expr), curl_off_t)) + +/* evaluates to true if expr is abuffer suitable for CURLOPT_ERRORBUFFER */ +/* XXX: also check size of an char[] array? */ +#define _curl_is_error_buffer(expr) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), char *) || \ + __builtin_types_compatible_p(__typeof__(expr), char[])) + +/* evaluates to true if expr is of type (const) void* or (const) FILE* */ +#if 0 +#define _curl_is_cb_data(expr) \ + (_curl_is_ptr((expr), void) || \ + _curl_is_ptr((expr), FILE)) +#else /* be less strict */ +#define _curl_is_cb_data(expr) \ + _curl_is_any_ptr(expr) +#endif + +/* evaluates to true if expr is of type FILE* */ +#define _curl_is_FILE(expr) \ + (__builtin_types_compatible_p(__typeof__(expr), FILE *)) + +/* evaluates to true if expr can be passed as POST data (void* or char*) */ +#define _curl_is_postfields(expr) \ + (_curl_is_ptr((expr), void) || \ + _curl_is_arr((expr), char)) + +/* FIXME: the whole callback checking is messy... + * The idea is to tolerate char vs. void and const vs. not const + * pointers in arguments at least + */ +/* helper: __builtin_types_compatible_p distinguishes between functions and + * function pointers, hide it */ +#define _curl_callback_compatible(func, type) \ + (__builtin_types_compatible_p(__typeof__(func), type) || \ + __builtin_types_compatible_p(__typeof__(func), type*)) + +/* evaluates to true if expr is of type curl_read_callback or "similar" */ +#define _curl_is_read_cb(expr) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), __typeof__(fread)) || \ + __builtin_types_compatible_p(__typeof__(expr), curl_read_callback) || \ + _curl_callback_compatible((expr), _curl_read_callback1) || \ + _curl_callback_compatible((expr), _curl_read_callback2) || \ + _curl_callback_compatible((expr), _curl_read_callback3) || \ + _curl_callback_compatible((expr), _curl_read_callback4) || \ + _curl_callback_compatible((expr), _curl_read_callback5) || \ + _curl_callback_compatible((expr), _curl_read_callback6)) +typedef size_t (_curl_read_callback1)(char *, size_t, size_t, void*); +typedef size_t (_curl_read_callback2)(char *, size_t, size_t, const void*); +typedef size_t (_curl_read_callback3)(char *, size_t, size_t, FILE*); +typedef size_t (_curl_read_callback4)(void *, size_t, size_t, void*); +typedef size_t (_curl_read_callback5)(void *, size_t, size_t, const void*); +typedef size_t (_curl_read_callback6)(void *, size_t, size_t, FILE*); + +/* evaluates to true if expr is of type curl_write_callback or "similar" */ +#define _curl_is_write_cb(expr) \ + (_curl_is_read_cb(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), __typeof__(fwrite)) || \ + __builtin_types_compatible_p(__typeof__(expr), curl_write_callback) || \ + _curl_callback_compatible((expr), _curl_write_callback1) || \ + _curl_callback_compatible((expr), _curl_write_callback2) || \ + _curl_callback_compatible((expr), _curl_write_callback3) || \ + _curl_callback_compatible((expr), _curl_write_callback4) || \ + _curl_callback_compatible((expr), _curl_write_callback5) || \ + _curl_callback_compatible((expr), _curl_write_callback6)) +typedef size_t (_curl_write_callback1)(const char *, size_t, size_t, void*); +typedef size_t (_curl_write_callback2)(const char *, size_t, size_t, + const void*); +typedef size_t (_curl_write_callback3)(const char *, size_t, size_t, FILE*); +typedef size_t (_curl_write_callback4)(const void *, size_t, size_t, void*); +typedef size_t (_curl_write_callback5)(const void *, size_t, size_t, + const void*); +typedef size_t (_curl_write_callback6)(const void *, size_t, size_t, FILE*); + +/* evaluates to true if expr is of type curl_ioctl_callback or "similar" */ +#define _curl_is_ioctl_cb(expr) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), curl_ioctl_callback) || \ + _curl_callback_compatible((expr), _curl_ioctl_callback1) || \ + _curl_callback_compatible((expr), _curl_ioctl_callback2) || \ + _curl_callback_compatible((expr), _curl_ioctl_callback3) || \ + _curl_callback_compatible((expr), _curl_ioctl_callback4)) +typedef curlioerr (_curl_ioctl_callback1)(CURL *, int, void*); +typedef curlioerr (_curl_ioctl_callback2)(CURL *, int, const void*); +typedef curlioerr (_curl_ioctl_callback3)(CURL *, curliocmd, void*); +typedef curlioerr (_curl_ioctl_callback4)(CURL *, curliocmd, const void*); + +/* evaluates to true if expr is of type curl_sockopt_callback or "similar" */ +#define _curl_is_sockopt_cb(expr) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), curl_sockopt_callback) || \ + _curl_callback_compatible((expr), _curl_sockopt_callback1) || \ + _curl_callback_compatible((expr), _curl_sockopt_callback2)) +typedef int (_curl_sockopt_callback1)(void *, curl_socket_t, curlsocktype); +typedef int (_curl_sockopt_callback2)(const void *, curl_socket_t, + curlsocktype); + +/* evaluates to true if expr is of type curl_opensocket_callback or + "similar" */ +#define _curl_is_opensocket_cb(expr) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), curl_opensocket_callback) ||\ + _curl_callback_compatible((expr), _curl_opensocket_callback1) || \ + _curl_callback_compatible((expr), _curl_opensocket_callback2) || \ + _curl_callback_compatible((expr), _curl_opensocket_callback3) || \ + _curl_callback_compatible((expr), _curl_opensocket_callback4)) +typedef curl_socket_t (_curl_opensocket_callback1) + (void *, curlsocktype, struct curl_sockaddr *); +typedef curl_socket_t (_curl_opensocket_callback2) + (void *, curlsocktype, const struct curl_sockaddr *); +typedef curl_socket_t (_curl_opensocket_callback3) + (const void *, curlsocktype, struct curl_sockaddr *); +typedef curl_socket_t (_curl_opensocket_callback4) + (const void *, curlsocktype, const struct curl_sockaddr *); + +/* evaluates to true if expr is of type curl_progress_callback or "similar" */ +#define _curl_is_progress_cb(expr) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), curl_progress_callback) || \ + _curl_callback_compatible((expr), _curl_progress_callback1) || \ + _curl_callback_compatible((expr), _curl_progress_callback2)) +typedef int (_curl_progress_callback1)(void *, + double, double, double, double); +typedef int (_curl_progress_callback2)(const void *, + double, double, double, double); + +/* evaluates to true if expr is of type curl_debug_callback or "similar" */ +#define _curl_is_debug_cb(expr) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), curl_debug_callback) || \ + _curl_callback_compatible((expr), _curl_debug_callback1) || \ + _curl_callback_compatible((expr), _curl_debug_callback2) || \ + _curl_callback_compatible((expr), _curl_debug_callback3) || \ + _curl_callback_compatible((expr), _curl_debug_callback4) || \ + _curl_callback_compatible((expr), _curl_debug_callback5) || \ + _curl_callback_compatible((expr), _curl_debug_callback6) || \ + _curl_callback_compatible((expr), _curl_debug_callback7) || \ + _curl_callback_compatible((expr), _curl_debug_callback8)) +typedef int (_curl_debug_callback1) (CURL *, + curl_infotype, char *, size_t, void *); +typedef int (_curl_debug_callback2) (CURL *, + curl_infotype, char *, size_t, const void *); +typedef int (_curl_debug_callback3) (CURL *, + curl_infotype, const char *, size_t, void *); +typedef int (_curl_debug_callback4) (CURL *, + curl_infotype, const char *, size_t, const void *); +typedef int (_curl_debug_callback5) (CURL *, + curl_infotype, unsigned char *, size_t, void *); +typedef int (_curl_debug_callback6) (CURL *, + curl_infotype, unsigned char *, size_t, const void *); +typedef int (_curl_debug_callback7) (CURL *, + curl_infotype, const unsigned char *, size_t, void *); +typedef int (_curl_debug_callback8) (CURL *, + curl_infotype, const unsigned char *, size_t, const void *); + +/* evaluates to true if expr is of type curl_ssl_ctx_callback or "similar" */ +/* this is getting even messier... */ +#define _curl_is_ssl_ctx_cb(expr) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), curl_ssl_ctx_callback) || \ + _curl_callback_compatible((expr), _curl_ssl_ctx_callback1) || \ + _curl_callback_compatible((expr), _curl_ssl_ctx_callback2) || \ + _curl_callback_compatible((expr), _curl_ssl_ctx_callback3) || \ + _curl_callback_compatible((expr), _curl_ssl_ctx_callback4) || \ + _curl_callback_compatible((expr), _curl_ssl_ctx_callback5) || \ + _curl_callback_compatible((expr), _curl_ssl_ctx_callback6) || \ + _curl_callback_compatible((expr), _curl_ssl_ctx_callback7) || \ + _curl_callback_compatible((expr), _curl_ssl_ctx_callback8)) +typedef CURLcode (_curl_ssl_ctx_callback1)(CURL *, void *, void *); +typedef CURLcode (_curl_ssl_ctx_callback2)(CURL *, void *, const void *); +typedef CURLcode (_curl_ssl_ctx_callback3)(CURL *, const void *, void *); +typedef CURLcode (_curl_ssl_ctx_callback4)(CURL *, const void *, const void *); +#ifdef HEADER_SSL_H +/* hack: if we included OpenSSL's ssl.h, we know about SSL_CTX + * this will of course break if we're included before OpenSSL headers... + */ +typedef CURLcode (_curl_ssl_ctx_callback5)(CURL *, SSL_CTX, void *); +typedef CURLcode (_curl_ssl_ctx_callback6)(CURL *, SSL_CTX, const void *); +typedef CURLcode (_curl_ssl_ctx_callback7)(CURL *, const SSL_CTX, void *); +typedef CURLcode (_curl_ssl_ctx_callback8)(CURL *, const SSL_CTX, + const void *); +#else +typedef _curl_ssl_ctx_callback1 _curl_ssl_ctx_callback5; +typedef _curl_ssl_ctx_callback1 _curl_ssl_ctx_callback6; +typedef _curl_ssl_ctx_callback1 _curl_ssl_ctx_callback7; +typedef _curl_ssl_ctx_callback1 _curl_ssl_ctx_callback8; +#endif + +/* evaluates to true if expr is of type curl_conv_callback or "similar" */ +#define _curl_is_conv_cb(expr) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), curl_conv_callback) || \ + _curl_callback_compatible((expr), _curl_conv_callback1) || \ + _curl_callback_compatible((expr), _curl_conv_callback2) || \ + _curl_callback_compatible((expr), _curl_conv_callback3) || \ + _curl_callback_compatible((expr), _curl_conv_callback4)) +typedef CURLcode (*_curl_conv_callback1)(char *, size_t length); +typedef CURLcode (*_curl_conv_callback2)(const char *, size_t length); +typedef CURLcode (*_curl_conv_callback3)(void *, size_t length); +typedef CURLcode (*_curl_conv_callback4)(const void *, size_t length); + +/* evaluates to true if expr is of type curl_seek_callback or "similar" */ +#define _curl_is_seek_cb(expr) \ + (_curl_is_NULL(expr) || \ + __builtin_types_compatible_p(__typeof__(expr), curl_seek_callback) || \ + _curl_callback_compatible((expr), _curl_seek_callback1) || \ + _curl_callback_compatible((expr), _curl_seek_callback2)) +typedef CURLcode (*_curl_seek_callback1)(void *, curl_off_t, int); +typedef CURLcode (*_curl_seek_callback2)(const void *, curl_off_t, int); + + +#endif /* __CURL_TYPECHECK_GCC_H */ diff --git a/Source/Import/libcurl/qcbuild.src b/Source/Import/libcurl/qcbuild.src new file mode 100644 index 0000000..88f63fa --- /dev/null +++ b/Source/Import/libcurl/qcbuild.src @@ -0,0 +1,63 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY + +TITLE = libcurl + +# +# Headers. +# + +ISRC = curl + + +# +# List of prebuild libraries to copy into Build dir. +# $(ARCH) keywords will be set to i386 or amd64 depending on +# detected/set target. +# + +.section Linux +.endsection + +.section MinGW + PREBUILD_LIBS = Prebuild/Win/i386/libcurl-4.dll + PREBUILD_LIBS += Prebuild/Win/i386/libcurl.a +.endsection + +# +# Info about license and auhtors. +# + +LICENSE = X11 +AUTHOR = Daniel Stenberg +COPYRIGHT = Copyright (C) 1998 - 2012, Daniel Stenberg + +# +# Description, purpose. +# + +PURPOSE = High level HTTP, FTP protocols. +DESC = Prebuild only. diff --git a/Source/Import/libevent/Example/Main.c b/Source/Import/libevent/Example/Main.c new file mode 100644 index 0000000..064edda --- /dev/null +++ b/Source/Import/libevent/Example/Main.c @@ -0,0 +1,175 @@ +// +// PURPOSE: Echo server listening on 9995 port. +// + +#include +#include +#include +#include + +#ifndef WIN32 +# include +# ifdef _XOPEN_SOURCE_EXTENDED +# include +# endif +# include +#endif + +#include +#include +#include +#include +#include + +static const int PORT = 9995; + +static void listener_cb(struct evconnlistener *, evutil_socket_t, struct sockaddr *, int socklen, void *); +static void conn_writecb(struct bufferevent *, void *); +static void conn_eventcb(struct bufferevent *, short, void *); +static void signal_cb(evutil_socket_t, short, void *); +static void conn_readcb(struct bufferevent *bev, void *user_data); + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + struct event_base *base; + struct evconnlistener *listener; + struct event *signal_event; + + struct sockaddr_in sin; + + #ifdef WIN32 + WSADATA wsa_data; + WSAStartup(0x0201, &wsa_data); + #endif + + base = event_base_new(); + + if (!base) + { + fprintf(stderr, "Could not initialize libevent!\n"); + + return 1; + } + + memset(&sin, 0, sizeof(sin)); + + sin.sin_family = AF_INET; + sin.sin_port = htons(PORT); + + listener = evconnlistener_new_bind(base, listener_cb, (void *) base, + LEV_OPT_REUSEABLE | LEV_OPT_CLOSE_ON_FREE, + -1, (struct sockaddr *) &sin, + sizeof(sin)); + + if (!listener) + { + fprintf(stderr, "Could not create a listener!\n"); + + return 1; + } + + signal_event = evsignal_new(base, SIGINT, signal_cb, (void *)base); + + if (!signal_event || event_add(signal_event, NULL)<0) + { + fprintf(stderr, "Could not create/add a signal event!\n"); + + return 1; + } + + event_base_dispatch(base); + + evconnlistener_free(listener); + event_free(signal_event); + event_base_free(base); + + printf("done\n"); + + return 0; +} + +// +// Callback called when new connection arrived. +// + +static void listener_cb(struct evconnlistener *listener, evutil_socket_t fd, + struct sockaddr *sa, int socklen, void *user_data) +{ + struct event_base *base = user_data; + + struct bufferevent *bev; + + printf("-> listener_cb()...\n"); + + printf("New connection.\n"); + + bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE); + + if (!bev) + { + fprintf(stderr, "Error constructing bufferevent!"); + + event_base_loopbreak(base); + + return; + } + + bufferevent_setcb(bev, conn_readcb, NULL, conn_eventcb, NULL); + + bufferevent_enable(bev, EV_WRITE); + bufferevent_enable(bev, EV_READ); + + printf("<- listener_cb()...\n"); +} + +// +// Callback called when new data arrived. +// + +static void conn_readcb(struct bufferevent *bev, void *user_data) +{ + printf("-> conn_readcb()...\n"); + + struct evbuffer *input = bufferevent_get_input(bev); + + size_t len = evbuffer_get_length(input); + + unsigned char *buf = evbuffer_pullup(input, len); + + printf("Readed [%d][%.*s]\n", len, len, buf); + + bufferevent_write(bev, buf, len); + + evbuffer_drain(input, len); + + printf("-> conn_readcb()...\n"); +} + +// +// Callback called when connection closed. +// + +static void conn_eventcb(struct bufferevent *bev, short events, void *user_data) +{ + printf("Connection closed.\n"); + + bufferevent_free(bev); +} + +// +// Callback called when SIGINT handled. +// + +static void signal_cb(evutil_socket_t sig, short events, void *user_data) +{ + struct event_base *base = user_data; + struct timeval delay = {2, 0}; + + printf("Caught an interrupt signal; exiting cleanly in two seconds.\n"); + + event_base_loopexit(base, &delay); +} diff --git a/Source/Import/libevent/Example/qcbuild.src b/Source/Import/libevent/Example/qcbuild.src new file mode 100644 index 0000000..adc1394 --- /dev/null +++ b/Source/Import/libevent/Example/qcbuild.src @@ -0,0 +1,38 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = libevent-example-server + +# +# Component's info. +# + +PURPOSE = Show how to use libevent to implement minimal echo server. +AUTHOR = Sylwester Wysocki (original example by Niels Provos) +CSRC = Main.c +LIBS = -levent -ldebug +DESC = Modified hello-world.c example from libevent project. + +DEPENDS = libevent LibDebug diff --git a/Source/Import/libevent/Includes/Linux/event2/buffer.h b/Source/Import/libevent/Includes/Linux/event2/buffer.h new file mode 100644 index 0000000..468588b --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/buffer.h @@ -0,0 +1,1076 @@ +/* + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_BUFFER_H_INCLUDED_ +#define EVENT2_BUFFER_H_INCLUDED_ + +/** @file event2/buffer.h + + Functions for buffering data for network sending or receiving. + + An evbuffer can be used for preparing data before sending it to + the network or conversely for reading data from the network. + Evbuffers try to avoid memory copies as much as possible. As a + result, evbuffers can be used to pass data around without actually + incurring the overhead of copying the data. + + A new evbuffer can be allocated with evbuffer_new(), and can be + freed with evbuffer_free(). Most users will be using evbuffers via + the bufferevent interface. To access a bufferevent's evbuffers, use + bufferevent_get_input() and bufferevent_get_output(). + + There are several guidelines for using evbuffers. + + - if you already know how much data you are going to add as a result + of calling evbuffer_add() multiple times, it makes sense to use + evbuffer_expand() first to make sure that enough memory is allocated + before hand. + + - evbuffer_add_buffer() adds the contents of one buffer to the other + without incurring any unnecessary memory copies. + + - evbuffer_add() and evbuffer_add_buffer() do not mix very well: + if you use them, you will wind up with fragmented memory in your + buffer. + + - For high-performance code, you may want to avoid copying data into and out + of buffers. You can skip the copy step by using + evbuffer_reserve_space()/evbuffer_commit_space() when writing into a + buffer, and evbuffer_peek() when reading. + + In Libevent 2.0 and later, evbuffers are represented using a linked + list of memory chunks, with pointers to the first and last chunk in + the chain. + + As the contents of an evbuffer can be stored in multiple different + memory blocks, it cannot be accessed directly. Instead, evbuffer_pullup() + can be used to force a specified number of bytes to be contiguous. This + will cause memory reallocation and memory copies if the data is split + across multiple blocks. It is more efficient, however, to use + evbuffer_peek() if you don't require that the memory to be contiguous. + */ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_UIO_H +#include +#endif +#include + +/** + An evbuffer is an opaque data type for efficiently buffering data to be + sent or received on the network. + + @see event2/event.h for more information +*/ +struct evbuffer +#ifdef EVENT_IN_DOXYGEN_ +{} +#endif +; + +/** + Pointer to a position within an evbuffer. + + Used when repeatedly searching through a buffer. Calling any function + that modifies or re-packs the buffer contents may invalidate all + evbuffer_ptrs for that buffer. Do not modify or contruct these values + except with evbuffer_ptr_set. + + An evbuffer_ptr can represent any position from the start of a buffer up + to a position immediately after the end of a buffer. + + @see evbuffer_ptr_set() + */ +struct evbuffer_ptr { + ev_ssize_t pos; + + /* Do not alter or rely on the values of fields: they are for internal + * use */ + struct { + void *chain; + size_t pos_in_chain; + } internal_; +}; + +/** Describes a single extent of memory inside an evbuffer. Used for + direct-access functions. + + @see evbuffer_reserve_space, evbuffer_commit_space, evbuffer_peek + */ +#ifdef EVENT__HAVE_SYS_UIO_H +#define evbuffer_iovec iovec +/* Internal use -- defined only if we are using the native struct iovec */ +#define EVBUFFER_IOVEC_IS_NATIVE_ +#else +struct evbuffer_iovec { + /** The start of the extent of memory. */ + void *iov_base; + /** The length of the extent of memory. */ + size_t iov_len; +}; +#endif + +/** + Allocate storage for a new evbuffer. + + @return a pointer to a newly allocated evbuffer struct, or NULL if an error + occurred + */ +EVENT2_EXPORT_SYMBOL +struct evbuffer *evbuffer_new(void); +/** + Deallocate storage for an evbuffer. + + @param buf pointer to the evbuffer to be freed + */ +EVENT2_EXPORT_SYMBOL +void evbuffer_free(struct evbuffer *buf); + +/** + Enable locking on an evbuffer so that it can safely be used by multiple + threads at the same time. + + NOTE: when locking is enabled, the lock will be held when callbacks are + invoked. This could result in deadlock if you aren't careful. Plan + accordingly! + + @param buf An evbuffer to make lockable. + @param lock A lock object, or NULL if we should allocate our own. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_enable_locking(struct evbuffer *buf, void *lock); + +/** + Acquire the lock on an evbuffer. Has no effect if locking was not enabled + with evbuffer_enable_locking. +*/ +EVENT2_EXPORT_SYMBOL +void evbuffer_lock(struct evbuffer *buf); + +/** + Release the lock on an evbuffer. Has no effect if locking was not enabled + with evbuffer_enable_locking. +*/ +EVENT2_EXPORT_SYMBOL +void evbuffer_unlock(struct evbuffer *buf); + + +/** If this flag is set, then we will not use evbuffer_peek(), + * evbuffer_remove(), evbuffer_remove_buffer(), and so on to read bytes + * from this buffer: we'll only take bytes out of this buffer by + * writing them to the network (as with evbuffer_write_atmost), by + * removing them without observing them (as with evbuffer_drain), + * or by copying them all out at once (as with evbuffer_add_buffer). + * + * Using this option allows the implementation to use sendfile-based + * operations for evbuffer_add_file(); see that function for more + * information. + * + * This flag is on by default for bufferevents that can take advantage + * of it; you should never actually need to set it on a bufferevent's + * output buffer. + */ +#define EVBUFFER_FLAG_DRAINS_TO_FD 1 + +/** Change the flags that are set for an evbuffer by adding more. + * + * @param buffer the evbuffer that the callback is watching. + * @param cb the callback whose status we want to change. + * @param flags One or more EVBUFFER_FLAG_* options + * @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_set_flags(struct evbuffer *buf, ev_uint64_t flags); +/** Change the flags that are set for an evbuffer by removing some. + * + * @param buffer the evbuffer that the callback is watching. + * @param cb the callback whose status we want to change. + * @param flags One or more EVBUFFER_FLAG_* options + * @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_clear_flags(struct evbuffer *buf, ev_uint64_t flags); + +/** + Returns the total number of bytes stored in the evbuffer + + @param buf pointer to the evbuffer + @return the number of bytes stored in the evbuffer +*/ +EVENT2_EXPORT_SYMBOL +size_t evbuffer_get_length(const struct evbuffer *buf); + +/** + Returns the number of contiguous available bytes in the first buffer chain. + + This is useful when processing data that might be split into multiple + chains, or that might all be in the first chain. Calls to + evbuffer_pullup() that cause reallocation and copying of data can thus be + avoided. + + @param buf pointer to the evbuffer + @return 0 if no data is available, otherwise the number of available bytes + in the first buffer chain. +*/ +EVENT2_EXPORT_SYMBOL +size_t evbuffer_get_contiguous_space(const struct evbuffer *buf); + +/** + Expands the available space in an evbuffer. + + Expands the available space in the evbuffer to at least datlen, so that + appending datlen additional bytes will not require any new allocations. + + @param buf the evbuffer to be expanded + @param datlen the new minimum length requirement + @return 0 if successful, or -1 if an error occurred +*/ +EVENT2_EXPORT_SYMBOL +int evbuffer_expand(struct evbuffer *buf, size_t datlen); + +/** + Reserves space in the last chain or chains of an evbuffer. + + Makes space available in the last chain or chains of an evbuffer that can + be arbitrarily written to by a user. The space does not become + available for reading until it has been committed with + evbuffer_commit_space(). + + The space is made available as one or more extents, represented by + an initial pointer and a length. You can force the memory to be + available as only one extent. Allowing more extents, however, makes the + function more efficient. + + Multiple subsequent calls to this function will make the same space + available until evbuffer_commit_space() has been called. + + It is an error to do anything that moves around the buffer's internal + memory structures before committing the space. + + NOTE: The code currently does not ever use more than two extents. + This may change in future versions. + + @param buf the evbuffer in which to reserve space. + @param size how much space to make available, at minimum. The + total length of the extents may be greater than the requested + length. + @param vec an array of one or more evbuffer_iovec structures to + hold pointers to the reserved extents of memory. + @param n_vec The length of the vec array. Must be at least 1; + 2 is more efficient. + @return the number of provided extents, or -1 on error. + @see evbuffer_commit_space() +*/ +EVENT2_EXPORT_SYMBOL +int +evbuffer_reserve_space(struct evbuffer *buf, ev_ssize_t size, + struct evbuffer_iovec *vec, int n_vec); + +/** + Commits previously reserved space. + + Commits some of the space previously reserved with + evbuffer_reserve_space(). It then becomes available for reading. + + This function may return an error if the pointer in the extents do + not match those returned from evbuffer_reserve_space, or if data + has been added to the buffer since the space was reserved. + + If you want to commit less data than you got reserved space for, + modify the iov_len pointer of the appropriate extent to a smaller + value. Note that you may have received more space than you + requested if it was available! + + @param buf the evbuffer in which to reserve space. + @param vec one or two extents returned by evbuffer_reserve_space. + @param n_vecs the number of extents. + @return 0 on success, -1 on error + @see evbuffer_reserve_space() +*/ +EVENT2_EXPORT_SYMBOL +int evbuffer_commit_space(struct evbuffer *buf, + struct evbuffer_iovec *vec, int n_vecs); + +/** + Append data to the end of an evbuffer. + + @param buf the evbuffer to be appended to + @param data pointer to the beginning of the data buffer + @param datlen the number of bytes to be copied from the data buffer + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add(struct evbuffer *buf, const void *data, size_t datlen); + + +/** + Read data from an evbuffer and drain the bytes read. + + If more bytes are requested than are available in the evbuffer, we + only extract as many bytes as were available. + + @param buf the evbuffer to be read from + @param data the destination buffer to store the result + @param datlen the maximum size of the destination buffer + @return the number of bytes read, or -1 if we can't drain the buffer. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_remove(struct evbuffer *buf, void *data, size_t datlen); + +/** + Read data from an evbuffer, and leave the buffer unchanged. + + If more bytes are requested than are available in the evbuffer, we + only extract as many bytes as were available. + + @param buf the evbuffer to be read from + @param data_out the destination buffer to store the result + @param datlen the maximum size of the destination buffer + @return the number of bytes read, or -1 if we can't drain the buffer. + */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t evbuffer_copyout(struct evbuffer *buf, void *data_out, size_t datlen); + +/** + Read data from the middle of an evbuffer, and leave the buffer unchanged. + + If more bytes are requested than are available in the evbuffer, we + only extract as many bytes as were available. + + @param buf the evbuffer to be read from + @param pos the position to start reading from + @param data_out the destination buffer to store the result + @param datlen the maximum size of the destination buffer + @return the number of bytes read, or -1 if we can't drain the buffer. + */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t evbuffer_copyout_from(struct evbuffer *buf, const struct evbuffer_ptr *pos, void *data_out, size_t datlen); + +/** + Read data from an evbuffer into another evbuffer, draining + the bytes from the source buffer. This function avoids copy + operations to the extent possible. + + If more bytes are requested than are available in src, the src + buffer is drained completely. + + @param src the evbuffer to be read from + @param dst the destination evbuffer to store the result into + @param datlen the maximum numbers of bytes to transfer + @return the number of bytes read + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_remove_buffer(struct evbuffer *src, struct evbuffer *dst, + size_t datlen); + +/** Used to tell evbuffer_readln what kind of line-ending to look for. + */ +enum evbuffer_eol_style { + /** Any sequence of CR and LF characters is acceptable as an + * EOL. + * + * Note that this style can produce ambiguous results: the + * sequence "CRLF" will be treated as a single EOL if it is + * all in the buffer at once, but if you first read a CR from + * the network and later read an LF from the network, it will + * be treated as two EOLs. + */ + EVBUFFER_EOL_ANY, + /** An EOL is an LF, optionally preceded by a CR. This style is + * most useful for implementing text-based internet protocols. */ + EVBUFFER_EOL_CRLF, + /** An EOL is a CR followed by an LF. */ + EVBUFFER_EOL_CRLF_STRICT, + /** An EOL is a LF. */ + EVBUFFER_EOL_LF, + /** An EOL is a NUL character (that is, a single byte with value 0) */ + EVBUFFER_EOL_NUL +}; + +/** + * Read a single line from an evbuffer. + * + * Reads a line terminated by an EOL as determined by the evbuffer_eol_style + * argument. Returns a newly allocated nul-terminated string; the caller must + * free the returned value. The EOL is not included in the returned string. + * + * @param buffer the evbuffer to read from + * @param n_read_out if non-NULL, points to a size_t that is set to the + * number of characters in the returned string. This is useful for + * strings that can contain NUL characters. + * @param eol_style the style of line-ending to use. + * @return pointer to a single line, or NULL if an error occurred + */ +EVENT2_EXPORT_SYMBOL +char *evbuffer_readln(struct evbuffer *buffer, size_t *n_read_out, + enum evbuffer_eol_style eol_style); + +/** + Move all data from one evbuffer into another evbuffer. + + This is a destructive add. The data from one buffer moves into + the other buffer. However, no unnecessary memory copies occur. + + @param outbuf the output buffer + @param inbuf the input buffer + @return 0 if successful, or -1 if an error occurred + + @see evbuffer_remove_buffer() + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_buffer(struct evbuffer *outbuf, struct evbuffer *inbuf); + +/** + Copy data from one evbuffer into another evbuffer. + + This is a non-destructive add. The data from one buffer is copied + into the other buffer. However, no unnecessary memory copies occur. + + Note that buffers already containing buffer references can't be added + to other buffers. + + @param outbuf the output buffer + @param inbuf the input buffer + @return 0 if successful, or -1 if an error occurred + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_buffer_reference(struct evbuffer *outbuf, + struct evbuffer *inbuf); + +/** + A cleanup function for a piece of memory added to an evbuffer by + reference. + + @see evbuffer_add_reference() + */ +typedef void (*evbuffer_ref_cleanup_cb)(const void *data, + size_t datalen, void *extra); + +/** + Reference memory into an evbuffer without copying. + + The memory needs to remain valid until all the added data has been + read. This function keeps just a reference to the memory without + actually incurring the overhead of a copy. + + @param outbuf the output buffer + @param data the memory to reference + @param datlen how memory to reference + @param cleanupfn callback to be invoked when the memory is no longer + referenced by this evbuffer. + @param cleanupfn_arg optional argument to the cleanup callback + @return 0 if successful, or -1 if an error occurred + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_reference(struct evbuffer *outbuf, + const void *data, size_t datlen, + evbuffer_ref_cleanup_cb cleanupfn, void *cleanupfn_arg); + +/** + Copy data from a file into the evbuffer for writing to a socket. + + This function avoids unnecessary data copies between userland and + kernel. If sendfile is available and the EVBUFFER_FLAG_DRAINS_TO_FD + flag is set, it uses those functions. Otherwise, it tries to use + mmap (or CreateFileMapping on Windows). + + The function owns the resulting file descriptor and will close it + when finished transferring data. + + The results of using evbuffer_remove() or evbuffer_pullup() on + evbuffers whose data was added using this function are undefined. + + For more fine-grained control, use evbuffer_add_file_segment. + + @param outbuf the output buffer + @param fd the file descriptor + @param offset the offset from which to read data + @param length how much data to read, or -1 to read as much as possible. + (-1 requires that 'fd' support fstat.) + @return 0 if successful, or -1 if an error occurred +*/ + +EVENT2_EXPORT_SYMBOL +int evbuffer_add_file(struct evbuffer *outbuf, int fd, ev_off_t offset, + ev_off_t length); + +/** + An evbuffer_file_segment holds a reference to a range of a file -- + possibly the whole file! -- for use in writing from an evbuffer to a + socket. It could be implemented with mmap, sendfile, splice, or (if all + else fails) by just pulling all the data into RAM. A single + evbuffer_file_segment can be added more than once, and to more than one + evbuffer. + */ +struct evbuffer_file_segment; + +/** + Flag for creating evbuffer_file_segment: If this flag is set, then when + the evbuffer_file_segment is freed and no longer in use by any + evbuffer, the underlying fd is closed. + */ +#define EVBUF_FS_CLOSE_ON_FREE 0x01 +/** + Flag for creating evbuffer_file_segment: Disable memory-map based + implementations. + */ +#define EVBUF_FS_DISABLE_MMAP 0x02 +/** + Flag for creating evbuffer_file_segment: Disable direct fd-to-fd + implementations (including sendfile and splice). + + You might want to use this option if data needs to be taken from the + evbuffer by any means other than writing it to the network: the sendfile + backend is fast, but it only works for sending files directly to the + network. + */ +#define EVBUF_FS_DISABLE_SENDFILE 0x04 +/** + Flag for creating evbuffer_file_segment: Do not allocate a lock for this + segment. If this option is set, then neither the segment nor any + evbuffer it is added to may ever be accessed from more than one thread + at a time. + */ +#define EVBUF_FS_DISABLE_LOCKING 0x08 + +/** + A cleanup function for a evbuffer_file_segment added to an evbuffer + for reference. + */ +typedef void (*evbuffer_file_segment_cleanup_cb)( + struct evbuffer_file_segment const* seg, int flags, void* arg); + +/** + Create and return a new evbuffer_file_segment for reading data from a + file and sending it out via an evbuffer. + + This function avoids unnecessary data copies between userland and + kernel. Where available, it uses sendfile or splice. + + The file descriptor must not be closed so long as any evbuffer is using + this segment. + + The results of using evbuffer_remove() or evbuffer_pullup() or any other + function that reads bytes from an evbuffer on any evbuffer containing + the newly returned segment are undefined, unless you pass the + EVBUF_FS_DISABLE_SENDFILE flag to this function. + + @param fd an open file to read from. + @param offset an index within the file at which to start reading + @param length how much data to read, or -1 to read as much as possible. + (-1 requires that 'fd' support fstat.) + @param flags any number of the EVBUF_FS_* flags + @return a new evbuffer_file_segment, or NULL on failure. + **/ +EVENT2_EXPORT_SYMBOL +struct evbuffer_file_segment *evbuffer_file_segment_new( + int fd, ev_off_t offset, ev_off_t length, unsigned flags); + +/** + Free an evbuffer_file_segment + + It is safe to call this function even if the segment has been added to + one or more evbuffers. The evbuffer_file_segment will not be freed + until no more references to it exist. + */ +EVENT2_EXPORT_SYMBOL +void evbuffer_file_segment_free(struct evbuffer_file_segment *seg); + +/** + Add cleanup callback and argument for the callback to an + evbuffer_file_segment. + + The cleanup callback will be invoked when no more references to the + evbuffer_file_segment exist. + **/ +EVENT2_EXPORT_SYMBOL +void evbuffer_file_segment_add_cleanup_cb(struct evbuffer_file_segment *seg, + evbuffer_file_segment_cleanup_cb cb, void* arg); + +/** + Insert some or all of an evbuffer_file_segment at the end of an evbuffer + + Note that the offset and length parameters of this function have a + different meaning from those provided to evbuffer_file_segment_new: When + you create the segment, the offset is the offset _within the file_, and + the length is the length _of the segment_, whereas when you add a + segment to an evbuffer, the offset is _within the segment_ and the + length is the length of the _part of the segment you want to use. + + In other words, if you have a 10 KiB file, and you create an + evbuffer_file_segment for it with offset 20 and length 1000, it will + refer to bytes 20..1019 inclusive. If you then pass this segment to + evbuffer_add_file_segment and specify an offset of 20 and a length of + 50, you will be adding bytes 40..99 inclusive. + + @param buf the evbuffer to append to + @param seg the segment to add + @param offset the offset within the segment to start from + @param length the amount of data to add, or -1 to add it all. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_file_segment(struct evbuffer *buf, + struct evbuffer_file_segment *seg, ev_off_t offset, ev_off_t length); + +/** + Append a formatted string to the end of an evbuffer. + + The string is formated as printf. + + @param buf the evbuffer that will be appended to + @param fmt a format string + @param ... arguments that will be passed to printf(3) + @return The number of bytes added if successful, or -1 if an error occurred. + + @see evutil_printf(), evbuffer_add_vprintf() + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_printf(struct evbuffer *buf, const char *fmt, ...) +#ifdef __GNUC__ + __attribute__((format(printf, 2, 3))) +#endif +; + +/** + Append a va_list formatted string to the end of an evbuffer. + + @param buf the evbuffer that will be appended to + @param fmt a format string + @param ap a varargs va_list argument array that will be passed to vprintf(3) + @return The number of bytes added if successful, or -1 if an error occurred. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_vprintf(struct evbuffer *buf, const char *fmt, va_list ap) +#ifdef __GNUC__ + __attribute__((format(printf, 2, 0))) +#endif +; + + +/** + Remove a specified number of bytes data from the beginning of an evbuffer. + + @param buf the evbuffer to be drained + @param len the number of bytes to drain from the beginning of the buffer + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_drain(struct evbuffer *buf, size_t len); + + +/** + Write the contents of an evbuffer to a file descriptor. + + The evbuffer will be drained after the bytes have been successfully written. + + @param buffer the evbuffer to be written and drained + @param fd the file descriptor to be written to + @return the number of bytes written, or -1 if an error occurred + @see evbuffer_read() + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_write(struct evbuffer *buffer, evutil_socket_t fd); + +/** + Write some of the contents of an evbuffer to a file descriptor. + + The evbuffer will be drained after the bytes have been successfully written. + + @param buffer the evbuffer to be written and drained + @param fd the file descriptor to be written to + @param howmuch the largest allowable number of bytes to write, or -1 + to write as many bytes as we can. + @return the number of bytes written, or -1 if an error occurred + @see evbuffer_read() + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_write_atmost(struct evbuffer *buffer, evutil_socket_t fd, + ev_ssize_t howmuch); + +/** + Read from a file descriptor and store the result in an evbuffer. + + @param buffer the evbuffer to store the result + @param fd the file descriptor to read from + @param howmuch the number of bytes to be read + @return the number of bytes read, or -1 if an error occurred + @see evbuffer_write() + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_read(struct evbuffer *buffer, evutil_socket_t fd, int howmuch); + +/** + Search for a string within an evbuffer. + + @param buffer the evbuffer to be searched + @param what the string to be searched for + @param len the length of the search string + @param start NULL or a pointer to a valid struct evbuffer_ptr. + @return a struct evbuffer_ptr whose 'pos' field has the offset of the + first occurrence of the string in the buffer after 'start'. The 'pos' + field of the result is -1 if the string was not found. + */ +EVENT2_EXPORT_SYMBOL +struct evbuffer_ptr evbuffer_search(struct evbuffer *buffer, const char *what, size_t len, const struct evbuffer_ptr *start); + +/** + Search for a string within part of an evbuffer. + + @param buffer the evbuffer to be searched + @param what the string to be searched for + @param len the length of the search string + @param start NULL or a pointer to a valid struct evbuffer_ptr that + indicates where we should start searching. + @param end NULL or a pointer to a valid struct evbuffer_ptr that + indicates where we should stop searching. + @return a struct evbuffer_ptr whose 'pos' field has the offset of the + first occurrence of the string in the buffer after 'start'. The 'pos' + field of the result is -1 if the string was not found. + */ +EVENT2_EXPORT_SYMBOL +struct evbuffer_ptr evbuffer_search_range(struct evbuffer *buffer, const char *what, size_t len, const struct evbuffer_ptr *start, const struct evbuffer_ptr *end); + +/** + Defines how to adjust an evbuffer_ptr by evbuffer_ptr_set() + + @see evbuffer_ptr_set() */ +enum evbuffer_ptr_how { + /** Sets the pointer to the position; can be called on with an + uninitialized evbuffer_ptr. */ + EVBUFFER_PTR_SET, + /** Advances the pointer by adding to the current position. */ + EVBUFFER_PTR_ADD +}; + +/** + Sets the search pointer in the buffer to position. + + There are two ways to use this function: you can call + evbuffer_ptr_set(buf, &pos, N, EVBUFFER_PTR_SET) + to move 'pos' to a position 'N' bytes after the start of the buffer, or + evbuffer_ptr_set(buf, &pos, N, EVBUFFER_PTR_ADD) + to move 'pos' forward by 'N' bytes. + + If evbuffer_ptr is not initialized, this function can only be called + with EVBUFFER_PTR_SET. + + An evbuffer_ptr can represent any position from the start of the buffer to + a position immediately after the end of the buffer. + + @param buffer the evbuffer to be search + @param ptr a pointer to a struct evbuffer_ptr + @param position the position at which to start the next search + @param how determines how the pointer should be manipulated. + @returns 0 on success or -1 otherwise +*/ +EVENT2_EXPORT_SYMBOL +int +evbuffer_ptr_set(struct evbuffer *buffer, struct evbuffer_ptr *ptr, + size_t position, enum evbuffer_ptr_how how); + +/** + Search for an end-of-line string within an evbuffer. + + @param buffer the evbuffer to be searched + @param start NULL or a pointer to a valid struct evbuffer_ptr to start + searching at. + @param eol_len_out If non-NULL, the pointed-to value will be set to + the length of the end-of-line string. + @param eol_style The kind of EOL to look for; see evbuffer_readln() for + more information + @return a struct evbuffer_ptr whose 'pos' field has the offset of the + first occurrence EOL in the buffer after 'start'. The 'pos' + field of the result is -1 if the string was not found. + */ +EVENT2_EXPORT_SYMBOL +struct evbuffer_ptr evbuffer_search_eol(struct evbuffer *buffer, + struct evbuffer_ptr *start, size_t *eol_len_out, + enum evbuffer_eol_style eol_style); + +/** Function to peek at data inside an evbuffer without removing it or + copying it out. + + Pointers to the data are returned by filling the 'vec_out' array + with pointers to one or more extents of data inside the buffer. + + The total data in the extents that you get back may be more than + you requested (if there is more data last extent than you asked + for), or less (if you do not provide enough evbuffer_iovecs, or if + the buffer does not have as much data as you asked to see). + + @param buffer the evbuffer to peek into, + @param len the number of bytes to try to peek. If len is negative, we + will try to fill as much of vec_out as we can. If len is negative + and vec_out is not provided, we return the number of evbuffer_iovecs + that would be needed to get all the data in the buffer. + @param start_at an evbuffer_ptr indicating the point at which we + should start looking for data. NULL means, "At the start of the + buffer." + @param vec_out an array of evbuffer_iovec + @param n_vec the length of vec_out. If 0, we only count how many + extents would be necessary to point to the requested amount of + data. + @return The number of extents needed. This may be less than n_vec + if we didn't need all the evbuffer_iovecs we were given, or more + than n_vec if we would need more to return all the data that was + requested. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_peek(struct evbuffer *buffer, ev_ssize_t len, + struct evbuffer_ptr *start_at, + struct evbuffer_iovec *vec_out, int n_vec); + + +/** Structure passed to an evbuffer_cb_func evbuffer callback + + @see evbuffer_cb_func, evbuffer_add_cb() + */ +struct evbuffer_cb_info { + /** The number of bytes in this evbuffer when callbacks were last + * invoked. */ + size_t orig_size; + /** The number of bytes added since callbacks were last invoked. */ + size_t n_added; + /** The number of bytes removed since callbacks were last invoked. */ + size_t n_deleted; +}; + +/** Type definition for a callback that is invoked whenever data is added or + removed from an evbuffer. + + An evbuffer may have one or more callbacks set at a time. The order + in which they are executed is undefined. + + A callback function may add more callbacks, or remove itself from the + list of callbacks, or add or remove data from the buffer. It may not + remove another callback from the list. + + If a callback adds or removes data from the buffer or from another + buffer, this can cause a recursive invocation of your callback or + other callbacks. If you ask for an infinite loop, you might just get + one: watch out! + + @param buffer the buffer whose size has changed + @param info a structure describing how the buffer changed. + @param arg a pointer to user data +*/ +typedef void (*evbuffer_cb_func)(struct evbuffer *buffer, const struct evbuffer_cb_info *info, void *arg); + +struct evbuffer_cb_entry; +/** Add a new callback to an evbuffer. + + Subsequent calls to evbuffer_add_cb() add new callbacks. To remove this + callback, call evbuffer_remove_cb or evbuffer_remove_cb_entry. + + @param buffer the evbuffer to be monitored + @param cb the callback function to invoke when the evbuffer is modified, + or NULL to remove all callbacks. + @param cbarg an argument to be provided to the callback function + @return a handle to the callback on success, or NULL on failure. + */ +EVENT2_EXPORT_SYMBOL +struct evbuffer_cb_entry *evbuffer_add_cb(struct evbuffer *buffer, evbuffer_cb_func cb, void *cbarg); + +/** Remove a callback from an evbuffer, given a handle returned from + evbuffer_add_cb. + + Calling this function invalidates the handle. + + @return 0 if a callback was removed, or -1 if no matching callback was + found. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_remove_cb_entry(struct evbuffer *buffer, + struct evbuffer_cb_entry *ent); + +/** Remove a callback from an evbuffer, given the function and argument + used to add it. + + @return 0 if a callback was removed, or -1 if no matching callback was + found. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_remove_cb(struct evbuffer *buffer, evbuffer_cb_func cb, void *cbarg); + +/** If this flag is not set, then a callback is temporarily disabled, and + * should not be invoked. + * + * @see evbuffer_cb_set_flags(), evbuffer_cb_clear_flags() + */ +#define EVBUFFER_CB_ENABLED 1 + +/** Change the flags that are set for a callback on a buffer by adding more. + + @param buffer the evbuffer that the callback is watching. + @param cb the callback whose status we want to change. + @param flags EVBUFFER_CB_ENABLED to re-enable the callback. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_cb_set_flags(struct evbuffer *buffer, + struct evbuffer_cb_entry *cb, ev_uint32_t flags); + +/** Change the flags that are set for a callback on a buffer by removing some + + @param buffer the evbuffer that the callback is watching. + @param cb the callback whose status we want to change. + @param flags EVBUFFER_CB_ENABLED to disable the callback. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_cb_clear_flags(struct evbuffer *buffer, + struct evbuffer_cb_entry *cb, ev_uint32_t flags); + +#if 0 +/** Postpone calling a given callback until unsuspend is called later. + + This is different from disabling the callback, since the callback will get + invoked later if the buffer size changes between now and when we unsuspend + it. + + @param the buffer that the callback is watching. + @param cb the callback we want to suspend. + */ +EVENT2_EXPORT_SYMBOL +void evbuffer_cb_suspend(struct evbuffer *buffer, struct evbuffer_cb_entry *cb); +/** Stop postponing a callback that we postponed with evbuffer_cb_suspend. + + If data was added to or removed from the buffer while the callback was + suspended, the callback will get called once now. + + @param the buffer that the callback is watching. + @param cb the callback we want to stop suspending. + */ +EVENT2_EXPORT_SYMBOL +void evbuffer_cb_unsuspend(struct evbuffer *buffer, struct evbuffer_cb_entry *cb); +#endif + +/** + Makes the data at the beginning of an evbuffer contiguous. + + @param buf the evbuffer to make contiguous + @param size the number of bytes to make contiguous, or -1 to make the + entire buffer contiguous. + @return a pointer to the contiguous memory array, or NULL if param size + requested more data than is present in the buffer. +*/ + +EVENT2_EXPORT_SYMBOL +unsigned char *evbuffer_pullup(struct evbuffer *buf, ev_ssize_t size); + +/** + Prepends data to the beginning of the evbuffer + + @param buf the evbuffer to which to prepend data + @param data a pointer to the memory to prepend + @param size the number of bytes to prepend + @return 0 if successful, or -1 otherwise +*/ + +EVENT2_EXPORT_SYMBOL +int evbuffer_prepend(struct evbuffer *buf, const void *data, size_t size); + +/** + Prepends all data from the src evbuffer to the beginning of the dst + evbuffer. + + @param dst the evbuffer to which to prepend data + @param src the evbuffer to prepend; it will be emptied as a result + @return 0 if successful, or -1 otherwise +*/ +EVENT2_EXPORT_SYMBOL +int evbuffer_prepend_buffer(struct evbuffer *dst, struct evbuffer* src); + +/** + Prevent calls that modify an evbuffer from succeeding. A buffer may + frozen at the front, at the back, or at both the front and the back. + + If the front of a buffer is frozen, operations that drain data from + the front of the buffer, or that prepend data to the buffer, will + fail until it is unfrozen. If the back a buffer is frozen, operations + that append data from the buffer will fail until it is unfrozen. + + @param buf The buffer to freeze + @param at_front If true, we freeze the front of the buffer. If false, + we freeze the back. + @return 0 on success, -1 on failure. +*/ +EVENT2_EXPORT_SYMBOL +int evbuffer_freeze(struct evbuffer *buf, int at_front); +/** + Re-enable calls that modify an evbuffer. + + @param buf The buffer to un-freeze + @param at_front If true, we unfreeze the front of the buffer. If false, + we unfreeze the back. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_unfreeze(struct evbuffer *buf, int at_front); + +struct event_base; +/** + Force all the callbacks on an evbuffer to be run, not immediately after + the evbuffer is altered, but instead from inside the event loop. + + This can be used to serialize all the callbacks to a single thread + of execution. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_defer_callbacks(struct evbuffer *buffer, struct event_base *base); + +/** + Append data from 1 or more iovec's to an evbuffer + + Calculates the number of bytes needed for an iovec structure and guarantees + all data will fit into a single chain. Can be used in lieu of functionality + which calls evbuffer_add() constantly before being used to increase + performance. + + @param buffer the destination buffer + @param vec the source iovec + @param n_vec the number of iovec structures. + @return the number of bytes successfully written to the output buffer. +*/ +EVENT2_EXPORT_SYMBOL +size_t evbuffer_add_iovec(struct evbuffer * buffer, struct evbuffer_iovec * vec, int n_vec); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_BUFFER_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/buffer_compat.h b/Source/Import/libevent/Includes/Linux/event2/buffer_compat.h new file mode 100644 index 0000000..24f828c --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/buffer_compat.h @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef EVENT2_BUFFER_COMPAT_H_INCLUDED_ +#define EVENT2_BUFFER_COMPAT_H_INCLUDED_ + +#include + +/** @file event2/buffer_compat.h + + Obsolete and deprecated versions of the functions in buffer.h: provided + only for backward compatibility. + */ + + +/** + Obsolete alias for evbuffer_readln(buffer, NULL, EVBUFFER_EOL_ANY). + + @deprecated This function is deprecated because its behavior is not correct + for almost any protocol, and also because it's wholly subsumed by + evbuffer_readln(). + + @param buffer the evbuffer to read from + @return pointer to a single line, or NULL if an error occurred + +*/ +EVENT2_EXPORT_SYMBOL +char *evbuffer_readline(struct evbuffer *buffer); + +/** Type definition for a callback that is invoked whenever data is added or + removed from an evbuffer. + + An evbuffer may have one or more callbacks set at a time. The order + in which they are executed is undefined. + + A callback function may add more callbacks, or remove itself from the + list of callbacks, or add or remove data from the buffer. It may not + remove another callback from the list. + + If a callback adds or removes data from the buffer or from another + buffer, this can cause a recursive invocation of your callback or + other callbacks. If you ask for an infinite loop, you might just get + one: watch out! + + @param buffer the buffer whose size has changed + @param old_len the previous length of the buffer + @param new_len the current length of the buffer + @param arg a pointer to user data +*/ +typedef void (*evbuffer_cb)(struct evbuffer *buffer, size_t old_len, size_t new_len, void *arg); + +/** + Replace all callbacks on an evbuffer with a single new callback, or + remove them. + + Subsequent calls to evbuffer_setcb() replace callbacks set by previous + calls. Setting the callback to NULL removes any previously set callback. + + @deprecated This function is deprecated because it clears all previous + callbacks set on the evbuffer, which can cause confusing behavior if + multiple parts of the code all want to add their own callbacks on a + buffer. Instead, use evbuffer_add(), evbuffer_del(), and + evbuffer_setflags() to manage your own evbuffer callbacks without + interfering with callbacks set by others. + + @param buffer the evbuffer to be monitored + @param cb the callback function to invoke when the evbuffer is modified, + or NULL to remove all callbacks. + @param cbarg an argument to be provided to the callback function + */ +EVENT2_EXPORT_SYMBOL +void evbuffer_setcb(struct evbuffer *buffer, evbuffer_cb cb, void *cbarg); + + +/** + Find a string within an evbuffer. + + @param buffer the evbuffer to be searched + @param what the string to be searched for + @param len the length of the search string + @return a pointer to the beginning of the search string, or NULL if the search failed. + */ +EVENT2_EXPORT_SYMBOL +unsigned char *evbuffer_find(struct evbuffer *buffer, const unsigned char *what, size_t len); + +/** deprecated in favor of calling the functions directly */ +#define EVBUFFER_LENGTH(x) evbuffer_get_length(x) +/** deprecated in favor of calling the functions directly */ +#define EVBUFFER_DATA(x) evbuffer_pullup((x), -1) + +#endif + diff --git a/Source/Import/libevent/Includes/Linux/event2/bufferevent.h b/Source/Import/libevent/Includes/Linux/event2/bufferevent.h new file mode 100644 index 0000000..825918e --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/bufferevent.h @@ -0,0 +1,1021 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_BUFFEREVENT_H_INCLUDED_ +#define EVENT2_BUFFEREVENT_H_INCLUDED_ + +/** + @file event2/bufferevent.h + + Functions for buffering data for network sending or receiving. Bufferevents + are higher level than evbuffers: each has an underlying evbuffer for reading + and one for writing, and callbacks that are invoked under certain + circumstances. + + A bufferevent provides input and output buffers that get filled and + drained automatically. The user of a bufferevent no longer deals + directly with the I/O, but instead is reading from input and writing + to output buffers. + + Once initialized, the bufferevent structure can be used repeatedly + with bufferevent_enable() and bufferevent_disable(). + + When reading is enabled, the bufferevent will try to read from the + file descriptor onto its input buffer, and call the read callback. + When writing is enabled, the bufferevent will try to write data onto its + file descriptor when the output buffer has enough data, and call the write + callback when the output buffer is sufficiently drained. + + Bufferevents come in several flavors, including: + +
+
Socket-based bufferevents
+
A bufferevent that reads and writes data onto a network + socket. Created with bufferevent_socket_new().
+ +
Paired bufferevents
+
A pair of bufferevents that send and receive data to one + another without touching the network. Created with + bufferevent_pair_new().
+ +
Filtering bufferevents
+
A bufferevent that transforms data, and sends or receives it + over another underlying bufferevent. Created with + bufferevent_filter_new().
+ +
SSL-backed bufferevents
+
A bufferevent that uses the openssl library to send and + receive data over an encrypted connection. Created with + bufferevent_openssl_socket_new() or + bufferevent_openssl_filter_new().
+
+ */ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/** @name Bufferevent event codes + + These flags are passed as arguments to a bufferevent's event callback. + + @{ +*/ +#define BEV_EVENT_READING 0x01 /**< error encountered while reading */ +#define BEV_EVENT_WRITING 0x02 /**< error encountered while writing */ +#define BEV_EVENT_EOF 0x10 /**< eof file reached */ +#define BEV_EVENT_ERROR 0x20 /**< unrecoverable error encountered */ +#define BEV_EVENT_TIMEOUT 0x40 /**< user-specified timeout reached */ +#define BEV_EVENT_CONNECTED 0x80 /**< connect operation finished. */ +/**@}*/ + +/** + An opaque type for handling buffered IO + + @see event2/bufferevent.h + */ +struct bufferevent +#ifdef EVENT_IN_DOXYGEN_ +{} +#endif +; +struct event_base; +struct evbuffer; +struct sockaddr; + +/** + A read or write callback for a bufferevent. + + The read callback is triggered when new data arrives in the input + buffer and the amount of readable data exceed the low watermark + which is 0 by default. + + The write callback is triggered if the write buffer has been + exhausted or fell below its low watermark. + + @param bev the bufferevent that triggered the callback + @param ctx the user-specified context for this bufferevent + */ +typedef void (*bufferevent_data_cb)(struct bufferevent *bev, void *ctx); + +/** + An event/error callback for a bufferevent. + + The event callback is triggered if either an EOF condition or another + unrecoverable error was encountered. + + For bufferevents with deferred callbacks, this is a bitwise OR of all errors + that have happened on the bufferevent since the last callback invocation. + + @param bev the bufferevent for which the error condition was reached + @param what a conjunction of flags: BEV_EVENT_READING or BEV_EVENT_WRITING + to indicate if the error was encountered on the read or write path, + and one of the following flags: BEV_EVENT_EOF, BEV_EVENT_ERROR, + BEV_EVENT_TIMEOUT, BEV_EVENT_CONNECTED. + + @param ctx the user-specified context for this bufferevent +*/ +typedef void (*bufferevent_event_cb)(struct bufferevent *bev, short what, void *ctx); + +/** Options that can be specified when creating a bufferevent */ +enum bufferevent_options { + /** If set, we close the underlying file + * descriptor/bufferevent/whatever when this bufferevent is freed. */ + BEV_OPT_CLOSE_ON_FREE = (1<<0), + + /** If set, and threading is enabled, operations on this bufferevent + * are protected by a lock */ + BEV_OPT_THREADSAFE = (1<<1), + + /** If set, callbacks are run deferred in the event loop. */ + BEV_OPT_DEFER_CALLBACKS = (1<<2), + + /** If set, callbacks are executed without locks being held on the + * bufferevent. This option currently requires that + * BEV_OPT_DEFER_CALLBACKS also be set; a future version of Libevent + * might remove the requirement.*/ + BEV_OPT_UNLOCK_CALLBACKS = (1<<3) +}; + +/** + Create a new socket bufferevent over an existing socket. + + @param base the event base to associate with the new bufferevent. + @param fd the file descriptor from which data is read and written to. + This file descriptor is not allowed to be a pipe(2). + It is safe to set the fd to -1, so long as you later + set it with bufferevent_setfd or bufferevent_socket_connect(). + @param options Zero or more BEV_OPT_* flags + @return a pointer to a newly allocated bufferevent struct, or NULL if an + error occurred + @see bufferevent_free() + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent *bufferevent_socket_new(struct event_base *base, evutil_socket_t fd, int options); + +/** + Launch a connect() attempt with a socket-based bufferevent. + + When the connect succeeds, the eventcb will be invoked with + BEV_EVENT_CONNECTED set. + + If the bufferevent does not already have a socket set, we allocate a new + socket here and make it nonblocking before we begin. + + If no address is provided, we assume that the socket is already connecting, + and configure the bufferevent so that a BEV_EVENT_CONNECTED event will be + yielded when it is done connecting. + + @param bufev an existing bufferevent allocated with + bufferevent_socket_new(). + @param addr the address we should connect to + @param socklen The length of the address + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_socket_connect(struct bufferevent *, const struct sockaddr *, int); + +struct evdns_base; +/** + Resolve the hostname 'hostname' and connect to it as with + bufferevent_socket_connect(). + + @param bufev An existing bufferevent allocated with bufferevent_socket_new() + @param evdns_base Optionally, an evdns_base to use for resolving hostnames + asynchronously. May be set to NULL for a blocking resolve. + @param family A preferred address family to resolve addresses to, or + AF_UNSPEC for no preference. Only AF_INET, AF_INET6, and AF_UNSPEC are + supported. + @param hostname The hostname to resolve; see below for notes on recognized + formats + @param port The port to connect to on the resolved address. + @return 0 if successful, -1 on failure. + + Recognized hostname formats are: + + www.example.com (hostname) + 1.2.3.4 (ipv4address) + ::1 (ipv6address) + [::1] ([ipv6address]) + + Performance note: If you do not provide an evdns_base, this function + may block while it waits for a DNS response. This is probably not + what you want. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_socket_connect_hostname(struct bufferevent *, + struct evdns_base *, int, const char *, int); + +/** + Return the error code for the last failed DNS lookup attempt made by + bufferevent_socket_connect_hostname(). + + @param bev The bufferevent object. + @return DNS error code. + @see evutil_gai_strerror() +*/ +EVENT2_EXPORT_SYMBOL +int bufferevent_socket_get_dns_error(struct bufferevent *bev); + +/** + Assign a bufferevent to a specific event_base. + + NOTE that only socket bufferevents support this function. + + @param base an event_base returned by event_init() + @param bufev a bufferevent struct returned by bufferevent_new() + or bufferevent_socket_new() + @return 0 if successful, or -1 if an error occurred + @see bufferevent_new() + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_base_set(struct event_base *base, struct bufferevent *bufev); + +/** + Return the event_base used by a bufferevent +*/ +EVENT2_EXPORT_SYMBOL +struct event_base *bufferevent_get_base(struct bufferevent *bev); + +/** + Assign a priority to a bufferevent. + + Only supported for socket bufferevents. + + @param bufev a bufferevent struct + @param pri the priority to be assigned + @return 0 if successful, or -1 if an error occurred + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_priority_set(struct bufferevent *bufev, int pri); + +/** + Return the priority of a bufferevent. + + Only supported for socket bufferevents + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_get_priority(const struct bufferevent *bufev); + +/** + Deallocate the storage associated with a bufferevent structure. + + If there is pending data to write on the bufferevent, it probably won't be + flushed before the bufferevent is freed. + + @param bufev the bufferevent structure to be freed. + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_free(struct bufferevent *bufev); + + +/** + Changes the callbacks for a bufferevent. + + @param bufev the bufferevent object for which to change callbacks + @param readcb callback to invoke when there is data to be read, or NULL if + no callback is desired + @param writecb callback to invoke when the file descriptor is ready for + writing, or NULL if no callback is desired + @param eventcb callback to invoke when there is an event on the file + descriptor + @param cbarg an argument that will be supplied to each of the callbacks + (readcb, writecb, and errorcb) + @see bufferevent_new() + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_setcb(struct bufferevent *bufev, + bufferevent_data_cb readcb, bufferevent_data_cb writecb, + bufferevent_event_cb eventcb, void *cbarg); + +/** + Retrieves the callbacks for a bufferevent. + + @param bufev the bufferevent to examine. + @param readcb_ptr if readcb_ptr is nonnull, *readcb_ptr is set to the current + read callback for the bufferevent. + @param writecb_ptr if writecb_ptr is nonnull, *writecb_ptr is set to the + current write callback for the bufferevent. + @param eventcb_ptr if eventcb_ptr is nonnull, *eventcb_ptr is set to the + current event callback for the bufferevent. + @param cbarg_ptr if cbarg_ptr is nonnull, *cbarg_ptr is set to the current + callback argument for the bufferevent. + @see buffervent_setcb() +*/ +EVENT2_EXPORT_SYMBOL +void bufferevent_getcb(struct bufferevent *bufev, + bufferevent_data_cb *readcb_ptr, + bufferevent_data_cb *writecb_ptr, + bufferevent_event_cb *eventcb_ptr, + void **cbarg_ptr); + +/** + Changes the file descriptor on which the bufferevent operates. + Not supported for all bufferevent types. + + @param bufev the bufferevent object for which to change the file descriptor + @param fd the file descriptor to operate on +*/ +EVENT2_EXPORT_SYMBOL +int bufferevent_setfd(struct bufferevent *bufev, evutil_socket_t fd); + +/** + Returns the file descriptor associated with a bufferevent, or -1 if + no file descriptor is associated with the bufferevent. + */ +EVENT2_EXPORT_SYMBOL +evutil_socket_t bufferevent_getfd(struct bufferevent *bufev); + +/** + Returns the underlying bufferevent associated with a bufferevent (if + the bufferevent is a wrapper), or NULL if there is no underlying bufferevent. + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent *bufferevent_get_underlying(struct bufferevent *bufev); + +/** + Write data to a bufferevent buffer. + + The bufferevent_write() function can be used to write data to the file + descriptor. The data is appended to the output buffer and written to the + descriptor automatically as it becomes available for writing. + + @param bufev the bufferevent to be written to + @param data a pointer to the data to be written + @param size the length of the data, in bytes + @return 0 if successful, or -1 if an error occurred + @see bufferevent_write_buffer() + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_write(struct bufferevent *bufev, + const void *data, size_t size); + + +/** + Write data from an evbuffer to a bufferevent buffer. The evbuffer is + being drained as a result. + + @param bufev the bufferevent to be written to + @param buf the evbuffer to be written + @return 0 if successful, or -1 if an error occurred + @see bufferevent_write() + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_write_buffer(struct bufferevent *bufev, struct evbuffer *buf); + + +/** + Read data from a bufferevent buffer. + + The bufferevent_read() function is used to read data from the input buffer. + + @param bufev the bufferevent to be read from + @param data pointer to a buffer that will store the data + @param size the size of the data buffer, in bytes + @return the amount of data read, in bytes. + */ +EVENT2_EXPORT_SYMBOL +size_t bufferevent_read(struct bufferevent *bufev, void *data, size_t size); + +/** + Read data from a bufferevent buffer into an evbuffer. This avoids + memory copies. + + @param bufev the bufferevent to be read from + @param buf the evbuffer to which to add data + @return 0 if successful, or -1 if an error occurred. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_read_buffer(struct bufferevent *bufev, struct evbuffer *buf); + +/** + Returns the input buffer. + + The user MUST NOT set the callback on this buffer. + + @param bufev the bufferevent from which to get the evbuffer + @return the evbuffer object for the input buffer + */ + +EVENT2_EXPORT_SYMBOL +struct evbuffer *bufferevent_get_input(struct bufferevent *bufev); + +/** + Returns the output buffer. + + The user MUST NOT set the callback on this buffer. + + When filters are being used, the filters need to be manually + triggered if the output buffer was manipulated. + + @param bufev the bufferevent from which to get the evbuffer + @return the evbuffer object for the output buffer + */ + +EVENT2_EXPORT_SYMBOL +struct evbuffer *bufferevent_get_output(struct bufferevent *bufev); + +/** + Enable a bufferevent. + + @param bufev the bufferevent to be enabled + @param event any combination of EV_READ | EV_WRITE. + @return 0 if successful, or -1 if an error occurred + @see bufferevent_disable() + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_enable(struct bufferevent *bufev, short event); + +/** + Disable a bufferevent. + + @param bufev the bufferevent to be disabled + @param event any combination of EV_READ | EV_WRITE. + @return 0 if successful, or -1 if an error occurred + @see bufferevent_enable() + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_disable(struct bufferevent *bufev, short event); + +/** + Return the events that are enabled on a given bufferevent. + + @param bufev the bufferevent to inspect + @return A combination of EV_READ | EV_WRITE + */ +EVENT2_EXPORT_SYMBOL +short bufferevent_get_enabled(struct bufferevent *bufev); + +/** + Set the read and write timeout for a bufferevent. + + A bufferevent's timeout will fire the first time that the indicated + amount of time has elapsed since a successful read or write operation, + during which the bufferevent was trying to read or write. + + (In other words, if reading or writing is disabled, or if the + bufferevent's read or write operation has been suspended because + there's no data to write, or not enough banwidth, or so on, the + timeout isn't active. The timeout only becomes active when we we're + willing to actually read or write.) + + Calling bufferevent_enable or setting a timeout for a bufferevent + whose timeout is already pending resets its timeout. + + If the timeout elapses, the corresponding operation (EV_READ or + EV_WRITE) becomes disabled until you re-enable it again. The + bufferevent's event callback is called with the + BEV_EVENT_TIMEOUT|BEV_EVENT_READING or + BEV_EVENT_TIMEOUT|BEV_EVENT_WRITING. + + @param bufev the bufferevent to be modified + @param timeout_read the read timeout, or NULL + @param timeout_write the write timeout, or NULL + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_set_timeouts(struct bufferevent *bufev, + const struct timeval *timeout_read, const struct timeval *timeout_write); + +/** + Sets the watermarks for read and write events. + + On input, a bufferevent does not invoke the user read callback unless + there is at least low watermark data in the buffer. If the read buffer + is beyond the high watermark, the bufferevent stops reading from the network. + + On output, the user write callback is invoked whenever the buffered data + falls below the low watermark. Filters that write to this bufev will try + not to write more bytes to this buffer than the high watermark would allow, + except when flushing. + + @param bufev the bufferevent to be modified + @param events EV_READ, EV_WRITE or both + @param lowmark the lower watermark to set + @param highmark the high watermark to set +*/ + +EVENT2_EXPORT_SYMBOL +void bufferevent_setwatermark(struct bufferevent *bufev, short events, + size_t lowmark, size_t highmark); + +/** + Retrieves the watermarks for read or write events. + Returns non-zero if events contains not only EV_READ or EV_WRITE. + Returns zero if events equal EV_READ or EV_WRITE + + @param bufev the bufferevent to be examined + @param events EV_READ or EV_WRITE + @param lowmark receives the lower watermark if not NULL + @param highmark receives the high watermark if not NULL +*/ +EVENT2_EXPORT_SYMBOL +int bufferevent_getwatermark(struct bufferevent *bufev, short events, + size_t *lowmark, size_t *highmark); + +/** + Acquire the lock on a bufferevent. Has no effect if locking was not + enabled with BEV_OPT_THREADSAFE. + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_lock(struct bufferevent *bufev); + +/** + Release the lock on a bufferevent. Has no effect if locking was not + enabled with BEV_OPT_THREADSAFE. + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_unlock(struct bufferevent *bufev); + + +/** + * Public interface to manually increase the reference count of a bufferevent + * this is useful in situations where a user may reference the bufferevent + * somewhere eles (unknown to libevent) + * + * @param bufev the bufferevent to increase the refcount on + * + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_incref(struct bufferevent *bufev); + +/** + * Public interface to manually decrement the reference count of a bufferevent + * + * Warning: make sure you know what you're doing. This is mainly used in + * conjunction with bufferevent_incref(). This will free up all data associated + * with a bufferevent if the reference count hits 0. + * + * @param bufev the bufferevent to decrement the refcount on + * + * @return 1 if the bufferevent was freed, otherwise 0 (still referenced) + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_decref(struct bufferevent *bufev); + +/** + Flags that can be passed into filters to let them know how to + deal with the incoming data. +*/ +enum bufferevent_flush_mode { + /** usually set when processing data */ + BEV_NORMAL = 0, + + /** want to checkpoint all data sent. */ + BEV_FLUSH = 1, + + /** encountered EOF on read or done sending data */ + BEV_FINISHED = 2 +}; + +/** + Triggers the bufferevent to produce more data if possible. + + @param bufev the bufferevent object + @param iotype either EV_READ or EV_WRITE or both. + @param mode either BEV_NORMAL or BEV_FLUSH or BEV_FINISHED + @return -1 on failure, 0 if no data was produces, 1 if data was produced + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_flush(struct bufferevent *bufev, + short iotype, + enum bufferevent_flush_mode mode); + +/** + Flags for bufferevent_trigger(_event) that modify when and how to trigger + the callback. +*/ +enum bufferevent_trigger_options { + /** trigger the callback regardless of the watermarks */ + BEV_TRIG_IGNORE_WATERMARKS = (1<<16), + + /** defer even if the callbacks are not */ + BEV_TRIG_DEFER_CALLBACKS = BEV_OPT_DEFER_CALLBACKS + + /* (Note: for internal reasons, these need to be disjoint from + * bufferevent_options, except when they mean the same thing. */ +}; + +/** + Triggers bufferevent data callbacks. + + The function will honor watermarks unless options contain + BEV_TRIG_IGNORE_WATERMARKS. If the options contain BEV_OPT_DEFER_CALLBACKS, + the callbacks are deferred. + + @param bufev the bufferevent object + @param iotype either EV_READ or EV_WRITE or both. + @param options + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_trigger(struct bufferevent *bufev, short iotype, + int options); + +/** + Triggers the bufferevent event callback. + + If the options contain BEV_OPT_DEFER_CALLBACKS, the callbacks are deferred. + + @param bufev the bufferevent object + @param what the flags to pass onto the event callback + @param options + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_trigger_event(struct bufferevent *bufev, short what, + int options); + +/** + @name Filtering support + + @{ +*/ +/** + Values that filters can return. + */ +enum bufferevent_filter_result { + /** everything is okay */ + BEV_OK = 0, + + /** the filter needs to read more data before output */ + BEV_NEED_MORE = 1, + + /** the filter encountered a critical error, no further data + can be processed. */ + BEV_ERROR = 2 +}; + +/** A callback function to implement a filter for a bufferevent. + + @param src An evbuffer to drain data from. + @param dst An evbuffer to add data to. + @param limit A suggested upper bound of bytes to write to dst. + The filter may ignore this value, but doing so means that + it will overflow the high-water mark associated with dst. + -1 means "no limit". + @param mode Whether we should write data as may be convenient + (BEV_NORMAL), or flush as much data as we can (BEV_FLUSH), + or flush as much as we can, possibly including an end-of-stream + marker (BEV_FINISH). + @param ctx A user-supplied pointer. + + @return BEV_OK if we wrote some data; BEV_NEED_MORE if we can't + produce any more output until we get some input; and BEV_ERROR + on an error. + */ +typedef enum bufferevent_filter_result (*bufferevent_filter_cb)( + struct evbuffer *src, struct evbuffer *dst, ev_ssize_t dst_limit, + enum bufferevent_flush_mode mode, void *ctx); + +/** + Allocate a new filtering bufferevent on top of an existing bufferevent. + + @param underlying the underlying bufferevent. + @param input_filter The filter to apply to data we read from the underlying + bufferevent + @param output_filter The filer to apply to data we write to the underlying + bufferevent + @param options A bitfield of bufferevent options. + @param free_context A function to use to free the filter context when + this bufferevent is freed. + @param ctx A context pointer to pass to the filter functions. + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent * +bufferevent_filter_new(struct bufferevent *underlying, + bufferevent_filter_cb input_filter, + bufferevent_filter_cb output_filter, + int options, + void (*free_context)(void *), + void *ctx); +/**@}*/ + +/** + Allocate a pair of linked bufferevents. The bufferevents behave as would + two bufferevent_sock instances connected to opposite ends of a + socketpair(), except that no internal socketpair is allocated. + + @param base The event base to associate with the socketpair. + @param options A set of options for this bufferevent + @param pair A pointer to an array to hold the two new bufferevent objects. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_pair_new(struct event_base *base, int options, + struct bufferevent *pair[2]); + +/** + Given one bufferevent returned by bufferevent_pair_new(), returns the + other one if it still exists. Otherwise returns NULL. + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent *bufferevent_pair_get_partner(struct bufferevent *bev); + +/** + Abstract type used to configure rate-limiting on a bufferevent or a group + of bufferevents. + */ +struct ev_token_bucket_cfg; + +/** + A group of bufferevents which are configured to respect the same rate + limit. +*/ +struct bufferevent_rate_limit_group; + +/** Maximum configurable rate- or burst-limit. */ +#define EV_RATE_LIMIT_MAX EV_SSIZE_MAX + +/** + Initialize and return a new object to configure the rate-limiting behavior + of bufferevents. + + @param read_rate The maximum number of bytes to read per tick on + average. + @param read_burst The maximum number of bytes to read in any single tick. + @param write_rate The maximum number of bytes to write per tick on + average. + @param write_burst The maximum number of bytes to write in any single tick. + @param tick_len The length of a single tick. Defaults to one second. + Any fractions of a millisecond are ignored. + + Note that all rate-limits hare are currently best-effort: future versions + of Libevent may implement them more tightly. + */ +EVENT2_EXPORT_SYMBOL +struct ev_token_bucket_cfg *ev_token_bucket_cfg_new( + size_t read_rate, size_t read_burst, + size_t write_rate, size_t write_burst, + const struct timeval *tick_len); + +/** Free all storage held in 'cfg'. + + Note: 'cfg' is not currently reference-counted; it is not safe to free it + until no bufferevent is using it. + */ +EVENT2_EXPORT_SYMBOL +void ev_token_bucket_cfg_free(struct ev_token_bucket_cfg *cfg); + +/** + Set the rate-limit of a the bufferevent 'bev' to the one specified in + 'cfg'. If 'cfg' is NULL, disable any per-bufferevent rate-limiting on + 'bev'. + + Note that only some bufferevent types currently respect rate-limiting. + They are: socket-based bufferevents (normal and IOCP-based), and SSL-based + bufferevents. + + Return 0 on sucess, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_set_rate_limit(struct bufferevent *bev, + struct ev_token_bucket_cfg *cfg); + +/** + Create a new rate-limit group for bufferevents. A rate-limit group + constrains the maximum number of bytes sent and received, in toto, + by all of its bufferevents. + + @param base An event_base to run any necessary timeouts for the group. + Note that all bufferevents in the group do not necessarily need to share + this event_base. + @param cfg The rate-limit for this group. + + Note that all rate-limits hare are currently best-effort: future versions + of Libevent may implement them more tightly. + + Note also that only some bufferevent types currently respect rate-limiting. + They are: socket-based bufferevents (normal and IOCP-based), and SSL-based + bufferevents. + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent_rate_limit_group *bufferevent_rate_limit_group_new( + struct event_base *base, + const struct ev_token_bucket_cfg *cfg); +/** + Change the rate-limiting settings for a given rate-limiting group. + + Return 0 on success, -1 on failure. +*/ +EVENT2_EXPORT_SYMBOL +int bufferevent_rate_limit_group_set_cfg( + struct bufferevent_rate_limit_group *, + const struct ev_token_bucket_cfg *); + +/** + Change the smallest quantum we're willing to allocate to any single + bufferevent in a group for reading or writing at a time. + + The rationale is that, because of TCP/IP protocol overheads and kernel + behavior, if a rate-limiting group is so tight on bandwidth that you're + only willing to send 1 byte per tick per bufferevent, you might instead + want to batch up the reads and writes so that you send N bytes per + 1/N of the bufferevents (chosen at random) each tick, so you still wind + up send 1 byte per tick per bufferevent on average, but you don't send + so many tiny packets. + + The default min-share is currently 64 bytes. + + Returns 0 on success, -1 on faulre. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_rate_limit_group_set_min_share( + struct bufferevent_rate_limit_group *, size_t); + +/** + Free a rate-limiting group. The group must have no members when + this function is called. +*/ +EVENT2_EXPORT_SYMBOL +void bufferevent_rate_limit_group_free(struct bufferevent_rate_limit_group *); + +/** + Add 'bev' to the list of bufferevents whose aggregate reading and writing + is restricted by 'g'. If 'g' is NULL, remove 'bev' from its current group. + + A bufferevent may belong to no more than one rate-limit group at a time. + If 'bev' is already a member of a group, it will be removed from its old + group before being added to 'g'. + + Return 0 on success and -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_add_to_rate_limit_group(struct bufferevent *bev, + struct bufferevent_rate_limit_group *g); + +/** Remove 'bev' from its current rate-limit group (if any). */ +EVENT2_EXPORT_SYMBOL +int bufferevent_remove_from_rate_limit_group(struct bufferevent *bev); + +/** + Set the size limit for single read operation. + + Set to 0 for a reasonable default. + + Return 0 on success and -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_set_max_single_read(struct bufferevent *bev, size_t size); + +/** + Set the size limit for single write operation. + + Set to 0 for a reasonable default. + + Return 0 on success and -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_set_max_single_write(struct bufferevent *bev, size_t size); + +/** Get the current size limit for single read operation. */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_max_single_read(struct bufferevent *bev); + +/** Get the current size limit for single write operation. */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_max_single_write(struct bufferevent *bev); + +/** + @name Rate limit inspection + + Return the current read or write bucket size for a bufferevent. + If it is not configured with a per-bufferevent ratelimit, return + EV_SSIZE_MAX. This function does not inspect the group limit, if any. + Note that it can return a negative value if the bufferevent has been + made to read or write more than its limit. + + @{ + */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_read_limit(struct bufferevent *bev); +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_write_limit(struct bufferevent *bev); +/*@}*/ + +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_max_to_read(struct bufferevent *bev); +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_max_to_write(struct bufferevent *bev); + +EVENT2_EXPORT_SYMBOL +const struct ev_token_bucket_cfg *bufferevent_get_token_bucket_cfg(const struct bufferevent * bev); + +/** + @name Group Rate limit inspection + + Return the read or write bucket size for a bufferevent rate limit + group. Note that it can return a negative value if bufferevents in + the group have been made to read or write more than their limits. + + @{ + */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_rate_limit_group_get_read_limit( + struct bufferevent_rate_limit_group *); +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_rate_limit_group_get_write_limit( + struct bufferevent_rate_limit_group *); +/*@}*/ + +/** + @name Rate limit manipulation + + Subtract a number of bytes from a bufferevent's read or write bucket. + The decrement value can be negative, if you want to manually refill + the bucket. If the change puts the bucket above or below zero, the + bufferevent will resume or suspend reading writing as appropriate. + These functions make no change in the buckets for the bufferevent's + group, if any. + + Returns 0 on success, -1 on internal error. + + @{ + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_decrement_read_limit(struct bufferevent *bev, ev_ssize_t decr); +EVENT2_EXPORT_SYMBOL +int bufferevent_decrement_write_limit(struct bufferevent *bev, ev_ssize_t decr); +/*@}*/ + +/** + @name Group rate limit manipulation + + Subtract a number of bytes from a bufferevent rate-limiting group's + read or write bucket. The decrement value can be negative, if you + want to manually refill the bucket. If the change puts the bucket + above or below zero, the bufferevents in the group will resume or + suspend reading writing as appropriate. + + Returns 0 on success, -1 on internal error. + + @{ + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_rate_limit_group_decrement_read( + struct bufferevent_rate_limit_group *, ev_ssize_t); +EVENT2_EXPORT_SYMBOL +int bufferevent_rate_limit_group_decrement_write( + struct bufferevent_rate_limit_group *, ev_ssize_t); +/*@}*/ + + +/** + * Inspect the total bytes read/written on a group. + * + * Set the variable pointed to by total_read_out to the total number of bytes + * ever read on grp, and the variable pointed to by total_written_out to the + * total number of bytes ever written on grp. */ +EVENT2_EXPORT_SYMBOL +void bufferevent_rate_limit_group_get_totals( + struct bufferevent_rate_limit_group *grp, + ev_uint64_t *total_read_out, ev_uint64_t *total_written_out); + +/** + * Reset the total bytes read/written on a group. + * + * Reset the number of bytes read or written on grp as given by + * bufferevent_rate_limit_group_reset_totals(). */ +EVENT2_EXPORT_SYMBOL +void +bufferevent_rate_limit_group_reset_totals( + struct bufferevent_rate_limit_group *grp); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_BUFFEREVENT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/bufferevent_compat.h b/Source/Import/libevent/Includes/Linux/event2/bufferevent_compat.h new file mode 100644 index 0000000..6548204 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/bufferevent_compat.h @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2007-2012 Niels Provos, Nick Mathewson + * Copyright (c) 2000-2007 Niels Provos + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_BUFFEREVENT_COMPAT_H_INCLUDED_ +#define EVENT2_BUFFEREVENT_COMPAT_H_INCLUDED_ + +#define evbuffercb bufferevent_data_cb +#define everrorcb bufferevent_event_cb + +/** + Create a new bufferevent for an fd. + + This function is deprecated. Use bufferevent_socket_new and + bufferevent_set_callbacks instead. + + Libevent provides an abstraction on top of the regular event callbacks. + This abstraction is called a buffered event. A buffered event provides + input and output buffers that get filled and drained automatically. The + user of a buffered event no longer deals directly with the I/O, but + instead is reading from input and writing to output buffers. + + Once initialized, the bufferevent structure can be used repeatedly with + bufferevent_enable() and bufferevent_disable(). + + When read enabled the bufferevent will try to read from the file descriptor + and call the read callback. The write callback is executed whenever the + output buffer is drained below the write low watermark, which is 0 by + default. + + If multiple bases are in use, bufferevent_base_set() must be called before + enabling the bufferevent for the first time. + + @deprecated This function is deprecated because it uses the current + event base, and as such can be error prone for multithreaded programs. + Use bufferevent_socket_new() instead. + + @param fd the file descriptor from which data is read and written to. + This file descriptor is not allowed to be a pipe(2). + @param readcb callback to invoke when there is data to be read, or NULL if + no callback is desired + @param writecb callback to invoke when the file descriptor is ready for + writing, or NULL if no callback is desired + @param errorcb callback to invoke when there is an error on the file + descriptor + @param cbarg an argument that will be supplied to each of the callbacks + (readcb, writecb, and errorcb) + @return a pointer to a newly allocated bufferevent struct, or NULL if an + error occurred + @see bufferevent_base_set(), bufferevent_free() + */ +struct bufferevent *bufferevent_new(evutil_socket_t fd, + evbuffercb readcb, evbuffercb writecb, everrorcb errorcb, void *cbarg); + + +/** + Set the read and write timeout for a buffered event. + + @param bufev the bufferevent to be modified + @param timeout_read the read timeout + @param timeout_write the write timeout + */ +void bufferevent_settimeout(struct bufferevent *bufev, + int timeout_read, int timeout_write); + +#define EVBUFFER_READ BEV_EVENT_READING +#define EVBUFFER_WRITE BEV_EVENT_WRITING +#define EVBUFFER_EOF BEV_EVENT_EOF +#define EVBUFFER_ERROR BEV_EVENT_ERROR +#define EVBUFFER_TIMEOUT BEV_EVENT_TIMEOUT + +/** macro for getting access to the input buffer of a bufferevent */ +#define EVBUFFER_INPUT(x) bufferevent_get_input(x) +/** macro for getting access to the output buffer of a bufferevent */ +#define EVBUFFER_OUTPUT(x) bufferevent_get_output(x) + +#endif diff --git a/Source/Import/libevent/Includes/Linux/event2/bufferevent_ssl.h b/Source/Import/libevent/Includes/Linux/event2/bufferevent_ssl.h new file mode 100644 index 0000000..bf39b84 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/bufferevent_ssl.h @@ -0,0 +1,134 @@ +/* + * Copyright (c) 2009-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_BUFFEREVENT_SSL_H_INCLUDED_ +#define EVENT2_BUFFEREVENT_SSL_H_INCLUDED_ + +/** @file event2/bufferevent_ssl.h + + OpenSSL support for bufferevents. + */ +#include +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* This is what openssl's SSL objects are underneath. */ +struct ssl_st; + +/** + The state of an SSL object to be used when creating a new + SSL bufferevent. + */ +enum bufferevent_ssl_state { + BUFFEREVENT_SSL_OPEN = 0, + BUFFEREVENT_SSL_CONNECTING = 1, + BUFFEREVENT_SSL_ACCEPTING = 2 +}; + +#if defined(EVENT__HAVE_OPENSSL) || defined(EVENT_IN_DOXYGEN_) +/** + Create a new SSL bufferevent to send its data over another bufferevent. + + @param base An event_base to use to detect reading and writing. It + must also be the base for the underlying bufferevent. + @param underlying A socket to use for this SSL + @param ssl A SSL* object from openssl. + @param state The current state of the SSL connection + @param options One or more bufferevent_options + @return A new bufferevent on success, or NULL on failure +*/ +EVENT2_EXPORT_SYMBOL +struct bufferevent * +bufferevent_openssl_filter_new(struct event_base *base, + struct bufferevent *underlying, + struct ssl_st *ssl, + enum bufferevent_ssl_state state, + int options); + +/** + Create a new SSL bufferevent to send its data over an SSL * on a socket. + + @param base An event_base to use to detect reading and writing + @param fd A socket to use for this SSL + @param ssl A SSL* object from openssl. + @param state The current state of the SSL connection + @param options One or more bufferevent_options + @return A new bufferevent on success, or NULL on failure. +*/ +EVENT2_EXPORT_SYMBOL +struct bufferevent * +bufferevent_openssl_socket_new(struct event_base *base, + evutil_socket_t fd, + struct ssl_st *ssl, + enum bufferevent_ssl_state state, + int options); + +/** Control how to report dirty SSL shutdowns. + + If the peer (or the network, or an attacker) closes the TCP + connection before closing the SSL channel, and the protocol is SSL >= v3, + this is a "dirty" shutdown. If allow_dirty_shutdown is 0 (default), + this is reported as BEV_EVENT_ERROR. + + If instead allow_dirty_shutdown=1, a dirty shutdown is reported as + BEV_EVENT_EOF. + + (Note that if the protocol is < SSLv3, you will always receive + BEV_EVENT_EOF, since SSL 2 and earlier cannot distinguish a secure + connection close from a dirty one. This is one reason (among many) + not to use SSL 2.) +*/ + +EVENT2_EXPORT_SYMBOL +int bufferevent_openssl_get_allow_dirty_shutdown(struct bufferevent *bev); +EVENT2_EXPORT_SYMBOL +void bufferevent_openssl_set_allow_dirty_shutdown(struct bufferevent *bev, + int allow_dirty_shutdown); + +/** Return the underlying openssl SSL * object for an SSL bufferevent. */ +EVENT2_EXPORT_SYMBOL +struct ssl_st * +bufferevent_openssl_get_ssl(struct bufferevent *bufev); + +/** Tells a bufferevent to begin SSL renegotiation. */ +EVENT2_EXPORT_SYMBOL +int bufferevent_ssl_renegotiate(struct bufferevent *bev); + +/** Return the most recent OpenSSL error reported on an SSL bufferevent. */ +EVENT2_EXPORT_SYMBOL +unsigned long bufferevent_get_openssl_error(struct bufferevent *bev); + +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_BUFFEREVENT_SSL_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/bufferevent_struct.h b/Source/Import/libevent/Includes/Linux/event2/bufferevent_struct.h new file mode 100644 index 0000000..e84c082 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/bufferevent_struct.h @@ -0,0 +1,116 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_BUFFEREVENT_STRUCT_H_INCLUDED_ +#define EVENT2_BUFFEREVENT_STRUCT_H_INCLUDED_ + +/** @file event2/bufferevent_struct.h + + Data structures for bufferevents. Using these structures may hurt forward + compatibility with later versions of Libevent: be careful! + + @deprecated Use of bufferevent_struct.h is completely deprecated; these + structures are only exposed for backward compatibility with programs + written before Libevent 2.0 that used them. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include +/* For struct event */ +#include + +struct event_watermark { + size_t low; + size_t high; +}; + +/** + Shared implementation of a bufferevent. + + This type is exposed only because it was exposed in previous versions, + and some people's code may rely on manipulating it. Otherwise, you + should really not rely on the layout, size, or contents of this structure: + it is fairly volatile, and WILL change in future versions of the code. +**/ +struct bufferevent { + /** Event base for which this bufferevent was created. */ + struct event_base *ev_base; + /** Pointer to a table of function pointers to set up how this + bufferevent behaves. */ + const struct bufferevent_ops *be_ops; + + /** A read event that triggers when a timeout has happened or a socket + is ready to read data. Only used by some subtypes of + bufferevent. */ + struct event ev_read; + /** A write event that triggers when a timeout has happened or a socket + is ready to write data. Only used by some subtypes of + bufferevent. */ + struct event ev_write; + + /** An input buffer. Only the bufferevent is allowed to add data to + this buffer, though the user is allowed to drain it. */ + struct evbuffer *input; + + /** An input buffer. Only the bufferevent is allowed to drain data + from this buffer, though the user is allowed to add it. */ + struct evbuffer *output; + + struct event_watermark wm_read; + struct event_watermark wm_write; + + bufferevent_data_cb readcb; + bufferevent_data_cb writecb; + /* This should be called 'eventcb', but renaming it would break + * backward compatibility */ + bufferevent_event_cb errorcb; + void *cbarg; + + struct timeval timeout_read; + struct timeval timeout_write; + + /** Events that are currently enabled: currently EV_READ and EV_WRITE + are supported. */ + short enabled; +}; + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_BUFFEREVENT_STRUCT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/dns.h b/Source/Import/libevent/Includes/Linux/event2/dns.h new file mode 100644 index 0000000..17cd86a --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/dns.h @@ -0,0 +1,717 @@ +/* + * Copyright (c) 2006-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * The original DNS code is due to Adam Langley with heavy + * modifications by Nick Mathewson. Adam put his DNS software in the + * public domain. You can find his original copyright below. Please, + * aware that the code as part of Libevent is governed by the 3-clause + * BSD license above. + * + * This software is Public Domain. To view a copy of the public domain dedication, + * visit http://creativecommons.org/licenses/publicdomain/ or send a letter to + * Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA. + * + * I ask and expect, but do not require, that all derivative works contain an + * attribution similar to: + * Parts developed by Adam Langley + * + * You may wish to replace the word "Parts" with something else depending on + * the amount of original code. + * + * (Derivative works does not include programs which link against, run or include + * the source verbatim in their source distributions) + */ + +/** @file event2/dns.h + * + * Welcome, gentle reader + * + * Async DNS lookups are really a whole lot harder than they should be, + * mostly stemming from the fact that the libc resolver has never been + * very good at them. Before you use this library you should see if libc + * can do the job for you with the modern async call getaddrinfo_a + * (see http://www.imperialviolet.org/page25.html#e498). Otherwise, + * please continue. + * + * The library keeps track of the state of nameservers and will avoid + * them when they go down. Otherwise it will round robin between them. + * + * Quick start guide: + * #include "evdns.h" + * void callback(int result, char type, int count, int ttl, + * void *addresses, void *arg); + * evdns_resolv_conf_parse(DNS_OPTIONS_ALL, "/etc/resolv.conf"); + * evdns_resolve("www.hostname.com", 0, callback, NULL); + * + * When the lookup is complete the callback function is called. The + * first argument will be one of the DNS_ERR_* defines in evdns.h. + * Hopefully it will be DNS_ERR_NONE, in which case type will be + * DNS_IPv4_A, count will be the number of IP addresses, ttl is the time + * which the data can be cached for (in seconds), addresses will point + * to an array of uint32_t's and arg will be whatever you passed to + * evdns_resolve. + * + * Searching: + * + * In order for this library to be a good replacement for glibc's resolver it + * supports searching. This involves setting a list of default domains, in + * which names will be queried for. The number of dots in the query name + * determines the order in which this list is used. + * + * Searching appears to be a single lookup from the point of view of the API, + * although many DNS queries may be generated from a single call to + * evdns_resolve. Searching can also drastically slow down the resolution + * of names. + * + * To disable searching: + * 1. Never set it up. If you never call evdns_resolv_conf_parse or + * evdns_search_add then no searching will occur. + * + * 2. If you do call evdns_resolv_conf_parse then don't pass + * DNS_OPTION_SEARCH (or DNS_OPTIONS_ALL, which implies it). + * + * 3. When calling evdns_resolve, pass the DNS_QUERY_NO_SEARCH flag. + * + * The order of searches depends on the number of dots in the name. If the + * number is greater than the ndots setting then the names is first tried + * globally. Otherwise each search domain is appended in turn. + * + * The ndots setting can either be set from a resolv.conf, or by calling + * evdns_search_ndots_set. + * + * For example, with ndots set to 1 (the default) and a search domain list of + * ["myhome.net"]: + * Query: www + * Order: www.myhome.net, www. + * + * Query: www.abc + * Order: www.abc., www.abc.myhome.net + * + * Internals: + * + * Requests are kept in two queues. The first is the inflight queue. In + * this queue requests have an allocated transaction id and nameserver. + * They will soon be transmitted if they haven't already been. + * + * The second is the waiting queue. The size of the inflight ring is + * limited and all other requests wait in waiting queue for space. This + * bounds the number of concurrent requests so that we don't flood the + * nameserver. Several algorithms require a full walk of the inflight + * queue and so bounding its size keeps thing going nicely under huge + * (many thousands of requests) loads. + * + * If a nameserver loses too many requests it is considered down and we + * try not to use it. After a while we send a probe to that nameserver + * (a lookup for google.com) and, if it replies, we consider it working + * again. If the nameserver fails a probe we wait longer to try again + * with the next probe. + */ + +#ifndef EVENT2_DNS_H_INCLUDED_ +#define EVENT2_DNS_H_INCLUDED_ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* For integer types. */ +#include + +/** Error codes 0-5 are as described in RFC 1035. */ +#define DNS_ERR_NONE 0 +/** The name server was unable to interpret the query */ +#define DNS_ERR_FORMAT 1 +/** The name server was unable to process this query due to a problem with the + * name server */ +#define DNS_ERR_SERVERFAILED 2 +/** The domain name does not exist */ +#define DNS_ERR_NOTEXIST 3 +/** The name server does not support the requested kind of query */ +#define DNS_ERR_NOTIMPL 4 +/** The name server refuses to reform the specified operation for policy + * reasons */ +#define DNS_ERR_REFUSED 5 +/** The reply was truncated or ill-formatted */ +#define DNS_ERR_TRUNCATED 65 +/** An unknown error occurred */ +#define DNS_ERR_UNKNOWN 66 +/** Communication with the server timed out */ +#define DNS_ERR_TIMEOUT 67 +/** The request was canceled because the DNS subsystem was shut down. */ +#define DNS_ERR_SHUTDOWN 68 +/** The request was canceled via a call to evdns_cancel_request */ +#define DNS_ERR_CANCEL 69 +/** There were no answers and no error condition in the DNS packet. + * This can happen when you ask for an address that exists, but a record + * type that doesn't. */ +#define DNS_ERR_NODATA 70 + +#define DNS_IPv4_A 1 +#define DNS_PTR 2 +#define DNS_IPv6_AAAA 3 + +#define DNS_QUERY_NO_SEARCH 1 + +#define DNS_OPTION_SEARCH 1 +#define DNS_OPTION_NAMESERVERS 2 +#define DNS_OPTION_MISC 4 +#define DNS_OPTION_HOSTSFILE 8 +#define DNS_OPTIONS_ALL 15 + +/* Obsolete name for DNS_QUERY_NO_SEARCH */ +#define DNS_NO_SEARCH DNS_QUERY_NO_SEARCH + +/** + * The callback that contains the results from a lookup. + * - result is one of the DNS_ERR_* values (DNS_ERR_NONE for success) + * - type is either DNS_IPv4_A or DNS_PTR or DNS_IPv6_AAAA + * - count contains the number of addresses of form type + * - ttl is the number of seconds the resolution may be cached for. + * - addresses needs to be cast according to type. It will be an array of + * 4-byte sequences for ipv4, or an array of 16-byte sequences for ipv6, + * or a nul-terminated string for PTR. + */ +typedef void (*evdns_callback_type) (int result, char type, int count, int ttl, void *addresses, void *arg); + +struct evdns_base; +struct event_base; + +/** Flag for evdns_base_new: process resolv.conf. */ +#define EVDNS_BASE_INITIALIZE_NAMESERVERS 1 +/** Flag for evdns_base_new: Do not prevent the libevent event loop from + * exiting when we have no active dns requests. */ +#define EVDNS_BASE_DISABLE_WHEN_INACTIVE 0x8000 + +/** + Initialize the asynchronous DNS library. + + This function initializes support for non-blocking name resolution by + calling evdns_resolv_conf_parse() on UNIX and + evdns_config_windows_nameservers() on Windows. + + @param event_base the event base to associate the dns client with + @param flags any of EVDNS_BASE_INITIALIZE_NAMESERVERS| + EVDNS_BASE_DISABLE_WHEN_INACTIVE + @return evdns_base object if successful, or NULL if an error occurred. + @see evdns_base_free() + */ +EVENT2_EXPORT_SYMBOL +struct evdns_base * evdns_base_new(struct event_base *event_base, int initialize_nameservers); + + +/** + Shut down the asynchronous DNS resolver and terminate all active requests. + + If the 'fail_requests' option is enabled, all active requests will return + an empty result with the error flag set to DNS_ERR_SHUTDOWN. Otherwise, + the requests will be silently discarded. + + @param evdns_base the evdns base to free + @param fail_requests if zero, active requests will be aborted; if non-zero, + active requests will return DNS_ERR_SHUTDOWN. + @see evdns_base_new() + */ +EVENT2_EXPORT_SYMBOL +void evdns_base_free(struct evdns_base *base, int fail_requests); + +/** + Remove all hosts entries that have been loaded into the event_base via + evdns_base_load_hosts or via event_base_resolv_conf_parse. + + @param evdns_base the evdns base to remove outdated host addresses from + */ +EVENT2_EXPORT_SYMBOL +void evdns_base_clear_host_addresses(struct evdns_base *base); + +/** + Convert a DNS error code to a string. + + @param err the DNS error code + @return a string containing an explanation of the error code +*/ +EVENT2_EXPORT_SYMBOL +const char *evdns_err_to_string(int err); + + +/** + Add a nameserver. + + The address should be an IPv4 address in network byte order. + The type of address is chosen so that it matches in_addr.s_addr. + + @param base the evdns_base to which to add the name server + @param address an IP address in network byte order + @return 0 if successful, or -1 if an error occurred + @see evdns_base_nameserver_ip_add() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_nameserver_add(struct evdns_base *base, + unsigned long int address); + +/** + Get the number of configured nameservers. + + This returns the number of configured nameservers (not necessarily the + number of running nameservers). This is useful for double-checking + whether our calls to the various nameserver configuration functions + have been successful. + + @param base the evdns_base to which to apply this operation + @return the number of configured nameservers + @see evdns_base_nameserver_add() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_count_nameservers(struct evdns_base *base); + +/** + Remove all configured nameservers, and suspend all pending resolves. + + Resolves will not necessarily be re-attempted until evdns_base_resume() is called. + + @param base the evdns_base to which to apply this operation + @return 0 if successful, or -1 if an error occurred + @see evdns_base_resume() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_clear_nameservers_and_suspend(struct evdns_base *base); + + +/** + Resume normal operation and continue any suspended resolve requests. + + Re-attempt resolves left in limbo after an earlier call to + evdns_base_clear_nameservers_and_suspend(). + + @param base the evdns_base to which to apply this operation + @return 0 if successful, or -1 if an error occurred + @see evdns_base_clear_nameservers_and_suspend() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_resume(struct evdns_base *base); + +/** + Add a nameserver by string address. + + This function parses a n IPv4 or IPv6 address from a string and adds it as a + nameserver. It supports the following formats: + - [IPv6Address]:port + - [IPv6Address] + - IPv6Address + - IPv4Address:port + - IPv4Address + + If no port is specified, it defaults to 53. + + @param base the evdns_base to which to apply this operation + @return 0 if successful, or -1 if an error occurred + @see evdns_base_nameserver_add() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_nameserver_ip_add(struct evdns_base *base, + const char *ip_as_string); + +/** + Add a nameserver by sockaddr. + **/ +EVENT2_EXPORT_SYMBOL +int +evdns_base_nameserver_sockaddr_add(struct evdns_base *base, + const struct sockaddr *sa, ev_socklen_t len, unsigned flags); + +struct evdns_request; + +/** + Lookup an A record for a given name. + + @param base the evdns_base to which to apply this operation + @param name a DNS hostname + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return an evdns_request object if successful, or NULL if an error occurred. + @see evdns_resolve_ipv6(), evdns_resolve_reverse(), evdns_resolve_reverse_ipv6(), evdns_cancel_request() + */ +EVENT2_EXPORT_SYMBOL +struct evdns_request *evdns_base_resolve_ipv4(struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr); + +/** + Lookup an AAAA record for a given name. + + @param base the evdns_base to which to apply this operation + @param name a DNS hostname + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return an evdns_request object if successful, or NULL if an error occurred. + @see evdns_resolve_ipv4(), evdns_resolve_reverse(), evdns_resolve_reverse_ipv6(), evdns_cancel_request() + */ +EVENT2_EXPORT_SYMBOL +struct evdns_request *evdns_base_resolve_ipv6(struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr); + +struct in_addr; +struct in6_addr; + +/** + Lookup a PTR record for a given IP address. + + @param base the evdns_base to which to apply this operation + @param in an IPv4 address + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return an evdns_request object if successful, or NULL if an error occurred. + @see evdns_resolve_reverse_ipv6(), evdns_cancel_request() + */ +EVENT2_EXPORT_SYMBOL +struct evdns_request *evdns_base_resolve_reverse(struct evdns_base *base, const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr); + + +/** + Lookup a PTR record for a given IPv6 address. + + @param base the evdns_base to which to apply this operation + @param in an IPv6 address + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return an evdns_request object if successful, or NULL if an error occurred. + @see evdns_resolve_reverse_ipv6(), evdns_cancel_request() + */ +EVENT2_EXPORT_SYMBOL +struct evdns_request *evdns_base_resolve_reverse_ipv6(struct evdns_base *base, const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr); + +/** + Cancels a pending DNS resolution request. + + @param base the evdns_base that was used to make the request + @param req the evdns_request that was returned by calling a resolve function + @see evdns_base_resolve_ipv4(), evdns_base_resolve_ipv6, evdns_base_resolve_reverse +*/ +EVENT2_EXPORT_SYMBOL +void evdns_cancel_request(struct evdns_base *base, struct evdns_request *req); + +/** + Set the value of a configuration option. + + The currently available configuration options are: + + ndots, timeout, max-timeouts, max-inflight, attempts, randomize-case, + bind-to, initial-probe-timeout, getaddrinfo-allow-skew. + + In versions before Libevent 2.0.3-alpha, the option name needed to end with + a colon. + + @param base the evdns_base to which to apply this operation + @param option the name of the configuration option to be modified + @param val the value to be set + @return 0 if successful, or -1 if an error occurred + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_set_option(struct evdns_base *base, const char *option, const char *val); + + +/** + Parse a resolv.conf file. + + The 'flags' parameter determines what information is parsed from the + resolv.conf file. See the man page for resolv.conf for the format of this + file. + + The following directives are not parsed from the file: sortlist, rotate, + no-check-names, inet6, debug. + + If this function encounters an error, the possible return values are: 1 = + failed to open file, 2 = failed to stat file, 3 = file too large, 4 = out of + memory, 5 = short read from file, 6 = no nameservers listed in the file + + @param base the evdns_base to which to apply this operation + @param flags any of DNS_OPTION_NAMESERVERS|DNS_OPTION_SEARCH|DNS_OPTION_MISC| + DNS_OPTION_HOSTSFILE|DNS_OPTIONS_ALL + @param filename the path to the resolv.conf file + @return 0 if successful, or various positive error codes if an error + occurred (see above) + @see resolv.conf(3), evdns_config_windows_nameservers() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_resolv_conf_parse(struct evdns_base *base, int flags, const char *const filename); + +/** + Load an /etc/hosts-style file from 'hosts_fname' into 'base'. + + If hosts_fname is NULL, add minimal entries for localhost, and nothing + else. + + Note that only evdns_getaddrinfo uses the /etc/hosts entries. + + This function does not replace previously loaded hosts entries; to do that, + call evdns_base_clear_host_addresses first. + + Return 0 on success, negative on failure. +*/ +EVENT2_EXPORT_SYMBOL +int evdns_base_load_hosts(struct evdns_base *base, const char *hosts_fname); + +/** + Obtain nameserver information using the Windows API. + + Attempt to configure a set of nameservers based on platform settings on + a win32 host. Preferentially tries to use GetNetworkParams; if that fails, + looks in the registry. + + @return 0 if successful, or -1 if an error occurred + @see evdns_resolv_conf_parse() + */ +#ifdef _WIN32 +EVENT2_EXPORT_SYMBOL +int evdns_base_config_windows_nameservers(struct evdns_base *); +#define EVDNS_BASE_CONFIG_WINDOWS_NAMESERVERS_IMPLEMENTED +#endif + + +/** + Clear the list of search domains. + */ +EVENT2_EXPORT_SYMBOL +void evdns_base_search_clear(struct evdns_base *base); + + +/** + Add a domain to the list of search domains + + @param domain the domain to be added to the search list + */ +EVENT2_EXPORT_SYMBOL +void evdns_base_search_add(struct evdns_base *base, const char *domain); + + +/** + Set the 'ndots' parameter for searches. + + Sets the number of dots which, when found in a name, causes + the first query to be without any search domain. + + @param ndots the new ndots parameter + */ +EVENT2_EXPORT_SYMBOL +void evdns_base_search_ndots_set(struct evdns_base *base, const int ndots); + +/** + A callback that is invoked when a log message is generated + + @param is_warning indicates if the log message is a 'warning' + @param msg the content of the log message + */ +typedef void (*evdns_debug_log_fn_type)(int is_warning, const char *msg); + + +/** + Set the callback function to handle DNS log messages. If this + callback is not set, evdns log messages are handled with the regular + Libevent logging system. + + @param fn the callback to be invoked when a log message is generated + */ +EVENT2_EXPORT_SYMBOL +void evdns_set_log_fn(evdns_debug_log_fn_type fn); + +/** + Set a callback that will be invoked to generate transaction IDs. By + default, we pick transaction IDs based on the current clock time, which + is bad for security. + + @param fn the new callback, or NULL to use the default. + + NOTE: This function has no effect in Libevent 2.0.4-alpha and later, + since Libevent now provides its own secure RNG. + */ +EVENT2_EXPORT_SYMBOL +void evdns_set_transaction_id_fn(ev_uint16_t (*fn)(void)); + +/** + Set a callback used to generate random bytes. By default, we use + the same function as passed to evdns_set_transaction_id_fn to generate + bytes two at a time. If a function is provided here, it's also used + to generate transaction IDs. + + NOTE: This function has no effect in Libevent 2.0.4-alpha and later, + since Libevent now provides its own secure RNG. +*/ +EVENT2_EXPORT_SYMBOL +void evdns_set_random_bytes_fn(void (*fn)(char *, size_t)); + +/* + * Functions used to implement a DNS server. + */ + +struct evdns_server_request; +struct evdns_server_question; + +/** + A callback to implement a DNS server. The callback function receives a DNS + request. It should then optionally add a number of answers to the reply + using the evdns_server_request_add_*_reply functions, before calling either + evdns_server_request_respond to send the reply back, or + evdns_server_request_drop to decline to answer the request. + + @param req A newly received request + @param user_data A pointer that was passed to + evdns_add_server_port_with_base(). + */ +typedef void (*evdns_request_callback_fn_type)(struct evdns_server_request *, void *); +#define EVDNS_ANSWER_SECTION 0 +#define EVDNS_AUTHORITY_SECTION 1 +#define EVDNS_ADDITIONAL_SECTION 2 + +#define EVDNS_TYPE_A 1 +#define EVDNS_TYPE_NS 2 +#define EVDNS_TYPE_CNAME 5 +#define EVDNS_TYPE_SOA 6 +#define EVDNS_TYPE_PTR 12 +#define EVDNS_TYPE_MX 15 +#define EVDNS_TYPE_TXT 16 +#define EVDNS_TYPE_AAAA 28 + +#define EVDNS_QTYPE_AXFR 252 +#define EVDNS_QTYPE_ALL 255 + +#define EVDNS_CLASS_INET 1 + +/* flags that can be set in answers; as part of the err parameter */ +#define EVDNS_FLAGS_AA 0x400 +#define EVDNS_FLAGS_RD 0x080 + +/** Create a new DNS server port. + + @param base The event base to handle events for the server port. + @param socket A UDP socket to accept DNS requests. + @param flags Always 0 for now. + @param callback A function to invoke whenever we get a DNS request + on the socket. + @param user_data Data to pass to the callback. + @return an evdns_server_port structure for this server port. + */ +EVENT2_EXPORT_SYMBOL +struct evdns_server_port *evdns_add_server_port_with_base(struct event_base *base, evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data); +/** Close down a DNS server port, and free associated structures. */ +EVENT2_EXPORT_SYMBOL +void evdns_close_server_port(struct evdns_server_port *port); + +/** Sets some flags in a reply we're building. + Allows setting of the AA or RD flags + */ +EVENT2_EXPORT_SYMBOL +void evdns_server_request_set_flags(struct evdns_server_request *req, int flags); + +/* Functions to add an answer to an in-progress DNS reply. + */ +EVENT2_EXPORT_SYMBOL +int evdns_server_request_add_reply(struct evdns_server_request *req, int section, const char *name, int type, int dns_class, int ttl, int datalen, int is_name, const char *data); +EVENT2_EXPORT_SYMBOL +int evdns_server_request_add_a_reply(struct evdns_server_request *req, const char *name, int n, const void *addrs, int ttl); +EVENT2_EXPORT_SYMBOL +int evdns_server_request_add_aaaa_reply(struct evdns_server_request *req, const char *name, int n, const void *addrs, int ttl); +EVENT2_EXPORT_SYMBOL +int evdns_server_request_add_ptr_reply(struct evdns_server_request *req, struct in_addr *in, const char *inaddr_name, const char *hostname, int ttl); +EVENT2_EXPORT_SYMBOL +int evdns_server_request_add_cname_reply(struct evdns_server_request *req, const char *name, const char *cname, int ttl); + +/** + Send back a response to a DNS request, and free the request structure. +*/ +EVENT2_EXPORT_SYMBOL +int evdns_server_request_respond(struct evdns_server_request *req, int err); +/** + Free a DNS request without sending back a reply. +*/ +EVENT2_EXPORT_SYMBOL +int evdns_server_request_drop(struct evdns_server_request *req); +struct sockaddr; +/** + Get the address that made a DNS request. + */ +EVENT2_EXPORT_SYMBOL +int evdns_server_request_get_requesting_addr(struct evdns_server_request *req, struct sockaddr *sa, int addr_len); + +/** Callback for evdns_getaddrinfo. */ +typedef void (*evdns_getaddrinfo_cb)(int result, struct evutil_addrinfo *res, void *arg); + +struct evdns_base; +struct evdns_getaddrinfo_request; +/** Make a non-blocking getaddrinfo request using the dns_base in 'dns_base'. + * + * If we can answer the request immediately (with an error or not!), then we + * invoke cb immediately and return NULL. Otherwise we return + * an evdns_getaddrinfo_request and invoke cb later. + * + * When the callback is invoked, we pass as its first argument the error code + * that getaddrinfo would return (or 0 for no error). As its second argument, + * we pass the evutil_addrinfo structures we found (or NULL on error). We + * pass 'arg' as the third argument. + * + * Limitations: + * + * - The AI_V4MAPPED and AI_ALL flags are not currently implemented. + * - For ai_socktype, we only handle SOCKTYPE_STREAM, SOCKTYPE_UDP, and 0. + * - For ai_protocol, we only handle IPPROTO_TCP, IPPROTO_UDP, and 0. + */ +EVENT2_EXPORT_SYMBOL +struct evdns_getaddrinfo_request *evdns_getaddrinfo( + struct evdns_base *dns_base, + const char *nodename, const char *servname, + const struct evutil_addrinfo *hints_in, + evdns_getaddrinfo_cb cb, void *arg); + +/* Cancel an in-progress evdns_getaddrinfo. This MUST NOT be called after the + * getaddrinfo's callback has been invoked. The resolves will be canceled, + * and the callback will be invoked with the error EVUTIL_EAI_CANCEL. */ +EVENT2_EXPORT_SYMBOL +void evdns_getaddrinfo_cancel(struct evdns_getaddrinfo_request *req); + +/** + Retrieve the address of the 'idx'th configured nameserver. + + @param base The evdns_base to examine. + @param idx The index of the nameserver to get the address of. + @param sa A location to receive the server's address. + @param len The number of bytes available at sa. + + @return the number of bytes written into sa on success. On failure, returns + -1 if idx is greater than the number of configured nameservers, or a + value greater than 'len' if len was not high enough. + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_get_nameserver_addr(struct evdns_base *base, int idx, + struct sockaddr *sa, ev_socklen_t len); + +#ifdef __cplusplus +} +#endif + +#endif /* !EVENT2_DNS_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/dns_compat.h b/Source/Import/libevent/Includes/Linux/event2/dns_compat.h new file mode 100644 index 0000000..965fd65 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/dns_compat.h @@ -0,0 +1,336 @@ +/* + * Copyright (c) 2006-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_DNS_COMPAT_H_INCLUDED_ +#define EVENT2_DNS_COMPAT_H_INCLUDED_ + +/** @file event2/dns_compat.h + + Potentially non-threadsafe versions of the functions in dns.h: provided + only for backwards compatibility. + + + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/** + Initialize the asynchronous DNS library. + + This function initializes support for non-blocking name resolution by + calling evdns_resolv_conf_parse() on UNIX and + evdns_config_windows_nameservers() on Windows. + + @deprecated This function is deprecated because it always uses the current + event base, and is easily confused by multiple calls to event_init(), and + so is not safe for multithreaded use. Additionally, it allocates a global + structure that only one thread can use. The replacement is + evdns_base_new(). + + @return 0 if successful, or -1 if an error occurred + @see evdns_shutdown() + */ +int evdns_init(void); + +struct evdns_base; +/** + Return the global evdns_base created by event_init() and used by the other + deprecated functions. + + @deprecated This function is deprecated because use of the global + evdns_base is error-prone. + */ +struct evdns_base *evdns_get_global_base(void); + +/** + Shut down the asynchronous DNS resolver and terminate all active requests. + + If the 'fail_requests' option is enabled, all active requests will return + an empty result with the error flag set to DNS_ERR_SHUTDOWN. Otherwise, + the requests will be silently discarded. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_shutdown(). + + @param fail_requests if zero, active requests will be aborted; if non-zero, + active requests will return DNS_ERR_SHUTDOWN. + @see evdns_init() + */ +void evdns_shutdown(int fail_requests); + +/** + Add a nameserver. + + The address should be an IPv4 address in network byte order. + The type of address is chosen so that it matches in_addr.s_addr. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_nameserver_add(). + + @param address an IP address in network byte order + @return 0 if successful, or -1 if an error occurred + @see evdns_nameserver_ip_add() + */ +int evdns_nameserver_add(unsigned long int address); + +/** + Get the number of configured nameservers. + + This returns the number of configured nameservers (not necessarily the + number of running nameservers). This is useful for double-checking + whether our calls to the various nameserver configuration functions + have been successful. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_count_nameservers(). + + @return the number of configured nameservers + @see evdns_nameserver_add() + */ +int evdns_count_nameservers(void); + +/** + Remove all configured nameservers, and suspend all pending resolves. + + Resolves will not necessarily be re-attempted until evdns_resume() is called. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_clear_nameservers_and_suspend(). + + @return 0 if successful, or -1 if an error occurred + @see evdns_resume() + */ +int evdns_clear_nameservers_and_suspend(void); + +/** + Resume normal operation and continue any suspended resolve requests. + + Re-attempt resolves left in limbo after an earlier call to + evdns_clear_nameservers_and_suspend(). + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_resume(). + + @return 0 if successful, or -1 if an error occurred + @see evdns_clear_nameservers_and_suspend() + */ +int evdns_resume(void); + +/** + Add a nameserver. + + This wraps the evdns_nameserver_add() function by parsing a string as an IP + address and adds it as a nameserver. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_nameserver_ip_add(). + + @return 0 if successful, or -1 if an error occurred + @see evdns_nameserver_add() + */ +int evdns_nameserver_ip_add(const char *ip_as_string); + +/** + Lookup an A record for a given name. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_resolve_ipv4(). + + @param name a DNS hostname + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return 0 if successful, or -1 if an error occurred + @see evdns_resolve_ipv6(), evdns_resolve_reverse(), evdns_resolve_reverse_ipv6() + */ +int evdns_resolve_ipv4(const char *name, int flags, evdns_callback_type callback, void *ptr); + +/** + Lookup an AAAA record for a given name. + + @param name a DNS hostname + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return 0 if successful, or -1 if an error occurred + @see evdns_resolve_ipv4(), evdns_resolve_reverse(), evdns_resolve_reverse_ipv6() + */ +int evdns_resolve_ipv6(const char *name, int flags, evdns_callback_type callback, void *ptr); + +struct in_addr; +struct in6_addr; + +/** + Lookup a PTR record for a given IP address. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_resolve_reverse(). + + @param in an IPv4 address + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return 0 if successful, or -1 if an error occurred + @see evdns_resolve_reverse_ipv6() + */ +int evdns_resolve_reverse(const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr); + +/** + Lookup a PTR record for a given IPv6 address. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_resolve_reverse_ipv6(). + + @param in an IPv6 address + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return 0 if successful, or -1 if an error occurred + @see evdns_resolve_reverse_ipv6() + */ +int evdns_resolve_reverse_ipv6(const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr); + +/** + Set the value of a configuration option. + + The currently available configuration options are: + + ndots, timeout, max-timeouts, max-inflight, and attempts + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_set_option(). + + @param option the name of the configuration option to be modified + @param val the value to be set + @param flags Ignored. + @return 0 if successful, or -1 if an error occurred + */ +int evdns_set_option(const char *option, const char *val, int flags); + +/** + Parse a resolv.conf file. + + The 'flags' parameter determines what information is parsed from the + resolv.conf file. See the man page for resolv.conf for the format of this + file. + + The following directives are not parsed from the file: sortlist, rotate, + no-check-names, inet6, debug. + + If this function encounters an error, the possible return values are: 1 = + failed to open file, 2 = failed to stat file, 3 = file too large, 4 = out of + memory, 5 = short read from file, 6 = no nameservers listed in the file + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_resolv_conf_parse(). + + @param flags any of DNS_OPTION_NAMESERVERS|DNS_OPTION_SEARCH|DNS_OPTION_MISC| + DNS_OPTIONS_ALL + @param filename the path to the resolv.conf file + @return 0 if successful, or various positive error codes if an error + occurred (see above) + @see resolv.conf(3), evdns_config_windows_nameservers() + */ +int evdns_resolv_conf_parse(int flags, const char *const filename); + +/** + Clear the list of search domains. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_search_clear(). + */ +void evdns_search_clear(void); + +/** + Add a domain to the list of search domains + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_search_add(). + + @param domain the domain to be added to the search list + */ +void evdns_search_add(const char *domain); + +/** + Set the 'ndots' parameter for searches. + + Sets the number of dots which, when found in a name, causes + the first query to be without any search domain. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_search_ndots_set(). + + @param ndots the new ndots parameter + */ +void evdns_search_ndots_set(const int ndots); + +/** + As evdns_server_new_with_base. + + @deprecated This function is deprecated because it does not allow the + caller to specify which even_base it uses. The recommended + function is evdns_add_server_port_with_base(). + +*/ +struct evdns_server_port *evdns_add_server_port(evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data); + +#ifdef _WIN32 +int evdns_config_windows_nameservers(void); +#define EVDNS_CONFIG_WINDOWS_NAMESERVERS_IMPLEMENTED +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_COMPAT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/dns_struct.h b/Source/Import/libevent/Includes/Linux/event2/dns_struct.h new file mode 100644 index 0000000..593a8a7 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/dns_struct.h @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_DNS_STRUCT_H_INCLUDED_ +#define EVENT2_DNS_STRUCT_H_INCLUDED_ + +/** @file event2/dns_struct.h + + Data structures for dns. Using these structures may hurt forward + compatibility with later versions of Libevent: be careful! + + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/* + * Structures used to implement a DNS server. + */ + +struct evdns_server_request { + int flags; + int nquestions; + struct evdns_server_question **questions; +}; +struct evdns_server_question { + int type; +#ifdef __cplusplus + int dns_question_class; +#else + /* You should refer to this field as "dns_question_class". The + * name "class" works in C for backward compatibility, and will be + * removed in a future version. (1.5 or later). */ + int class; +#define dns_question_class class +#endif + char name[1]; +}; + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_DNS_STRUCT_H_INCLUDED_ */ + diff --git a/Source/Import/libevent/Includes/Linux/event2/event-config.h b/Source/Import/libevent/Includes/Linux/event2/event-config.h new file mode 100644 index 0000000..2c1b96f --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/event-config.h @@ -0,0 +1,545 @@ +/* event2/event-config.h + * + * This file was generated by autoconf when libevent was built, and post- + * processed by Libevent so that its macros would have a uniform prefix. + * + * DO NOT EDIT THIS FILE. + * + * Do not rely on macros in this file existing in later versions. + */ + +#ifndef EVENT2_EVENT_CONFIG_H_INCLUDED_ +#define EVENT2_EVENT_CONFIG_H_INCLUDED_ + +/* config.h. Generated from config.h.in by configure. */ +/* config.h.in. Generated from configure.ac by autoheader. */ + +/* Define if libevent should build without support for a debug mode */ +/* #undef EVENT__DISABLE_DEBUG_MODE */ + +/* Define if libevent should not allow replacing the mm functions */ +/* #undef EVENT__DISABLE_MM_REPLACEMENT */ + +/* Define if libevent should not be compiled with thread support */ +/* #undef EVENT__DISABLE_THREAD_SUPPORT */ + +/* Define to 1 if you have the `accept4' function. */ +/* #undef EVENT__HAVE_ACCEPT4 */ + +/* Define to 1 if you have the `arc4random' function. */ +/* #undef EVENT__HAVE_ARC4RANDOM */ + +/* Define to 1 if you have the `arc4random_buf' function. */ +/* #undef EVENT__HAVE_ARC4RANDOM_BUF */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_ARPA_INET_H */ + +/* Define to 1 if you have the `clock_gettime' function. */ +/* #undef EVENT__HAVE_CLOCK_GETTIME */ + +/* Define to 1 if you have the declaration of `CTL_KERN', and to 0 if you + don't. */ +/* #undef EVENT__HAVE_DECL_CTL_KERN */ + +/* Define to 1 if you have the declaration of `KERN_ARND', and to 0 if you + don't. */ +/* #undef EVENT__HAVE_DECL_KERN_ARND */ + +/* Define to 1 if you have the declaration of `KERN_RANDOM', and to 0 if you + don't. */ +/* #undef EVENT__HAVE_DECL_KERN_RANDOM */ + +/* Define to 1 if you have the declaration of `RANDOM_UUID', and to 0 if you + don't. */ +/* #undef EVENT__HAVE_DECL_RANDOM_UUID */ + +/* Define if /dev/poll is available */ +/* #undef EVENT__HAVE_DEVPOLL */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_DLFCN_H */ + +/* Define if your system supports the epoll system calls */ +/* #undef EVENT__HAVE_EPOLL */ + +/* Define to 1 if you have the `epoll_create1' function. */ +/* #undef EVENT__HAVE_EPOLL_CREATE1 */ + +/* Define to 1 if you have the `epoll_ctl' function. */ +/* #undef EVENT__HAVE_EPOLL_CTL */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_ERRNO_H 1 + +/* Define to 1 if you have ERR_remove_thread_stat(). */ +/* #undef EVENT__HAVE_ERR_REMOVE_THREAD_STATE */ + +/* Define to 1 if you have the `eventfd' function. */ +/* #undef EVENT__HAVE_EVENTFD */ + +/* Define if your system supports event ports */ +/* #undef EVENT__HAVE_EVENT_PORTS */ + +/* Define to 1 if you have the `fcntl' function. */ +/* #undef EVENT__HAVE_FCNTL */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_FCNTL_H 1 + +/* Define to 1 if the system has the type `fd_mask'. */ +/* #undef EVENT__HAVE_FD_MASK */ + +/* Do we have getaddrinfo()? */ +/* #undef EVENT__HAVE_GETADDRINFO */ + +/* Define to 1 if you have the `getegid' function. */ +/* #undef EVENT__HAVE_GETEGID */ + +/* Define to 1 if you have the `geteuid' function. */ +/* #undef EVENT__HAVE_GETEUID */ + +/* Define this if you have any gethostbyname_r() */ +/* #undef EVENT__HAVE_GETHOSTBYNAME_R */ + +/* Define this if gethostbyname_r takes 3 arguments */ +/* #undef EVENT__HAVE_GETHOSTBYNAME_R_3_ARG */ + +/* Define this if gethostbyname_r takes 5 arguments */ +/* #undef EVENT__HAVE_GETHOSTBYNAME_R_5_ARG */ + +/* Define this if gethostbyname_r takes 6 arguments */ +/* #undef EVENT__HAVE_GETHOSTBYNAME_R_6_ARG */ + +/* Define to 1 if you have the `getifaddrs' function. */ +/* #undef EVENT__HAVE_GETIFADDRS */ + +/* Define to 1 if you have the `getnameinfo' function. */ +#define EVENT__HAVE_GETNAMEINFO 1 + +/* Define to 1 if you have the `getprotobynumber' function. */ +#define EVENT__HAVE_GETPROTOBYNUMBER 1 + +/* Define to 1 if you have the `getservbyname' function. */ +#define EVENT__HAVE_GETSERVBYNAME 1 + +/* Define to 1 if you have the `gettimeofday' function. */ +#define EVENT__HAVE_GETTIMEOFDAY 1 + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_IFADDRS_H */ + +/* Define to 1 if you have the `inet_ntop' function. */ +#define EVENT__HAVE_INET_NTOP 1 + +/* Define to 1 if you have the `inet_pton' function. */ +#define EVENT__HAVE_INET_PTON 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_INTTYPES_H 1 + +/* Define to 1 if you have the `issetugid' function. */ +/* #undef EVENT__HAVE_ISSETUGID */ + +/* Define to 1 if you have the `kqueue' function. */ +/* #undef EVENT__HAVE_KQUEUE */ + +/* Define if the system has zlib */ +#define EVENT__HAVE_LIBZ 1 + +/* Define to 1 if you have the `mach_absolute_time' function. */ +/* #undef EVENT__HAVE_MACH_ABSOLUTE_TIME */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_MACH_MACH_TIME_H */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_MEMORY_H 1 + +/* Define to 1 if you have the `mmap' function. */ +/* #undef EVENT__HAVE_MMAP */ + +/* Define to 1 if you have the `nanosleep' function. */ +/* #undef EVENT__HAVE_NANOSLEEP */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_NETDB_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_NETINET_IN6_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_NETINET_IN_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_NETINET_TCP_H */ + +/* Define if the system has openssl */ +/* #undef EVENT__HAVE_OPENSSL */ + +/* Define to 1 if you have the `pipe' function. */ +/* #undef EVENT__HAVE_PIPE */ + +/* Define to 1 if you have the `pipe2' function. */ +/* #undef EVENT__HAVE_PIPE2 */ + +/* Define to 1 if you have the `poll' function. */ +/* #undef EVENT__HAVE_POLL */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_POLL_H */ + +/* Define to 1 if you have the `port_create' function. */ +/* #undef EVENT__HAVE_PORT_CREATE */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_PORT_H */ + +/* Define if you have POSIX threads libraries and header files. */ +/* #undef EVENT__HAVE_PTHREAD */ + +/* Define if we have pthreads on this system */ +/* #undef EVENT__HAVE_PTHREADS */ + +/* Define to 1 if you have the `putenv' function. */ +#define EVENT__HAVE_PUTENV 1 + +/* Define to 1 if the system has the type `sa_family_t'. */ +/* #undef EVENT__HAVE_SA_FAMILY_T */ + +/* Define to 1 if you have the `select' function. */ +/* #undef EVENT__HAVE_SELECT */ + +/* Define to 1 if you have the `sendfile' function. */ +/* #undef EVENT__HAVE_SENDFILE */ + +/* Define to 1 if you have the `setenv' function. */ +/* #undef EVENT__HAVE_SETENV */ + +/* Define if F_SETFD is defined in */ +/* #undef EVENT__HAVE_SETFD */ + +/* Define to 1 if you have the `setrlimit' function. */ +/* #undef EVENT__HAVE_SETRLIMIT */ + +/* Define to 1 if you have the `sigaction' function. */ +/* #undef EVENT__HAVE_SIGACTION */ + +/* Define to 1 if you have the `signal' function. */ +#define EVENT__HAVE_SIGNAL 1 + +/* Define to 1 if you have the `splice' function. */ +/* #undef EVENT__HAVE_SPLICE */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STDARG_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STDDEF_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STDINT_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STDLIB_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STRINGS_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STRING_H 1 + +/* Define to 1 if you have the `strlcpy' function. */ +/* #undef EVENT__HAVE_STRLCPY */ + +/* Define to 1 if you have the `strsep' function. */ +/* #undef EVENT__HAVE_STRSEP */ + +/* Define to 1 if you have the `strtok_r' function. */ +#define EVENT__HAVE_STRTOK_R 1 + +/* Define to 1 if you have the `strtoll' function. */ +#define EVENT__HAVE_STRTOLL 1 + +/* Define to 1 if the system has the type `struct addrinfo'. */ +#define EVENT__HAVE_STRUCT_ADDRINFO 1 + +/* Define to 1 if the system has the type `struct in6_addr'. */ +#define EVENT__HAVE_STRUCT_IN6_ADDR 1 + +/* Define to 1 if `s6_addr16' is a member of `struct in6_addr'. */ +/* #undef EVENT__HAVE_STRUCT_IN6_ADDR_S6_ADDR16 */ + +/* Define to 1 if `s6_addr32' is a member of `struct in6_addr'. */ +/* #undef EVENT__HAVE_STRUCT_IN6_ADDR_S6_ADDR32 */ + +/* Define to 1 if the system has the type `struct sockaddr_in6'. */ +#define EVENT__HAVE_STRUCT_SOCKADDR_IN6 1 + +/* Define to 1 if `sin6_len' is a member of `struct sockaddr_in6'. */ +/* #undef EVENT__HAVE_STRUCT_SOCKADDR_IN6_SIN6_LEN */ + +/* Define to 1 if `sin_len' is a member of `struct sockaddr_in'. */ +/* #undef EVENT__HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */ + +/* Define to 1 if the system has the type `struct sockaddr_storage'. */ +#define EVENT__HAVE_STRUCT_SOCKADDR_STORAGE 1 + +/* Define to 1 if `ss_family' is a member of `struct sockaddr_storage'. */ +#define EVENT__HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY 1 + +/* Define to 1 if `__ss_family' is a member of `struct sockaddr_storage'. */ +/* #undef EVENT__HAVE_STRUCT_SOCKADDR_STORAGE___SS_FAMILY */ + +/* Define to 1 if the system has the type `struct so_linger'. */ +/* #undef EVENT__HAVE_STRUCT_SO_LINGER */ + +/* Define to 1 if you have the `sysctl' function. */ +/* #undef EVENT__HAVE_SYSCTL */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_DEVPOLL_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_EPOLL_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_EVENTFD_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_EVENT_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_IOCTL_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_MMAN_H */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_SYS_PARAM_H 1 + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_QUEUE_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_RESOURCE_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_SELECT_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_SENDFILE_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_SOCKET_H */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_SYS_STAT_H 1 + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_SYSCTL_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_TIMERFD_H */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_SYS_TIME_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_SYS_TYPES_H 1 + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_UIO_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_WAIT_H */ + +/* Define if TAILQ_FOREACH is defined in */ +/* #undef EVENT__HAVE_TAILQFOREACH */ + +/* Define if timeradd is defined in */ +/* #undef EVENT__HAVE_TIMERADD */ + +/* Define if timerclear is defined in */ +#define EVENT__HAVE_TIMERCLEAR 1 + +/* Define if timercmp is defined in */ +#define EVENT__HAVE_TIMERCMP 1 + +/* Define to 1 if you have the `timerfd_create' function. */ +/* #undef EVENT__HAVE_TIMERFD_CREATE */ + +/* Define if timerisset is defined in */ +#define EVENT__HAVE_TIMERISSET 1 + +/* Define to 1 if the system has the type `uint16_t'. */ +#define EVENT__HAVE_UINT16_T 1 + +/* Define to 1 if the system has the type `uint32_t'. */ +#define EVENT__HAVE_UINT32_T 1 + +/* Define to 1 if the system has the type `uint64_t'. */ +#define EVENT__HAVE_UINT64_T 1 + +/* Define to 1 if the system has the type `uint8_t'. */ +#define EVENT__HAVE_UINT8_T 1 + +/* Define to 1 if the system has the type `uintptr_t'. */ +#define EVENT__HAVE_UINTPTR_T 1 + +/* Define to 1 if you have the `umask' function. */ +#define EVENT__HAVE_UMASK 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_UNISTD_H 1 + +/* Define to 1 if you have the `unsetenv' function. */ +/* #undef EVENT__HAVE_UNSETENV */ + +/* Define to 1 if you have the `usleep' function. */ +#define EVENT__HAVE_USLEEP 1 + +/* Define to 1 if you have the `vasprintf' function. */ +#define EVENT__HAVE_VASPRINTF 1 + +/* Define if waitpid() supports WNOWAIT */ +/* #undef EVENT__HAVE_WAITPID_WITH_WNOWAIT */ + +/* Define if kqueue works correctly with pipes */ +/* #undef EVENT__HAVE_WORKING_KQUEUE */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_ZLIB_H 1 + +/* Define to the sub-directory where libtool stores uninstalled libraries. */ +#define EVENT__LT_OBJDIR ".libs/" + +/* Numeric representation of the version */ +#define EVENT__NUMERIC_VERSION 0x02010800 + +/* Name of package */ +#define EVENT__PACKAGE "libevent" + +/* Define to the address where bug reports for this package should be sent. */ +#define EVENT__PACKAGE_BUGREPORT "" + +/* Define to the full name of this package. */ +#define EVENT__PACKAGE_NAME "libevent" + +/* Define to the full name and version of this package. */ +#define EVENT__PACKAGE_STRING "libevent 2.1.8-stable" + +/* Define to the one symbol short name of this package. */ +#define EVENT__PACKAGE_TARNAME "libevent" + +/* Define to the home page for this package. */ +#define EVENT__PACKAGE_URL "" + +/* Define to the version of this package. */ +#define EVENT__PACKAGE_VERSION "2.1.8-stable" + +/* Define to necessary symbol if this constant uses a non-standard name on + your system. */ +/* #undef EVENT__PTHREAD_CREATE_JOINABLE */ + +/* The size of `int', as computed by sizeof. */ +#define EVENT__SIZEOF_INT 4 + +/* The size of `long', as computed by sizeof. */ +#define EVENT__SIZEOF_LONG 4 + +/* The size of `long long', as computed by sizeof. */ +#define EVENT__SIZEOF_LONG_LONG 8 + +/* The size of `off_t', as computed by sizeof. */ +#define EVENT__SIZEOF_OFF_T 8 + +/* The size of `pthread_t', as computed by sizeof. */ +/* #undef EVENT__SIZEOF_PTHREAD_T */ + +/* The size of `short', as computed by sizeof. */ +#define EVENT__SIZEOF_SHORT 2 + +/* The size of `size_t', as computed by sizeof. */ +#define EVENT__SIZEOF_SIZE_T 8 + +/* The size of `void *', as computed by sizeof. */ +#define EVENT__SIZEOF_VOID_P 8 + +/* Define to 1 if you have the ANSI C header files. */ +#define EVENT__STDC_HEADERS 1 + +/* Define to 1 if you can safely include both and . */ +#define EVENT__TIME_WITH_SYS_TIME 1 + +/* Enable extensions on AIX 3, Interix. */ +#ifndef EVENT___ALL_SOURCE +# define EVENT___ALL_SOURCE 1 +#endif +/* Enable GNU extensions on systems that have them. */ +#ifndef EVENT___GNU_SOURCE +# define EVENT___GNU_SOURCE 1 +#endif +/* Enable threading extensions on Solaris. */ +#ifndef EVENT___POSIX_PTHREAD_SEMANTICS +# define EVENT___POSIX_PTHREAD_SEMANTICS 1 +#endif +/* Enable extensions on HP NonStop. */ +#ifndef EVENT___TANDEM_SOURCE +# define EVENT___TANDEM_SOURCE 1 +#endif +/* Enable general extensions on Solaris. */ +#ifndef EVENT____EXTENSIONS__ +# define EVENT____EXTENSIONS__ 1 +#endif + + +/* Version number of package */ +#define EVENT__VERSION "2.1.8-stable" + +/* Enable large inode numbers on Mac OS X 10.5. */ +#ifndef EVENT___DARWIN_USE_64_BIT_INODE +# define EVENT___DARWIN_USE_64_BIT_INODE 1 +#endif + +/* Number of bits in a file offset, on hosts where this is settable. */ +#define EVENT___FILE_OFFSET_BITS 64 + +/* Define for large files, on AIX-style hosts. */ +/* #undef EVENT___LARGE_FILES */ + +/* Define to 1 if on MINIX. */ +/* #undef EVENT___MINIX */ + +/* Define to 2 if the system does not provide POSIX.1 features except with + this defined. */ +/* #undef EVENT___POSIX_1_SOURCE */ + +/* Define to 1 if you need to in order for `stat' and other things to work. */ +/* #undef EVENT___POSIX_SOURCE */ + +/* Define to appropriate substitue if compiler doesnt have __func__ */ +/* #undef EVENT____func__ */ + +/* Define to empty if `const' does not conform to ANSI C. */ +/* #undef EVENT__const */ + +/* Define to `__inline__' or `__inline' if that's what the C compiler + calls it, or to nothing if 'inline' is not supported under any name. */ +#ifndef EVENT____cplusplus +/* #undef EVENT__inline */ +#endif + +/* Define to `int' if does not define. */ +/* #undef EVENT__pid_t */ + +/* Define to `unsigned int' if does not define. */ +/* #undef EVENT__size_t */ + +/* Define to unsigned int if you dont have it */ +#define EVENT__socklen_t unsigned int + +/* Define to `int' if does not define. */ +/* #undef EVENT__ssize_t */ + +#endif /* event2/event-config.h */ diff --git a/Source/Import/libevent/Includes/Linux/event2/event.h b/Source/Import/libevent/Includes/Linux/event2/event.h new file mode 100644 index 0000000..6e0a4f0 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/event.h @@ -0,0 +1,1675 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_EVENT_H_INCLUDED_ +#define EVENT2_EVENT_H_INCLUDED_ + +/** + @mainpage + + @section intro Introduction + + Libevent is an event notification library for developing scalable network + servers. The Libevent API provides a mechanism to execute a callback + function when a specific event occurs on a file descriptor or after a + timeout has been reached. Furthermore, Libevent also support callbacks due + to signals or regular timeouts. + + Libevent is meant to replace the event loop found in event driven network + servers. An application just needs to call event_base_dispatch() and then add or + remove events dynamically without having to change the event loop. + + + Currently, Libevent supports /dev/poll, kqueue(2), select(2), poll(2), + epoll(4), and evports. The internal event mechanism is completely + independent of the exposed event API, and a simple update of Libevent can + provide new functionality without having to redesign the applications. As a + result, Libevent allows for portable application development and provides + the most scalable event notification mechanism available on an operating + system. Libevent can also be used for multithreaded programs. Libevent + should compile on Linux, *BSD, Mac OS X, Solaris and, Windows. + + @section usage Standard usage + + Every program that uses Libevent must include the + header, and pass the -levent flag to the linker. (You can instead link + -levent_core if you only want the main event and buffered IO-based code, + and don't want to link any protocol code.) + + @section setup Library setup + + Before you call any other Libevent functions, you need to set up the + library. If you're going to use Libevent from multiple threads in a + multithreaded application, you need to initialize thread support -- + typically by using evthread_use_pthreads() or + evthread_use_windows_threads(). See for more + information. + + This is also the point where you can replace Libevent's memory + management functions with event_set_mem_functions, and enable debug mode + with event_enable_debug_mode(). + + @section base Creating an event base + + Next, you need to create an event_base structure, using event_base_new() + or event_base_new_with_config(). The event_base is responsible for + keeping track of which events are "pending" (that is to say, being + watched to see if they become active) and which events are "active". + Every event is associated with a single event_base. + + @section event Event notification + + For each file descriptor that you wish to monitor, you must create an + event structure with event_new(). (You may also declare an event + structure and call event_assign() to initialize the members of the + structure.) To enable notification, you add the structure to the list + of monitored events by calling event_add(). The event structure must + remain allocated as long as it is active, so it should generally be + allocated on the heap. + + @section loop Dispatching events. + + Finally, you call event_base_dispatch() to loop and dispatch events. + You can also use event_base_loop() for more fine-grained control. + + Currently, only one thread can be dispatching a given event_base at a + time. If you want to run events in multiple threads at once, you can + either have a single event_base whose events add work to a work queue, + or you can create multiple event_base objects. + + @section bufferevent I/O Buffers + + Libevent provides a buffered I/O abstraction on top of the regular event + callbacks. This abstraction is called a bufferevent. A bufferevent + provides input and output buffers that get filled and drained + automatically. The user of a buffered event no longer deals directly + with the I/O, but instead is reading from input and writing to output + buffers. + + Once initialized via bufferevent_socket_new(), the bufferevent structure + can be used repeatedly with bufferevent_enable() and + bufferevent_disable(). Instead of reading and writing directly to a + socket, you would call bufferevent_read() and bufferevent_write(). + + When read enabled the bufferevent will try to read from the file descriptor + and call the read callback. The write callback is executed whenever the + output buffer is drained below the write low watermark, which is 0 by + default. + + See for more information. + + @section timers Timers + + Libevent can also be used to create timers that invoke a callback after a + certain amount of time has expired. The evtimer_new() macro returns + an event struct to use as a timer. To activate the timer, call + evtimer_add(). Timers can be deactivated by calling evtimer_del(). + (These macros are thin wrappers around event_new(), event_add(), + and event_del(); you can also use those instead.) + + @section evdns Asynchronous DNS resolution + + Libevent provides an asynchronous DNS resolver that should be used instead + of the standard DNS resolver functions. See the + functions for more detail. + + @section evhttp Event-driven HTTP servers + + Libevent provides a very simple event-driven HTTP server that can be + embedded in your program and used to service HTTP requests. + + To use this capability, you need to include the header in your + program. See that header for more information. + + @section evrpc A framework for RPC servers and clients + + Libevent provides a framework for creating RPC servers and clients. It + takes care of marshaling and unmarshaling all data structures. + + @section api API Reference + + To browse the complete documentation of the libevent API, click on any of + the following links. + + event2/event.h + The primary libevent header + + event2/thread.h + Functions for use by multithreaded programs + + event2/buffer.h and event2/bufferevent.h + Buffer management for network reading and writing + + event2/util.h + Utility functions for portable nonblocking network code + + event2/dns.h + Asynchronous DNS resolution + + event2/http.h + An embedded libevent-based HTTP server + + event2/rpc.h + A framework for creating RPC servers and clients + + */ + +/** @file event2/event.h + + Core functions for waiting for and receiving events, and using event bases. +*/ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +#include + +/* For int types. */ +#include + +/** + * Structure to hold information and state for a Libevent dispatch loop. + * + * The event_base lies at the center of Libevent; every application will + * have one. It keeps track of all pending and active events, and + * notifies your application of the active ones. + * + * This is an opaque structure; you can allocate one using + * event_base_new() or event_base_new_with_config(). + * + * @see event_base_new(), event_base_free(), event_base_loop(), + * event_base_new_with_config() + */ +struct event_base +#ifdef EVENT_IN_DOXYGEN_ +{/*Empty body so that doxygen will generate documentation here.*/} +#endif +; + +/** + * @struct event + * + * Structure to represent a single event. + * + * An event can have some underlying condition it represents: a socket + * becoming readable or writeable (or both), or a signal becoming raised. + * (An event that represents no underlying condition is still useful: you + * can use one to implement a timer, or to communicate between threads.) + * + * Generally, you can create events with event_new(), then make them + * pending with event_add(). As your event_base runs, it will run the + * callbacks of an events whose conditions are triggered. When you + * longer want the event, free it with event_free(). + * + * In more depth: + * + * An event may be "pending" (one whose condition we are watching), + * "active" (one whose condition has triggered and whose callback is about + * to run), neither, or both. Events come into existence via + * event_assign() or event_new(), and are then neither active nor pending. + * + * To make an event pending, pass it to event_add(). When doing so, you + * can also set a timeout for the event. + * + * Events become active during an event_base_loop() call when either their + * condition has triggered, or when their timeout has elapsed. You can + * also activate an event manually using event_active(). The even_base + * loop will run the callbacks of active events; after it has done so, it + * marks them as no longer active. + * + * You can make an event non-pending by passing it to event_del(). This + * also makes the event non-active. + * + * Events can be "persistent" or "non-persistent". A non-persistent event + * becomes non-pending as soon as it is triggered: thus, it only runs at + * most once per call to event_add(). A persistent event remains pending + * even when it becomes active: you'll need to event_del() it manually in + * order to make it non-pending. When a persistent event with a timeout + * becomes active, its timeout is reset: this means you can use persistent + * events to implement periodic timeouts. + * + * This should be treated as an opaque structure; you should never read or + * write any of its fields directly. For backward compatibility with old + * code, it is defined in the event2/event_struct.h header; including this + * header may make your code incompatible with other versions of Libevent. + * + * @see event_new(), event_free(), event_assign(), event_get_assignment(), + * event_add(), event_del(), event_active(), event_pending(), + * event_get_fd(), event_get_base(), event_get_events(), + * event_get_callback(), event_get_callback_arg(), + * event_priority_set() + */ +struct event +#ifdef EVENT_IN_DOXYGEN_ +{/*Empty body so that doxygen will generate documentation here.*/} +#endif +; + +/** + * Configuration for an event_base. + * + * There are many options that can be used to alter the behavior and + * implementation of an event_base. To avoid having to pass them all in a + * complex many-argument constructor, we provide an abstract data type + * wrhere you set up configation information before passing it to + * event_base_new_with_config(). + * + * @see event_config_new(), event_config_free(), event_base_new_with_config(), + * event_config_avoid_method(), event_config_require_features(), + * event_config_set_flag(), event_config_set_num_cpus_hint() + */ +struct event_config +#ifdef EVENT_IN_DOXYGEN_ +{/*Empty body so that doxygen will generate documentation here.*/} +#endif +; + +/** + * Enable some relatively expensive debugging checks in Libevent that + * would normally be turned off. Generally, these checks cause code that + * would otherwise crash mysteriously to fail earlier with an assertion + * failure. Note that this method MUST be called before any events or + * event_bases have been created. + * + * Debug mode can currently catch the following errors: + * An event is re-assigned while it is added + * Any function is called on a non-assigned event + * + * Note that debugging mode uses memory to track every event that has been + * initialized (via event_assign, event_set, or event_new) but not yet + * released (via event_free or event_debug_unassign). If you want to use + * debug mode, and you find yourself running out of memory, you will need + * to use event_debug_unassign to explicitly stop tracking events that + * are no longer considered set-up. + * + * @see event_debug_unassign() + */ +EVENT2_EXPORT_SYMBOL +void event_enable_debug_mode(void); + +/** + * When debugging mode is enabled, informs Libevent that an event should no + * longer be considered as assigned. When debugging mode is not enabled, does + * nothing. + * + * This function must only be called on a non-added event. + * + * @see event_enable_debug_mode() + */ +EVENT2_EXPORT_SYMBOL +void event_debug_unassign(struct event *); + +/** + * Create and return a new event_base to use with the rest of Libevent. + * + * @return a new event_base on success, or NULL on failure. + * + * @see event_base_free(), event_base_new_with_config() + */ +EVENT2_EXPORT_SYMBOL +struct event_base *event_base_new(void); + +/** + Reinitialize the event base after a fork + + Some event mechanisms do not survive across fork. The event base needs + to be reinitialized with the event_reinit() function. + + @param base the event base that needs to be re-initialized + @return 0 if successful, or -1 if some events could not be re-added. + @see event_base_new() +*/ +EVENT2_EXPORT_SYMBOL +int event_reinit(struct event_base *base); + +/** + Event dispatching loop + + This loop will run the event base until either there are no more pending or + active, or until something calls event_base_loopbreak() or + event_base_loopexit(). + + @param base the event_base structure returned by event_base_new() or + event_base_new_with_config() + @return 0 if successful, -1 if an error occurred, or 1 if we exited because + no events were pending or active. + @see event_base_loop() + */ +EVENT2_EXPORT_SYMBOL +int event_base_dispatch(struct event_base *); + +/** + Get the kernel event notification mechanism used by Libevent. + + @param eb the event_base structure returned by event_base_new() + @return a string identifying the kernel event mechanism (kqueue, epoll, etc.) + */ +EVENT2_EXPORT_SYMBOL +const char *event_base_get_method(const struct event_base *); + +/** + Gets all event notification mechanisms supported by Libevent. + + This functions returns the event mechanism in order preferred by + Libevent. Note that this list will include all backends that + Libevent has compiled-in support for, and will not necessarily check + your OS to see whether it has the required resources. + + @return an array with pointers to the names of support methods. + The end of the array is indicated by a NULL pointer. If an + error is encountered NULL is returned. +*/ +EVENT2_EXPORT_SYMBOL +const char **event_get_supported_methods(void); + +/** Query the current monotonic time from a the timer for a struct + * event_base. + */ +EVENT2_EXPORT_SYMBOL +int event_gettime_monotonic(struct event_base *base, struct timeval *tp); + +/** + @name event type flag + + Flags to pass to event_base_get_num_events() to specify the kinds of events + we want to aggregate counts for +*/ +/**@{*/ +/** count the number of active events, which have been triggered.*/ +#define EVENT_BASE_COUNT_ACTIVE 1U +/** count the number of virtual events, which is used to represent an internal + * condition, other than a pending event, that keeps the loop from exiting. */ +#define EVENT_BASE_COUNT_VIRTUAL 2U +/** count the number of events which have been added to event base, including + * internal events. */ +#define EVENT_BASE_COUNT_ADDED 4U +/**@}*/ + +/** + Gets the number of events in event_base, as specified in the flags. + + Since event base has some internal events added to make some of its + functionalities work, EVENT_BASE_COUNT_ADDED may return more than the + number of events you added using event_add(). + + If you pass EVENT_BASE_COUNT_ACTIVE and EVENT_BASE_COUNT_ADDED together, an + active event will be counted twice. However, this might not be the case in + future libevent versions. The return value is an indication of the work + load, but the user shouldn't rely on the exact value as this may change in + the future. + + @param eb the event_base structure returned by event_base_new() + @param flags a bitwise combination of the kinds of events to aggregate + counts for + @return the number of events specified in the flags +*/ +EVENT2_EXPORT_SYMBOL +int event_base_get_num_events(struct event_base *, unsigned int); + +/** + Get the maximum number of events in a given event_base as specified in the + flags. + + @param eb the event_base structure returned by event_base_new() + @param flags a bitwise combination of the kinds of events to aggregate + counts for + @param clear option used to reset the maximum count. + @return the number of events specified in the flags + */ +EVENT2_EXPORT_SYMBOL +int event_base_get_max_events(struct event_base *, unsigned int, int); + +/** + Allocates a new event configuration object. + + The event configuration object can be used to change the behavior of + an event base. + + @return an event_config object that can be used to store configuration, or + NULL if an error is encountered. + @see event_base_new_with_config(), event_config_free(), event_config +*/ +EVENT2_EXPORT_SYMBOL +struct event_config *event_config_new(void); + +/** + Deallocates all memory associated with an event configuration object + + @param cfg the event configuration object to be freed. +*/ +EVENT2_EXPORT_SYMBOL +void event_config_free(struct event_config *cfg); + +/** + Enters an event method that should be avoided into the configuration. + + This can be used to avoid event mechanisms that do not support certain + file descriptor types, or for debugging to avoid certain event + mechanisms. An application can make use of multiple event bases to + accommodate incompatible file descriptor types. + + @param cfg the event configuration object + @param method the name of the event method to avoid + @return 0 on success, -1 on failure. +*/ +EVENT2_EXPORT_SYMBOL +int event_config_avoid_method(struct event_config *cfg, const char *method); + +/** + A flag used to describe which features an event_base (must) provide. + + Because of OS limitations, not every Libevent backend supports every + possible feature. You can use this type with + event_config_require_features() to tell Libevent to only proceed if your + event_base implements a given feature, and you can receive this type from + event_base_get_features() to see which features are available. +*/ +enum event_method_feature { + /** Require an event method that allows edge-triggered events with EV_ET. */ + EV_FEATURE_ET = 0x01, + /** Require an event method where having one event triggered among + * many is [approximately] an O(1) operation. This excludes (for + * example) select and poll, which are approximately O(N) for N + * equal to the total number of possible events. */ + EV_FEATURE_O1 = 0x02, + /** Require an event method that allows file descriptors as well as + * sockets. */ + EV_FEATURE_FDS = 0x04, + /** Require an event method that allows you to use EV_CLOSED to detect + * connection close without the necessity of reading all the pending data. + * + * Methods that do support EV_CLOSED may not be able to provide support on + * all kernel versions. + **/ + EV_FEATURE_EARLY_CLOSE = 0x08 +}; + +/** + A flag passed to event_config_set_flag(). + + These flags change the behavior of an allocated event_base. + + @see event_config_set_flag(), event_base_new_with_config(), + event_method_feature + */ +enum event_base_config_flag { + /** Do not allocate a lock for the event base, even if we have + locking set up. + + Setting this option will make it unsafe and nonfunctional to call + functions on the base concurrently from multiple threads. + */ + EVENT_BASE_FLAG_NOLOCK = 0x01, + /** Do not check the EVENT_* environment variables when configuring + an event_base */ + EVENT_BASE_FLAG_IGNORE_ENV = 0x02, + /** Windows only: enable the IOCP dispatcher at startup + + If this flag is set then bufferevent_socket_new() and + evconn_listener_new() will use IOCP-backed implementations + instead of the usual select-based one on Windows. + */ + EVENT_BASE_FLAG_STARTUP_IOCP = 0x04, + /** Instead of checking the current time every time the event loop is + ready to run timeout callbacks, check after each timeout callback. + */ + EVENT_BASE_FLAG_NO_CACHE_TIME = 0x08, + + /** If we are using the epoll backend, this flag says that it is + safe to use Libevent's internal change-list code to batch up + adds and deletes in order to try to do as few syscalls as + possible. Setting this flag can make your code run faster, but + it may trigger a Linux bug: it is not safe to use this flag + if you have any fds cloned by dup() or its variants. Doing so + will produce strange and hard-to-diagnose bugs. + + This flag can also be activated by setting the + EVENT_EPOLL_USE_CHANGELIST environment variable. + + This flag has no effect if you wind up using a backend other than + epoll. + */ + EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST = 0x10, + + /** Ordinarily, Libevent implements its time and timeout code using + the fastest monotonic timer that we have. If this flag is set, + however, we use less efficient more precise timer, assuming one is + present. + */ + EVENT_BASE_FLAG_PRECISE_TIMER = 0x20 +}; + +/** + Return a bitmask of the features implemented by an event base. This + will be a bitwise OR of one or more of the values of + event_method_feature + + @see event_method_feature + */ +EVENT2_EXPORT_SYMBOL +int event_base_get_features(const struct event_base *base); + +/** + Enters a required event method feature that the application demands. + + Note that not every feature or combination of features is supported + on every platform. Code that requests features should be prepared + to handle the case where event_base_new_with_config() returns NULL, as in: + 
+     event_config_require_features(cfg, EV_FEATURE_ET);
+     base = event_base_new_with_config(cfg);
+     if (base == NULL) {
+       // We can't get edge-triggered behavior here.
+       event_config_require_features(cfg, 0);
+       base = event_base_new_with_config(cfg);
+     }
+
+ + @param cfg the event configuration object + @param feature a bitfield of one or more event_method_feature values. + Replaces values from previous calls to this function. + @return 0 on success, -1 on failure. + @see event_method_feature, event_base_new_with_config() +*/ +EVENT2_EXPORT_SYMBOL +int event_config_require_features(struct event_config *cfg, int feature); + +/** + * Sets one or more flags to configure what parts of the eventual event_base + * will be initialized, and how they'll work. + * + * @see event_base_config_flags, event_base_new_with_config() + **/ +EVENT2_EXPORT_SYMBOL +int event_config_set_flag(struct event_config *cfg, int flag); + +/** + * Records a hint for the number of CPUs in the system. This is used for + * tuning thread pools, etc, for optimal performance. In Libevent 2.0, + * it is only on Windows, and only when IOCP is in use. + * + * @param cfg the event configuration object + * @param cpus the number of cpus + * @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int event_config_set_num_cpus_hint(struct event_config *cfg, int cpus); + +/** + * Record an interval and/or a number of callbacks after which the event base + * should check for new events. By default, the event base will run as many + * events are as activated at the higest activated priority before checking + * for new events. If you configure it by setting max_interval, it will check + * the time after each callback, and not allow more than max_interval to + * elapse before checking for new events. If you configure it by setting + * max_callbacks to a value >= 0, it will run no more than max_callbacks + * callbacks before checking for new events. + * + * This option can decrease the latency of high-priority events, and + * avoid priority inversions where multiple low-priority events keep us from + * polling for high-priority events, but at the expense of slightly decreasing + * the throughput. Use it with caution! + * + * @param cfg The event_base configuration object. + * @param max_interval An interval after which Libevent should stop running + * callbacks and check for more events, or NULL if there should be + * no such interval. + * @param max_callbacks A number of callbacks after which Libevent should + * stop running callbacks and check for more events, or -1 if there + * should be no such limit. + * @param min_priority A priority below which max_interval and max_callbacks + * should not be enforced. If this is set to 0, they are enforced + * for events of every priority; if it's set to 1, they're enforced + * for events of priority 1 and above, and so on. + * @return 0 on success, -1 on failure. + **/ +EVENT2_EXPORT_SYMBOL +int event_config_set_max_dispatch_interval(struct event_config *cfg, + const struct timeval *max_interval, int max_callbacks, + int min_priority); + +/** + Initialize the event API. + + Use event_base_new_with_config() to initialize a new event base, taking + the specified configuration under consideration. The configuration object + can currently be used to avoid certain event notification mechanisms. + + @param cfg the event configuration object + @return an initialized event_base that can be used to registering events, + or NULL if no event base can be created with the requested event_config. + @see event_base_new(), event_base_free(), event_init(), event_assign() +*/ +EVENT2_EXPORT_SYMBOL +struct event_base *event_base_new_with_config(const struct event_config *); + +/** + Deallocate all memory associated with an event_base, and free the base. + + Note that this function will not close any fds or free any memory passed + to event_new as the argument to callback. + + If there are any pending finalizer callbacks, this function will invoke + them. + + @param eb an event_base to be freed + */ +EVENT2_EXPORT_SYMBOL +void event_base_free(struct event_base *); + +/** + As event_free, but do not run finalizers. + + THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + BECOMES STABLE. + */ +EVENT2_EXPORT_SYMBOL +void event_base_free_nofinalize(struct event_base *); + +/** @name Log severities + */ +/**@{*/ +#define EVENT_LOG_DEBUG 0 +#define EVENT_LOG_MSG 1 +#define EVENT_LOG_WARN 2 +#define EVENT_LOG_ERR 3 +/**@}*/ + +/* Obsolete names: these are deprecated, but older programs might use them. + * They violate the reserved-identifier namespace. */ +#define _EVENT_LOG_DEBUG EVENT_LOG_DEBUG +#define _EVENT_LOG_MSG EVENT_LOG_MSG +#define _EVENT_LOG_WARN EVENT_LOG_WARN +#define _EVENT_LOG_ERR EVENT_LOG_ERR + +/** + A callback function used to intercept Libevent's log messages. + + @see event_set_log_callback + */ +typedef void (*event_log_cb)(int severity, const char *msg); +/** + Redirect Libevent's log messages. + + @param cb a function taking two arguments: an integer severity between + EVENT_LOG_DEBUG and EVENT_LOG_ERR, and a string. If cb is NULL, + then the default log is used. + + NOTE: The function you provide *must not* call any other libevent + functionality. Doing so can produce undefined behavior. + */ +EVENT2_EXPORT_SYMBOL +void event_set_log_callback(event_log_cb cb); + +/** + A function to be called if Libevent encounters a fatal internal error. + + @see event_set_fatal_callback + */ +typedef void (*event_fatal_cb)(int err); + +/** + Override Libevent's behavior in the event of a fatal internal error. + + By default, Libevent will call exit(1) if a programming error makes it + impossible to continue correct operation. This function allows you to supply + another callback instead. Note that if the function is ever invoked, + something is wrong with your program, or with Libevent: any subsequent calls + to Libevent may result in undefined behavior. + + Libevent will (almost) always log an EVENT_LOG_ERR message before calling + this function; look at the last log message to see why Libevent has died. + */ +EVENT2_EXPORT_SYMBOL +void event_set_fatal_callback(event_fatal_cb cb); + +#define EVENT_DBG_ALL 0xffffffffu +#define EVENT_DBG_NONE 0 + +/** + Turn on debugging logs and have them sent to the default log handler. + + This is a global setting; if you are going to call it, you must call this + before any calls that create an event-base. You must call it before any + multithreaded use of Libevent. + + Debug logs are verbose. + + @param which Controls which debug messages are turned on. This option is + unused for now; for forward compatibility, you must pass in the constant + "EVENT_DBG_ALL" to turn debugging logs on, or "EVENT_DBG_NONE" to turn + debugging logs off. + */ +EVENT2_EXPORT_SYMBOL +void event_enable_debug_logging(ev_uint32_t which); + +/** + Associate a different event base with an event. + + The event to be associated must not be currently active or pending. + + @param eb the event base + @param ev the event + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int event_base_set(struct event_base *, struct event *); + +/** @name Loop flags + + These flags control the behavior of event_base_loop(). + */ +/**@{*/ +/** Block until we have an active event, then exit once all active events + * have had their callbacks run. */ +#define EVLOOP_ONCE 0x01 +/** Do not block: see which events are ready now, run the callbacks + * of the highest-priority ones, then exit. */ +#define EVLOOP_NONBLOCK 0x02 +/** Do not exit the loop because we have no pending events. Instead, keep + * running until event_base_loopexit() or event_base_loopbreak() makes us + * stop. + */ +#define EVLOOP_NO_EXIT_ON_EMPTY 0x04 +/**@}*/ + +/** + Wait for events to become active, and run their callbacks. + + This is a more flexible version of event_base_dispatch(). + + By default, this loop will run the event base until either there are no more + pending or active events, or until something calls event_base_loopbreak() or + event_base_loopexit(). You can override this behavior with the 'flags' + argument. + + @param eb the event_base structure returned by event_base_new() or + event_base_new_with_config() + @param flags any combination of EVLOOP_ONCE | EVLOOP_NONBLOCK + @return 0 if successful, -1 if an error occurred, or 1 if we exited because + no events were pending or active. + @see event_base_loopexit(), event_base_dispatch(), EVLOOP_ONCE, + EVLOOP_NONBLOCK + */ +EVENT2_EXPORT_SYMBOL +int event_base_loop(struct event_base *, int); + +/** + Exit the event loop after the specified time + + The next event_base_loop() iteration after the given timer expires will + complete normally (handling all queued events) then exit without + blocking for events again. + + Subsequent invocations of event_base_loop() will proceed normally. + + @param eb the event_base structure returned by event_init() + @param tv the amount of time after which the loop should terminate, + or NULL to exit after running all currently active events. + @return 0 if successful, or -1 if an error occurred + @see event_base_loopbreak() + */ +EVENT2_EXPORT_SYMBOL +int event_base_loopexit(struct event_base *, const struct timeval *); + +/** + Abort the active event_base_loop() immediately. + + event_base_loop() will abort the loop after the next event is completed; + event_base_loopbreak() is typically invoked from this event's callback. + This behavior is analogous to the "break;" statement. + + Subsequent invocations of event_base_loop() will proceed normally. + + @param eb the event_base structure returned by event_init() + @return 0 if successful, or -1 if an error occurred + @see event_base_loopexit() + */ +EVENT2_EXPORT_SYMBOL +int event_base_loopbreak(struct event_base *); + +/** + Tell the active event_base_loop() to scan for new events immediately. + + Calling this function makes the currently active event_base_loop() + start the loop over again (scanning for new events) after the current + event callback finishes. If the event loop is not running, this + function has no effect. + + event_base_loopbreak() is typically invoked from this event's callback. + This behavior is analogous to the "continue;" statement. + + Subsequent invocations of event loop will proceed normally. + + @param eb the event_base structure returned by event_init() + @return 0 if successful, or -1 if an error occurred + @see event_base_loopbreak() + */ +EVENT2_EXPORT_SYMBOL +int event_base_loopcontinue(struct event_base *); + +/** + Checks if the event loop was told to exit by event_base_loopexit(). + + This function will return true for an event_base at every point after + event_loopexit() is called, until the event loop is next entered. + + @param eb the event_base structure returned by event_init() + @return true if event_base_loopexit() was called on this event base, + or 0 otherwise + @see event_base_loopexit() + @see event_base_got_break() + */ +EVENT2_EXPORT_SYMBOL +int event_base_got_exit(struct event_base *); + +/** + Checks if the event loop was told to abort immediately by event_base_loopbreak(). + + This function will return true for an event_base at every point after + event_base_loopbreak() is called, until the event loop is next entered. + + @param eb the event_base structure returned by event_init() + @return true if event_base_loopbreak() was called on this event base, + or 0 otherwise + @see event_base_loopbreak() + @see event_base_got_exit() + */ +EVENT2_EXPORT_SYMBOL +int event_base_got_break(struct event_base *); + +/** + * @name event flags + * + * Flags to pass to event_new(), event_assign(), event_pending(), and + * anything else with an argument of the form "short events" + */ +/**@{*/ +/** Indicates that a timeout has occurred. It's not necessary to pass + * this flag to event_for new()/event_assign() to get a timeout. */ +#define EV_TIMEOUT 0x01 +/** Wait for a socket or FD to become readable */ +#define EV_READ 0x02 +/** Wait for a socket or FD to become writeable */ +#define EV_WRITE 0x04 +/** Wait for a POSIX signal to be raised*/ +#define EV_SIGNAL 0x08 +/** + * Persistent event: won't get removed automatically when activated. + * + * When a persistent event with a timeout becomes activated, its timeout + * is reset to 0. + */ +#define EV_PERSIST 0x10 +/** Select edge-triggered behavior, if supported by the backend. */ +#define EV_ET 0x20 +/** + * If this option is provided, then event_del() will not block in one thread + * while waiting for the event callback to complete in another thread. + * + * To use this option safely, you may need to use event_finalize() or + * event_free_finalize() in order to safely tear down an event in a + * multithreaded application. See those functions for more information. + * + * THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + * BECOMES STABLE. + **/ +#define EV_FINALIZE 0x40 +/** + * Detects connection close events. You can use this to detect when a + * connection has been closed, without having to read all the pending data + * from a connection. + * + * Not all backends support EV_CLOSED. To detect or require it, use the + * feature flag EV_FEATURE_EARLY_CLOSE. + **/ +#define EV_CLOSED 0x80 +/**@}*/ + +/** + @name evtimer_* macros + + Aliases for working with one-shot timer events */ +/**@{*/ +#define evtimer_assign(ev, b, cb, arg) \ + event_assign((ev), (b), -1, 0, (cb), (arg)) +#define evtimer_new(b, cb, arg) event_new((b), -1, 0, (cb), (arg)) +#define evtimer_add(ev, tv) event_add((ev), (tv)) +#define evtimer_del(ev) event_del(ev) +#define evtimer_pending(ev, tv) event_pending((ev), EV_TIMEOUT, (tv)) +#define evtimer_initialized(ev) event_initialized(ev) +/**@}*/ + +/** + @name evsignal_* macros + + Aliases for working with signal events + */ +/**@{*/ +#define evsignal_add(ev, tv) event_add((ev), (tv)) +#define evsignal_assign(ev, b, x, cb, arg) \ + event_assign((ev), (b), (x), EV_SIGNAL|EV_PERSIST, cb, (arg)) +#define evsignal_new(b, x, cb, arg) \ + event_new((b), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg)) +#define evsignal_del(ev) event_del(ev) +#define evsignal_pending(ev, tv) event_pending((ev), EV_SIGNAL, (tv)) +#define evsignal_initialized(ev) event_initialized(ev) +/**@}*/ + +/** + A callback function for an event. + + It receives three arguments: + + @param fd An fd or signal + @param events One or more EV_* flags + @param arg A user-supplied argument. + + @see event_new() + */ +typedef void (*event_callback_fn)(evutil_socket_t, short, void *); + +/** + Return a value used to specify that the event itself must be used as the callback argument. + + The function event_new() takes a callback argument which is passed + to the event's callback function. To specify that the argument to be + passed to the callback function is the event that event_new() returns, + pass in the return value of event_self_cbarg() as the callback argument + for event_new(). + + For example: + 
+      struct event *ev = event_new(base, sock, events, callback, %event_self_cbarg());
+
+ + For consistency with event_new(), it is possible to pass the return value + of this function as the callback argument for event_assign() – this + achieves the same result as passing the event in directly. + + @return a value to be passed as the callback argument to event_new() or + event_assign(). + @see event_new(), event_assign() + */ +EVENT2_EXPORT_SYMBOL +void *event_self_cbarg(void); + +/** + Allocate and asssign a new event structure, ready to be added. + + The function event_new() returns a new event that can be used in + future calls to event_add() and event_del(). The fd and events + arguments determine which conditions will trigger the event; the + callback and callback_arg arguments tell Libevent what to do when the + event becomes active. + + If events contains one of EV_READ, EV_WRITE, or EV_READ|EV_WRITE, then + fd is a file descriptor or socket that should get monitored for + readiness to read, readiness to write, or readiness for either operation + (respectively). If events contains EV_SIGNAL, then fd is a signal + number to wait for. If events contains none of those flags, then the + event can be triggered only by a timeout or by manual activation with + event_active(): In this case, fd must be -1. + + The EV_PERSIST flag can also be passed in the events argument: it makes + event_add() persistent until event_del() is called. + + The EV_ET flag is compatible with EV_READ and EV_WRITE, and supported + only by certain backends. It tells Libevent to use edge-triggered + events. + + The EV_TIMEOUT flag has no effect here. + + It is okay to have multiple events all listening on the same fds; but + they must either all be edge-triggered, or all not be edge triggerd. + + When the event becomes active, the event loop will run the provided + callbuck function, with three arguments. The first will be the provided + fd value. The second will be a bitfield of the events that triggered: + EV_READ, EV_WRITE, or EV_SIGNAL. Here the EV_TIMEOUT flag indicates + that a timeout occurred, and EV_ET indicates that an edge-triggered + event occurred. The third event will be the callback_arg pointer that + you provide. + + @param base the event base to which the event should be attached. + @param fd the file descriptor or signal to be monitored, or -1. + @param events desired events to monitor: bitfield of EV_READ, EV_WRITE, + EV_SIGNAL, EV_PERSIST, EV_ET. + @param callback callback function to be invoked when the event occurs + @param callback_arg an argument to be passed to the callback function + + @return a newly allocated struct event that must later be freed with + event_free(). + @see event_free(), event_add(), event_del(), event_assign() + */ +EVENT2_EXPORT_SYMBOL +struct event *event_new(struct event_base *, evutil_socket_t, short, event_callback_fn, void *); + + +/** + Prepare a new, already-allocated event structure to be added. + + The function event_assign() prepares the event structure ev to be used + in future calls to event_add() and event_del(). Unlike event_new(), it + doesn't allocate memory itself: it requires that you have already + allocated a struct event, probably on the heap. Doing this will + typically make your code depend on the size of the event structure, and + thereby create incompatibility with future versions of Libevent. + + The easiest way to avoid this problem is just to use event_new() and + event_free() instead. + + A slightly harder way to future-proof your code is to use + event_get_struct_event_size() to determine the required size of an event + at runtime. + + Note that it is NOT safe to call this function on an event that is + active or pending. Doing so WILL corrupt internal data structures in + Libevent, and lead to strange, hard-to-diagnose bugs. You _can_ use + event_assign to change an existing event, but only if it is not active + or pending! + + The arguments for this function, and the behavior of the events that it + makes, are as for event_new(). + + @param ev an event struct to be modified + @param base the event base to which ev should be attached. + @param fd the file descriptor to be monitored + @param events desired events to monitor; can be EV_READ and/or EV_WRITE + @param callback callback function to be invoked when the event occurs + @param callback_arg an argument to be passed to the callback function + + @return 0 if success, or -1 on invalid arguments. + + @see event_new(), event_add(), event_del(), event_base_once(), + event_get_struct_event_size() + */ +EVENT2_EXPORT_SYMBOL +int event_assign(struct event *, struct event_base *, evutil_socket_t, short, event_callback_fn, void *); + +/** + Deallocate a struct event * returned by event_new(). + + If the event is pending or active, first make it non-pending and + non-active. + */ +EVENT2_EXPORT_SYMBOL +void event_free(struct event *); + +/** + * Callback type for event_finalize and event_free_finalize(). + * + * THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + * BECOMES STABLE. + * + **/ +typedef void (*event_finalize_callback_fn)(struct event *, void *); +/** + @name Finalization functions + + These functions are used to safely tear down an event in a multithreaded + application. If you construct your events with EV_FINALIZE to avoid + deadlocks, you will need a way to remove an event in the certainty that + it will definitely not be running its callback when you deallocate it + and its callback argument. + + To do this, call one of event_finalize() or event_free_finalize with + 0 for its first argument, the event to tear down as its second argument, + and a callback function as its third argument. The callback will be + invoked as part of the event loop, with the event's priority. + + After you call a finalizer function, event_add() and event_active() will + no longer work on the event, and event_del() will produce a no-op. You + must not try to change the event's fields with event_assign() or + event_set() while the finalize callback is in progress. Once the + callback has been invoked, you should treat the event structure as + containing uninitialized memory. + + The event_free_finalize() function frees the event after it's finalized; + event_finalize() does not. + + A finalizer callback must not make events pending or active. It must not + add events, activate events, or attempt to "resucitate" the event being + finalized in any way. + + THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + BECOMES STABLE. + + @return 0 on succes, -1 on failure. + */ +/**@{*/ +EVENT2_EXPORT_SYMBOL +int event_finalize(unsigned, struct event *, event_finalize_callback_fn); +EVENT2_EXPORT_SYMBOL +int event_free_finalize(unsigned, struct event *, event_finalize_callback_fn); +/**@}*/ + +/** + Schedule a one-time event + + The function event_base_once() is similar to event_new(). However, it + schedules a callback to be called exactly once, and does not require the + caller to prepare an event structure. + + Note that in Libevent 2.0 and earlier, if the event is never triggered, the + internal memory used to hold it will never be freed. In Libevent 2.1, + the internal memory will get freed by event_base_free() if the event + is never triggered. The 'arg' value, however, will not get freed in either + case--you'll need to free that on your own if you want it to go away. + + @param base an event_base + @param fd a file descriptor to monitor, or -1 for no fd. + @param events event(s) to monitor; can be any of EV_READ | + EV_WRITE, or EV_TIMEOUT + @param callback callback function to be invoked when the event occurs + @param arg an argument to be passed to the callback function + @param timeout the maximum amount of time to wait for the event. NULL + makes an EV_READ/EV_WRITE event make forever; NULL makes an + EV_TIMEOUT event succees immediately. + @return 0 if successful, or -1 if an error occurred + */ +EVENT2_EXPORT_SYMBOL +int event_base_once(struct event_base *, evutil_socket_t, short, event_callback_fn, void *, const struct timeval *); + +/** + Add an event to the set of pending events. + + The function event_add() schedules the execution of the event 'ev' when the + condition specified by event_assign() or event_new() occurs, or when the time + specified in timeout has elapesed. If atimeout is NULL, no timeout + occurs and the function will only be + called if a matching event occurs. The event in the + ev argument must be already initialized by event_assign() or event_new() + and may not be used + in calls to event_assign() until it is no longer pending. + + If the event in the ev argument already has a scheduled timeout, calling + event_add() replaces the old timeout with the new one if tv is non-NULL. + + @param ev an event struct initialized via event_assign() or event_new() + @param timeout the maximum amount of time to wait for the event, or NULL + to wait forever + @return 0 if successful, or -1 if an error occurred + @see event_del(), event_assign(), event_new() + */ +EVENT2_EXPORT_SYMBOL +int event_add(struct event *ev, const struct timeval *timeout); + +/** + Remove a timer from a pending event without removing the event itself. + + If the event has a scheduled timeout, this function unschedules it but + leaves the event otherwise pending. + + @param ev an event struct initialized via event_assign() or event_new() + @return 0 on success, or -1 if an error occurrect. +*/ +EVENT2_EXPORT_SYMBOL +int event_remove_timer(struct event *ev); + +/** + Remove an event from the set of monitored events. + + The function event_del() will cancel the event in the argument ev. If the + event has already executed or has never been added the call will have no + effect. + + @param ev an event struct to be removed from the working set + @return 0 if successful, or -1 if an error occurred + @see event_add() + */ +EVENT2_EXPORT_SYMBOL +int event_del(struct event *); + +/** + As event_del(), but never blocks while the event's callback is running + in another thread, even if the event was constructed without the + EV_FINALIZE flag. + + THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + BECOMES STABLE. + */ +EVENT2_EXPORT_SYMBOL +int event_del_noblock(struct event *ev); +/** + As event_del(), but always blocks while the event's callback is running + in another thread, even if the event was constructed with the + EV_FINALIZE flag. + + THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + BECOMES STABLE. + */ +EVENT2_EXPORT_SYMBOL +int event_del_block(struct event *ev); + +/** + Make an event active. + + You can use this function on a pending or a non-pending event to make it + active, so that its callback will be run by event_base_dispatch() or + event_base_loop(). + + One common use in multithreaded programs is to wake the thread running + event_base_loop() from another thread. + + @param ev an event to make active. + @param res a set of flags to pass to the event's callback. + @param ncalls an obsolete argument: this is ignored. + **/ +EVENT2_EXPORT_SYMBOL +void event_active(struct event *ev, int res, short ncalls); + +/** + Checks if a specific event is pending or scheduled. + + @param ev an event struct previously passed to event_add() + @param events the requested event type; any of EV_TIMEOUT|EV_READ| + EV_WRITE|EV_SIGNAL + @param tv if this field is not NULL, and the event has a timeout, + this field is set to hold the time at which the timeout will + expire. + + @return true if the event is pending on any of the events in 'what', (that + is to say, it has been added), or 0 if the event is not added. + */ +EVENT2_EXPORT_SYMBOL +int event_pending(const struct event *ev, short events, struct timeval *tv); + +/** + If called from within the callback for an event, returns that event. + + The behavior of this function is not defined when called from outside the + callback function for an event. + */ +EVENT2_EXPORT_SYMBOL +struct event *event_base_get_running_event(struct event_base *base); + +/** + Test if an event structure might be initialized. + + The event_initialized() function can be used to check if an event has been + initialized. + + Warning: This function is only useful for distinguishing a a zeroed-out + piece of memory from an initialized event, it can easily be confused by + uninitialized memory. Thus, it should ONLY be used to distinguish an + initialized event from zero. + + @param ev an event structure to be tested + @return 1 if the structure might be initialized, or 0 if it has not been + initialized + */ +EVENT2_EXPORT_SYMBOL +int event_initialized(const struct event *ev); + +/** + Get the signal number assigned to a signal event +*/ +#define event_get_signal(ev) ((int)event_get_fd(ev)) + +/** + Get the socket or signal assigned to an event, or -1 if the event has + no socket. +*/ +EVENT2_EXPORT_SYMBOL +evutil_socket_t event_get_fd(const struct event *ev); + +/** + Get the event_base associated with an event. +*/ +EVENT2_EXPORT_SYMBOL +struct event_base *event_get_base(const struct event *ev); + +/** + Return the events (EV_READ, EV_WRITE, etc) assigned to an event. +*/ +EVENT2_EXPORT_SYMBOL +short event_get_events(const struct event *ev); + +/** + Return the callback assigned to an event. +*/ +EVENT2_EXPORT_SYMBOL +event_callback_fn event_get_callback(const struct event *ev); + +/** + Return the callback argument assigned to an event. +*/ +EVENT2_EXPORT_SYMBOL +void *event_get_callback_arg(const struct event *ev); + +/** + Return the priority of an event. + @see event_priority_init(), event_get_priority() +*/ +EVENT2_EXPORT_SYMBOL +int event_get_priority(const struct event *ev); + +/** + Extract _all_ of arguments given to construct a given event. The + event_base is copied into *base_out, the fd is copied into *fd_out, and so + on. + + If any of the "_out" arguments is NULL, it will be ignored. + */ +EVENT2_EXPORT_SYMBOL +void event_get_assignment(const struct event *event, + struct event_base **base_out, evutil_socket_t *fd_out, short *events_out, + event_callback_fn *callback_out, void **arg_out); + +/** + Return the size of struct event that the Libevent library was compiled + with. + + This will be NO GREATER than sizeof(struct event) if you're running with + the same version of Libevent that your application was built with, but + otherwise might not. + + Note that it might be SMALLER than sizeof(struct event) if some future + version of Libevent adds extra padding to the end of struct event. + We might do this to help ensure ABI-compatibility between different + versions of Libevent. + */ +EVENT2_EXPORT_SYMBOL +size_t event_get_struct_event_size(void); + +/** + Get the Libevent version. + + Note that this will give you the version of the library that you're + currently linked against, not the version of the headers that you've + compiled against. + + @return a string containing the version number of Libevent +*/ +EVENT2_EXPORT_SYMBOL +const char *event_get_version(void); + +/** + Return a numeric representation of Libevent's version. + + Note that this will give you the version of the library that you're + currently linked against, not the version of the headers you've used to + compile. + + The format uses one byte each for the major, minor, and patchlevel parts of + the version number. The low-order byte is unused. For example, version + 2.0.1-alpha has a numeric representation of 0x02000100 +*/ +EVENT2_EXPORT_SYMBOL +ev_uint32_t event_get_version_number(void); + +/** As event_get_version, but gives the version of Libevent's headers. */ +#define LIBEVENT_VERSION EVENT__VERSION +/** As event_get_version_number, but gives the version number of Libevent's + * headers. */ +#define LIBEVENT_VERSION_NUMBER EVENT__NUMERIC_VERSION + +/** Largest number of priorities that Libevent can support. */ +#define EVENT_MAX_PRIORITIES 256 +/** + Set the number of different event priorities + + By default Libevent schedules all active events with the same priority. + However, some time it is desirable to process some events with a higher + priority than others. For that reason, Libevent supports strict priority + queues. Active events with a lower priority are always processed before + events with a higher priority. + + The number of different priorities can be set initially with the + event_base_priority_init() function. This function should be called + before the first call to event_base_dispatch(). The + event_priority_set() function can be used to assign a priority to an + event. By default, Libevent assigns the middle priority to all events + unless their priority is explicitly set. + + Note that urgent-priority events can starve less-urgent events: after + running all urgent-priority callbacks, Libevent checks for more urgent + events again, before running less-urgent events. Less-urgent events + will not have their callbacks run until there are no events more urgent + than them that want to be active. + + @param eb the event_base structure returned by event_base_new() + @param npriorities the maximum number of priorities + @return 0 if successful, or -1 if an error occurred + @see event_priority_set() + */ +EVENT2_EXPORT_SYMBOL +int event_base_priority_init(struct event_base *, int); + +/** + Get the number of different event priorities. + + @param eb the event_base structure returned by event_base_new() + @return Number of different event priorities + @see event_base_priority_init() +*/ +EVENT2_EXPORT_SYMBOL +int event_base_get_npriorities(struct event_base *eb); + +/** + Assign a priority to an event. + + @param ev an event struct + @param priority the new priority to be assigned + @return 0 if successful, or -1 if an error occurred + @see event_priority_init(), event_get_priority() + */ +EVENT2_EXPORT_SYMBOL +int event_priority_set(struct event *, int); + +/** + Prepare an event_base to use a large number of timeouts with the same + duration. + + Libevent's default scheduling algorithm is optimized for having a large + number of timeouts with their durations more or less randomly + distributed. But if you have a large number of timeouts that all have + the same duration (for example, if you have a large number of + connections that all have a 10-second timeout), then you can improve + Libevent's performance by telling Libevent about it. + + To do this, call this function with the common duration. It will return a + pointer to a different, opaque timeout value. (Don't depend on its actual + contents!) When you use this timeout value in event_add(), Libevent will + schedule the event more efficiently. + + (This optimization probably will not be worthwhile until you have thousands + or tens of thousands of events with the same timeout.) + */ +EVENT2_EXPORT_SYMBOL +const struct timeval *event_base_init_common_timeout(struct event_base *base, + const struct timeval *duration); + +#if !defined(EVENT__DISABLE_MM_REPLACEMENT) || defined(EVENT_IN_DOXYGEN_) +/** + Override the functions that Libevent uses for memory management. + + Usually, Libevent uses the standard libc functions malloc, realloc, and + free to allocate memory. Passing replacements for those functions to + event_set_mem_functions() overrides this behavior. + + Note that all memory returned from Libevent will be allocated by the + replacement functions rather than by malloc() and realloc(). Thus, if you + have replaced those functions, it will not be appropriate to free() memory + that you get from Libevent. Instead, you must use the free_fn replacement + that you provided. + + Note also that if you are going to call this function, you should do so + before any call to any Libevent function that does allocation. + Otherwise, those funtions will allocate their memory using malloc(), but + then later free it using your provided free_fn. + + @param malloc_fn A replacement for malloc. + @param realloc_fn A replacement for realloc + @param free_fn A replacement for free. + **/ +EVENT2_EXPORT_SYMBOL +void event_set_mem_functions( + void *(*malloc_fn)(size_t sz), + void *(*realloc_fn)(void *ptr, size_t sz), + void (*free_fn)(void *ptr)); +/** This definition is present if Libevent was built with support for + event_set_mem_functions() */ +#define EVENT_SET_MEM_FUNCTIONS_IMPLEMENTED +#endif + +/** + Writes a human-readable description of all inserted and/or active + events to a provided stdio stream. + + This is intended for debugging; its format is not guaranteed to be the same + between libevent versions. + + @param base An event_base on which to scan the events. + @param output A stdio file to write on. + */ +EVENT2_EXPORT_SYMBOL +void event_base_dump_events(struct event_base *, FILE *); + + +/** + Activates all pending events for the given fd and event mask. + + This function activates pending events only. Events which have not been + added will not become active. + + @param base the event_base on which to activate the events. + @param fd An fd to active events on. + @param events One or more of EV_{READ,WRITE}. + */ +EVENT2_EXPORT_SYMBOL +void event_base_active_by_fd(struct event_base *base, evutil_socket_t fd, short events); + +/** + Activates all pending signals with a given signal number + + This function activates pending events only. Events which have not been + added will not become active. + + @param base the event_base on which to activate the events. + @param fd The signal to active events on. + */ +EVENT2_EXPORT_SYMBOL +void event_base_active_by_signal(struct event_base *base, int sig); + +/** + * Callback for iterating events in an event base via event_base_foreach_event + */ +typedef int (*event_base_foreach_event_cb)(const struct event_base *, const struct event *, void *); + +/** + Iterate over all added or active events events in an event loop, and invoke + a given callback on each one. + + The callback must not call any function that modifies the event base, that + modifies any event in the event base, or that adds or removes any event to + the event base. Doing so is unsupported and will lead to undefined + behavior -- likely, to crashes. + + event_base_foreach_event() holds a lock on the event_base() for the whole + time it's running: slow callbacks are not advisable. + + Note that Libevent adds some events of its own to make pieces of its + functionality work. You must not assume that the only events you'll + encounter will be the ones you added yourself. + + The callback function must return 0 to continue iteration, or some other + integer to stop iterating. + + @param base An event_base on which to scan the events. + @param fn A callback function to receive the events. + @param arg An argument passed to the callback function. + @return 0 if we iterated over every event, or the value returned by the + callback function if the loop exited early. +*/ +EVENT2_EXPORT_SYMBOL +int event_base_foreach_event(struct event_base *base, event_base_foreach_event_cb fn, void *arg); + + +/** Sets 'tv' to the current time (as returned by gettimeofday()), + looking at the cached value in 'base' if possible, and calling + gettimeofday() or clock_gettime() as appropriate if there is no + cached time. + + Generally, this value will only be cached while actually + processing event callbacks, and may be very inaccuate if your + callbacks take a long time to execute. + + Returns 0 on success, negative on failure. + */ +EVENT2_EXPORT_SYMBOL +int event_base_gettimeofday_cached(struct event_base *base, + struct timeval *tv); + +/** Update cached_tv in the 'base' to the current time + * + * You can use this function is useful for selectively increasing + * the accuracy of the cached time value in 'base' during callbacks + * that take a long time to execute. + * + * This function has no effect if the base is currently not in its + * event loop, or if timeval caching is disabled via + * EVENT_BASE_FLAG_NO_CACHE_TIME. + * + * @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int event_base_update_cache_time(struct event_base *base); + +/** Release up all globally-allocated resources allocated by Libevent. + + This function does not free developer-controlled resources like + event_bases, events, bufferevents, listeners, and so on. It only releases + resources like global locks that there is no other way to free. + + It is not actually necessary to call this function before exit: every + resource that it frees would be released anyway on exit. It mainly exists + so that resource-leak debugging tools don't see Libevent as holding + resources at exit. + + You should only call this function when no other Libevent functions will + be invoked -- e.g., when cleanly exiting a program. + */ +EVENT2_EXPORT_SYMBOL +void libevent_global_shutdown(void); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/event_compat.h b/Source/Import/libevent/Includes/Linux/event2/event_compat.h new file mode 100644 index 0000000..5110175 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/event_compat.h @@ -0,0 +1,230 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_EVENT_COMPAT_H_INCLUDED_ +#define EVENT2_EVENT_COMPAT_H_INCLUDED_ + +/** @file event2/event_compat.h + + Potentially non-threadsafe versions of the functions in event.h: provided + only for backwards compatibility. + + In the oldest versions of Libevent, event_base was not a first-class + structure. Instead, there was a single event base that every function + manipulated. Later, when separate event bases were added, the old functions + that didn't take an event_base argument needed to work by manipulating the + "current" event base. This could lead to thread-safety issues, and obscure, + hard-to-diagnose bugs. + + @deprecated All functions in this file are by definition deprecated. + */ +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/** + Initialize the event API. + + The event API needs to be initialized with event_init() before it can be + used. Sets the global current base that gets used for events that have no + base associated with them. + + @deprecated This function is deprecated because it replaces the "current" + event_base, and is totally unsafe for multithreaded use. The replacement + is event_base_new(). + + @see event_base_set(), event_base_new() + */ +EVENT2_EXPORT_SYMBOL +struct event_base *event_init(void); + +/** + Loop to process events. + + Like event_base_dispatch(), but uses the "current" base. + + @deprecated This function is deprecated because it is easily confused by + multiple calls to event_init(), and because it is not safe for + multithreaded use. The replacement is event_base_dispatch(). + + @see event_base_dispatch(), event_init() + */ +EVENT2_EXPORT_SYMBOL +int event_dispatch(void); + +/** + Handle events. + + This function behaves like event_base_loop(), but uses the "current" base + + @deprecated This function is deprecated because it uses the event base from + the last call to event_init, and is therefore not safe for multithreaded + use. The replacement is event_base_loop(). + + @see event_base_loop(), event_init() +*/ +EVENT2_EXPORT_SYMBOL +int event_loop(int); + + +/** + Exit the event loop after the specified time. + + This function behaves like event_base_loopexit(), except that it uses the + "current" base. + + @deprecated This function is deprecated because it uses the event base from + the last call to event_init, and is therefore not safe for multithreaded + use. The replacement is event_base_loopexit(). + + @see event_init, event_base_loopexit() + */ +EVENT2_EXPORT_SYMBOL +int event_loopexit(const struct timeval *); + + +/** + Abort the active event_loop() immediately. + + This function behaves like event_base_loopbreakt(), except that it uses the + "current" base. + + @deprecated This function is deprecated because it uses the event base from + the last call to event_init, and is therefore not safe for multithreaded + use. The replacement is event_base_loopbreak(). + + @see event_base_loopbreak(), event_init() + */ +EVENT2_EXPORT_SYMBOL +int event_loopbreak(void); + +/** + Schedule a one-time event to occur. + + @deprecated This function is obsolete, and has been replaced by + event_base_once(). Its use is deprecated because it relies on the + "current" base configured by event_init(). + + @see event_base_once() + */ +EVENT2_EXPORT_SYMBOL +int event_once(evutil_socket_t , short, + void (*)(evutil_socket_t, short, void *), void *, const struct timeval *); + + +/** + Get the kernel event notification mechanism used by Libevent. + + @deprecated This function is obsolete, and has been replaced by + event_base_get_method(). Its use is deprecated because it relies on the + "current" base configured by event_init(). + + @see event_base_get_method() + */ +EVENT2_EXPORT_SYMBOL +const char *event_get_method(void); + + +/** + Set the number of different event priorities. + + @deprecated This function is deprecated because it is easily confused by + multiple calls to event_init(), and because it is not safe for + multithreaded use. The replacement is event_base_priority_init(). + + @see event_base_priority_init() + */ +EVENT2_EXPORT_SYMBOL +int event_priority_init(int); + +/** + Prepare an event structure to be added. + + @deprecated event_set() is not recommended for new code, because it requires + a subsequent call to event_base_set() to be safe under most circumstances. + Use event_assign() or event_new() instead. + */ +EVENT2_EXPORT_SYMBOL +void event_set(struct event *, evutil_socket_t, short, void (*)(evutil_socket_t, short, void *), void *); + +#define evtimer_set(ev, cb, arg) event_set((ev), -1, 0, (cb), (arg)) +#define evsignal_set(ev, x, cb, arg) \ + event_set((ev), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg)) + + +/** + @name timeout_* macros + + @deprecated These macros are deprecated because their naming is inconsistent + with the rest of Libevent. Use the evtimer_* macros instead. + @{ + */ +#define timeout_add(ev, tv) event_add((ev), (tv)) +#define timeout_set(ev, cb, arg) event_set((ev), -1, 0, (cb), (arg)) +#define timeout_del(ev) event_del(ev) +#define timeout_pending(ev, tv) event_pending((ev), EV_TIMEOUT, (tv)) +#define timeout_initialized(ev) event_initialized(ev) +/**@}*/ + +/** + @name signal_* macros + + @deprecated These macros are deprecated because their naming is inconsistent + with the rest of Libevent. Use the evsignal_* macros instead. + @{ + */ +#define signal_add(ev, tv) event_add((ev), (tv)) +#define signal_set(ev, x, cb, arg) \ + event_set((ev), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg)) +#define signal_del(ev) event_del(ev) +#define signal_pending(ev, tv) event_pending((ev), EV_SIGNAL, (tv)) +#define signal_initialized(ev) event_initialized(ev) +/**@}*/ + +#ifndef EVENT_FD +/* These macros are obsolete; use event_get_fd and event_get_signal instead. */ +#define EVENT_FD(ev) ((int)event_get_fd(ev)) +#define EVENT_SIGNAL(ev) event_get_signal(ev) +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_COMPAT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/event_struct.h b/Source/Import/libevent/Includes/Linux/event2/event_struct.h new file mode 100644 index 0000000..1c8b71b --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/event_struct.h @@ -0,0 +1,180 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_EVENT_STRUCT_H_INCLUDED_ +#define EVENT2_EVENT_STRUCT_H_INCLUDED_ + +/** @file event2/event_struct.h + + Structures used by event.h. Using these structures directly WILL harm + forward compatibility: be careful. + + No field declared in this file should be used directly in user code. Except + for historical reasons, these fields would not be exposed at all. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/* For evkeyvalq */ +#include + +#define EVLIST_TIMEOUT 0x01 +#define EVLIST_INSERTED 0x02 +#define EVLIST_SIGNAL 0x04 +#define EVLIST_ACTIVE 0x08 +#define EVLIST_INTERNAL 0x10 +#define EVLIST_ACTIVE_LATER 0x20 +#define EVLIST_FINALIZING 0x40 +#define EVLIST_INIT 0x80 + +#define EVLIST_ALL 0xff + +/* Fix so that people don't have to run with */ +#ifndef TAILQ_ENTRY +#define EVENT_DEFINED_TQENTRY_ +#define TAILQ_ENTRY(type) \ +struct { \ + struct type *tqe_next; /* next element */ \ + struct type **tqe_prev; /* address of previous next element */ \ +} +#endif /* !TAILQ_ENTRY */ + +#ifndef TAILQ_HEAD +#define EVENT_DEFINED_TQHEAD_ +#define TAILQ_HEAD(name, type) \ +struct name { \ + struct type *tqh_first; \ + struct type **tqh_last; \ +} +#endif + +/* Fix so that people don't have to run with */ +#ifndef LIST_ENTRY +#define EVENT_DEFINED_LISTENTRY_ +#define LIST_ENTRY(type) \ +struct { \ + struct type *le_next; /* next element */ \ + struct type **le_prev; /* address of previous next element */ \ +} +#endif /* !LIST_ENTRY */ + +#ifndef LIST_HEAD +#define EVENT_DEFINED_LISTHEAD_ +#define LIST_HEAD(name, type) \ +struct name { \ + struct type *lh_first; /* first element */ \ + } +#endif /* !LIST_HEAD */ + +struct event; + +struct event_callback { + TAILQ_ENTRY(event_callback) evcb_active_next; + short evcb_flags; + ev_uint8_t evcb_pri; /* smaller numbers are higher priority */ + ev_uint8_t evcb_closure; + /* allows us to adopt for different types of events */ + union { + void (*evcb_callback)(evutil_socket_t, short, void *); + void (*evcb_selfcb)(struct event_callback *, void *); + void (*evcb_evfinalize)(struct event *, void *); + void (*evcb_cbfinalize)(struct event_callback *, void *); + } evcb_cb_union; + void *evcb_arg; +}; + +struct event_base; +struct event { + struct event_callback ev_evcallback; + + /* for managing timeouts */ + union { + TAILQ_ENTRY(event) ev_next_with_common_timeout; + int min_heap_idx; + } ev_timeout_pos; + evutil_socket_t ev_fd; + + struct event_base *ev_base; + + union { + /* used for io events */ + struct { + LIST_ENTRY (event) ev_io_next; + struct timeval ev_timeout; + } ev_io; + + /* used by signal events */ + struct { + LIST_ENTRY (event) ev_signal_next; + short ev_ncalls; + /* Allows deletes in callback */ + short *ev_pncalls; + } ev_signal; + } ev_; + + short ev_events; + short ev_res; /* result passed to event callback */ + struct timeval ev_timeout; +}; + +TAILQ_HEAD (event_list, event); + +#ifdef EVENT_DEFINED_TQENTRY_ +#undef TAILQ_ENTRY +#endif + +#ifdef EVENT_DEFINED_TQHEAD_ +#undef TAILQ_HEAD +#endif + +LIST_HEAD (event_dlist, event); + +#ifdef EVENT_DEFINED_LISTENTRY_ +#undef LIST_ENTRY +#endif + +#ifdef EVENT_DEFINED_LISTHEAD_ +#undef LIST_HEAD +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_STRUCT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/http.h b/Source/Import/libevent/Includes/Linux/event2/http.h new file mode 100644 index 0000000..8fb5642 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/http.h @@ -0,0 +1,1189 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_HTTP_H_INCLUDED_ +#define EVENT2_HTTP_H_INCLUDED_ + +/* For int types. */ +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* In case we haven't included the right headers yet. */ +struct evbuffer; +struct event_base; +struct bufferevent; +struct evhttp_connection; + +/** @file event2/http.h + * + * Basic support for HTTP serving. + * + * As Libevent is a library for dealing with event notification and most + * interesting applications are networked today, I have often found the + * need to write HTTP code. The following prototypes and definitions provide + * an application with a minimal interface for making HTTP requests and for + * creating a very simple HTTP server. + */ + +/* Response codes */ +#define HTTP_OK 200 /**< request completed ok */ +#define HTTP_NOCONTENT 204 /**< request does not have content */ +#define HTTP_MOVEPERM 301 /**< the uri moved permanently */ +#define HTTP_MOVETEMP 302 /**< the uri moved temporarily */ +#define HTTP_NOTMODIFIED 304 /**< page was not modified from last */ +#define HTTP_BADREQUEST 400 /**< invalid http request was made */ +#define HTTP_NOTFOUND 404 /**< could not find content for uri */ +#define HTTP_BADMETHOD 405 /**< method not allowed for this uri */ +#define HTTP_ENTITYTOOLARGE 413 /**< */ +#define HTTP_EXPECTATIONFAILED 417 /**< we can't handle this expectation */ +#define HTTP_INTERNAL 500 /**< internal error */ +#define HTTP_NOTIMPLEMENTED 501 /**< not implemented */ +#define HTTP_SERVUNAVAIL 503 /**< the server is not available */ + +struct evhttp; +struct evhttp_request; +struct evkeyvalq; +struct evhttp_bound_socket; +struct evconnlistener; +struct evdns_base; + +/** + * Create a new HTTP server. + * + * @param base (optional) the event base to receive the HTTP events + * @return a pointer to a newly initialized evhttp server structure + * @see evhttp_free() + */ +EVENT2_EXPORT_SYMBOL +struct evhttp *evhttp_new(struct event_base *base); + +/** + * Binds an HTTP server on the specified address and port. + * + * Can be called multiple times to bind the same http server + * to multiple different ports. + * + * @param http a pointer to an evhttp object + * @param address a string containing the IP address to listen(2) on + * @param port the port number to listen on + * @return 0 on success, -1 on failure. + * @see evhttp_accept_socket() + */ +EVENT2_EXPORT_SYMBOL +int evhttp_bind_socket(struct evhttp *http, const char *address, ev_uint16_t port); + +/** + * Like evhttp_bind_socket(), but returns a handle for referencing the socket. + * + * The returned pointer is not valid after \a http is freed. + * + * @param http a pointer to an evhttp object + * @param address a string containing the IP address to listen(2) on + * @param port the port number to listen on + * @return Handle for the socket on success, NULL on failure. + * @see evhttp_bind_socket(), evhttp_del_accept_socket() + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_bound_socket *evhttp_bind_socket_with_handle(struct evhttp *http, const char *address, ev_uint16_t port); + +/** + * Makes an HTTP server accept connections on the specified socket. + * + * This may be useful to create a socket and then fork multiple instances + * of an http server, or when a socket has been communicated via file + * descriptor passing in situations where an http servers does not have + * permissions to bind to a low-numbered port. + * + * Can be called multiple times to have the http server listen to + * multiple different sockets. + * + * @param http a pointer to an evhttp object + * @param fd a socket fd that is ready for accepting connections + * @return 0 on success, -1 on failure. + * @see evhttp_bind_socket() + */ +EVENT2_EXPORT_SYMBOL +int evhttp_accept_socket(struct evhttp *http, evutil_socket_t fd); + +/** + * Like evhttp_accept_socket(), but returns a handle for referencing the socket. + * + * The returned pointer is not valid after \a http is freed. + * + * @param http a pointer to an evhttp object + * @param fd a socket fd that is ready for accepting connections + * @return Handle for the socket on success, NULL on failure. + * @see evhttp_accept_socket(), evhttp_del_accept_socket() + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_bound_socket *evhttp_accept_socket_with_handle(struct evhttp *http, evutil_socket_t fd); + +/** + * The most low-level evhttp_bind/accept method: takes an evconnlistener, and + * returns an evhttp_bound_socket. The listener will be freed when the bound + * socket is freed. + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_bound_socket *evhttp_bind_listener(struct evhttp *http, struct evconnlistener *listener); + +/** + * Return the listener used to implement a bound socket. + */ +EVENT2_EXPORT_SYMBOL +struct evconnlistener *evhttp_bound_socket_get_listener(struct evhttp_bound_socket *bound); + +typedef void evhttp_bound_socket_foreach_fn(struct evhttp_bound_socket *, void *); +/** + * Applies the function specified in the first argument to all + * evhttp_bound_sockets associated with "http". The user must not + * attempt to free or remove any connections, sockets or listeners + * in the callback "function". + * + * @param http pointer to an evhttp object + * @param function function to apply to every bound socket + * @param argument pointer value passed to function for every socket iterated + */ +EVENT2_EXPORT_SYMBOL +void evhttp_foreach_bound_socket(struct evhttp *http, evhttp_bound_socket_foreach_fn *function, void *argument); + +/** + * Makes an HTTP server stop accepting connections on the specified socket + * + * This may be useful when a socket has been sent via file descriptor passing + * and is no longer needed by the current process. + * + * If you created this bound socket with evhttp_bind_socket_with_handle or + * evhttp_accept_socket_with_handle, this function closes the fd you provided. + * If you created this bound socket with evhttp_bind_listener, this function + * frees the listener you provided. + * + * \a bound_socket is an invalid pointer after this call returns. + * + * @param http a pointer to an evhttp object + * @param bound_socket a handle returned by evhttp_{bind,accept}_socket_with_handle + * @see evhttp_bind_socket_with_handle(), evhttp_accept_socket_with_handle() + */ +EVENT2_EXPORT_SYMBOL +void evhttp_del_accept_socket(struct evhttp *http, struct evhttp_bound_socket *bound_socket); + +/** + * Get the raw file descriptor referenced by an evhttp_bound_socket. + * + * @param bound_socket a handle returned by evhttp_{bind,accept}_socket_with_handle + * @return the file descriptor used by the bound socket + * @see evhttp_bind_socket_with_handle(), evhttp_accept_socket_with_handle() + */ +EVENT2_EXPORT_SYMBOL +evutil_socket_t evhttp_bound_socket_get_fd(struct evhttp_bound_socket *bound_socket); + +/** + * Free the previously created HTTP server. + * + * Works only if no requests are currently being served. + * + * @param http the evhttp server object to be freed + * @see evhttp_start() + */ +EVENT2_EXPORT_SYMBOL +void evhttp_free(struct evhttp* http); + +/** XXX Document. */ +EVENT2_EXPORT_SYMBOL +void evhttp_set_max_headers_size(struct evhttp* http, ev_ssize_t max_headers_size); +/** XXX Document. */ +EVENT2_EXPORT_SYMBOL +void evhttp_set_max_body_size(struct evhttp* http, ev_ssize_t max_body_size); + +/** + Set the value to use for the Content-Type header when none was provided. If + the content type string is NULL, the Content-Type header will not be + automatically added. + + @param http the http server on which to set the default content type + @param content_type the value for the Content-Type header +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_set_default_content_type(struct evhttp *http, + const char *content_type); + +/** + Sets the what HTTP methods are supported in requests accepted by this + server, and passed to user callbacks. + + If not supported they will generate a "405 Method not allowed" response. + + By default this includes the following methods: GET, POST, HEAD, PUT, DELETE + + @param http the http server on which to set the methods + @param methods bit mask constructed from evhttp_cmd_type values +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_set_allowed_methods(struct evhttp* http, ev_uint16_t methods); + +/** + Set a callback for a specified URI + + @param http the http sever on which to set the callback + @param path the path for which to invoke the callback + @param cb the callback function that gets invoked on requesting path + @param cb_arg an additional context argument for the callback + @return 0 on success, -1 if the callback existed already, -2 on failure +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_set_cb(struct evhttp *http, const char *path, + void (*cb)(struct evhttp_request *, void *), void *cb_arg); + +/** Removes the callback for a specified URI */ +EVENT2_EXPORT_SYMBOL +int evhttp_del_cb(struct evhttp *, const char *); + +/** + Set a callback for all requests that are not caught by specific callbacks + + Invokes the specified callback for all requests that do not match any of + the previously specified request paths. This is catchall for requests not + specifically configured with evhttp_set_cb(). + + @param http the evhttp server object for which to set the callback + @param cb the callback to invoke for any unmatched requests + @param arg an context argument for the callback +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_set_gencb(struct evhttp *http, + void (*cb)(struct evhttp_request *, void *), void *arg); + +/** + Set a callback used to create new bufferevents for connections + to a given evhttp object. + + You can use this to override the default bufferevent type -- for example, + to make this evhttp object use SSL bufferevents rather than unencrypted + ones. + + New bufferevents must be allocated with no fd set on them. + + @param http the evhttp server object for which to set the callback + @param cb the callback to invoke for incoming connections + @param arg an context argument for the callback + */ +EVENT2_EXPORT_SYMBOL +void evhttp_set_bevcb(struct evhttp *http, + struct bufferevent *(*cb)(struct event_base *, void *), void *arg); + +/** + Adds a virtual host to the http server. + + A virtual host is a newly initialized evhttp object that has request + callbacks set on it via evhttp_set_cb() or evhttp_set_gencb(). It + most not have any listing sockets associated with it. + + If the virtual host has not been removed by the time that evhttp_free() + is called on the main http server, it will be automatically freed, too. + + It is possible to have hierarchical vhosts. For example: A vhost + with the pattern *.example.com may have other vhosts with patterns + foo.example.com and bar.example.com associated with it. + + @param http the evhttp object to which to add a virtual host + @param pattern the glob pattern against which the hostname is matched. + The match is case insensitive and follows otherwise regular shell + matching. + @param vhost the virtual host to add the regular http server. + @return 0 on success, -1 on failure + @see evhttp_remove_virtual_host() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_add_virtual_host(struct evhttp* http, const char *pattern, + struct evhttp* vhost); + +/** + Removes a virtual host from the http server. + + @param http the evhttp object from which to remove the virtual host + @param vhost the virtual host to remove from the regular http server. + @return 0 on success, -1 on failure + @see evhttp_add_virtual_host() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_remove_virtual_host(struct evhttp* http, struct evhttp* vhost); + +/** + Add a server alias to an http object. The http object can be a virtual + host or the main server. + + @param http the evhttp object + @param alias the alias to add + @see evhttp_add_remove_alias() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_add_server_alias(struct evhttp *http, const char *alias); + +/** + Remove a server alias from an http object. + + @param http the evhttp object + @param alias the alias to remove + @see evhttp_add_server_alias() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_remove_server_alias(struct evhttp *http, const char *alias); + +/** + * Set the timeout for an HTTP request. + * + * @param http an evhttp object + * @param timeout_in_secs the timeout, in seconds + */ +EVENT2_EXPORT_SYMBOL +void evhttp_set_timeout(struct evhttp *http, int timeout_in_secs); + +/** + * Set the timeout for an HTTP request. + * + * @param http an evhttp object + * @param tv the timeout, or NULL + */ +EVENT2_EXPORT_SYMBOL +void evhttp_set_timeout_tv(struct evhttp *http, const struct timeval* tv); + +/* Read all the clients body, and only after this respond with an error if the + * clients body exceed max_body_size */ +#define EVHTTP_SERVER_LINGERING_CLOSE 0x0001 +/** + * Set connection flags for HTTP server. + * + * @see EVHTTP_SERVER_* + * @return 0 on success, otherwise non zero (for example if flag doesn't + * supported). + */ +EVENT2_EXPORT_SYMBOL +int evhttp_set_flags(struct evhttp *http, int flags); + +/* Request/Response functionality */ + +/** + * Send an HTML error message to the client. + * + * @param req a request object + * @param error the HTTP error code + * @param reason a brief explanation of the error. If this is NULL, we'll + * just use the standard meaning of the error code. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_send_error(struct evhttp_request *req, int error, + const char *reason); + +/** + * Send an HTML reply to the client. + * + * The body of the reply consists of the data in databuf. After calling + * evhttp_send_reply() databuf will be empty, but the buffer is still + * owned by the caller and needs to be deallocated by the caller if + * necessary. + * + * @param req a request object + * @param code the HTTP response code to send + * @param reason a brief message to send with the response code + * @param databuf the body of the response + */ +EVENT2_EXPORT_SYMBOL +void evhttp_send_reply(struct evhttp_request *req, int code, + const char *reason, struct evbuffer *databuf); + +/* Low-level response interface, for streaming/chunked replies */ + +/** + Initiate a reply that uses Transfer-Encoding chunked. + + This allows the caller to stream the reply back to the client and is + useful when either not all of the reply data is immediately available + or when sending very large replies. + + The caller needs to supply data chunks with evhttp_send_reply_chunk() + and complete the reply by calling evhttp_send_reply_end(). + + @param req a request object + @param code the HTTP response code to send + @param reason a brief message to send with the response code +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_send_reply_start(struct evhttp_request *req, int code, + const char *reason); + +/** + Send another data chunk as part of an ongoing chunked reply. + + The reply chunk consists of the data in databuf. After calling + evhttp_send_reply_chunk() databuf will be empty, but the buffer is + still owned by the caller and needs to be deallocated by the caller + if necessary. + + @param req a request object + @param databuf the data chunk to send as part of the reply. +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_send_reply_chunk(struct evhttp_request *req, + struct evbuffer *databuf); + +/** + Send another data chunk as part of an ongoing chunked reply. + + The reply chunk consists of the data in databuf. After calling + evhttp_send_reply_chunk() databuf will be empty, but the buffer is + still owned by the caller and needs to be deallocated by the caller + if necessary. + + @param req a request object + @param databuf the data chunk to send as part of the reply. + @param cb callback funcion + @param call back's argument. +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_send_reply_chunk_with_cb(struct evhttp_request *, struct evbuffer *, + void (*cb)(struct evhttp_connection *, void *), void *arg); + +/** + Complete a chunked reply, freeing the request as appropriate. + + @param req a request object +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_send_reply_end(struct evhttp_request *req); + +/* + * Interfaces for making requests + */ + +/** The different request types supported by evhttp. These are as specified + * in RFC2616, except for PATCH which is specified by RFC5789. + * + * By default, only some of these methods are accepted and passed to user + * callbacks; use evhttp_set_allowed_methods() to change which methods + * are allowed. + */ +enum evhttp_cmd_type { + EVHTTP_REQ_GET = 1 << 0, + EVHTTP_REQ_POST = 1 << 1, + EVHTTP_REQ_HEAD = 1 << 2, + EVHTTP_REQ_PUT = 1 << 3, + EVHTTP_REQ_DELETE = 1 << 4, + EVHTTP_REQ_OPTIONS = 1 << 5, + EVHTTP_REQ_TRACE = 1 << 6, + EVHTTP_REQ_CONNECT = 1 << 7, + EVHTTP_REQ_PATCH = 1 << 8 +}; + +/** a request object can represent either a request or a reply */ +enum evhttp_request_kind { EVHTTP_REQUEST, EVHTTP_RESPONSE }; + +/** + * Create and return a connection object that can be used to for making HTTP + * requests. The connection object tries to resolve address and establish the + * connection when it is given an http request object. + * + * @param base the event_base to use for handling the connection + * @param dnsbase the dns_base to use for resolving host names; if not + * specified host name resolution will block. + * @param bev a bufferevent to use for connecting to the server; if NULL, a + * socket-based bufferevent will be created. This buffrevent will be freed + * when the connection closes. It must have no fd set on it. + * @param address the address to which to connect + * @param port the port to connect to + * @return an evhttp_connection object that can be used for making requests + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_connection *evhttp_connection_base_bufferevent_new( + struct event_base *base, struct evdns_base *dnsbase, struct bufferevent* bev, const char *address, ev_uint16_t port); + +/** + * Return the bufferevent that an evhttp_connection is using. + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent* evhttp_connection_get_bufferevent(struct evhttp_connection *evcon); + +/** + * Return the HTTP server associated with this connection, or NULL. + */ +EVENT2_EXPORT_SYMBOL +struct evhttp *evhttp_connection_get_server(struct evhttp_connection *evcon); + +/** + * Creates a new request object that needs to be filled in with the request + * parameters. The callback is executed when the request completed or an + * error occurred. + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_request *evhttp_request_new( + void (*cb)(struct evhttp_request *, void *), void *arg); + +/** + * Enable delivery of chunks to requestor. + * @param cb will be called after every read of data with the same argument + * as the completion callback. Will never be called on an empty + * response. May drain the input buffer; it will be drained + * automatically on return. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_request_set_chunked_cb(struct evhttp_request *, + void (*cb)(struct evhttp_request *, void *)); + +/** + * Register callback for additional parsing of request headers. + * @param cb will be called after receiving and parsing the full header. + * It allows analyzing the header and possibly closing the connection + * by returning a value < 0. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_request_set_header_cb(struct evhttp_request *, + int (*cb)(struct evhttp_request *, void *)); + +/** + * The different error types supported by evhttp + * + * @see evhttp_request_set_error_cb() + */ +enum evhttp_request_error { + /** + * Timeout reached, also @see evhttp_connection_set_timeout() + */ + EVREQ_HTTP_TIMEOUT, + /** + * EOF reached + */ + EVREQ_HTTP_EOF, + /** + * Error while reading header, or invalid header + */ + EVREQ_HTTP_INVALID_HEADER, + /** + * Error encountered while reading or writing + */ + EVREQ_HTTP_BUFFER_ERROR, + /** + * The evhttp_cancel_request() called on this request. + */ + EVREQ_HTTP_REQUEST_CANCEL, + /** + * Body is greater then evhttp_connection_set_max_body_size() + */ + EVREQ_HTTP_DATA_TOO_LONG +}; +/** + * Set a callback for errors + * @see evhttp_request_error for error types. + * + * On error, both the error callback and the regular callback will be called, + * error callback is called before the regular callback. + **/ +EVENT2_EXPORT_SYMBOL +void evhttp_request_set_error_cb(struct evhttp_request *, + void (*)(enum evhttp_request_error, void *)); + +/** + * Set a callback to be called on request completion of evhttp_send_* function. + * + * The callback function will be called on the completion of the request after + * the output data has been written and before the evhttp_request object + * is destroyed. This can be useful for tracking resources associated with a + * request (ex: timing metrics). + * + * @param req a request object + * @param cb callback function that will be called on request completion + * @param cb_arg an additional context argument for the callback + */ +EVENT2_EXPORT_SYMBOL +void evhttp_request_set_on_complete_cb(struct evhttp_request *req, + void (*cb)(struct evhttp_request *, void *), void *cb_arg); + +/** Frees the request object and removes associated events. */ +EVENT2_EXPORT_SYMBOL +void evhttp_request_free(struct evhttp_request *req); + +/** + * Create and return a connection object that can be used to for making HTTP + * requests. The connection object tries to resolve address and establish the + * connection when it is given an http request object. + * + * @param base the event_base to use for handling the connection + * @param dnsbase the dns_base to use for resolving host names; if not + * specified host name resolution will block. + * @param address the address to which to connect + * @param port the port to connect to + * @return an evhttp_connection object that can be used for making requests + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_connection *evhttp_connection_base_new( + struct event_base *base, struct evdns_base *dnsbase, + const char *address, ev_uint16_t port); + +/** + * Set family hint for DNS requests. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_family(struct evhttp_connection *evcon, + int family); + +/* reuse connection address on retry */ +#define EVHTTP_CON_REUSE_CONNECTED_ADDR 0x0008 +/* Try to read error, since server may already send and close + * connection, but if at that time we have some data to send then we + * can send get EPIPE and fail, while we can read that HTTP error. */ +#define EVHTTP_CON_READ_ON_WRITE_ERROR 0x0010 +/* @see EVHTTP_SERVER_LINGERING_CLOSE */ +#define EVHTTP_CON_LINGERING_CLOSE 0x0020 +/* Padding for public flags, @see EVHTTP_CON_* in http-internal.h */ +#define EVHTTP_CON_PUBLIC_FLAGS_END 0x100000 +/** + * Set connection flags. + * + * @see EVHTTP_CON_* + * @return 0 on success, otherwise non zero (for example if flag doesn't + * supported). + */ +EVENT2_EXPORT_SYMBOL +int evhttp_connection_set_flags(struct evhttp_connection *evcon, + int flags); + +/** Takes ownership of the request object + * + * Can be used in a request callback to keep onto the request until + * evhttp_request_free() is explicitly called by the user. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_request_own(struct evhttp_request *req); + +/** Returns 1 if the request is owned by the user */ +EVENT2_EXPORT_SYMBOL +int evhttp_request_is_owned(struct evhttp_request *req); + +/** + * Returns the connection object associated with the request or NULL + * + * The user needs to either free the request explicitly or call + * evhttp_send_reply_end(). + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_connection *evhttp_request_get_connection(struct evhttp_request *req); + +/** + * Returns the underlying event_base for this connection + */ +EVENT2_EXPORT_SYMBOL +struct event_base *evhttp_connection_get_base(struct evhttp_connection *req); + +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_max_headers_size(struct evhttp_connection *evcon, + ev_ssize_t new_max_headers_size); + +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_max_body_size(struct evhttp_connection* evcon, + ev_ssize_t new_max_body_size); + +/** Frees an http connection */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_free(struct evhttp_connection *evcon); + +/** Disowns a given connection object + * + * Can be used to tell libevent to free the connection object after + * the last request has completed or failed. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_free_on_completion(struct evhttp_connection *evcon); + +/** sets the ip address from which http connections are made */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_local_address(struct evhttp_connection *evcon, + const char *address); + +/** sets the local port from which http connections are made */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_local_port(struct evhttp_connection *evcon, + ev_uint16_t port); + +/** Sets the timeout in seconds for events related to this connection */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_timeout(struct evhttp_connection *evcon, + int timeout_in_secs); + +/** Sets the timeout for events related to this connection. Takes a struct + * timeval. */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_timeout_tv(struct evhttp_connection *evcon, + const struct timeval *tv); + +/** Sets the delay before retrying requests on this connection. This is only + * used if evhttp_connection_set_retries is used to make the number of retries + * at least one. Each retry after the first is twice as long as the one before + * it. */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_initial_retry_tv(struct evhttp_connection *evcon, + const struct timeval *tv); + +/** Sets the retry limit for this connection - -1 repeats indefinitely */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_retries(struct evhttp_connection *evcon, + int retry_max); + +/** Set a callback for connection close. */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_closecb(struct evhttp_connection *evcon, + void (*)(struct evhttp_connection *, void *), void *); + +/** Get the remote address and port associated with this connection. */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_get_peer(struct evhttp_connection *evcon, + char **address, ev_uint16_t *port); + +/** Get the remote address associated with this connection. + * extracted from getpeername() OR from nameserver. + * + * @return NULL if getpeername() return non success, + * or connection is not connected, + * otherwise it return pointer to struct sockaddr_storage */ +EVENT2_EXPORT_SYMBOL +const struct sockaddr* +evhttp_connection_get_addr(struct evhttp_connection *evcon); + +/** + Make an HTTP request over the specified connection. + + The connection gets ownership of the request. On failure, the + request object is no longer valid as it has been freed. + + @param evcon the evhttp_connection object over which to send the request + @param req the previously created and configured request object + @param type the request type EVHTTP_REQ_GET, EVHTTP_REQ_POST, etc. + @param uri the URI associated with the request + @return 0 on success, -1 on failure + @see evhttp_cancel_request() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_make_request(struct evhttp_connection *evcon, + struct evhttp_request *req, + enum evhttp_cmd_type type, const char *uri); + +/** + Cancels a pending HTTP request. + + Cancels an ongoing HTTP request. The callback associated with this request + is not executed and the request object is freed. If the request is + currently being processed, e.g. it is ongoing, the corresponding + evhttp_connection object is going to get reset. + + A request cannot be canceled if its callback has executed already. A request + may be canceled reentrantly from its chunked callback. + + @param req the evhttp_request to cancel; req becomes invalid after this call. +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_cancel_request(struct evhttp_request *req); + +/** + * A structure to hold a parsed URI or Relative-Ref conforming to RFC3986. + */ +struct evhttp_uri; + +/** Returns the request URI */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_request_get_uri(const struct evhttp_request *req); +/** Returns the request URI (parsed) */ +EVENT2_EXPORT_SYMBOL +const struct evhttp_uri *evhttp_request_get_evhttp_uri(const struct evhttp_request *req); +/** Returns the request command */ +EVENT2_EXPORT_SYMBOL +enum evhttp_cmd_type evhttp_request_get_command(const struct evhttp_request *req); + +EVENT2_EXPORT_SYMBOL +int evhttp_request_get_response_code(const struct evhttp_request *req); +EVENT2_EXPORT_SYMBOL +const char * evhttp_request_get_response_code_line(const struct evhttp_request *req); + +/** Returns the input headers */ +EVENT2_EXPORT_SYMBOL +struct evkeyvalq *evhttp_request_get_input_headers(struct evhttp_request *req); +/** Returns the output headers */ +EVENT2_EXPORT_SYMBOL +struct evkeyvalq *evhttp_request_get_output_headers(struct evhttp_request *req); +/** Returns the input buffer */ +EVENT2_EXPORT_SYMBOL +struct evbuffer *evhttp_request_get_input_buffer(struct evhttp_request *req); +/** Returns the output buffer */ +EVENT2_EXPORT_SYMBOL +struct evbuffer *evhttp_request_get_output_buffer(struct evhttp_request *req); +/** Returns the host associated with the request. If a client sends an absolute + URI, the host part of that is preferred. Otherwise, the input headers are + searched for a Host: header. NULL is returned if no absolute URI or Host: + header is provided. */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_request_get_host(struct evhttp_request *req); + +/* Interfaces for dealing with HTTP headers */ + +/** + Finds the value belonging to a header. + + @param headers the evkeyvalq object in which to find the header + @param key the name of the header to find + @returns a pointer to the value for the header or NULL if the header + could not be found. + @see evhttp_add_header(), evhttp_remove_header() +*/ +EVENT2_EXPORT_SYMBOL +const char *evhttp_find_header(const struct evkeyvalq *headers, + const char *key); + +/** + Removes a header from a list of existing headers. + + @param headers the evkeyvalq object from which to remove a header + @param key the name of the header to remove + @returns 0 if the header was removed, -1 otherwise. + @see evhttp_find_header(), evhttp_add_header() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_remove_header(struct evkeyvalq *headers, const char *key); + +/** + Adds a header to a list of existing headers. + + @param headers the evkeyvalq object to which to add a header + @param key the name of the header + @param value the value belonging to the header + @returns 0 on success, -1 otherwise. + @see evhttp_find_header(), evhttp_clear_headers() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_add_header(struct evkeyvalq *headers, const char *key, const char *value); + +/** + Removes all headers from the header list. + + @param headers the evkeyvalq object from which to remove all headers +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_clear_headers(struct evkeyvalq *headers); + +/* Miscellaneous utility functions */ + + +/** + Helper function to encode a string for inclusion in a URI. All + characters are replaced by their hex-escaped (%22) equivalents, + except for characters explicitly unreserved by RFC3986 -- that is, + ASCII alphanumeric characters, hyphen, dot, underscore, and tilde. + + The returned string must be freed by the caller. + + @param str an unencoded string + @return a newly allocated URI-encoded string or NULL on failure + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_encode_uri(const char *str); + +/** + As evhttp_encode_uri, but if 'size' is nonnegative, treat the string + as being 'size' bytes long. This allows you to encode strings that + may contain 0-valued bytes. + + The returned string must be freed by the caller. + + @param str an unencoded string + @param size the length of the string to encode, or -1 if the string + is NUL-terminated + @param space_to_plus if true, space characters in 'str' are encoded + as +, not %20. + @return a newly allocate URI-encoded string, or NULL on failure. + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_uriencode(const char *str, ev_ssize_t size, int space_to_plus); + +/** + Helper function to sort of decode a URI-encoded string. Unlike + evhttp_get_decoded_uri, it decodes all plus characters that appear + _after_ the first question mark character, but no plusses that occur + before. This is not a good way to decode URIs in whole or in part. + + The returned string must be freed by the caller + + @deprecated This function is deprecated; you probably want to use + evhttp_get_decoded_uri instead. + + @param uri an encoded URI + @return a newly allocated unencoded URI or NULL on failure + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_decode_uri(const char *uri); + +/** + Helper function to decode a URI-escaped string or HTTP parameter. + + If 'decode_plus' is 1, then we decode the string as an HTTP parameter + value, and convert all plus ('+') characters to spaces. If + 'decode_plus' is 0, we leave all plus characters unchanged. + + The returned string must be freed by the caller. + + @param uri a URI-encode encoded URI + @param decode_plus determines whether we convert '+' to space. + @param size_out if size_out is not NULL, *size_out is set to the size of the + returned string + @return a newly allocated unencoded URI or NULL on failure + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_uridecode(const char *uri, int decode_plus, + size_t *size_out); + +/** + Helper function to parse out arguments in a query. + + Parsing a URI like + + http://foo.com/?q=test&s=some+thing + + will result in two entries in the key value queue. + + The first entry is: key="q", value="test" + The second entry is: key="s", value="some thing" + + @deprecated This function is deprecated as of Libevent 2.0.9. Use + evhttp_uri_parse and evhttp_parse_query_str instead. + + @param uri the request URI + @param headers the head of the evkeyval queue + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evhttp_parse_query(const char *uri, struct evkeyvalq *headers); + +/** + Helper function to parse out arguments from the query portion of an + HTTP URI. + + Parsing a query string like + + q=test&s=some+thing + + will result in two entries in the key value queue. + + The first entry is: key="q", value="test" + The second entry is: key="s", value="some thing" + + @param query_parse the query portion of the URI + @param headers the head of the evkeyval queue + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evhttp_parse_query_str(const char *uri, struct evkeyvalq *headers); + +/** + * Escape HTML character entities in a string. + * + * Replaces <, >, ", ' and & with <, >, ", + * ' and & correspondingly. + * + * The returned string needs to be freed by the caller. + * + * @param html an unescaped HTML string + * @return an escaped HTML string or NULL on error + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_htmlescape(const char *html); + +/** + * Return a new empty evhttp_uri with no fields set. + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_uri *evhttp_uri_new(void); + +/** + * Changes the flags set on a given URI. See EVHTTP_URI_* for + * a list of flags. + **/ +EVENT2_EXPORT_SYMBOL +void evhttp_uri_set_flags(struct evhttp_uri *uri, unsigned flags); + +/** Return the scheme of an evhttp_uri, or NULL if there is no scheme has + * been set and the evhttp_uri contains a Relative-Ref. */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_scheme(const struct evhttp_uri *uri); +/** + * Return the userinfo part of an evhttp_uri, or NULL if it has no userinfo + * set. + */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_userinfo(const struct evhttp_uri *uri); +/** + * Return the host part of an evhttp_uri, or NULL if it has no host set. + * The host may either be a regular hostname (conforming to the RFC 3986 + * "regname" production), or an IPv4 address, or the empty string, or a + * bracketed IPv6 address, or a bracketed 'IP-Future' address. + * + * Note that having a NULL host means that the URI has no authority + * section, but having an empty-string host means that the URI has an + * authority section with no host part. For example, + * "mailto:user@example.com" has a host of NULL, but "file:///etc/motd" + * has a host of "". + */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_host(const struct evhttp_uri *uri); +/** Return the port part of an evhttp_uri, or -1 if there is no port set. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_get_port(const struct evhttp_uri *uri); +/** Return the path part of an evhttp_uri, or NULL if it has no path set */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_path(const struct evhttp_uri *uri); +/** Return the query part of an evhttp_uri (excluding the leading "?"), or + * NULL if it has no query set */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_query(const struct evhttp_uri *uri); +/** Return the fragment part of an evhttp_uri (excluding the leading "#"), + * or NULL if it has no fragment set */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_fragment(const struct evhttp_uri *uri); + +/** Set the scheme of an evhttp_uri, or clear the scheme if scheme==NULL. + * Returns 0 on success, -1 if scheme is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_scheme(struct evhttp_uri *uri, const char *scheme); +/** Set the userinfo of an evhttp_uri, or clear the userinfo if userinfo==NULL. + * Returns 0 on success, -1 if userinfo is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_userinfo(struct evhttp_uri *uri, const char *userinfo); +/** Set the host of an evhttp_uri, or clear the host if host==NULL. + * Returns 0 on success, -1 if host is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_host(struct evhttp_uri *uri, const char *host); +/** Set the port of an evhttp_uri, or clear the port if port==-1. + * Returns 0 on success, -1 if port is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_port(struct evhttp_uri *uri, int port); +/** Set the path of an evhttp_uri, or clear the path if path==NULL. + * Returns 0 on success, -1 if path is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_path(struct evhttp_uri *uri, const char *path); +/** Set the query of an evhttp_uri, or clear the query if query==NULL. + * The query should not include a leading "?". + * Returns 0 on success, -1 if query is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_query(struct evhttp_uri *uri, const char *query); +/** Set the fragment of an evhttp_uri, or clear the fragment if fragment==NULL. + * The fragment should not include a leading "#". + * Returns 0 on success, -1 if fragment is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_fragment(struct evhttp_uri *uri, const char *fragment); + +/** + * Helper function to parse a URI-Reference as specified by RFC3986. + * + * This function matches the URI-Reference production from RFC3986, + * which includes both URIs like + * + * scheme://[[userinfo]@]foo.com[:port]]/[path][?query][#fragment] + * + * and relative-refs like + * + * [path][?query][#fragment] + * + * Any optional elements portions not present in the original URI are + * left set to NULL in the resulting evhttp_uri. If no port is + * specified, the port is set to -1. + * + * Note that no decoding is performed on percent-escaped characters in + * the string; if you want to parse them, use evhttp_uridecode or + * evhttp_parse_query_str as appropriate. + * + * Note also that most URI schemes will have additional constraints that + * this function does not know about, and cannot check. For example, + * mailto://www.example.com/cgi-bin/fortune.pl is not a reasonable + * mailto url, http://www.example.com:99999/ is not a reasonable HTTP + * URL, and ftp:username@example.com is not a reasonable FTP URL. + * Nevertheless, all of these URLs conform to RFC3986, and this function + * accepts all of them as valid. + * + * @param source_uri the request URI + * @param flags Zero or more EVHTTP_URI_* flags to affect the behavior + * of the parser. + * @return uri container to hold parsed data, or NULL if there is error + * @see evhttp_uri_free() + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_uri *evhttp_uri_parse_with_flags(const char *source_uri, + unsigned flags); + +/** Tolerate URIs that do not conform to RFC3986. + * + * Unfortunately, some HTTP clients generate URIs that, according to RFC3986, + * are not conformant URIs. If you need to support these URIs, you can + * do so by passing this flag to evhttp_uri_parse_with_flags. + * + * Currently, these changes are: + *
    + *
  • Nonconformant URIs are allowed to contain otherwise unreasonable + * characters in their path, query, and fragment components. + *
+ */ +#define EVHTTP_URI_NONCONFORMANT 0x01 + +/** Alias for evhttp_uri_parse_with_flags(source_uri, 0) */ +EVENT2_EXPORT_SYMBOL +struct evhttp_uri *evhttp_uri_parse(const char *source_uri); + +/** + * Free all memory allocated for a parsed uri. Only use this for URIs + * generated by evhttp_uri_parse. + * + * @param uri container with parsed data + * @see evhttp_uri_parse() + */ +EVENT2_EXPORT_SYMBOL +void evhttp_uri_free(struct evhttp_uri *uri); + +/** + * Join together the uri parts from parsed data to form a URI-Reference. + * + * Note that no escaping of reserved characters is done on the members + * of the evhttp_uri, so the generated string might not be a valid URI + * unless the members of evhttp_uri are themselves valid. + * + * @param uri container with parsed data + * @param buf destination buffer + * @param limit destination buffer size + * @return an joined uri as string or NULL on error + * @see evhttp_uri_parse() + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_uri_join(struct evhttp_uri *uri, char *buf, size_t limit); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_HTTP_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/http_compat.h b/Source/Import/libevent/Includes/Linux/event2/http_compat.h new file mode 100644 index 0000000..43c2c43 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/http_compat.h @@ -0,0 +1,90 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_HTTP_COMPAT_H_INCLUDED_ +#define EVENT2_HTTP_COMPAT_H_INCLUDED_ + +/** @file event2/http_compat.h + + Potentially non-threadsafe versions of the functions in http.h: provided + only for backwards compatibility. + + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/** + * Start an HTTP server on the specified address and port + * + * @deprecated It does not allow an event base to be specified + * + * @param address the address to which the HTTP server should be bound + * @param port the port number on which the HTTP server should listen + * @return an struct evhttp object + */ +struct evhttp *evhttp_start(const char *address, ev_uint16_t port); + +/** + * A connection object that can be used to for making HTTP requests. The + * connection object tries to establish the connection when it is given an + * http request object. + * + * @deprecated It does not allow an event base to be specified + */ +struct evhttp_connection *evhttp_connection_new( + const char *address, ev_uint16_t port); + +/** + * Associates an event base with the connection - can only be called + * on a freshly created connection object that has not been used yet. + * + * @deprecated XXXX Why? + */ +void evhttp_connection_set_base(struct evhttp_connection *evcon, + struct event_base *base); + + +/** Returns the request URI */ +#define evhttp_request_uri evhttp_request_get_uri + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_COMPAT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/http_struct.h b/Source/Import/libevent/Includes/Linux/event2/http_struct.h new file mode 100644 index 0000000..4bf5b1f --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/http_struct.h @@ -0,0 +1,152 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_HTTP_STRUCT_H_INCLUDED_ +#define EVENT2_HTTP_STRUCT_H_INCLUDED_ + +/** @file event2/http_struct.h + + Data structures for http. Using these structures may hurt forward + compatibility with later versions of Libevent: be careful! + + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/** + * the request structure that a server receives. + * WARNING: expect this structure to change. I will try to provide + * reasonable accessors. + */ +struct evhttp_request { +#if defined(TAILQ_ENTRY) + TAILQ_ENTRY(evhttp_request) next; +#else +struct { + struct evhttp_request *tqe_next; + struct evhttp_request **tqe_prev; +} next; +#endif + + /* the connection object that this request belongs to */ + struct evhttp_connection *evcon; + int flags; +/** The request obj owns the evhttp connection and needs to free it */ +#define EVHTTP_REQ_OWN_CONNECTION 0x0001 +/** Request was made via a proxy */ +#define EVHTTP_PROXY_REQUEST 0x0002 +/** The request object is owned by the user; the user must free it */ +#define EVHTTP_USER_OWNED 0x0004 +/** The request will be used again upstack; freeing must be deferred */ +#define EVHTTP_REQ_DEFER_FREE 0x0008 +/** The request should be freed upstack */ +#define EVHTTP_REQ_NEEDS_FREE 0x0010 + + struct evkeyvalq *input_headers; + struct evkeyvalq *output_headers; + + /* address of the remote host and the port connection came from */ + char *remote_host; + ev_uint16_t remote_port; + + /* cache of the hostname for evhttp_request_get_host */ + char *host_cache; + + enum evhttp_request_kind kind; + enum evhttp_cmd_type type; + + size_t headers_size; + size_t body_size; + + char *uri; /* uri after HTTP request was parsed */ + struct evhttp_uri *uri_elems; /* uri elements */ + + char major; /* HTTP Major number */ + char minor; /* HTTP Minor number */ + + int response_code; /* HTTP Response code */ + char *response_code_line; /* Readable response */ + + struct evbuffer *input_buffer; /* read data */ + ev_int64_t ntoread; + unsigned chunked:1, /* a chunked request */ + userdone:1; /* the user has sent all data */ + + struct evbuffer *output_buffer; /* outgoing post or data */ + + /* Callback */ + void (*cb)(struct evhttp_request *, void *); + void *cb_arg; + + /* + * Chunked data callback - call for each completed chunk if + * specified. If not specified, all the data is delivered via + * the regular callback. + */ + void (*chunk_cb)(struct evhttp_request *, void *); + + /* + * Callback added for forked-daapd so they can collect ICY + * (shoutcast) metadata from the http header. If return + * int is negative the connection will be closed. + */ + int (*header_cb)(struct evhttp_request *, void *); + + /* + * Error callback - called when error is occured. + * @see evhttp_request_error for error types. + * + * @see evhttp_request_set_error_cb() + */ + void (*error_cb)(enum evhttp_request_error, void *); + + /* + * Send complete callback - called when the request is actually + * sent and completed. + */ + void (*on_complete_cb)(struct evhttp_request *, void *); + void *on_complete_cb_arg; +}; + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_HTTP_STRUCT_H_INCLUDED_ */ + diff --git a/Source/Import/libevent/Includes/Linux/event2/keyvalq_struct.h b/Source/Import/libevent/Includes/Linux/event2/keyvalq_struct.h new file mode 100644 index 0000000..bffa54b --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/keyvalq_struct.h @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_KEYVALQ_STRUCT_H_INCLUDED_ +#define EVENT2_KEYVALQ_STRUCT_H_INCLUDED_ + +#ifdef __cplusplus +extern "C" { +#endif + +/* Fix so that people don't have to run with */ +/* XXXX This code is duplicated with event_struct.h */ +#ifndef TAILQ_ENTRY +#define EVENT_DEFINED_TQENTRY_ +#define TAILQ_ENTRY(type) \ +struct { \ + struct type *tqe_next; /* next element */ \ + struct type **tqe_prev; /* address of previous next element */ \ +} +#endif /* !TAILQ_ENTRY */ + +#ifndef TAILQ_HEAD +#define EVENT_DEFINED_TQHEAD_ +#define TAILQ_HEAD(name, type) \ +struct name { \ + struct type *tqh_first; \ + struct type **tqh_last; \ +} +#endif + +/* + * Key-Value pairs. Can be used for HTTP headers but also for + * query argument parsing. + */ +struct evkeyval { + TAILQ_ENTRY(evkeyval) next; + + char *key; + char *value; +}; + +TAILQ_HEAD (evkeyvalq, evkeyval); + +/* XXXX This code is duplicated with event_struct.h */ +#ifdef EVENT_DEFINED_TQENTRY_ +#undef TAILQ_ENTRY +#endif + +#ifdef EVENT_DEFINED_TQHEAD_ +#undef TAILQ_HEAD +#endif + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/libevent/Includes/Linux/event2/listener.h b/Source/Import/libevent/Includes/Linux/event2/listener.h new file mode 100644 index 0000000..84b4da0 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/listener.h @@ -0,0 +1,180 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_LISTENER_H_INCLUDED_ +#define EVENT2_LISTENER_H_INCLUDED_ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +struct sockaddr; +struct evconnlistener; + +/** + A callback that we invoke when a listener has a new connection. + + @param listener The evconnlistener + @param fd The new file descriptor + @param addr The source address of the connection + @param socklen The length of addr + @param user_arg the pointer passed to evconnlistener_new() + */ +typedef void (*evconnlistener_cb)(struct evconnlistener *, evutil_socket_t, struct sockaddr *, int socklen, void *); + +/** + A callback that we invoke when a listener encounters a non-retriable error. + + @param listener The evconnlistener + @param user_arg the pointer passed to evconnlistener_new() + */ +typedef void (*evconnlistener_errorcb)(struct evconnlistener *, void *); + +/** Flag: Indicates that we should not make incoming sockets nonblocking + * before passing them to the callback. */ +#define LEV_OPT_LEAVE_SOCKETS_BLOCKING (1u<<0) +/** Flag: Indicates that freeing the listener should close the underlying + * socket. */ +#define LEV_OPT_CLOSE_ON_FREE (1u<<1) +/** Flag: Indicates that we should set the close-on-exec flag, if possible */ +#define LEV_OPT_CLOSE_ON_EXEC (1u<<2) +/** Flag: Indicates that we should disable the timeout (if any) between when + * this socket is closed and when we can listen again on the same port. */ +#define LEV_OPT_REUSEABLE (1u<<3) +/** Flag: Indicates that the listener should be locked so it's safe to use + * from multiple threadcs at once. */ +#define LEV_OPT_THREADSAFE (1u<<4) +/** Flag: Indicates that the listener should be created in disabled + * state. Use evconnlistener_enable() to enable it later. */ +#define LEV_OPT_DISABLED (1u<<5) +/** Flag: Indicates that the listener should defer accept() until data is + * available, if possible. Ignored on platforms that do not support this. + * + * This option can help performance for protocols where the client transmits + * immediately after connecting. Do not use this option if your protocol + * _doesn't_ start out with the client transmitting data, since in that case + * this option will sometimes cause the kernel to never tell you about the + * connection. + * + * This option is only supported by evconnlistener_new_bind(): it can't + * work with evconnlistener_new_fd(), since the listener needs to be told + * to use the option before it is actually bound. + */ +#define LEV_OPT_DEFERRED_ACCEPT (1u<<6) +/** Flag: Indicates that we ask to allow multiple servers (processes or + * threads) to bind to the same port if they each set the option. + * + * SO_REUSEPORT is what most people would expect SO_REUSEADDR to be, however + * SO_REUSEPORT does not imply SO_REUSEADDR. + * + * This is only available on Linux and kernel 3.9+ + */ +#define LEV_OPT_REUSEABLE_PORT (1u<<7) + +/** + Allocate a new evconnlistener object to listen for incoming TCP connections + on a given file descriptor. + + @param base The event base to associate the listener with. + @param cb A callback to be invoked when a new connection arrives. If the + callback is NULL, the listener will be treated as disabled until the + callback is set. + @param ptr A user-supplied pointer to give to the callback. + @param flags Any number of LEV_OPT_* flags + @param backlog Passed to the listen() call to determine the length of the + acceptable connection backlog. Set to -1 for a reasonable default. + Set to 0 if the socket is already listening. + @param fd The file descriptor to listen on. It must be a nonblocking + file descriptor, and it should already be bound to an appropriate + port and address. +*/ +EVENT2_EXPORT_SYMBOL +struct evconnlistener *evconnlistener_new(struct event_base *base, + evconnlistener_cb cb, void *ptr, unsigned flags, int backlog, + evutil_socket_t fd); +/** + Allocate a new evconnlistener object to listen for incoming TCP connections + on a given address. + + @param base The event base to associate the listener with. + @param cb A callback to be invoked when a new connection arrives. If the + callback is NULL, the listener will be treated as disabled until the + callback is set. + @param ptr A user-supplied pointer to give to the callback. + @param flags Any number of LEV_OPT_* flags + @param backlog Passed to the listen() call to determine the length of the + acceptable connection backlog. Set to -1 for a reasonable default. + @param addr The address to listen for connections on. + @param socklen The length of the address. + */ +EVENT2_EXPORT_SYMBOL +struct evconnlistener *evconnlistener_new_bind(struct event_base *base, + evconnlistener_cb cb, void *ptr, unsigned flags, int backlog, + const struct sockaddr *sa, int socklen); +/** + Disable and deallocate an evconnlistener. + */ +EVENT2_EXPORT_SYMBOL +void evconnlistener_free(struct evconnlistener *lev); +/** + Re-enable an evconnlistener that has been disabled. + */ +EVENT2_EXPORT_SYMBOL +int evconnlistener_enable(struct evconnlistener *lev); +/** + Stop listening for connections on an evconnlistener. + */ +EVENT2_EXPORT_SYMBOL +int evconnlistener_disable(struct evconnlistener *lev); + +/** Return an evconnlistener's associated event_base. */ +EVENT2_EXPORT_SYMBOL +struct event_base *evconnlistener_get_base(struct evconnlistener *lev); + +/** Return the socket that an evconnlistner is listening on. */ +EVENT2_EXPORT_SYMBOL +evutil_socket_t evconnlistener_get_fd(struct evconnlistener *lev); + +/** Change the callback on the listener to cb and its user_data to arg. + */ +EVENT2_EXPORT_SYMBOL +void evconnlistener_set_cb(struct evconnlistener *lev, + evconnlistener_cb cb, void *arg); + +/** Set an evconnlistener's error callback. */ +EVENT2_EXPORT_SYMBOL +void evconnlistener_set_error_cb(struct evconnlistener *lev, + evconnlistener_errorcb errorcb); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/libevent/Includes/Linux/event2/rpc.h b/Source/Import/libevent/Includes/Linux/event2/rpc.h new file mode 100644 index 0000000..dd43df2 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/rpc.h @@ -0,0 +1,596 @@ +/* + * Copyright (c) 2006-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_RPC_H_INCLUDED_ +#define EVENT2_RPC_H_INCLUDED_ + +#ifdef __cplusplus +extern "C" { +#endif + +/** @file rpc.h + * + * This header files provides basic support for an RPC server and client. + * + * To support RPCs in a server, every supported RPC command needs to be + * defined and registered. + * + * EVRPC_HEADER(SendCommand, Request, Reply); + * + * SendCommand is the name of the RPC command. + * Request is the name of a structure generated by event_rpcgen.py. + * It contains all parameters relating to the SendCommand RPC. The + * server needs to fill in the Reply structure. + * Reply is the name of a structure generated by event_rpcgen.py. It + * contains the answer to the RPC. + * + * To register an RPC with an HTTP server, you need to first create an RPC + * base with: + * + * struct evrpc_base *base = evrpc_init(http); + * + * A specific RPC can then be registered with + * + * EVRPC_REGISTER(base, SendCommand, Request, Reply, FunctionCB, arg); + * + * when the server receives an appropriately formatted RPC, the user callback + * is invoked. The callback needs to fill in the reply structure. + * + * void FunctionCB(EVRPC_STRUCT(SendCommand)* rpc, void *arg); + * + * To send the reply, call EVRPC_REQUEST_DONE(rpc); + * + * See the regression test for an example. + */ + +/** + Determines if the member has been set in the message + + @param msg the message to inspect + @param member the member variable to test for presences + @return 1 if it's present or 0 otherwise. +*/ +#define EVTAG_HAS(msg, member) \ + ((msg)->member##_set == 1) + +#ifndef EVENT2_RPC_COMPAT_H_INCLUDED_ + +/** + Assigns a value to the member in the message. + + @param msg the message to which to assign a value + @param member the name of the member variable + @param value the value to assign +*/ +#define EVTAG_ASSIGN(msg, member, value) \ + (*(msg)->base->member##_assign)((msg), (value)) +/** + Assigns a value to the member in the message. + + @param msg the message to which to assign a value + @param member the name of the member variable + @param value the value to assign + @param len the length of the value +*/ +#define EVTAG_ASSIGN_WITH_LEN(msg, member, value, len) \ + (*(msg)->base->member##_assign)((msg), (value), (len)) +/** + Returns the value for a member. + + @param msg the message from which to get the value + @param member the name of the member variable + @param pvalue a pointer to the variable to hold the value + @return 0 on success, -1 otherwise. +*/ +#define EVTAG_GET(msg, member, pvalue) \ + (*(msg)->base->member##_get)((msg), (pvalue)) +/** + Returns the value for a member. + + @param msg the message from which to get the value + @param member the name of the member variable + @param pvalue a pointer to the variable to hold the value + @param plen a pointer to the length of the value + @return 0 on success, -1 otherwise. +*/ +#define EVTAG_GET_WITH_LEN(msg, member, pvalue, plen) \ + (*(msg)->base->member##_get)((msg), (pvalue), (plen)) + +#endif /* EVENT2_RPC_COMPAT_H_INCLUDED_ */ + +/** + Adds a value to an array. +*/ +#define EVTAG_ARRAY_ADD_VALUE(msg, member, value) \ + (*(msg)->base->member##_add)((msg), (value)) +/** + Allocates a new entry in the array and returns it. +*/ +#define EVTAG_ARRAY_ADD(msg, member) \ + (*(msg)->base->member##_add)(msg) +/** + Gets a variable at the specified offset from the array. +*/ +#define EVTAG_ARRAY_GET(msg, member, offset, pvalue) \ + (*(msg)->base->member##_get)((msg), (offset), (pvalue)) +/** + Returns the number of entries in the array. +*/ +#define EVTAG_ARRAY_LEN(msg, member) ((msg)->member##_length) + + +struct evbuffer; +struct event_base; +struct evrpc_req_generic; +struct evrpc_request_wrapper; +struct evrpc; + +/** The type of a specific RPC Message + * + * @param rpcname the name of the RPC message + */ +#define EVRPC_STRUCT(rpcname) struct evrpc_req__##rpcname + +struct evhttp_request; +struct evrpc_status; +struct evrpc_hook_meta; + +/** Creates the definitions and prototypes for an RPC + * + * You need to use EVRPC_HEADER to create structures and function prototypes + * needed by the server and client implementation. The structures have to be + * defined in an .rpc file and converted to source code via event_rpcgen.py + * + * @param rpcname the name of the RPC + * @param reqstruct the name of the RPC request structure + * @param replystruct the name of the RPC reply structure + * @see EVRPC_GENERATE() + */ +#define EVRPC_HEADER(rpcname, reqstruct, rplystruct) \ +EVRPC_STRUCT(rpcname) { \ + struct evrpc_hook_meta *hook_meta; \ + struct reqstruct* request; \ + struct rplystruct* reply; \ + struct evrpc* rpc; \ + struct evhttp_request* http_req; \ + struct evbuffer* rpc_data; \ +}; \ +int evrpc_send_request_##rpcname(struct evrpc_pool *, \ + struct reqstruct *, struct rplystruct *, \ + void (*)(struct evrpc_status *, \ + struct reqstruct *, struct rplystruct *, void *cbarg), \ + void *); + +struct evrpc_pool; + +/** use EVRPC_GENERATE instead */ +struct evrpc_request_wrapper *evrpc_make_request_ctx( + struct evrpc_pool *pool, void *request, void *reply, + const char *rpcname, + void (*req_marshal)(struct evbuffer*, void *), + void (*rpl_clear)(void *), + int (*rpl_unmarshal)(void *, struct evbuffer *), + void (*cb)(struct evrpc_status *, void *, void *, void *), + void *cbarg); + +/** Creates a context structure that contains rpc specific information. + * + * EVRPC_MAKE_CTX is used to populate a RPC specific context that + * contains information about marshaling the RPC data types. + * + * @param rpcname the name of the RPC + * @param reqstruct the name of the RPC request structure + * @param replystruct the name of the RPC reply structure + * @param pool the evrpc_pool over which to make the request + * @param request a pointer to the RPC request structure object + * @param reply a pointer to the RPC reply structure object + * @param cb the callback function to call when the RPC has completed + * @param cbarg the argument to supply to the callback + */ +#define EVRPC_MAKE_CTX(rpcname, reqstruct, rplystruct, \ + pool, request, reply, cb, cbarg) \ + evrpc_make_request_ctx(pool, request, reply, \ + #rpcname, \ + (void (*)(struct evbuffer *, void *))reqstruct##_marshal, \ + (void (*)(void *))rplystruct##_clear, \ + (int (*)(void *, struct evbuffer *))rplystruct##_unmarshal, \ + (void (*)(struct evrpc_status *, void *, void *, void *))cb, \ + cbarg) + +/** Generates the code for receiving and sending an RPC message + * + * EVRPC_GENERATE is used to create the code corresponding to sending + * and receiving a particular RPC message + * + * @param rpcname the name of the RPC + * @param reqstruct the name of the RPC request structure + * @param replystruct the name of the RPC reply structure + * @see EVRPC_HEADER() + */ +#define EVRPC_GENERATE(rpcname, reqstruct, rplystruct) \ + int evrpc_send_request_##rpcname(struct evrpc_pool *pool, \ + struct reqstruct *request, struct rplystruct *reply, \ + void (*cb)(struct evrpc_status *, \ + struct reqstruct *, struct rplystruct *, void *cbarg), \ + void *cbarg) { \ + return evrpc_send_request_generic(pool, request, reply, \ + (void (*)(struct evrpc_status *, void *, void *, void *))cb, \ + cbarg, \ + #rpcname, \ + (void (*)(struct evbuffer *, void *))reqstruct##_marshal, \ + (void (*)(void *))rplystruct##_clear, \ + (int (*)(void *, struct evbuffer *))rplystruct##_unmarshal); \ +} + +/** Provides access to the HTTP request object underlying an RPC + * + * Access to the underlying http object; can be used to look at headers or + * for getting the remote ip address + * + * @param rpc_req the rpc request structure provided to the server callback + * @return an struct evhttp_request object that can be inspected for + * HTTP headers or sender information. + */ +#define EVRPC_REQUEST_HTTP(rpc_req) (rpc_req)->http_req + +/** completes the server response to an rpc request */ +void evrpc_request_done(struct evrpc_req_generic *req); + +/** accessors for request and reply */ +void *evrpc_get_request(struct evrpc_req_generic *req); +void *evrpc_get_reply(struct evrpc_req_generic *req); + +/** Creates the reply to an RPC request + * + * EVRPC_REQUEST_DONE is used to answer a request; the reply is expected + * to have been filled in. The request and reply pointers become invalid + * after this call has finished. + * + * @param rpc_req the rpc request structure provided to the server callback + */ +#define EVRPC_REQUEST_DONE(rpc_req) do { \ + struct evrpc_req_generic *req_ = (struct evrpc_req_generic *)(rpc_req); \ + evrpc_request_done(req_); \ +} while (0) + + +struct evrpc_base; +struct evhttp; + +/* functions to start up the rpc system */ + +/** Creates a new rpc base from which RPC requests can be received + * + * @param server a pointer to an existing HTTP server + * @return a newly allocated evrpc_base struct + * @see evrpc_free() + */ +struct evrpc_base *evrpc_init(struct evhttp *server); + +/** + * Frees the evrpc base + * + * For now, you are responsible for making sure that no rpcs are ongoing. + * + * @param base the evrpc_base object to be freed + * @see evrpc_init + */ +void evrpc_free(struct evrpc_base *base); + +/** register RPCs with the HTTP Server + * + * registers a new RPC with the HTTP server, each RPC needs to have + * a unique name under which it can be identified. + * + * @param base the evrpc_base structure in which the RPC should be + * registered. + * @param name the name of the RPC + * @param request the name of the RPC request structure + * @param reply the name of the RPC reply structure + * @param callback the callback that should be invoked when the RPC + * is received. The callback has the following prototype + * void (*callback)(EVRPC_STRUCT(Message)* rpc, void *arg) + * @param cbarg an additional parameter that can be passed to the callback. + * The parameter can be used to carry around state. + */ +#define EVRPC_REGISTER(base, name, request, reply, callback, cbarg) \ + evrpc_register_generic(base, #name, \ + (void (*)(struct evrpc_req_generic *, void *))callback, cbarg, \ + (void *(*)(void *))request##_new, NULL, \ + (void (*)(void *))request##_free, \ + (int (*)(void *, struct evbuffer *))request##_unmarshal, \ + (void *(*)(void *))reply##_new, NULL, \ + (void (*)(void *))reply##_free, \ + (int (*)(void *))reply##_complete, \ + (void (*)(struct evbuffer *, void *))reply##_marshal) + +/** + Low level function for registering an RPC with a server. + + Use EVRPC_REGISTER() instead. + + @see EVRPC_REGISTER() +*/ +int evrpc_register_rpc(struct evrpc_base *, struct evrpc *, + void (*)(struct evrpc_req_generic*, void *), void *); + +/** + * Unregisters an already registered RPC + * + * @param base the evrpc_base object from which to unregister an RPC + * @param name the name of the rpc to unregister + * @return -1 on error or 0 when successful. + * @see EVRPC_REGISTER() + */ +#define EVRPC_UNREGISTER(base, name) evrpc_unregister_rpc((base), #name) + +int evrpc_unregister_rpc(struct evrpc_base *base, const char *name); + +/* + * Client-side RPC support + */ + +struct evhttp_connection; +struct evrpc_status; + +/** launches an RPC and sends it to the server + * + * EVRPC_MAKE_REQUEST() is used by the client to send an RPC to the server. + * + * @param name the name of the RPC + * @param pool the evrpc_pool that contains the connection objects over which + * the request should be sent. + * @param request a pointer to the RPC request structure - it contains the + * data to be sent to the server. + * @param reply a pointer to the RPC reply structure. It is going to be filled + * if the request was answered successfully + * @param cb the callback to invoke when the RPC request has been answered + * @param cbarg an additional argument to be passed to the client + * @return 0 on success, -1 on failure + */ +#define EVRPC_MAKE_REQUEST(name, pool, request, reply, cb, cbarg) \ + evrpc_send_request_##name((pool), (request), (reply), (cb), (cbarg)) + +/** + Makes an RPC request based on the provided context. + + This is a low-level function and should not be used directly + unless a custom context object is provided. Use EVRPC_MAKE_REQUEST() + instead. + + @param ctx a context from EVRPC_MAKE_CTX() + @returns 0 on success, -1 otherwise. + @see EVRPC_MAKE_REQUEST(), EVRPC_MAKE_CTX() +*/ +int evrpc_make_request(struct evrpc_request_wrapper *ctx); + +/** creates an rpc connection pool + * + * a pool has a number of connections associated with it. + * rpc requests are always made via a pool. + * + * @param base a pointer to an struct event_based object; can be left NULL + * in singled-threaded applications + * @return a newly allocated struct evrpc_pool object + * @see evrpc_pool_free() + */ +struct evrpc_pool *evrpc_pool_new(struct event_base *base); +/** frees an rpc connection pool + * + * @param pool a pointer to an evrpc_pool allocated via evrpc_pool_new() + * @see evrpc_pool_new() + */ +void evrpc_pool_free(struct evrpc_pool *pool); + +/** + * Adds a connection over which rpc can be dispatched to the pool. + * + * The connection object must have been newly created. + * + * @param pool the pool to which to add the connection + * @param evcon the connection to add to the pool. + */ +void evrpc_pool_add_connection(struct evrpc_pool *pool, + struct evhttp_connection *evcon); + +/** + * Removes a connection from the pool. + * + * The connection object must have been newly created. + * + * @param pool the pool from which to remove the connection + * @param evcon the connection to remove from the pool. + */ +void evrpc_pool_remove_connection(struct evrpc_pool *pool, + struct evhttp_connection *evcon); + +/** + * Sets the timeout in secs after which a request has to complete. The + * RPC is completely aborted if it does not complete by then. Setting + * the timeout to 0 means that it never timeouts and can be used to + * implement callback type RPCs. + * + * Any connection already in the pool will be updated with the new + * timeout. Connections added to the pool after set_timeout has be + * called receive the pool timeout only if no timeout has been set + * for the connection itself. + * + * @param pool a pointer to a struct evrpc_pool object + * @param timeout_in_secs the number of seconds after which a request should + * timeout and a failure be returned to the callback. + */ +void evrpc_pool_set_timeout(struct evrpc_pool *pool, int timeout_in_secs); + +/** + * Hooks for changing the input and output of RPCs; this can be used to + * implement compression, authentication, encryption, ... + */ + +enum EVRPC_HOOK_TYPE { + EVRPC_INPUT, /**< apply the function to an input hook */ + EVRPC_OUTPUT /**< apply the function to an output hook */ +}; + +#ifndef _WIN32 +/** Deprecated alias for EVRPC_INPUT. Not available on windows, where it + * conflicts with platform headers. */ +#define INPUT EVRPC_INPUT +/** Deprecated alias for EVRPC_OUTPUT. Not available on windows, where it + * conflicts with platform headers. */ +#define OUTPUT EVRPC_OUTPUT +#endif + +/** + * Return value from hook processing functions + */ + +enum EVRPC_HOOK_RESULT { + EVRPC_TERMINATE = -1, /**< indicates the rpc should be terminated */ + EVRPC_CONTINUE = 0, /**< continue processing the rpc */ + EVRPC_PAUSE = 1 /**< pause processing request until resumed */ +}; + +/** adds a processing hook to either an rpc base or rpc pool + * + * If a hook returns TERMINATE, the processing is aborted. On CONTINUE, + * the request is immediately processed after the hook returns. If the + * hook returns PAUSE, request processing stops until evrpc_resume_request() + * has been called. + * + * The add functions return handles that can be used for removing hooks. + * + * @param vbase a pointer to either struct evrpc_base or struct evrpc_pool + * @param hook_type either INPUT or OUTPUT + * @param cb the callback to call when the hook is activated + * @param cb_arg an additional argument for the callback + * @return a handle to the hook so it can be removed later + * @see evrpc_remove_hook() + */ +void *evrpc_add_hook(void *vbase, + enum EVRPC_HOOK_TYPE hook_type, + int (*cb)(void *, struct evhttp_request *, struct evbuffer *, void *), + void *cb_arg); + +/** removes a previously added hook + * + * @param vbase a pointer to either struct evrpc_base or struct evrpc_pool + * @param hook_type either INPUT or OUTPUT + * @param handle a handle returned by evrpc_add_hook() + * @return 1 on success or 0 on failure + * @see evrpc_add_hook() + */ +int evrpc_remove_hook(void *vbase, + enum EVRPC_HOOK_TYPE hook_type, + void *handle); + +/** resume a paused request + * + * @param vbase a pointer to either struct evrpc_base or struct evrpc_pool + * @param ctx the context pointer provided to the original hook call + */ +int +evrpc_resume_request(void *vbase, void *ctx, enum EVRPC_HOOK_RESULT res); + +/** adds meta data to request + * + * evrpc_hook_add_meta() allows hooks to add meta data to a request. for + * a client request, the meta data can be inserted by an outgoing request hook + * and retrieved by the incoming request hook. + * + * @param ctx the context provided to the hook call + * @param key a NUL-terminated c-string + * @param data the data to be associated with the key + * @param data_size the size of the data + */ +void evrpc_hook_add_meta(void *ctx, const char *key, + const void *data, size_t data_size); + +/** retrieves meta data previously associated + * + * evrpc_hook_find_meta() can be used to retrieve meta data associated to a + * request by a previous hook. + * @param ctx the context provided to the hook call + * @param key a NUL-terminated c-string + * @param data pointer to a data pointer that will contain the retrieved data + * @param data_size pointer to the size of the data + * @return 0 on success or -1 on failure + */ +int evrpc_hook_find_meta(void *ctx, const char *key, + void **data, size_t *data_size); + +/** + * returns the connection object associated with the request + * + * @param ctx the context provided to the hook call + * @return a pointer to the evhttp_connection object + */ +struct evhttp_connection *evrpc_hook_get_connection(void *ctx); + +/** + Function for sending a generic RPC request. + + Do not call this function directly, use EVRPC_MAKE_REQUEST() instead. + + @see EVRPC_MAKE_REQUEST() + */ +int evrpc_send_request_generic(struct evrpc_pool *pool, + void *request, void *reply, + void (*cb)(struct evrpc_status *, void *, void *, void *), + void *cb_arg, + const char *rpcname, + void (*req_marshal)(struct evbuffer *, void *), + void (*rpl_clear)(void *), + int (*rpl_unmarshal)(void *, struct evbuffer *)); + +/** + Function for registering a generic RPC with the RPC base. + + Do not call this function directly, use EVRPC_REGISTER() instead. + + @see EVRPC_REGISTER() + */ +int +evrpc_register_generic(struct evrpc_base *base, const char *name, + void (*callback)(struct evrpc_req_generic *, void *), void *cbarg, + void *(*req_new)(void *), void *req_new_arg, void (*req_free)(void *), + int (*req_unmarshal)(void *, struct evbuffer *), + void *(*rpl_new)(void *), void *rpl_new_arg, void (*rpl_free)(void *), + int (*rpl_complete)(void *), + void (*rpl_marshal)(struct evbuffer *, void *)); + +/** accessors for obscure and undocumented functionality */ +struct evrpc_pool* evrpc_request_get_pool(struct evrpc_request_wrapper *ctx); +void evrpc_request_set_pool(struct evrpc_request_wrapper *ctx, + struct evrpc_pool *pool); +void evrpc_request_set_cb(struct evrpc_request_wrapper *ctx, + void (*cb)(struct evrpc_status*, void *request, void *reply, void *arg), + void *cb_arg); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_RPC_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/rpc_compat.h b/Source/Import/libevent/Includes/Linux/event2/rpc_compat.h new file mode 100644 index 0000000..8d8334d --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/rpc_compat.h @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2006-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_RPC_COMPAT_H_INCLUDED_ +#define EVENT2_RPC_COMPAT_H_INCLUDED_ + +/** @file event2/rpc_compat.h + + Deprecated versions of the functions in rpc.h: provided only for + backwards compatibility. + + */ + +#ifdef __cplusplus +extern "C" { +#endif + +/** backwards compatible accessors that work only with gcc */ +#if defined(__GNUC__) && !defined(__STRICT_ANSI__) + +#undef EVTAG_ASSIGN +#undef EVTAG_GET +#undef EVTAG_ADD + +#define EVTAG_ASSIGN(msg, member, args...) \ + (*(msg)->base->member##_assign)(msg, ## args) +#define EVTAG_GET(msg, member, args...) \ + (*(msg)->base->member##_get)(msg, ## args) +#define EVTAG_ADD(msg, member, args...) \ + (*(msg)->base->member##_add)(msg, ## args) +#endif +#define EVTAG_LEN(msg, member) ((msg)->member##_length) + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_COMPAT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/rpc_struct.h b/Source/Import/libevent/Includes/Linux/event2/rpc_struct.h new file mode 100644 index 0000000..8f691f4 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/rpc_struct.h @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2006-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_RPC_STRUCT_H_INCLUDED_ +#define EVENT2_RPC_STRUCT_H_INCLUDED_ + +#ifdef __cplusplus +extern "C" { +#endif + +/** @file event2/rpc_struct.h + + Structures used by rpc.h. Using these structures directly may harm + forward compatibility: be careful! + + */ + +/** + * provides information about the completed RPC request. + */ +struct evrpc_status { +#define EVRPC_STATUS_ERR_NONE 0 +#define EVRPC_STATUS_ERR_TIMEOUT 1 +#define EVRPC_STATUS_ERR_BADPAYLOAD 2 +#define EVRPC_STATUS_ERR_UNSTARTED 3 +#define EVRPC_STATUS_ERR_HOOKABORTED 4 + int error; + + /* for looking at headers or other information */ + struct evhttp_request *http_req; +}; + +/* the structure below needs to be synchronized with evrpc_req_generic */ + +/* Encapsulates a request */ +struct evrpc { + TAILQ_ENTRY(evrpc) next; + + /* the URI at which the request handler lives */ + const char* uri; + + /* creates a new request structure */ + void *(*request_new)(void *); + void *request_new_arg; + + /* frees the request structure */ + void (*request_free)(void *); + + /* unmarshals the buffer into the proper request structure */ + int (*request_unmarshal)(void *, struct evbuffer *); + + /* creates a new reply structure */ + void *(*reply_new)(void *); + void *reply_new_arg; + + /* frees the reply structure */ + void (*reply_free)(void *); + + /* verifies that the reply is valid */ + int (*reply_complete)(void *); + + /* marshals the reply into a buffer */ + void (*reply_marshal)(struct evbuffer*, void *); + + /* the callback invoked for each received rpc */ + void (*cb)(struct evrpc_req_generic *, void *); + void *cb_arg; + + /* reference for further configuration */ + struct evrpc_base *base; +}; + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_RPC_STRUCT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/tag.h b/Source/Import/libevent/Includes/Linux/event2/tag.h new file mode 100644 index 0000000..2f73bfc --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/tag.h @@ -0,0 +1,146 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_TAG_H_INCLUDED_ +#define EVENT2_TAG_H_INCLUDED_ + +/** @file event2/tag.h + + Helper functions for reading and writing tagged data onto buffers. + + */ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +struct evbuffer; + +/* + * Marshaling tagged data - We assume that all tags are inserted in their + * numeric order - so that unknown tags will always be higher than the + * known ones - and we can just ignore the end of an event buffer. + */ + +EVENT2_EXPORT_SYMBOL +void evtag_init(void); + +/** + Unmarshals the header and returns the length of the payload + + @param evbuf the buffer from which to unmarshal data + @param ptag a pointer in which the tag id is being stored + @returns -1 on failure or the number of bytes in the remaining payload. +*/ +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_header(struct evbuffer *evbuf, ev_uint32_t *ptag); + +EVENT2_EXPORT_SYMBOL +void evtag_marshal(struct evbuffer *evbuf, ev_uint32_t tag, const void *data, + ev_uint32_t len); +EVENT2_EXPORT_SYMBOL +void evtag_marshal_buffer(struct evbuffer *evbuf, ev_uint32_t tag, + struct evbuffer *data); + +/** + Encode an integer and store it in an evbuffer. + + We encode integers by nybbles; the first nibble contains the number + of significant nibbles - 1; this allows us to encode up to 64-bit + integers. This function is byte-order independent. + + @param evbuf evbuffer to store the encoded number + @param number a 32-bit integer + */ +EVENT2_EXPORT_SYMBOL +void evtag_encode_int(struct evbuffer *evbuf, ev_uint32_t number); +EVENT2_EXPORT_SYMBOL +void evtag_encode_int64(struct evbuffer *evbuf, ev_uint64_t number); + +EVENT2_EXPORT_SYMBOL +void evtag_marshal_int(struct evbuffer *evbuf, ev_uint32_t tag, + ev_uint32_t integer); +EVENT2_EXPORT_SYMBOL +void evtag_marshal_int64(struct evbuffer *evbuf, ev_uint32_t tag, + ev_uint64_t integer); + +EVENT2_EXPORT_SYMBOL +void evtag_marshal_string(struct evbuffer *buf, ev_uint32_t tag, + const char *string); + +EVENT2_EXPORT_SYMBOL +void evtag_marshal_timeval(struct evbuffer *evbuf, ev_uint32_t tag, + struct timeval *tv); + +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal(struct evbuffer *src, ev_uint32_t *ptag, + struct evbuffer *dst); +EVENT2_EXPORT_SYMBOL +int evtag_peek(struct evbuffer *evbuf, ev_uint32_t *ptag); +EVENT2_EXPORT_SYMBOL +int evtag_peek_length(struct evbuffer *evbuf, ev_uint32_t *plength); +EVENT2_EXPORT_SYMBOL +int evtag_payload_length(struct evbuffer *evbuf, ev_uint32_t *plength); +EVENT2_EXPORT_SYMBOL +int evtag_consume(struct evbuffer *evbuf); + +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_int(struct evbuffer *evbuf, ev_uint32_t need_tag, + ev_uint32_t *pinteger); +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_int64(struct evbuffer *evbuf, ev_uint32_t need_tag, + ev_uint64_t *pinteger); + +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_fixed(struct evbuffer *src, ev_uint32_t need_tag, + void *data, size_t len); + +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_string(struct evbuffer *evbuf, ev_uint32_t need_tag, + char **pstring); + +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_timeval(struct evbuffer *evbuf, ev_uint32_t need_tag, + struct timeval *ptv); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_TAG_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/tag_compat.h b/Source/Import/libevent/Includes/Linux/event2/tag_compat.h new file mode 100644 index 0000000..a276c0d --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/tag_compat.h @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_TAG_COMPAT_H_INCLUDED_ +#define EVENT2_TAG_COMPAT_H_INCLUDED_ + +/** @file event2/tag_compat.h + + Obsolete/deprecated functions from tag.h; provided only for backwards + compatibility. + */ + +/** + @name Misnamed functions + + @deprecated These macros are deprecated because their names don't follow + Libevent's naming conventions. Use evtag_encode_int and + evtag_encode_int64 instead. + + @{ +*/ +#define encode_int(evbuf, number) evtag_encode_int((evbuf), (number)) +#define encode_int64(evbuf, number) evtag_encode_int64((evbuf), (number)) +/**@}*/ + +#endif /* EVENT2_TAG_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/thread.h b/Source/Import/libevent/Includes/Linux/event2/thread.h new file mode 100644 index 0000000..b519986 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/thread.h @@ -0,0 +1,253 @@ +/* + * Copyright (c) 2008-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_THREAD_H_INCLUDED_ +#define EVENT2_THREAD_H_INCLUDED_ + +/** @file event2/thread.h + + Functions for multi-threaded applications using Libevent. + + When using a multi-threaded application in which multiple threads + add and delete events from a single event base, Libevent needs to + lock its data structures. + + Like the memory-management function hooks, all of the threading functions + _must_ be set up before an event_base is created if you want the base to + use them. + + Most programs will either be using Windows threads or Posix threads. You + can configure Libevent to use one of these event_use_windows_threads() or + event_use_pthreads() respectively. If you're using another threading + library, you'll need to configure threading functions manually using + evthread_set_lock_callbacks() and evthread_set_condition_callbacks(). + + */ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +/** + @name Flags passed to lock functions + + @{ +*/ +/** A flag passed to a locking callback when the lock was allocated as a + * read-write lock, and we want to acquire or release the lock for writing. */ +#define EVTHREAD_WRITE 0x04 +/** A flag passed to a locking callback when the lock was allocated as a + * read-write lock, and we want to acquire or release the lock for reading. */ +#define EVTHREAD_READ 0x08 +/** A flag passed to a locking callback when we don't want to block waiting + * for the lock; if we can't get the lock immediately, we will instead + * return nonzero from the locking callback. */ +#define EVTHREAD_TRY 0x10 +/**@}*/ + +#if !defined(EVENT__DISABLE_THREAD_SUPPORT) || defined(EVENT_IN_DOXYGEN_) + +#define EVTHREAD_LOCK_API_VERSION 1 + +/** + @name Types of locks + + @{*/ +/** A recursive lock is one that can be acquired multiple times at once by the + * same thread. No other process can allocate the lock until the thread that + * has been holding it has unlocked it as many times as it locked it. */ +#define EVTHREAD_LOCKTYPE_RECURSIVE 1 +/* A read-write lock is one that allows multiple simultaneous readers, but + * where any one writer excludes all other writers and readers. */ +#define EVTHREAD_LOCKTYPE_READWRITE 2 +/**@}*/ + +/** This structure describes the interface a threading library uses for + * locking. It's used to tell evthread_set_lock_callbacks() how to use + * locking on this platform. + */ +struct evthread_lock_callbacks { + /** The current version of the locking API. Set this to + * EVTHREAD_LOCK_API_VERSION */ + int lock_api_version; + /** Which kinds of locks does this version of the locking API + * support? A bitfield of EVTHREAD_LOCKTYPE_RECURSIVE and + * EVTHREAD_LOCKTYPE_READWRITE. + * + * (Note that RECURSIVE locks are currently mandatory, and + * READWRITE locks are not currently used.) + **/ + unsigned supported_locktypes; + /** Function to allocate and initialize new lock of type 'locktype'. + * Returns NULL on failure. */ + void *(*alloc)(unsigned locktype); + /** Funtion to release all storage held in 'lock', which was created + * with type 'locktype'. */ + void (*free)(void *lock, unsigned locktype); + /** Acquire an already-allocated lock at 'lock' with mode 'mode'. + * Returns 0 on success, and nonzero on failure. */ + int (*lock)(unsigned mode, void *lock); + /** Release a lock at 'lock' using mode 'mode'. Returns 0 on success, + * and nonzero on failure. */ + int (*unlock)(unsigned mode, void *lock); +}; + +/** Sets a group of functions that Libevent should use for locking. + * For full information on the required callback API, see the + * documentation for the individual members of evthread_lock_callbacks. + * + * Note that if you're using Windows or the Pthreads threading library, you + * probably shouldn't call this function; instead, use + * evthread_use_windows_threads() or evthread_use_posix_threads() if you can. + */ +EVENT2_EXPORT_SYMBOL +int evthread_set_lock_callbacks(const struct evthread_lock_callbacks *); + +#define EVTHREAD_CONDITION_API_VERSION 1 + +struct timeval; + +/** This structure describes the interface a threading library uses for + * condition variables. It's used to tell evthread_set_condition_callbacks + * how to use locking on this platform. + */ +struct evthread_condition_callbacks { + /** The current version of the conditions API. Set this to + * EVTHREAD_CONDITION_API_VERSION */ + int condition_api_version; + /** Function to allocate and initialize a new condition variable. + * Returns the condition variable on success, and NULL on failure. + * The 'condtype' argument will be 0 with this API version. + */ + void *(*alloc_condition)(unsigned condtype); + /** Function to free a condition variable. */ + void (*free_condition)(void *cond); + /** Function to signal a condition variable. If 'broadcast' is 1, all + * threads waiting on 'cond' should be woken; otherwise, only on one + * thread is worken. Should return 0 on success, -1 on failure. + * This function will only be called while holding the associated + * lock for the condition. + */ + int (*signal_condition)(void *cond, int broadcast); + /** Function to wait for a condition variable. The lock 'lock' + * will be held when this function is called; should be released + * while waiting for the condition to be come signalled, and + * should be held again when this function returns. + * If timeout is provided, it is interval of seconds to wait for + * the event to become signalled; if it is NULL, the function + * should wait indefinitely. + * + * The function should return -1 on error; 0 if the condition + * was signalled, or 1 on a timeout. */ + int (*wait_condition)(void *cond, void *lock, + const struct timeval *timeout); +}; + +/** Sets a group of functions that Libevent should use for condition variables. + * For full information on the required callback API, see the + * documentation for the individual members of evthread_condition_callbacks. + * + * Note that if you're using Windows or the Pthreads threading library, you + * probably shouldn't call this function; instead, use + * evthread_use_windows_threads() or evthread_use_pthreads() if you can. + */ +EVENT2_EXPORT_SYMBOL +int evthread_set_condition_callbacks( + const struct evthread_condition_callbacks *); + +/** + Sets the function for determining the thread id. + + @param base the event base for which to set the id function + @param id_fn the identify function Libevent should invoke to + determine the identity of a thread. +*/ +EVENT2_EXPORT_SYMBOL +void evthread_set_id_callback( + unsigned long (*id_fn)(void)); + +#if (defined(_WIN32) && !defined(EVENT__DISABLE_THREAD_SUPPORT)) || defined(EVENT_IN_DOXYGEN_) +/** Sets up Libevent for use with Windows builtin locking and thread ID + functions. Unavailable if Libevent is not built for Windows. + + @return 0 on success, -1 on failure. */ +EVENT2_EXPORT_SYMBOL +int evthread_use_windows_threads(void); +/** + Defined if Libevent was built with support for evthread_use_windows_threads() +*/ +#define EVTHREAD_USE_WINDOWS_THREADS_IMPLEMENTED 1 +#endif + +#if defined(EVENT__HAVE_PTHREADS) || defined(EVENT_IN_DOXYGEN_) +/** Sets up Libevent for use with Pthreads locking and thread ID functions. + Unavailable if Libevent is not build for use with pthreads. Requires + libraries to link against Libevent_pthreads as well as Libevent. + + @return 0 on success, -1 on failure. */ +EVENT2_EXPORT_SYMBOL +int evthread_use_pthreads(void); +/** Defined if Libevent was built with support for evthread_use_pthreads() */ +#define EVTHREAD_USE_PTHREADS_IMPLEMENTED 1 + +#endif + +/** Enable debugging wrappers around the current lock callbacks. If Libevent + * makes one of several common locking errors, exit with an assertion failure. + * + * If you're going to call this function, you must do so before any locks are + * allocated. + **/ +EVENT2_EXPORT_SYMBOL +void evthread_enable_lock_debugging(void); + +/* Old (misspelled) version: This is deprecated; use + * evthread_enable_log_debugging instead. */ +EVENT2_EXPORT_SYMBOL +void evthread_enable_lock_debuging(void); + +#endif /* EVENT__DISABLE_THREAD_SUPPORT */ + +struct event_base; +/** Make sure it's safe to tell an event base to wake up from another thread + or a signal handler. + + You shouldn't need to call this by hand; configuring the base with thread + support should be necessary and sufficient. + + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evthread_make_base_notifiable(struct event_base *base); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_THREAD_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/util.h b/Source/Import/libevent/Includes/Linux/event2/util.h new file mode 100644 index 0000000..dd4bbb6 --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/util.h @@ -0,0 +1,866 @@ +/* + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_UTIL_H_INCLUDED_ +#define EVENT2_UTIL_H_INCLUDED_ + +/** @file event2/util.h + + Common convenience functions for cross-platform portability and + related socket manipulations. + + */ +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif +#ifdef EVENT__HAVE_STDINT_H +#include +#elif defined(EVENT__HAVE_INTTYPES_H) +#include +#endif +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_STDDEF_H +#include +#endif +#ifdef _MSC_VER +#include +#endif +#include +#ifdef EVENT__HAVE_NETDB_H +#if !defined(_GNU_SOURCE) +#define _GNU_SOURCE +#endif +#include +#endif + +#ifdef _WIN32 +#include +#ifdef EVENT__HAVE_GETADDRINFO +/* for EAI_* definitions. */ +#include +#endif +#else +#ifdef EVENT__HAVE_ERRNO_H +#include +#endif +#include +#endif + +#include + +/* Some openbsd autoconf versions get the name of this macro wrong. */ +#if defined(EVENT__SIZEOF_VOID__) && !defined(EVENT__SIZEOF_VOID_P) +#define EVENT__SIZEOF_VOID_P EVENT__SIZEOF_VOID__ +#endif + +/** + * @name Standard integer types. + * + * Integer type definitions for types that are supposed to be defined in the + * C99-specified stdint.h. Shamefully, some platforms do not include + * stdint.h, so we need to replace it. (If you are on a platform like this, + * your C headers are now over 10 years out of date. You should bug them to + * do something about this.) + * + * We define: + * + *
+ *
ev_uint64_t, ev_uint32_t, ev_uint16_t, ev_uint8_t
+ *
unsigned integer types of exactly 64, 32, 16, and 8 bits + * respectively.
+ *
ev_int64_t, ev_int32_t, ev_int16_t, ev_int8_t
+ *
signed integer types of exactly 64, 32, 16, and 8 bits + * respectively.
+ *
ev_uintptr_t, ev_intptr_t
+ *
unsigned/signed integers large enough + * to hold a pointer without loss of bits.
+ *
ev_ssize_t
+ *
A signed type of the same size as size_t
+ *
ev_off_t
+ *
A signed type typically used to represent offsets within a + * (potentially large) file
+ * + * @{ + */ +#ifdef EVENT__HAVE_UINT64_T +#define ev_uint64_t uint64_t +#define ev_int64_t int64_t +#elif defined(_WIN32) +#define ev_uint64_t unsigned __int64 +#define ev_int64_t signed __int64 +#elif EVENT__SIZEOF_LONG_LONG == 8 +#define ev_uint64_t unsigned long long +#define ev_int64_t long long +#elif EVENT__SIZEOF_LONG == 8 +#define ev_uint64_t unsigned long +#define ev_int64_t long +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_uint64_t ... +#define ev_int64_t ... +#else +#error "No way to define ev_uint64_t" +#endif + +#ifdef EVENT__HAVE_UINT32_T +#define ev_uint32_t uint32_t +#define ev_int32_t int32_t +#elif defined(_WIN32) +#define ev_uint32_t unsigned int +#define ev_int32_t signed int +#elif EVENT__SIZEOF_LONG == 4 +#define ev_uint32_t unsigned long +#define ev_int32_t signed long +#elif EVENT__SIZEOF_INT == 4 +#define ev_uint32_t unsigned int +#define ev_int32_t signed int +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_uint32_t ... +#define ev_int32_t ... +#else +#error "No way to define ev_uint32_t" +#endif + +#ifdef EVENT__HAVE_UINT16_T +#define ev_uint16_t uint16_t +#define ev_int16_t int16_t +#elif defined(_WIN32) +#define ev_uint16_t unsigned short +#define ev_int16_t signed short +#elif EVENT__SIZEOF_INT == 2 +#define ev_uint16_t unsigned int +#define ev_int16_t signed int +#elif EVENT__SIZEOF_SHORT == 2 +#define ev_uint16_t unsigned short +#define ev_int16_t signed short +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_uint16_t ... +#define ev_int16_t ... +#else +#error "No way to define ev_uint16_t" +#endif + +#ifdef EVENT__HAVE_UINT8_T +#define ev_uint8_t uint8_t +#define ev_int8_t int8_t +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_uint8_t ... +#define ev_int8_t ... +#else +#define ev_uint8_t unsigned char +#define ev_int8_t signed char +#endif + +#ifdef EVENT__HAVE_UINTPTR_T +#define ev_uintptr_t uintptr_t +#define ev_intptr_t intptr_t +#elif EVENT__SIZEOF_VOID_P <= 4 +#define ev_uintptr_t ev_uint32_t +#define ev_intptr_t ev_int32_t +#elif EVENT__SIZEOF_VOID_P <= 8 +#define ev_uintptr_t ev_uint64_t +#define ev_intptr_t ev_int64_t +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_uintptr_t ... +#define ev_intptr_t ... +#else +#error "No way to define ev_uintptr_t" +#endif + +#ifdef EVENT__ssize_t +#define ev_ssize_t EVENT__ssize_t +#else +#define ev_ssize_t ssize_t +#endif + +/* Note that we define ev_off_t based on the compile-time size of off_t that + * we used to build Libevent, and not based on the current size of off_t. + * (For example, we don't define ev_off_t to off_t.). We do this because + * some systems let you build your software with different off_t sizes + * at runtime, and so putting in any dependency on off_t would risk API + * mismatch. + */ +#ifdef _WIN32 +#define ev_off_t ev_int64_t +#elif EVENT__SIZEOF_OFF_T == 8 +#define ev_off_t ev_int64_t +#elif EVENT__SIZEOF_OFF_T == 4 +#define ev_off_t ev_int32_t +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_off_t ... +#else +#define ev_off_t off_t +#endif +/**@}*/ + +/* Limits for integer types. + + We're making two assumptions here: + - The compiler does constant folding properly. + - The platform does signed arithmetic in two's complement. +*/ + +/** + @name Limits for integer types + + These macros hold the largest or smallest values possible for the + ev_[u]int*_t types. + + @{ +*/ +#ifndef EVENT__HAVE_STDINT_H +#define EV_UINT64_MAX ((((ev_uint64_t)0xffffffffUL) << 32) | 0xffffffffUL) +#define EV_INT64_MAX ((((ev_int64_t) 0x7fffffffL) << 32) | 0xffffffffL) +#define EV_INT64_MIN ((-EV_INT64_MAX) - 1) +#define EV_UINT32_MAX ((ev_uint32_t)0xffffffffUL) +#define EV_INT32_MAX ((ev_int32_t) 0x7fffffffL) +#define EV_INT32_MIN ((-EV_INT32_MAX) - 1) +#define EV_UINT16_MAX ((ev_uint16_t)0xffffUL) +#define EV_INT16_MAX ((ev_int16_t) 0x7fffL) +#define EV_INT16_MIN ((-EV_INT16_MAX) - 1) +#define EV_UINT8_MAX 255 +#define EV_INT8_MAX 127 +#define EV_INT8_MIN ((-EV_INT8_MAX) - 1) +#else +#define EV_UINT64_MAX UINT64_MAX +#define EV_INT64_MAX INT64_MAX +#define EV_INT64_MIN INT64_MIN +#define EV_UINT32_MAX UINT32_MAX +#define EV_INT32_MAX INT32_MAX +#define EV_INT32_MIN INT32_MIN +#define EV_UINT16_MAX UINT16_MAX +#define EV_INT16_MAX INT16_MAX +#define EV_UINT8_MAX UINT8_MAX +#define EV_INT8_MAX INT8_MAX +#define EV_INT8_MIN INT8_MIN +/** @} */ +#endif + + +/** + @name Limits for SIZE_T and SSIZE_T + + @{ +*/ +#if EVENT__SIZEOF_SIZE_T == 8 +#define EV_SIZE_MAX EV_UINT64_MAX +#define EV_SSIZE_MAX EV_INT64_MAX +#elif EVENT__SIZEOF_SIZE_T == 4 +#define EV_SIZE_MAX EV_UINT32_MAX +#define EV_SSIZE_MAX EV_INT32_MAX +#elif defined(EVENT_IN_DOXYGEN_) +#define EV_SIZE_MAX ... +#define EV_SSIZE_MAX ... +#else +#error "No way to define SIZE_MAX" +#endif + +#define EV_SSIZE_MIN ((-EV_SSIZE_MAX) - 1) +/**@}*/ + +#ifdef _WIN32 +#define ev_socklen_t int +#elif defined(EVENT__socklen_t) +#define ev_socklen_t EVENT__socklen_t +#else +#define ev_socklen_t socklen_t +#endif + +#ifdef EVENT__HAVE_STRUCT_SOCKADDR_STORAGE___SS_FAMILY +#if !defined(EVENT__HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY) \ + && !defined(ss_family) +#define ss_family __ss_family +#endif +#endif + +/** + * A type wide enough to hold the output of "socket()" or "accept()". On + * Windows, this is an intptr_t; elsewhere, it is an int. */ +#ifdef _WIN32 +#define evutil_socket_t intptr_t +#else +#define evutil_socket_t int +#endif + +/** + * Structure to hold information about a monotonic timer + * + * Use this with evutil_configure_monotonic_time() and + * evutil_gettime_monotonic(). + * + * This is an opaque structure; you can allocate one using + * evutil_monotonic_timer_new(). + * + * @see evutil_monotonic_timer_new(), evutil_monotonic_timer_free(), + * evutil_configure_monotonic_time(), evutil_gettime_monotonic() + */ +struct evutil_monotonic_timer +#ifdef EVENT_IN_DOXYGEN_ +{/*Empty body so that doxygen will generate documentation here.*/} +#endif +; + +#define EV_MONOT_PRECISE 1 +#define EV_MONOT_FALLBACK 2 + +/** Format a date string using RFC 1123 format (used in HTTP). + * If `tm` is NULL, current system's time will be used. + * The number of characters written will be returned. + * One should check if the return value is smaller than `datelen` to check if + * the result is truncated or not. + */ +EVENT2_EXPORT_SYMBOL int +evutil_date_rfc1123(char *date, const size_t datelen, const struct tm *tm); + +/** Allocate a new struct evutil_monotonic_timer for use with the + * evutil_configure_monotonic_time() and evutil_gettime_monotonic() + * functions. You must configure the timer with + * evutil_configure_monotonic_time() before using it. + */ +EVENT2_EXPORT_SYMBOL +struct evutil_monotonic_timer * evutil_monotonic_timer_new(void); + +/** Free a struct evutil_monotonic_timer that was allocated using + * evutil_monotonic_timer_new(). + */ +EVENT2_EXPORT_SYMBOL +void evutil_monotonic_timer_free(struct evutil_monotonic_timer *timer); + +/** Set up a struct evutil_monotonic_timer; flags can include + * EV_MONOT_PRECISE and EV_MONOT_FALLBACK. + */ +EVENT2_EXPORT_SYMBOL +int evutil_configure_monotonic_time(struct evutil_monotonic_timer *timer, + int flags); + +/** Query the current monotonic time from a struct evutil_monotonic_timer + * previously configured with evutil_configure_monotonic_time(). Monotonic + * time is guaranteed never to run in reverse, but is not necessarily epoch- + * based, or relative to any other definite point. Use it to make reliable + * measurements of elapsed time between events even when the system time + * may be changed. + * + * It is not safe to use this funtion on the same timer from multiple + * threads. + */ +EVENT2_EXPORT_SYMBOL +int evutil_gettime_monotonic(struct evutil_monotonic_timer *timer, + struct timeval *tp); + +/** Create two new sockets that are connected to each other. + + On Unix, this simply calls socketpair(). On Windows, it uses the + loopback network interface on 127.0.0.1, and only + AF_INET,SOCK_STREAM are supported. + + (This may fail on some Windows hosts where firewall software has cleverly + decided to keep 127.0.0.1 from talking to itself.) + + Parameters and return values are as for socketpair() +*/ +EVENT2_EXPORT_SYMBOL +int evutil_socketpair(int d, int type, int protocol, evutil_socket_t sv[2]); +/** Do platform-specific operations as needed to make a socket nonblocking. + + @param sock The socket to make nonblocking + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evutil_make_socket_nonblocking(evutil_socket_t sock); + +/** Do platform-specific operations to make a listener socket reusable. + + Specifically, we want to make sure that another program will be able + to bind this address right after we've closed the listener. + + This differs from Windows's interpretation of "reusable", which + allows multiple listeners to bind the same address at the same time. + + @param sock The socket to make reusable + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evutil_make_listen_socket_reuseable(evutil_socket_t sock); + +/** Do platform-specific operations to make a listener port reusable. + + Specifically, we want to make sure that multiple programs which also + set the same socket option will be able to bind, listen at the same time. + + This is a feature available only to Linux 3.9+ + + @param sock The socket to make reusable + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evutil_make_listen_socket_reuseable_port(evutil_socket_t sock); + +/** Do platform-specific operations as needed to close a socket upon a + successful execution of one of the exec*() functions. + + @param sock The socket to be closed + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evutil_make_socket_closeonexec(evutil_socket_t sock); + +/** Do the platform-specific call needed to close a socket returned from + socket() or accept(). + + @param sock The socket to be closed + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evutil_closesocket(evutil_socket_t sock); +#define EVUTIL_CLOSESOCKET(s) evutil_closesocket(s) + +/** Do platform-specific operations, if possible, to make a tcp listener + * socket defer accept()s until there is data to read. + * + * Not all platforms support this. You don't want to do this for every + * listener socket: only the ones that implement a protocol where the + * client transmits before the server needs to respond. + * + * @param sock The listening socket to to make deferred + * @return 0 on success (whether the operation is supported or not), + * -1 on failure +*/ +EVENT2_EXPORT_SYMBOL +int evutil_make_tcp_listen_socket_deferred(evutil_socket_t sock); + +#ifdef _WIN32 +/** Return the most recent socket error. Not idempotent on all platforms. */ +#define EVUTIL_SOCKET_ERROR() WSAGetLastError() +/** Replace the most recent socket error with errcode */ +#define EVUTIL_SET_SOCKET_ERROR(errcode) \ + do { WSASetLastError(errcode); } while (0) +/** Return the most recent socket error to occur on sock. */ +EVENT2_EXPORT_SYMBOL +int evutil_socket_geterror(evutil_socket_t sock); +/** Convert a socket error to a string. */ +EVENT2_EXPORT_SYMBOL +const char *evutil_socket_error_to_string(int errcode); +#elif defined(EVENT_IN_DOXYGEN_) +/** + @name Socket error functions + + These functions are needed for making programs compatible between + Windows and Unix-like platforms. + + You see, Winsock handles socket errors differently from the rest of + the world. Elsewhere, a socket error is like any other error and is + stored in errno. But winsock functions require you to retrieve the + error with a special function, and don't let you use strerror for + the error codes. And handling EWOULDBLOCK is ... different. + + @{ +*/ +/** Return the most recent socket error. Not idempotent on all platforms. */ +#define EVUTIL_SOCKET_ERROR() ... +/** Replace the most recent socket error with errcode */ +#define EVUTIL_SET_SOCKET_ERROR(errcode) ... +/** Return the most recent socket error to occur on sock. */ +#define evutil_socket_geterror(sock) ... +/** Convert a socket error to a string. */ +#define evutil_socket_error_to_string(errcode) ... +/**@}*/ +#else +#define EVUTIL_SOCKET_ERROR() (errno) +#define EVUTIL_SET_SOCKET_ERROR(errcode) \ + do { errno = (errcode); } while (0) +#define evutil_socket_geterror(sock) (errno) +#define evutil_socket_error_to_string(errcode) (strerror(errcode)) +#endif + + +/** + * @name Manipulation macros for struct timeval. + * + * We define replacements + * for timeradd, timersub, timerclear, timercmp, and timerisset. + * + * @{ + */ +#ifdef EVENT__HAVE_TIMERADD +#define evutil_timeradd(tvp, uvp, vvp) timeradd((tvp), (uvp), (vvp)) +#define evutil_timersub(tvp, uvp, vvp) timersub((tvp), (uvp), (vvp)) +#else +#define evutil_timeradd(tvp, uvp, vvp) \ + do { \ + (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \ + (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \ + if ((vvp)->tv_usec >= 1000000) { \ + (vvp)->tv_sec++; \ + (vvp)->tv_usec -= 1000000; \ + } \ + } while (0) +#define evutil_timersub(tvp, uvp, vvp) \ + do { \ + (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \ + (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \ + if ((vvp)->tv_usec < 0) { \ + (vvp)->tv_sec--; \ + (vvp)->tv_usec += 1000000; \ + } \ + } while (0) +#endif /* !EVENT__HAVE_TIMERADD */ + +#ifdef EVENT__HAVE_TIMERCLEAR +#define evutil_timerclear(tvp) timerclear(tvp) +#else +#define evutil_timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0 +#endif +/**@}*/ + +/** Return true iff the tvp is related to uvp according to the relational + * operator cmp. Recognized values for cmp are ==, <=, <, >=, and >. */ +#define evutil_timercmp(tvp, uvp, cmp) \ + (((tvp)->tv_sec == (uvp)->tv_sec) ? \ + ((tvp)->tv_usec cmp (uvp)->tv_usec) : \ + ((tvp)->tv_sec cmp (uvp)->tv_sec)) + +#ifdef EVENT__HAVE_TIMERISSET +#define evutil_timerisset(tvp) timerisset(tvp) +#else +#define evutil_timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec) +#endif + +/** Replacement for offsetof on platforms that don't define it. */ +#ifdef offsetof +#define evutil_offsetof(type, field) offsetof(type, field) +#else +#define evutil_offsetof(type, field) ((off_t)(&((type *)0)->field)) +#endif + +/* big-int related functions */ +/** Parse a 64-bit value from a string. Arguments are as for strtol. */ +EVENT2_EXPORT_SYMBOL +ev_int64_t evutil_strtoll(const char *s, char **endptr, int base); + +/** Replacement for gettimeofday on platforms that lack it. */ +#ifdef EVENT__HAVE_GETTIMEOFDAY +#define evutil_gettimeofday(tv, tz) gettimeofday((tv), (tz)) +#else +struct timezone; +EVENT2_EXPORT_SYMBOL +int evutil_gettimeofday(struct timeval *tv, struct timezone *tz); +#endif + +/** Replacement for snprintf to get consistent behavior on platforms for + which the return value of snprintf does not conform to C99. + */ +EVENT2_EXPORT_SYMBOL +int evutil_snprintf(char *buf, size_t buflen, const char *format, ...) +#ifdef __GNUC__ + __attribute__((format(printf, 3, 4))) +#endif +; +/** Replacement for vsnprintf to get consistent behavior on platforms for + which the return value of snprintf does not conform to C99. + */ +EVENT2_EXPORT_SYMBOL +int evutil_vsnprintf(char *buf, size_t buflen, const char *format, va_list ap) +#ifdef __GNUC__ + __attribute__((format(printf, 3, 0))) +#endif +; + +/** Replacement for inet_ntop for platforms which lack it. */ +EVENT2_EXPORT_SYMBOL +const char *evutil_inet_ntop(int af, const void *src, char *dst, size_t len); +/** Replacement for inet_pton for platforms which lack it. */ +EVENT2_EXPORT_SYMBOL +int evutil_inet_pton(int af, const char *src, void *dst); +struct sockaddr; + +/** Parse an IPv4 or IPv6 address, with optional port, from a string. + + Recognized formats are: + - [IPv6Address]:port + - [IPv6Address] + - IPv6Address + - IPv4Address:port + - IPv4Address + + If no port is specified, the port in the output is set to 0. + + @param str The string to parse. + @param out A struct sockaddr to hold the result. This should probably be + a struct sockaddr_storage. + @param outlen A pointer to the number of bytes that that 'out' can safely + hold. Set to the number of bytes used in 'out' on success. + @return -1 if the address is not well-formed, if the port is out of range, + or if out is not large enough to hold the result. Otherwise returns + 0 on success. +*/ +EVENT2_EXPORT_SYMBOL +int evutil_parse_sockaddr_port(const char *str, struct sockaddr *out, int *outlen); + +/** Compare two sockaddrs; return 0 if they are equal, or less than 0 if sa1 + * preceeds sa2, or greater than 0 if sa1 follows sa2. If include_port is + * true, consider the port as well as the address. Only implemented for + * AF_INET and AF_INET6 addresses. The ordering is not guaranteed to remain + * the same between Libevent versions. */ +EVENT2_EXPORT_SYMBOL +int evutil_sockaddr_cmp(const struct sockaddr *sa1, const struct sockaddr *sa2, + int include_port); + +/** As strcasecmp, but always compares the characters in locale-independent + ASCII. That's useful if you're handling data in ASCII-based protocols. + */ +EVENT2_EXPORT_SYMBOL +int evutil_ascii_strcasecmp(const char *str1, const char *str2); +/** As strncasecmp, but always compares the characters in locale-independent + ASCII. That's useful if you're handling data in ASCII-based protocols. + */ +EVENT2_EXPORT_SYMBOL +int evutil_ascii_strncasecmp(const char *str1, const char *str2, size_t n); + +/* Here we define evutil_addrinfo to the native addrinfo type, or redefine it + * if this system has no getaddrinfo(). */ +#ifdef EVENT__HAVE_STRUCT_ADDRINFO +#define evutil_addrinfo addrinfo +#else +/** A definition of struct addrinfo for systems that lack it. + + (This is just an alias for struct addrinfo if the system defines + struct addrinfo.) +*/ +struct evutil_addrinfo { + int ai_flags; /* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */ + int ai_family; /* PF_xxx */ + int ai_socktype; /* SOCK_xxx */ + int ai_protocol; /* 0 or IPPROTO_xxx for IPv4 and IPv6 */ + size_t ai_addrlen; /* length of ai_addr */ + char *ai_canonname; /* canonical name for nodename */ + struct sockaddr *ai_addr; /* binary address */ + struct evutil_addrinfo *ai_next; /* next structure in linked list */ +}; +#endif +/** @name evutil_getaddrinfo() error codes + + These values are possible error codes for evutil_getaddrinfo() and + related functions. + + @{ +*/ +#if defined(EAI_ADDRFAMILY) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_ADDRFAMILY EAI_ADDRFAMILY +#else +#define EVUTIL_EAI_ADDRFAMILY -901 +#endif +#if defined(EAI_AGAIN) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_AGAIN EAI_AGAIN +#else +#define EVUTIL_EAI_AGAIN -902 +#endif +#if defined(EAI_BADFLAGS) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_BADFLAGS EAI_BADFLAGS +#else +#define EVUTIL_EAI_BADFLAGS -903 +#endif +#if defined(EAI_FAIL) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_FAIL EAI_FAIL +#else +#define EVUTIL_EAI_FAIL -904 +#endif +#if defined(EAI_FAMILY) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_FAMILY EAI_FAMILY +#else +#define EVUTIL_EAI_FAMILY -905 +#endif +#if defined(EAI_MEMORY) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_MEMORY EAI_MEMORY +#else +#define EVUTIL_EAI_MEMORY -906 +#endif +/* This test is a bit complicated, since some MS SDKs decide to + * remove NODATA or redefine it to be the same as NONAME, in a + * fun interpretation of RFC 2553 and RFC 3493. */ +#if defined(EAI_NODATA) && defined(EVENT__HAVE_GETADDRINFO) && (!defined(EAI_NONAME) || EAI_NODATA != EAI_NONAME) +#define EVUTIL_EAI_NODATA EAI_NODATA +#else +#define EVUTIL_EAI_NODATA -907 +#endif +#if defined(EAI_NONAME) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_NONAME EAI_NONAME +#else +#define EVUTIL_EAI_NONAME -908 +#endif +#if defined(EAI_SERVICE) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_SERVICE EAI_SERVICE +#else +#define EVUTIL_EAI_SERVICE -909 +#endif +#if defined(EAI_SOCKTYPE) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_SOCKTYPE EAI_SOCKTYPE +#else +#define EVUTIL_EAI_SOCKTYPE -910 +#endif +#if defined(EAI_SYSTEM) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_SYSTEM EAI_SYSTEM +#else +#define EVUTIL_EAI_SYSTEM -911 +#endif + +#define EVUTIL_EAI_CANCEL -90001 + +#if defined(AI_PASSIVE) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_PASSIVE AI_PASSIVE +#else +#define EVUTIL_AI_PASSIVE 0x1000 +#endif +#if defined(AI_CANONNAME) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_CANONNAME AI_CANONNAME +#else +#define EVUTIL_AI_CANONNAME 0x2000 +#endif +#if defined(AI_NUMERICHOST) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_NUMERICHOST AI_NUMERICHOST +#else +#define EVUTIL_AI_NUMERICHOST 0x4000 +#endif +#if defined(AI_NUMERICSERV) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_NUMERICSERV AI_NUMERICSERV +#else +#define EVUTIL_AI_NUMERICSERV 0x8000 +#endif +#if defined(AI_V4MAPPED) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_V4MAPPED AI_V4MAPPED +#else +#define EVUTIL_AI_V4MAPPED 0x10000 +#endif +#if defined(AI_ALL) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_ALL AI_ALL +#else +#define EVUTIL_AI_ALL 0x20000 +#endif +#if defined(AI_ADDRCONFIG) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_ADDRCONFIG AI_ADDRCONFIG +#else +#define EVUTIL_AI_ADDRCONFIG 0x40000 +#endif +/**@}*/ + +struct evutil_addrinfo; +/** + * This function clones getaddrinfo for systems that don't have it. For full + * details, see RFC 3493, section 6.1. + * + * Limitations: + * - When the system has no getaddrinfo, we fall back to gethostbyname_r or + * gethostbyname, with their attendant issues. + * - The AI_V4MAPPED and AI_ALL flags are not currently implemented. + * + * For a nonblocking variant, see evdns_getaddrinfo. + */ +EVENT2_EXPORT_SYMBOL +int evutil_getaddrinfo(const char *nodename, const char *servname, + const struct evutil_addrinfo *hints_in, struct evutil_addrinfo **res); + +/** Release storage allocated by evutil_getaddrinfo or evdns_getaddrinfo. */ +EVENT2_EXPORT_SYMBOL +void evutil_freeaddrinfo(struct evutil_addrinfo *ai); + +EVENT2_EXPORT_SYMBOL +const char *evutil_gai_strerror(int err); + +/** Generate n bytes of secure pseudorandom data, and store them in buf. + * + * Current versions of Libevent use an ARC4-based random number generator, + * seeded using the platform's entropy source (/dev/urandom on Unix-like + * systems; CryptGenRandom on Windows). This is not actually as secure as it + * should be: ARC4 is a pretty lousy cipher, and the current implementation + * provides only rudimentary prediction- and backtracking-resistance. Don't + * use this for serious cryptographic applications. + */ +EVENT2_EXPORT_SYMBOL +void evutil_secure_rng_get_bytes(void *buf, size_t n); + +/** + * Seed the secure random number generator if needed, and return 0 on + * success or -1 on failure. + * + * It is okay to call this function more than once; it will still return + * 0 if the RNG has been successfully seeded and -1 if it can't be + * seeded. + * + * Ordinarily you don't need to call this function from your own code; + * Libevent will seed the RNG itself the first time it needs good random + * numbers. You only need to call it if (a) you want to double-check + * that one of the seeding methods did succeed, or (b) you plan to drop + * the capability to seed (by chrooting, or dropping capabilities, or + * whatever), and you want to make sure that seeding happens before your + * program loses the ability to do it. + */ +EVENT2_EXPORT_SYMBOL +int evutil_secure_rng_init(void); + +/** + * Set a filename to use in place of /dev/urandom for seeding the secure + * PRNG. Return 0 on success, -1 on failure. + * + * Call this function BEFORE calling any other initialization or RNG + * functions. + * + * (This string will _NOT_ be copied internally. Do not free it while any + * user of the secure RNG might be running. Don't pass anything other than a + * real /dev/...random device file here, or you might lose security.) + * + * This API is unstable, and might change in a future libevent version. + */ +EVENT2_EXPORT_SYMBOL +int evutil_secure_rng_set_urandom_device_file(char *fname); + +/** Seed the random number generator with extra random bytes. + + You should almost never need to call this function; it should be + sufficient to invoke evutil_secure_rng_init(), or let Libevent take + care of calling evutil_secure_rng_init() on its own. + + If you call this function as a _replacement_ for the regular + entropy sources, then you need to be sure that your input + contains a fairly large amount of strong entropy. Doing so is + notoriously hard: most people who try get it wrong. Watch out! + + @param dat a buffer full of a strong source of random numbers + @param datlen the number of bytes to read from datlen + */ +EVENT2_EXPORT_SYMBOL +void evutil_secure_rng_add_bytes(const char *dat, size_t datlen); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT1_EVUTIL_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Linux/event2/visibility.h b/Source/Import/libevent/Includes/Linux/event2/visibility.h new file mode 100644 index 0000000..fb16dbe --- /dev/null +++ b/Source/Import/libevent/Includes/Linux/event2/visibility.h @@ -0,0 +1,50 @@ +/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */ +/* + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_VISIBILITY_H_INCLUDED_ +#define EVENT2_VISIBILITY_H_INCLUDED_ + +#include + +#if defined(event_EXPORTS) || defined(event_extra_EXPORTS) || defined(event_core_EXPORTS) +# if defined (__SUNPRO_C) && (__SUNPRO_C >= 0x550) +# define EVENT2_EXPORT_SYMBOL __global +# elif defined __GNUC__ +# define EVENT2_EXPORT_SYMBOL __attribute__ ((visibility("default"))) +# elif defined(_MSC_VER) +# define EVENT2_EXPORT_SYMBOL extern __declspec(dllexport) +# else +# define EVENT2_EXPORT_SYMBOL /* unknown compiler */ +# endif +#else +# if defined(EVENT__NEED_DLLIMPORT) && defined(_MSC_VER) && !defined(EVENT_BUILDING_REGRESS_TEST) +# define EVENT2_EXPORT_SYMBOL extern __declspec(dllimport) +# else +# define EVENT2_EXPORT_SYMBOL +# endif +#endif + +#endif /* EVENT2_VISIBILITY_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/buffer.h b/Source/Import/libevent/Includes/Windows/event2/buffer.h new file mode 100644 index 0000000..468588b --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/buffer.h @@ -0,0 +1,1076 @@ +/* + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_BUFFER_H_INCLUDED_ +#define EVENT2_BUFFER_H_INCLUDED_ + +/** @file event2/buffer.h + + Functions for buffering data for network sending or receiving. + + An evbuffer can be used for preparing data before sending it to + the network or conversely for reading data from the network. + Evbuffers try to avoid memory copies as much as possible. As a + result, evbuffers can be used to pass data around without actually + incurring the overhead of copying the data. + + A new evbuffer can be allocated with evbuffer_new(), and can be + freed with evbuffer_free(). Most users will be using evbuffers via + the bufferevent interface. To access a bufferevent's evbuffers, use + bufferevent_get_input() and bufferevent_get_output(). + + There are several guidelines for using evbuffers. + + - if you already know how much data you are going to add as a result + of calling evbuffer_add() multiple times, it makes sense to use + evbuffer_expand() first to make sure that enough memory is allocated + before hand. + + - evbuffer_add_buffer() adds the contents of one buffer to the other + without incurring any unnecessary memory copies. + + - evbuffer_add() and evbuffer_add_buffer() do not mix very well: + if you use them, you will wind up with fragmented memory in your + buffer. + + - For high-performance code, you may want to avoid copying data into and out + of buffers. You can skip the copy step by using + evbuffer_reserve_space()/evbuffer_commit_space() when writing into a + buffer, and evbuffer_peek() when reading. + + In Libevent 2.0 and later, evbuffers are represented using a linked + list of memory chunks, with pointers to the first and last chunk in + the chain. + + As the contents of an evbuffer can be stored in multiple different + memory blocks, it cannot be accessed directly. Instead, evbuffer_pullup() + can be used to force a specified number of bytes to be contiguous. This + will cause memory reallocation and memory copies if the data is split + across multiple blocks. It is more efficient, however, to use + evbuffer_peek() if you don't require that the memory to be contiguous. + */ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_UIO_H +#include +#endif +#include + +/** + An evbuffer is an opaque data type for efficiently buffering data to be + sent or received on the network. + + @see event2/event.h for more information +*/ +struct evbuffer +#ifdef EVENT_IN_DOXYGEN_ +{} +#endif +; + +/** + Pointer to a position within an evbuffer. + + Used when repeatedly searching through a buffer. Calling any function + that modifies or re-packs the buffer contents may invalidate all + evbuffer_ptrs for that buffer. Do not modify or contruct these values + except with evbuffer_ptr_set. + + An evbuffer_ptr can represent any position from the start of a buffer up + to a position immediately after the end of a buffer. + + @see evbuffer_ptr_set() + */ +struct evbuffer_ptr { + ev_ssize_t pos; + + /* Do not alter or rely on the values of fields: they are for internal + * use */ + struct { + void *chain; + size_t pos_in_chain; + } internal_; +}; + +/** Describes a single extent of memory inside an evbuffer. Used for + direct-access functions. + + @see evbuffer_reserve_space, evbuffer_commit_space, evbuffer_peek + */ +#ifdef EVENT__HAVE_SYS_UIO_H +#define evbuffer_iovec iovec +/* Internal use -- defined only if we are using the native struct iovec */ +#define EVBUFFER_IOVEC_IS_NATIVE_ +#else +struct evbuffer_iovec { + /** The start of the extent of memory. */ + void *iov_base; + /** The length of the extent of memory. */ + size_t iov_len; +}; +#endif + +/** + Allocate storage for a new evbuffer. + + @return a pointer to a newly allocated evbuffer struct, or NULL if an error + occurred + */ +EVENT2_EXPORT_SYMBOL +struct evbuffer *evbuffer_new(void); +/** + Deallocate storage for an evbuffer. + + @param buf pointer to the evbuffer to be freed + */ +EVENT2_EXPORT_SYMBOL +void evbuffer_free(struct evbuffer *buf); + +/** + Enable locking on an evbuffer so that it can safely be used by multiple + threads at the same time. + + NOTE: when locking is enabled, the lock will be held when callbacks are + invoked. This could result in deadlock if you aren't careful. Plan + accordingly! + + @param buf An evbuffer to make lockable. + @param lock A lock object, or NULL if we should allocate our own. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_enable_locking(struct evbuffer *buf, void *lock); + +/** + Acquire the lock on an evbuffer. Has no effect if locking was not enabled + with evbuffer_enable_locking. +*/ +EVENT2_EXPORT_SYMBOL +void evbuffer_lock(struct evbuffer *buf); + +/** + Release the lock on an evbuffer. Has no effect if locking was not enabled + with evbuffer_enable_locking. +*/ +EVENT2_EXPORT_SYMBOL +void evbuffer_unlock(struct evbuffer *buf); + + +/** If this flag is set, then we will not use evbuffer_peek(), + * evbuffer_remove(), evbuffer_remove_buffer(), and so on to read bytes + * from this buffer: we'll only take bytes out of this buffer by + * writing them to the network (as with evbuffer_write_atmost), by + * removing them without observing them (as with evbuffer_drain), + * or by copying them all out at once (as with evbuffer_add_buffer). + * + * Using this option allows the implementation to use sendfile-based + * operations for evbuffer_add_file(); see that function for more + * information. + * + * This flag is on by default for bufferevents that can take advantage + * of it; you should never actually need to set it on a bufferevent's + * output buffer. + */ +#define EVBUFFER_FLAG_DRAINS_TO_FD 1 + +/** Change the flags that are set for an evbuffer by adding more. + * + * @param buffer the evbuffer that the callback is watching. + * @param cb the callback whose status we want to change. + * @param flags One or more EVBUFFER_FLAG_* options + * @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_set_flags(struct evbuffer *buf, ev_uint64_t flags); +/** Change the flags that are set for an evbuffer by removing some. + * + * @param buffer the evbuffer that the callback is watching. + * @param cb the callback whose status we want to change. + * @param flags One or more EVBUFFER_FLAG_* options + * @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_clear_flags(struct evbuffer *buf, ev_uint64_t flags); + +/** + Returns the total number of bytes stored in the evbuffer + + @param buf pointer to the evbuffer + @return the number of bytes stored in the evbuffer +*/ +EVENT2_EXPORT_SYMBOL +size_t evbuffer_get_length(const struct evbuffer *buf); + +/** + Returns the number of contiguous available bytes in the first buffer chain. + + This is useful when processing data that might be split into multiple + chains, or that might all be in the first chain. Calls to + evbuffer_pullup() that cause reallocation and copying of data can thus be + avoided. + + @param buf pointer to the evbuffer + @return 0 if no data is available, otherwise the number of available bytes + in the first buffer chain. +*/ +EVENT2_EXPORT_SYMBOL +size_t evbuffer_get_contiguous_space(const struct evbuffer *buf); + +/** + Expands the available space in an evbuffer. + + Expands the available space in the evbuffer to at least datlen, so that + appending datlen additional bytes will not require any new allocations. + + @param buf the evbuffer to be expanded + @param datlen the new minimum length requirement + @return 0 if successful, or -1 if an error occurred +*/ +EVENT2_EXPORT_SYMBOL +int evbuffer_expand(struct evbuffer *buf, size_t datlen); + +/** + Reserves space in the last chain or chains of an evbuffer. + + Makes space available in the last chain or chains of an evbuffer that can + be arbitrarily written to by a user. The space does not become + available for reading until it has been committed with + evbuffer_commit_space(). + + The space is made available as one or more extents, represented by + an initial pointer and a length. You can force the memory to be + available as only one extent. Allowing more extents, however, makes the + function more efficient. + + Multiple subsequent calls to this function will make the same space + available until evbuffer_commit_space() has been called. + + It is an error to do anything that moves around the buffer's internal + memory structures before committing the space. + + NOTE: The code currently does not ever use more than two extents. + This may change in future versions. + + @param buf the evbuffer in which to reserve space. + @param size how much space to make available, at minimum. The + total length of the extents may be greater than the requested + length. + @param vec an array of one or more evbuffer_iovec structures to + hold pointers to the reserved extents of memory. + @param n_vec The length of the vec array. Must be at least 1; + 2 is more efficient. + @return the number of provided extents, or -1 on error. + @see evbuffer_commit_space() +*/ +EVENT2_EXPORT_SYMBOL +int +evbuffer_reserve_space(struct evbuffer *buf, ev_ssize_t size, + struct evbuffer_iovec *vec, int n_vec); + +/** + Commits previously reserved space. + + Commits some of the space previously reserved with + evbuffer_reserve_space(). It then becomes available for reading. + + This function may return an error if the pointer in the extents do + not match those returned from evbuffer_reserve_space, or if data + has been added to the buffer since the space was reserved. + + If you want to commit less data than you got reserved space for, + modify the iov_len pointer of the appropriate extent to a smaller + value. Note that you may have received more space than you + requested if it was available! + + @param buf the evbuffer in which to reserve space. + @param vec one or two extents returned by evbuffer_reserve_space. + @param n_vecs the number of extents. + @return 0 on success, -1 on error + @see evbuffer_reserve_space() +*/ +EVENT2_EXPORT_SYMBOL +int evbuffer_commit_space(struct evbuffer *buf, + struct evbuffer_iovec *vec, int n_vecs); + +/** + Append data to the end of an evbuffer. + + @param buf the evbuffer to be appended to + @param data pointer to the beginning of the data buffer + @param datlen the number of bytes to be copied from the data buffer + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add(struct evbuffer *buf, const void *data, size_t datlen); + + +/** + Read data from an evbuffer and drain the bytes read. + + If more bytes are requested than are available in the evbuffer, we + only extract as many bytes as were available. + + @param buf the evbuffer to be read from + @param data the destination buffer to store the result + @param datlen the maximum size of the destination buffer + @return the number of bytes read, or -1 if we can't drain the buffer. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_remove(struct evbuffer *buf, void *data, size_t datlen); + +/** + Read data from an evbuffer, and leave the buffer unchanged. + + If more bytes are requested than are available in the evbuffer, we + only extract as many bytes as were available. + + @param buf the evbuffer to be read from + @param data_out the destination buffer to store the result + @param datlen the maximum size of the destination buffer + @return the number of bytes read, or -1 if we can't drain the buffer. + */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t evbuffer_copyout(struct evbuffer *buf, void *data_out, size_t datlen); + +/** + Read data from the middle of an evbuffer, and leave the buffer unchanged. + + If more bytes are requested than are available in the evbuffer, we + only extract as many bytes as were available. + + @param buf the evbuffer to be read from + @param pos the position to start reading from + @param data_out the destination buffer to store the result + @param datlen the maximum size of the destination buffer + @return the number of bytes read, or -1 if we can't drain the buffer. + */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t evbuffer_copyout_from(struct evbuffer *buf, const struct evbuffer_ptr *pos, void *data_out, size_t datlen); + +/** + Read data from an evbuffer into another evbuffer, draining + the bytes from the source buffer. This function avoids copy + operations to the extent possible. + + If more bytes are requested than are available in src, the src + buffer is drained completely. + + @param src the evbuffer to be read from + @param dst the destination evbuffer to store the result into + @param datlen the maximum numbers of bytes to transfer + @return the number of bytes read + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_remove_buffer(struct evbuffer *src, struct evbuffer *dst, + size_t datlen); + +/** Used to tell evbuffer_readln what kind of line-ending to look for. + */ +enum evbuffer_eol_style { + /** Any sequence of CR and LF characters is acceptable as an + * EOL. + * + * Note that this style can produce ambiguous results: the + * sequence "CRLF" will be treated as a single EOL if it is + * all in the buffer at once, but if you first read a CR from + * the network and later read an LF from the network, it will + * be treated as two EOLs. + */ + EVBUFFER_EOL_ANY, + /** An EOL is an LF, optionally preceded by a CR. This style is + * most useful for implementing text-based internet protocols. */ + EVBUFFER_EOL_CRLF, + /** An EOL is a CR followed by an LF. */ + EVBUFFER_EOL_CRLF_STRICT, + /** An EOL is a LF. */ + EVBUFFER_EOL_LF, + /** An EOL is a NUL character (that is, a single byte with value 0) */ + EVBUFFER_EOL_NUL +}; + +/** + * Read a single line from an evbuffer. + * + * Reads a line terminated by an EOL as determined by the evbuffer_eol_style + * argument. Returns a newly allocated nul-terminated string; the caller must + * free the returned value. The EOL is not included in the returned string. + * + * @param buffer the evbuffer to read from + * @param n_read_out if non-NULL, points to a size_t that is set to the + * number of characters in the returned string. This is useful for + * strings that can contain NUL characters. + * @param eol_style the style of line-ending to use. + * @return pointer to a single line, or NULL if an error occurred + */ +EVENT2_EXPORT_SYMBOL +char *evbuffer_readln(struct evbuffer *buffer, size_t *n_read_out, + enum evbuffer_eol_style eol_style); + +/** + Move all data from one evbuffer into another evbuffer. + + This is a destructive add. The data from one buffer moves into + the other buffer. However, no unnecessary memory copies occur. + + @param outbuf the output buffer + @param inbuf the input buffer + @return 0 if successful, or -1 if an error occurred + + @see evbuffer_remove_buffer() + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_buffer(struct evbuffer *outbuf, struct evbuffer *inbuf); + +/** + Copy data from one evbuffer into another evbuffer. + + This is a non-destructive add. The data from one buffer is copied + into the other buffer. However, no unnecessary memory copies occur. + + Note that buffers already containing buffer references can't be added + to other buffers. + + @param outbuf the output buffer + @param inbuf the input buffer + @return 0 if successful, or -1 if an error occurred + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_buffer_reference(struct evbuffer *outbuf, + struct evbuffer *inbuf); + +/** + A cleanup function for a piece of memory added to an evbuffer by + reference. + + @see evbuffer_add_reference() + */ +typedef void (*evbuffer_ref_cleanup_cb)(const void *data, + size_t datalen, void *extra); + +/** + Reference memory into an evbuffer without copying. + + The memory needs to remain valid until all the added data has been + read. This function keeps just a reference to the memory without + actually incurring the overhead of a copy. + + @param outbuf the output buffer + @param data the memory to reference + @param datlen how memory to reference + @param cleanupfn callback to be invoked when the memory is no longer + referenced by this evbuffer. + @param cleanupfn_arg optional argument to the cleanup callback + @return 0 if successful, or -1 if an error occurred + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_reference(struct evbuffer *outbuf, + const void *data, size_t datlen, + evbuffer_ref_cleanup_cb cleanupfn, void *cleanupfn_arg); + +/** + Copy data from a file into the evbuffer for writing to a socket. + + This function avoids unnecessary data copies between userland and + kernel. If sendfile is available and the EVBUFFER_FLAG_DRAINS_TO_FD + flag is set, it uses those functions. Otherwise, it tries to use + mmap (or CreateFileMapping on Windows). + + The function owns the resulting file descriptor and will close it + when finished transferring data. + + The results of using evbuffer_remove() or evbuffer_pullup() on + evbuffers whose data was added using this function are undefined. + + For more fine-grained control, use evbuffer_add_file_segment. + + @param outbuf the output buffer + @param fd the file descriptor + @param offset the offset from which to read data + @param length how much data to read, or -1 to read as much as possible. + (-1 requires that 'fd' support fstat.) + @return 0 if successful, or -1 if an error occurred +*/ + +EVENT2_EXPORT_SYMBOL +int evbuffer_add_file(struct evbuffer *outbuf, int fd, ev_off_t offset, + ev_off_t length); + +/** + An evbuffer_file_segment holds a reference to a range of a file -- + possibly the whole file! -- for use in writing from an evbuffer to a + socket. It could be implemented with mmap, sendfile, splice, or (if all + else fails) by just pulling all the data into RAM. A single + evbuffer_file_segment can be added more than once, and to more than one + evbuffer. + */ +struct evbuffer_file_segment; + +/** + Flag for creating evbuffer_file_segment: If this flag is set, then when + the evbuffer_file_segment is freed and no longer in use by any + evbuffer, the underlying fd is closed. + */ +#define EVBUF_FS_CLOSE_ON_FREE 0x01 +/** + Flag for creating evbuffer_file_segment: Disable memory-map based + implementations. + */ +#define EVBUF_FS_DISABLE_MMAP 0x02 +/** + Flag for creating evbuffer_file_segment: Disable direct fd-to-fd + implementations (including sendfile and splice). + + You might want to use this option if data needs to be taken from the + evbuffer by any means other than writing it to the network: the sendfile + backend is fast, but it only works for sending files directly to the + network. + */ +#define EVBUF_FS_DISABLE_SENDFILE 0x04 +/** + Flag for creating evbuffer_file_segment: Do not allocate a lock for this + segment. If this option is set, then neither the segment nor any + evbuffer it is added to may ever be accessed from more than one thread + at a time. + */ +#define EVBUF_FS_DISABLE_LOCKING 0x08 + +/** + A cleanup function for a evbuffer_file_segment added to an evbuffer + for reference. + */ +typedef void (*evbuffer_file_segment_cleanup_cb)( + struct evbuffer_file_segment const* seg, int flags, void* arg); + +/** + Create and return a new evbuffer_file_segment for reading data from a + file and sending it out via an evbuffer. + + This function avoids unnecessary data copies between userland and + kernel. Where available, it uses sendfile or splice. + + The file descriptor must not be closed so long as any evbuffer is using + this segment. + + The results of using evbuffer_remove() or evbuffer_pullup() or any other + function that reads bytes from an evbuffer on any evbuffer containing + the newly returned segment are undefined, unless you pass the + EVBUF_FS_DISABLE_SENDFILE flag to this function. + + @param fd an open file to read from. + @param offset an index within the file at which to start reading + @param length how much data to read, or -1 to read as much as possible. + (-1 requires that 'fd' support fstat.) + @param flags any number of the EVBUF_FS_* flags + @return a new evbuffer_file_segment, or NULL on failure. + **/ +EVENT2_EXPORT_SYMBOL +struct evbuffer_file_segment *evbuffer_file_segment_new( + int fd, ev_off_t offset, ev_off_t length, unsigned flags); + +/** + Free an evbuffer_file_segment + + It is safe to call this function even if the segment has been added to + one or more evbuffers. The evbuffer_file_segment will not be freed + until no more references to it exist. + */ +EVENT2_EXPORT_SYMBOL +void evbuffer_file_segment_free(struct evbuffer_file_segment *seg); + +/** + Add cleanup callback and argument for the callback to an + evbuffer_file_segment. + + The cleanup callback will be invoked when no more references to the + evbuffer_file_segment exist. + **/ +EVENT2_EXPORT_SYMBOL +void evbuffer_file_segment_add_cleanup_cb(struct evbuffer_file_segment *seg, + evbuffer_file_segment_cleanup_cb cb, void* arg); + +/** + Insert some or all of an evbuffer_file_segment at the end of an evbuffer + + Note that the offset and length parameters of this function have a + different meaning from those provided to evbuffer_file_segment_new: When + you create the segment, the offset is the offset _within the file_, and + the length is the length _of the segment_, whereas when you add a + segment to an evbuffer, the offset is _within the segment_ and the + length is the length of the _part of the segment you want to use. + + In other words, if you have a 10 KiB file, and you create an + evbuffer_file_segment for it with offset 20 and length 1000, it will + refer to bytes 20..1019 inclusive. If you then pass this segment to + evbuffer_add_file_segment and specify an offset of 20 and a length of + 50, you will be adding bytes 40..99 inclusive. + + @param buf the evbuffer to append to + @param seg the segment to add + @param offset the offset within the segment to start from + @param length the amount of data to add, or -1 to add it all. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_file_segment(struct evbuffer *buf, + struct evbuffer_file_segment *seg, ev_off_t offset, ev_off_t length); + +/** + Append a formatted string to the end of an evbuffer. + + The string is formated as printf. + + @param buf the evbuffer that will be appended to + @param fmt a format string + @param ... arguments that will be passed to printf(3) + @return The number of bytes added if successful, or -1 if an error occurred. + + @see evutil_printf(), evbuffer_add_vprintf() + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_printf(struct evbuffer *buf, const char *fmt, ...) +#ifdef __GNUC__ + __attribute__((format(printf, 2, 3))) +#endif +; + +/** + Append a va_list formatted string to the end of an evbuffer. + + @param buf the evbuffer that will be appended to + @param fmt a format string + @param ap a varargs va_list argument array that will be passed to vprintf(3) + @return The number of bytes added if successful, or -1 if an error occurred. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_add_vprintf(struct evbuffer *buf, const char *fmt, va_list ap) +#ifdef __GNUC__ + __attribute__((format(printf, 2, 0))) +#endif +; + + +/** + Remove a specified number of bytes data from the beginning of an evbuffer. + + @param buf the evbuffer to be drained + @param len the number of bytes to drain from the beginning of the buffer + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_drain(struct evbuffer *buf, size_t len); + + +/** + Write the contents of an evbuffer to a file descriptor. + + The evbuffer will be drained after the bytes have been successfully written. + + @param buffer the evbuffer to be written and drained + @param fd the file descriptor to be written to + @return the number of bytes written, or -1 if an error occurred + @see evbuffer_read() + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_write(struct evbuffer *buffer, evutil_socket_t fd); + +/** + Write some of the contents of an evbuffer to a file descriptor. + + The evbuffer will be drained after the bytes have been successfully written. + + @param buffer the evbuffer to be written and drained + @param fd the file descriptor to be written to + @param howmuch the largest allowable number of bytes to write, or -1 + to write as many bytes as we can. + @return the number of bytes written, or -1 if an error occurred + @see evbuffer_read() + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_write_atmost(struct evbuffer *buffer, evutil_socket_t fd, + ev_ssize_t howmuch); + +/** + Read from a file descriptor and store the result in an evbuffer. + + @param buffer the evbuffer to store the result + @param fd the file descriptor to read from + @param howmuch the number of bytes to be read + @return the number of bytes read, or -1 if an error occurred + @see evbuffer_write() + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_read(struct evbuffer *buffer, evutil_socket_t fd, int howmuch); + +/** + Search for a string within an evbuffer. + + @param buffer the evbuffer to be searched + @param what the string to be searched for + @param len the length of the search string + @param start NULL or a pointer to a valid struct evbuffer_ptr. + @return a struct evbuffer_ptr whose 'pos' field has the offset of the + first occurrence of the string in the buffer after 'start'. The 'pos' + field of the result is -1 if the string was not found. + */ +EVENT2_EXPORT_SYMBOL +struct evbuffer_ptr evbuffer_search(struct evbuffer *buffer, const char *what, size_t len, const struct evbuffer_ptr *start); + +/** + Search for a string within part of an evbuffer. + + @param buffer the evbuffer to be searched + @param what the string to be searched for + @param len the length of the search string + @param start NULL or a pointer to a valid struct evbuffer_ptr that + indicates where we should start searching. + @param end NULL or a pointer to a valid struct evbuffer_ptr that + indicates where we should stop searching. + @return a struct evbuffer_ptr whose 'pos' field has the offset of the + first occurrence of the string in the buffer after 'start'. The 'pos' + field of the result is -1 if the string was not found. + */ +EVENT2_EXPORT_SYMBOL +struct evbuffer_ptr evbuffer_search_range(struct evbuffer *buffer, const char *what, size_t len, const struct evbuffer_ptr *start, const struct evbuffer_ptr *end); + +/** + Defines how to adjust an evbuffer_ptr by evbuffer_ptr_set() + + @see evbuffer_ptr_set() */ +enum evbuffer_ptr_how { + /** Sets the pointer to the position; can be called on with an + uninitialized evbuffer_ptr. */ + EVBUFFER_PTR_SET, + /** Advances the pointer by adding to the current position. */ + EVBUFFER_PTR_ADD +}; + +/** + Sets the search pointer in the buffer to position. + + There are two ways to use this function: you can call + evbuffer_ptr_set(buf, &pos, N, EVBUFFER_PTR_SET) + to move 'pos' to a position 'N' bytes after the start of the buffer, or + evbuffer_ptr_set(buf, &pos, N, EVBUFFER_PTR_ADD) + to move 'pos' forward by 'N' bytes. + + If evbuffer_ptr is not initialized, this function can only be called + with EVBUFFER_PTR_SET. + + An evbuffer_ptr can represent any position from the start of the buffer to + a position immediately after the end of the buffer. + + @param buffer the evbuffer to be search + @param ptr a pointer to a struct evbuffer_ptr + @param position the position at which to start the next search + @param how determines how the pointer should be manipulated. + @returns 0 on success or -1 otherwise +*/ +EVENT2_EXPORT_SYMBOL +int +evbuffer_ptr_set(struct evbuffer *buffer, struct evbuffer_ptr *ptr, + size_t position, enum evbuffer_ptr_how how); + +/** + Search for an end-of-line string within an evbuffer. + + @param buffer the evbuffer to be searched + @param start NULL or a pointer to a valid struct evbuffer_ptr to start + searching at. + @param eol_len_out If non-NULL, the pointed-to value will be set to + the length of the end-of-line string. + @param eol_style The kind of EOL to look for; see evbuffer_readln() for + more information + @return a struct evbuffer_ptr whose 'pos' field has the offset of the + first occurrence EOL in the buffer after 'start'. The 'pos' + field of the result is -1 if the string was not found. + */ +EVENT2_EXPORT_SYMBOL +struct evbuffer_ptr evbuffer_search_eol(struct evbuffer *buffer, + struct evbuffer_ptr *start, size_t *eol_len_out, + enum evbuffer_eol_style eol_style); + +/** Function to peek at data inside an evbuffer without removing it or + copying it out. + + Pointers to the data are returned by filling the 'vec_out' array + with pointers to one or more extents of data inside the buffer. + + The total data in the extents that you get back may be more than + you requested (if there is more data last extent than you asked + for), or less (if you do not provide enough evbuffer_iovecs, or if + the buffer does not have as much data as you asked to see). + + @param buffer the evbuffer to peek into, + @param len the number of bytes to try to peek. If len is negative, we + will try to fill as much of vec_out as we can. If len is negative + and vec_out is not provided, we return the number of evbuffer_iovecs + that would be needed to get all the data in the buffer. + @param start_at an evbuffer_ptr indicating the point at which we + should start looking for data. NULL means, "At the start of the + buffer." + @param vec_out an array of evbuffer_iovec + @param n_vec the length of vec_out. If 0, we only count how many + extents would be necessary to point to the requested amount of + data. + @return The number of extents needed. This may be less than n_vec + if we didn't need all the evbuffer_iovecs we were given, or more + than n_vec if we would need more to return all the data that was + requested. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_peek(struct evbuffer *buffer, ev_ssize_t len, + struct evbuffer_ptr *start_at, + struct evbuffer_iovec *vec_out, int n_vec); + + +/** Structure passed to an evbuffer_cb_func evbuffer callback + + @see evbuffer_cb_func, evbuffer_add_cb() + */ +struct evbuffer_cb_info { + /** The number of bytes in this evbuffer when callbacks were last + * invoked. */ + size_t orig_size; + /** The number of bytes added since callbacks were last invoked. */ + size_t n_added; + /** The number of bytes removed since callbacks were last invoked. */ + size_t n_deleted; +}; + +/** Type definition for a callback that is invoked whenever data is added or + removed from an evbuffer. + + An evbuffer may have one or more callbacks set at a time. The order + in which they are executed is undefined. + + A callback function may add more callbacks, or remove itself from the + list of callbacks, or add or remove data from the buffer. It may not + remove another callback from the list. + + If a callback adds or removes data from the buffer or from another + buffer, this can cause a recursive invocation of your callback or + other callbacks. If you ask for an infinite loop, you might just get + one: watch out! + + @param buffer the buffer whose size has changed + @param info a structure describing how the buffer changed. + @param arg a pointer to user data +*/ +typedef void (*evbuffer_cb_func)(struct evbuffer *buffer, const struct evbuffer_cb_info *info, void *arg); + +struct evbuffer_cb_entry; +/** Add a new callback to an evbuffer. + + Subsequent calls to evbuffer_add_cb() add new callbacks. To remove this + callback, call evbuffer_remove_cb or evbuffer_remove_cb_entry. + + @param buffer the evbuffer to be monitored + @param cb the callback function to invoke when the evbuffer is modified, + or NULL to remove all callbacks. + @param cbarg an argument to be provided to the callback function + @return a handle to the callback on success, or NULL on failure. + */ +EVENT2_EXPORT_SYMBOL +struct evbuffer_cb_entry *evbuffer_add_cb(struct evbuffer *buffer, evbuffer_cb_func cb, void *cbarg); + +/** Remove a callback from an evbuffer, given a handle returned from + evbuffer_add_cb. + + Calling this function invalidates the handle. + + @return 0 if a callback was removed, or -1 if no matching callback was + found. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_remove_cb_entry(struct evbuffer *buffer, + struct evbuffer_cb_entry *ent); + +/** Remove a callback from an evbuffer, given the function and argument + used to add it. + + @return 0 if a callback was removed, or -1 if no matching callback was + found. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_remove_cb(struct evbuffer *buffer, evbuffer_cb_func cb, void *cbarg); + +/** If this flag is not set, then a callback is temporarily disabled, and + * should not be invoked. + * + * @see evbuffer_cb_set_flags(), evbuffer_cb_clear_flags() + */ +#define EVBUFFER_CB_ENABLED 1 + +/** Change the flags that are set for a callback on a buffer by adding more. + + @param buffer the evbuffer that the callback is watching. + @param cb the callback whose status we want to change. + @param flags EVBUFFER_CB_ENABLED to re-enable the callback. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_cb_set_flags(struct evbuffer *buffer, + struct evbuffer_cb_entry *cb, ev_uint32_t flags); + +/** Change the flags that are set for a callback on a buffer by removing some + + @param buffer the evbuffer that the callback is watching. + @param cb the callback whose status we want to change. + @param flags EVBUFFER_CB_ENABLED to disable the callback. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_cb_clear_flags(struct evbuffer *buffer, + struct evbuffer_cb_entry *cb, ev_uint32_t flags); + +#if 0 +/** Postpone calling a given callback until unsuspend is called later. + + This is different from disabling the callback, since the callback will get + invoked later if the buffer size changes between now and when we unsuspend + it. + + @param the buffer that the callback is watching. + @param cb the callback we want to suspend. + */ +EVENT2_EXPORT_SYMBOL +void evbuffer_cb_suspend(struct evbuffer *buffer, struct evbuffer_cb_entry *cb); +/** Stop postponing a callback that we postponed with evbuffer_cb_suspend. + + If data was added to or removed from the buffer while the callback was + suspended, the callback will get called once now. + + @param the buffer that the callback is watching. + @param cb the callback we want to stop suspending. + */ +EVENT2_EXPORT_SYMBOL +void evbuffer_cb_unsuspend(struct evbuffer *buffer, struct evbuffer_cb_entry *cb); +#endif + +/** + Makes the data at the beginning of an evbuffer contiguous. + + @param buf the evbuffer to make contiguous + @param size the number of bytes to make contiguous, or -1 to make the + entire buffer contiguous. + @return a pointer to the contiguous memory array, or NULL if param size + requested more data than is present in the buffer. +*/ + +EVENT2_EXPORT_SYMBOL +unsigned char *evbuffer_pullup(struct evbuffer *buf, ev_ssize_t size); + +/** + Prepends data to the beginning of the evbuffer + + @param buf the evbuffer to which to prepend data + @param data a pointer to the memory to prepend + @param size the number of bytes to prepend + @return 0 if successful, or -1 otherwise +*/ + +EVENT2_EXPORT_SYMBOL +int evbuffer_prepend(struct evbuffer *buf, const void *data, size_t size); + +/** + Prepends all data from the src evbuffer to the beginning of the dst + evbuffer. + + @param dst the evbuffer to which to prepend data + @param src the evbuffer to prepend; it will be emptied as a result + @return 0 if successful, or -1 otherwise +*/ +EVENT2_EXPORT_SYMBOL +int evbuffer_prepend_buffer(struct evbuffer *dst, struct evbuffer* src); + +/** + Prevent calls that modify an evbuffer from succeeding. A buffer may + frozen at the front, at the back, or at both the front and the back. + + If the front of a buffer is frozen, operations that drain data from + the front of the buffer, or that prepend data to the buffer, will + fail until it is unfrozen. If the back a buffer is frozen, operations + that append data from the buffer will fail until it is unfrozen. + + @param buf The buffer to freeze + @param at_front If true, we freeze the front of the buffer. If false, + we freeze the back. + @return 0 on success, -1 on failure. +*/ +EVENT2_EXPORT_SYMBOL +int evbuffer_freeze(struct evbuffer *buf, int at_front); +/** + Re-enable calls that modify an evbuffer. + + @param buf The buffer to un-freeze + @param at_front If true, we unfreeze the front of the buffer. If false, + we unfreeze the back. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_unfreeze(struct evbuffer *buf, int at_front); + +struct event_base; +/** + Force all the callbacks on an evbuffer to be run, not immediately after + the evbuffer is altered, but instead from inside the event loop. + + This can be used to serialize all the callbacks to a single thread + of execution. + */ +EVENT2_EXPORT_SYMBOL +int evbuffer_defer_callbacks(struct evbuffer *buffer, struct event_base *base); + +/** + Append data from 1 or more iovec's to an evbuffer + + Calculates the number of bytes needed for an iovec structure and guarantees + all data will fit into a single chain. Can be used in lieu of functionality + which calls evbuffer_add() constantly before being used to increase + performance. + + @param buffer the destination buffer + @param vec the source iovec + @param n_vec the number of iovec structures. + @return the number of bytes successfully written to the output buffer. +*/ +EVENT2_EXPORT_SYMBOL +size_t evbuffer_add_iovec(struct evbuffer * buffer, struct evbuffer_iovec * vec, int n_vec); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_BUFFER_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/buffer_compat.h b/Source/Import/libevent/Includes/Windows/event2/buffer_compat.h new file mode 100644 index 0000000..24f828c --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/buffer_compat.h @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef EVENT2_BUFFER_COMPAT_H_INCLUDED_ +#define EVENT2_BUFFER_COMPAT_H_INCLUDED_ + +#include + +/** @file event2/buffer_compat.h + + Obsolete and deprecated versions of the functions in buffer.h: provided + only for backward compatibility. + */ + + +/** + Obsolete alias for evbuffer_readln(buffer, NULL, EVBUFFER_EOL_ANY). + + @deprecated This function is deprecated because its behavior is not correct + for almost any protocol, and also because it's wholly subsumed by + evbuffer_readln(). + + @param buffer the evbuffer to read from + @return pointer to a single line, or NULL if an error occurred + +*/ +EVENT2_EXPORT_SYMBOL +char *evbuffer_readline(struct evbuffer *buffer); + +/** Type definition for a callback that is invoked whenever data is added or + removed from an evbuffer. + + An evbuffer may have one or more callbacks set at a time. The order + in which they are executed is undefined. + + A callback function may add more callbacks, or remove itself from the + list of callbacks, or add or remove data from the buffer. It may not + remove another callback from the list. + + If a callback adds or removes data from the buffer or from another + buffer, this can cause a recursive invocation of your callback or + other callbacks. If you ask for an infinite loop, you might just get + one: watch out! + + @param buffer the buffer whose size has changed + @param old_len the previous length of the buffer + @param new_len the current length of the buffer + @param arg a pointer to user data +*/ +typedef void (*evbuffer_cb)(struct evbuffer *buffer, size_t old_len, size_t new_len, void *arg); + +/** + Replace all callbacks on an evbuffer with a single new callback, or + remove them. + + Subsequent calls to evbuffer_setcb() replace callbacks set by previous + calls. Setting the callback to NULL removes any previously set callback. + + @deprecated This function is deprecated because it clears all previous + callbacks set on the evbuffer, which can cause confusing behavior if + multiple parts of the code all want to add their own callbacks on a + buffer. Instead, use evbuffer_add(), evbuffer_del(), and + evbuffer_setflags() to manage your own evbuffer callbacks without + interfering with callbacks set by others. + + @param buffer the evbuffer to be monitored + @param cb the callback function to invoke when the evbuffer is modified, + or NULL to remove all callbacks. + @param cbarg an argument to be provided to the callback function + */ +EVENT2_EXPORT_SYMBOL +void evbuffer_setcb(struct evbuffer *buffer, evbuffer_cb cb, void *cbarg); + + +/** + Find a string within an evbuffer. + + @param buffer the evbuffer to be searched + @param what the string to be searched for + @param len the length of the search string + @return a pointer to the beginning of the search string, or NULL if the search failed. + */ +EVENT2_EXPORT_SYMBOL +unsigned char *evbuffer_find(struct evbuffer *buffer, const unsigned char *what, size_t len); + +/** deprecated in favor of calling the functions directly */ +#define EVBUFFER_LENGTH(x) evbuffer_get_length(x) +/** deprecated in favor of calling the functions directly */ +#define EVBUFFER_DATA(x) evbuffer_pullup((x), -1) + +#endif + diff --git a/Source/Import/libevent/Includes/Windows/event2/bufferevent.h b/Source/Import/libevent/Includes/Windows/event2/bufferevent.h new file mode 100644 index 0000000..825918e --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/bufferevent.h @@ -0,0 +1,1021 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_BUFFEREVENT_H_INCLUDED_ +#define EVENT2_BUFFEREVENT_H_INCLUDED_ + +/** + @file event2/bufferevent.h + + Functions for buffering data for network sending or receiving. Bufferevents + are higher level than evbuffers: each has an underlying evbuffer for reading + and one for writing, and callbacks that are invoked under certain + circumstances. + + A bufferevent provides input and output buffers that get filled and + drained automatically. The user of a bufferevent no longer deals + directly with the I/O, but instead is reading from input and writing + to output buffers. + + Once initialized, the bufferevent structure can be used repeatedly + with bufferevent_enable() and bufferevent_disable(). + + When reading is enabled, the bufferevent will try to read from the + file descriptor onto its input buffer, and call the read callback. + When writing is enabled, the bufferevent will try to write data onto its + file descriptor when the output buffer has enough data, and call the write + callback when the output buffer is sufficiently drained. + + Bufferevents come in several flavors, including: + +
+
Socket-based bufferevents
+
A bufferevent that reads and writes data onto a network + socket. Created with bufferevent_socket_new().
+ +
Paired bufferevents
+
A pair of bufferevents that send and receive data to one + another without touching the network. Created with + bufferevent_pair_new().
+ +
Filtering bufferevents
+
A bufferevent that transforms data, and sends or receives it + over another underlying bufferevent. Created with + bufferevent_filter_new().
+ +
SSL-backed bufferevents
+
A bufferevent that uses the openssl library to send and + receive data over an encrypted connection. Created with + bufferevent_openssl_socket_new() or + bufferevent_openssl_filter_new().
+
+ */ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/** @name Bufferevent event codes + + These flags are passed as arguments to a bufferevent's event callback. + + @{ +*/ +#define BEV_EVENT_READING 0x01 /**< error encountered while reading */ +#define BEV_EVENT_WRITING 0x02 /**< error encountered while writing */ +#define BEV_EVENT_EOF 0x10 /**< eof file reached */ +#define BEV_EVENT_ERROR 0x20 /**< unrecoverable error encountered */ +#define BEV_EVENT_TIMEOUT 0x40 /**< user-specified timeout reached */ +#define BEV_EVENT_CONNECTED 0x80 /**< connect operation finished. */ +/**@}*/ + +/** + An opaque type for handling buffered IO + + @see event2/bufferevent.h + */ +struct bufferevent +#ifdef EVENT_IN_DOXYGEN_ +{} +#endif +; +struct event_base; +struct evbuffer; +struct sockaddr; + +/** + A read or write callback for a bufferevent. + + The read callback is triggered when new data arrives in the input + buffer and the amount of readable data exceed the low watermark + which is 0 by default. + + The write callback is triggered if the write buffer has been + exhausted or fell below its low watermark. + + @param bev the bufferevent that triggered the callback + @param ctx the user-specified context for this bufferevent + */ +typedef void (*bufferevent_data_cb)(struct bufferevent *bev, void *ctx); + +/** + An event/error callback for a bufferevent. + + The event callback is triggered if either an EOF condition or another + unrecoverable error was encountered. + + For bufferevents with deferred callbacks, this is a bitwise OR of all errors + that have happened on the bufferevent since the last callback invocation. + + @param bev the bufferevent for which the error condition was reached + @param what a conjunction of flags: BEV_EVENT_READING or BEV_EVENT_WRITING + to indicate if the error was encountered on the read or write path, + and one of the following flags: BEV_EVENT_EOF, BEV_EVENT_ERROR, + BEV_EVENT_TIMEOUT, BEV_EVENT_CONNECTED. + + @param ctx the user-specified context for this bufferevent +*/ +typedef void (*bufferevent_event_cb)(struct bufferevent *bev, short what, void *ctx); + +/** Options that can be specified when creating a bufferevent */ +enum bufferevent_options { + /** If set, we close the underlying file + * descriptor/bufferevent/whatever when this bufferevent is freed. */ + BEV_OPT_CLOSE_ON_FREE = (1<<0), + + /** If set, and threading is enabled, operations on this bufferevent + * are protected by a lock */ + BEV_OPT_THREADSAFE = (1<<1), + + /** If set, callbacks are run deferred in the event loop. */ + BEV_OPT_DEFER_CALLBACKS = (1<<2), + + /** If set, callbacks are executed without locks being held on the + * bufferevent. This option currently requires that + * BEV_OPT_DEFER_CALLBACKS also be set; a future version of Libevent + * might remove the requirement.*/ + BEV_OPT_UNLOCK_CALLBACKS = (1<<3) +}; + +/** + Create a new socket bufferevent over an existing socket. + + @param base the event base to associate with the new bufferevent. + @param fd the file descriptor from which data is read and written to. + This file descriptor is not allowed to be a pipe(2). + It is safe to set the fd to -1, so long as you later + set it with bufferevent_setfd or bufferevent_socket_connect(). + @param options Zero or more BEV_OPT_* flags + @return a pointer to a newly allocated bufferevent struct, or NULL if an + error occurred + @see bufferevent_free() + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent *bufferevent_socket_new(struct event_base *base, evutil_socket_t fd, int options); + +/** + Launch a connect() attempt with a socket-based bufferevent. + + When the connect succeeds, the eventcb will be invoked with + BEV_EVENT_CONNECTED set. + + If the bufferevent does not already have a socket set, we allocate a new + socket here and make it nonblocking before we begin. + + If no address is provided, we assume that the socket is already connecting, + and configure the bufferevent so that a BEV_EVENT_CONNECTED event will be + yielded when it is done connecting. + + @param bufev an existing bufferevent allocated with + bufferevent_socket_new(). + @param addr the address we should connect to + @param socklen The length of the address + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_socket_connect(struct bufferevent *, const struct sockaddr *, int); + +struct evdns_base; +/** + Resolve the hostname 'hostname' and connect to it as with + bufferevent_socket_connect(). + + @param bufev An existing bufferevent allocated with bufferevent_socket_new() + @param evdns_base Optionally, an evdns_base to use for resolving hostnames + asynchronously. May be set to NULL for a blocking resolve. + @param family A preferred address family to resolve addresses to, or + AF_UNSPEC for no preference. Only AF_INET, AF_INET6, and AF_UNSPEC are + supported. + @param hostname The hostname to resolve; see below for notes on recognized + formats + @param port The port to connect to on the resolved address. + @return 0 if successful, -1 on failure. + + Recognized hostname formats are: + + www.example.com (hostname) + 1.2.3.4 (ipv4address) + ::1 (ipv6address) + [::1] ([ipv6address]) + + Performance note: If you do not provide an evdns_base, this function + may block while it waits for a DNS response. This is probably not + what you want. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_socket_connect_hostname(struct bufferevent *, + struct evdns_base *, int, const char *, int); + +/** + Return the error code for the last failed DNS lookup attempt made by + bufferevent_socket_connect_hostname(). + + @param bev The bufferevent object. + @return DNS error code. + @see evutil_gai_strerror() +*/ +EVENT2_EXPORT_SYMBOL +int bufferevent_socket_get_dns_error(struct bufferevent *bev); + +/** + Assign a bufferevent to a specific event_base. + + NOTE that only socket bufferevents support this function. + + @param base an event_base returned by event_init() + @param bufev a bufferevent struct returned by bufferevent_new() + or bufferevent_socket_new() + @return 0 if successful, or -1 if an error occurred + @see bufferevent_new() + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_base_set(struct event_base *base, struct bufferevent *bufev); + +/** + Return the event_base used by a bufferevent +*/ +EVENT2_EXPORT_SYMBOL +struct event_base *bufferevent_get_base(struct bufferevent *bev); + +/** + Assign a priority to a bufferevent. + + Only supported for socket bufferevents. + + @param bufev a bufferevent struct + @param pri the priority to be assigned + @return 0 if successful, or -1 if an error occurred + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_priority_set(struct bufferevent *bufev, int pri); + +/** + Return the priority of a bufferevent. + + Only supported for socket bufferevents + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_get_priority(const struct bufferevent *bufev); + +/** + Deallocate the storage associated with a bufferevent structure. + + If there is pending data to write on the bufferevent, it probably won't be + flushed before the bufferevent is freed. + + @param bufev the bufferevent structure to be freed. + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_free(struct bufferevent *bufev); + + +/** + Changes the callbacks for a bufferevent. + + @param bufev the bufferevent object for which to change callbacks + @param readcb callback to invoke when there is data to be read, or NULL if + no callback is desired + @param writecb callback to invoke when the file descriptor is ready for + writing, or NULL if no callback is desired + @param eventcb callback to invoke when there is an event on the file + descriptor + @param cbarg an argument that will be supplied to each of the callbacks + (readcb, writecb, and errorcb) + @see bufferevent_new() + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_setcb(struct bufferevent *bufev, + bufferevent_data_cb readcb, bufferevent_data_cb writecb, + bufferevent_event_cb eventcb, void *cbarg); + +/** + Retrieves the callbacks for a bufferevent. + + @param bufev the bufferevent to examine. + @param readcb_ptr if readcb_ptr is nonnull, *readcb_ptr is set to the current + read callback for the bufferevent. + @param writecb_ptr if writecb_ptr is nonnull, *writecb_ptr is set to the + current write callback for the bufferevent. + @param eventcb_ptr if eventcb_ptr is nonnull, *eventcb_ptr is set to the + current event callback for the bufferevent. + @param cbarg_ptr if cbarg_ptr is nonnull, *cbarg_ptr is set to the current + callback argument for the bufferevent. + @see buffervent_setcb() +*/ +EVENT2_EXPORT_SYMBOL +void bufferevent_getcb(struct bufferevent *bufev, + bufferevent_data_cb *readcb_ptr, + bufferevent_data_cb *writecb_ptr, + bufferevent_event_cb *eventcb_ptr, + void **cbarg_ptr); + +/** + Changes the file descriptor on which the bufferevent operates. + Not supported for all bufferevent types. + + @param bufev the bufferevent object for which to change the file descriptor + @param fd the file descriptor to operate on +*/ +EVENT2_EXPORT_SYMBOL +int bufferevent_setfd(struct bufferevent *bufev, evutil_socket_t fd); + +/** + Returns the file descriptor associated with a bufferevent, or -1 if + no file descriptor is associated with the bufferevent. + */ +EVENT2_EXPORT_SYMBOL +evutil_socket_t bufferevent_getfd(struct bufferevent *bufev); + +/** + Returns the underlying bufferevent associated with a bufferevent (if + the bufferevent is a wrapper), or NULL if there is no underlying bufferevent. + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent *bufferevent_get_underlying(struct bufferevent *bufev); + +/** + Write data to a bufferevent buffer. + + The bufferevent_write() function can be used to write data to the file + descriptor. The data is appended to the output buffer and written to the + descriptor automatically as it becomes available for writing. + + @param bufev the bufferevent to be written to + @param data a pointer to the data to be written + @param size the length of the data, in bytes + @return 0 if successful, or -1 if an error occurred + @see bufferevent_write_buffer() + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_write(struct bufferevent *bufev, + const void *data, size_t size); + + +/** + Write data from an evbuffer to a bufferevent buffer. The evbuffer is + being drained as a result. + + @param bufev the bufferevent to be written to + @param buf the evbuffer to be written + @return 0 if successful, or -1 if an error occurred + @see bufferevent_write() + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_write_buffer(struct bufferevent *bufev, struct evbuffer *buf); + + +/** + Read data from a bufferevent buffer. + + The bufferevent_read() function is used to read data from the input buffer. + + @param bufev the bufferevent to be read from + @param data pointer to a buffer that will store the data + @param size the size of the data buffer, in bytes + @return the amount of data read, in bytes. + */ +EVENT2_EXPORT_SYMBOL +size_t bufferevent_read(struct bufferevent *bufev, void *data, size_t size); + +/** + Read data from a bufferevent buffer into an evbuffer. This avoids + memory copies. + + @param bufev the bufferevent to be read from + @param buf the evbuffer to which to add data + @return 0 if successful, or -1 if an error occurred. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_read_buffer(struct bufferevent *bufev, struct evbuffer *buf); + +/** + Returns the input buffer. + + The user MUST NOT set the callback on this buffer. + + @param bufev the bufferevent from which to get the evbuffer + @return the evbuffer object for the input buffer + */ + +EVENT2_EXPORT_SYMBOL +struct evbuffer *bufferevent_get_input(struct bufferevent *bufev); + +/** + Returns the output buffer. + + The user MUST NOT set the callback on this buffer. + + When filters are being used, the filters need to be manually + triggered if the output buffer was manipulated. + + @param bufev the bufferevent from which to get the evbuffer + @return the evbuffer object for the output buffer + */ + +EVENT2_EXPORT_SYMBOL +struct evbuffer *bufferevent_get_output(struct bufferevent *bufev); + +/** + Enable a bufferevent. + + @param bufev the bufferevent to be enabled + @param event any combination of EV_READ | EV_WRITE. + @return 0 if successful, or -1 if an error occurred + @see bufferevent_disable() + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_enable(struct bufferevent *bufev, short event); + +/** + Disable a bufferevent. + + @param bufev the bufferevent to be disabled + @param event any combination of EV_READ | EV_WRITE. + @return 0 if successful, or -1 if an error occurred + @see bufferevent_enable() + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_disable(struct bufferevent *bufev, short event); + +/** + Return the events that are enabled on a given bufferevent. + + @param bufev the bufferevent to inspect + @return A combination of EV_READ | EV_WRITE + */ +EVENT2_EXPORT_SYMBOL +short bufferevent_get_enabled(struct bufferevent *bufev); + +/** + Set the read and write timeout for a bufferevent. + + A bufferevent's timeout will fire the first time that the indicated + amount of time has elapsed since a successful read or write operation, + during which the bufferevent was trying to read or write. + + (In other words, if reading or writing is disabled, or if the + bufferevent's read or write operation has been suspended because + there's no data to write, or not enough banwidth, or so on, the + timeout isn't active. The timeout only becomes active when we we're + willing to actually read or write.) + + Calling bufferevent_enable or setting a timeout for a bufferevent + whose timeout is already pending resets its timeout. + + If the timeout elapses, the corresponding operation (EV_READ or + EV_WRITE) becomes disabled until you re-enable it again. The + bufferevent's event callback is called with the + BEV_EVENT_TIMEOUT|BEV_EVENT_READING or + BEV_EVENT_TIMEOUT|BEV_EVENT_WRITING. + + @param bufev the bufferevent to be modified + @param timeout_read the read timeout, or NULL + @param timeout_write the write timeout, or NULL + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_set_timeouts(struct bufferevent *bufev, + const struct timeval *timeout_read, const struct timeval *timeout_write); + +/** + Sets the watermarks for read and write events. + + On input, a bufferevent does not invoke the user read callback unless + there is at least low watermark data in the buffer. If the read buffer + is beyond the high watermark, the bufferevent stops reading from the network. + + On output, the user write callback is invoked whenever the buffered data + falls below the low watermark. Filters that write to this bufev will try + not to write more bytes to this buffer than the high watermark would allow, + except when flushing. + + @param bufev the bufferevent to be modified + @param events EV_READ, EV_WRITE or both + @param lowmark the lower watermark to set + @param highmark the high watermark to set +*/ + +EVENT2_EXPORT_SYMBOL +void bufferevent_setwatermark(struct bufferevent *bufev, short events, + size_t lowmark, size_t highmark); + +/** + Retrieves the watermarks for read or write events. + Returns non-zero if events contains not only EV_READ or EV_WRITE. + Returns zero if events equal EV_READ or EV_WRITE + + @param bufev the bufferevent to be examined + @param events EV_READ or EV_WRITE + @param lowmark receives the lower watermark if not NULL + @param highmark receives the high watermark if not NULL +*/ +EVENT2_EXPORT_SYMBOL +int bufferevent_getwatermark(struct bufferevent *bufev, short events, + size_t *lowmark, size_t *highmark); + +/** + Acquire the lock on a bufferevent. Has no effect if locking was not + enabled with BEV_OPT_THREADSAFE. + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_lock(struct bufferevent *bufev); + +/** + Release the lock on a bufferevent. Has no effect if locking was not + enabled with BEV_OPT_THREADSAFE. + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_unlock(struct bufferevent *bufev); + + +/** + * Public interface to manually increase the reference count of a bufferevent + * this is useful in situations where a user may reference the bufferevent + * somewhere eles (unknown to libevent) + * + * @param bufev the bufferevent to increase the refcount on + * + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_incref(struct bufferevent *bufev); + +/** + * Public interface to manually decrement the reference count of a bufferevent + * + * Warning: make sure you know what you're doing. This is mainly used in + * conjunction with bufferevent_incref(). This will free up all data associated + * with a bufferevent if the reference count hits 0. + * + * @param bufev the bufferevent to decrement the refcount on + * + * @return 1 if the bufferevent was freed, otherwise 0 (still referenced) + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_decref(struct bufferevent *bufev); + +/** + Flags that can be passed into filters to let them know how to + deal with the incoming data. +*/ +enum bufferevent_flush_mode { + /** usually set when processing data */ + BEV_NORMAL = 0, + + /** want to checkpoint all data sent. */ + BEV_FLUSH = 1, + + /** encountered EOF on read or done sending data */ + BEV_FINISHED = 2 +}; + +/** + Triggers the bufferevent to produce more data if possible. + + @param bufev the bufferevent object + @param iotype either EV_READ or EV_WRITE or both. + @param mode either BEV_NORMAL or BEV_FLUSH or BEV_FINISHED + @return -1 on failure, 0 if no data was produces, 1 if data was produced + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_flush(struct bufferevent *bufev, + short iotype, + enum bufferevent_flush_mode mode); + +/** + Flags for bufferevent_trigger(_event) that modify when and how to trigger + the callback. +*/ +enum bufferevent_trigger_options { + /** trigger the callback regardless of the watermarks */ + BEV_TRIG_IGNORE_WATERMARKS = (1<<16), + + /** defer even if the callbacks are not */ + BEV_TRIG_DEFER_CALLBACKS = BEV_OPT_DEFER_CALLBACKS + + /* (Note: for internal reasons, these need to be disjoint from + * bufferevent_options, except when they mean the same thing. */ +}; + +/** + Triggers bufferevent data callbacks. + + The function will honor watermarks unless options contain + BEV_TRIG_IGNORE_WATERMARKS. If the options contain BEV_OPT_DEFER_CALLBACKS, + the callbacks are deferred. + + @param bufev the bufferevent object + @param iotype either EV_READ or EV_WRITE or both. + @param options + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_trigger(struct bufferevent *bufev, short iotype, + int options); + +/** + Triggers the bufferevent event callback. + + If the options contain BEV_OPT_DEFER_CALLBACKS, the callbacks are deferred. + + @param bufev the bufferevent object + @param what the flags to pass onto the event callback + @param options + */ +EVENT2_EXPORT_SYMBOL +void bufferevent_trigger_event(struct bufferevent *bufev, short what, + int options); + +/** + @name Filtering support + + @{ +*/ +/** + Values that filters can return. + */ +enum bufferevent_filter_result { + /** everything is okay */ + BEV_OK = 0, + + /** the filter needs to read more data before output */ + BEV_NEED_MORE = 1, + + /** the filter encountered a critical error, no further data + can be processed. */ + BEV_ERROR = 2 +}; + +/** A callback function to implement a filter for a bufferevent. + + @param src An evbuffer to drain data from. + @param dst An evbuffer to add data to. + @param limit A suggested upper bound of bytes to write to dst. + The filter may ignore this value, but doing so means that + it will overflow the high-water mark associated with dst. + -1 means "no limit". + @param mode Whether we should write data as may be convenient + (BEV_NORMAL), or flush as much data as we can (BEV_FLUSH), + or flush as much as we can, possibly including an end-of-stream + marker (BEV_FINISH). + @param ctx A user-supplied pointer. + + @return BEV_OK if we wrote some data; BEV_NEED_MORE if we can't + produce any more output until we get some input; and BEV_ERROR + on an error. + */ +typedef enum bufferevent_filter_result (*bufferevent_filter_cb)( + struct evbuffer *src, struct evbuffer *dst, ev_ssize_t dst_limit, + enum bufferevent_flush_mode mode, void *ctx); + +/** + Allocate a new filtering bufferevent on top of an existing bufferevent. + + @param underlying the underlying bufferevent. + @param input_filter The filter to apply to data we read from the underlying + bufferevent + @param output_filter The filer to apply to data we write to the underlying + bufferevent + @param options A bitfield of bufferevent options. + @param free_context A function to use to free the filter context when + this bufferevent is freed. + @param ctx A context pointer to pass to the filter functions. + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent * +bufferevent_filter_new(struct bufferevent *underlying, + bufferevent_filter_cb input_filter, + bufferevent_filter_cb output_filter, + int options, + void (*free_context)(void *), + void *ctx); +/**@}*/ + +/** + Allocate a pair of linked bufferevents. The bufferevents behave as would + two bufferevent_sock instances connected to opposite ends of a + socketpair(), except that no internal socketpair is allocated. + + @param base The event base to associate with the socketpair. + @param options A set of options for this bufferevent + @param pair A pointer to an array to hold the two new bufferevent objects. + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_pair_new(struct event_base *base, int options, + struct bufferevent *pair[2]); + +/** + Given one bufferevent returned by bufferevent_pair_new(), returns the + other one if it still exists. Otherwise returns NULL. + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent *bufferevent_pair_get_partner(struct bufferevent *bev); + +/** + Abstract type used to configure rate-limiting on a bufferevent or a group + of bufferevents. + */ +struct ev_token_bucket_cfg; + +/** + A group of bufferevents which are configured to respect the same rate + limit. +*/ +struct bufferevent_rate_limit_group; + +/** Maximum configurable rate- or burst-limit. */ +#define EV_RATE_LIMIT_MAX EV_SSIZE_MAX + +/** + Initialize and return a new object to configure the rate-limiting behavior + of bufferevents. + + @param read_rate The maximum number of bytes to read per tick on + average. + @param read_burst The maximum number of bytes to read in any single tick. + @param write_rate The maximum number of bytes to write per tick on + average. + @param write_burst The maximum number of bytes to write in any single tick. + @param tick_len The length of a single tick. Defaults to one second. + Any fractions of a millisecond are ignored. + + Note that all rate-limits hare are currently best-effort: future versions + of Libevent may implement them more tightly. + */ +EVENT2_EXPORT_SYMBOL +struct ev_token_bucket_cfg *ev_token_bucket_cfg_new( + size_t read_rate, size_t read_burst, + size_t write_rate, size_t write_burst, + const struct timeval *tick_len); + +/** Free all storage held in 'cfg'. + + Note: 'cfg' is not currently reference-counted; it is not safe to free it + until no bufferevent is using it. + */ +EVENT2_EXPORT_SYMBOL +void ev_token_bucket_cfg_free(struct ev_token_bucket_cfg *cfg); + +/** + Set the rate-limit of a the bufferevent 'bev' to the one specified in + 'cfg'. If 'cfg' is NULL, disable any per-bufferevent rate-limiting on + 'bev'. + + Note that only some bufferevent types currently respect rate-limiting. + They are: socket-based bufferevents (normal and IOCP-based), and SSL-based + bufferevents. + + Return 0 on sucess, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_set_rate_limit(struct bufferevent *bev, + struct ev_token_bucket_cfg *cfg); + +/** + Create a new rate-limit group for bufferevents. A rate-limit group + constrains the maximum number of bytes sent and received, in toto, + by all of its bufferevents. + + @param base An event_base to run any necessary timeouts for the group. + Note that all bufferevents in the group do not necessarily need to share + this event_base. + @param cfg The rate-limit for this group. + + Note that all rate-limits hare are currently best-effort: future versions + of Libevent may implement them more tightly. + + Note also that only some bufferevent types currently respect rate-limiting. + They are: socket-based bufferevents (normal and IOCP-based), and SSL-based + bufferevents. + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent_rate_limit_group *bufferevent_rate_limit_group_new( + struct event_base *base, + const struct ev_token_bucket_cfg *cfg); +/** + Change the rate-limiting settings for a given rate-limiting group. + + Return 0 on success, -1 on failure. +*/ +EVENT2_EXPORT_SYMBOL +int bufferevent_rate_limit_group_set_cfg( + struct bufferevent_rate_limit_group *, + const struct ev_token_bucket_cfg *); + +/** + Change the smallest quantum we're willing to allocate to any single + bufferevent in a group for reading or writing at a time. + + The rationale is that, because of TCP/IP protocol overheads and kernel + behavior, if a rate-limiting group is so tight on bandwidth that you're + only willing to send 1 byte per tick per bufferevent, you might instead + want to batch up the reads and writes so that you send N bytes per + 1/N of the bufferevents (chosen at random) each tick, so you still wind + up send 1 byte per tick per bufferevent on average, but you don't send + so many tiny packets. + + The default min-share is currently 64 bytes. + + Returns 0 on success, -1 on faulre. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_rate_limit_group_set_min_share( + struct bufferevent_rate_limit_group *, size_t); + +/** + Free a rate-limiting group. The group must have no members when + this function is called. +*/ +EVENT2_EXPORT_SYMBOL +void bufferevent_rate_limit_group_free(struct bufferevent_rate_limit_group *); + +/** + Add 'bev' to the list of bufferevents whose aggregate reading and writing + is restricted by 'g'. If 'g' is NULL, remove 'bev' from its current group. + + A bufferevent may belong to no more than one rate-limit group at a time. + If 'bev' is already a member of a group, it will be removed from its old + group before being added to 'g'. + + Return 0 on success and -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_add_to_rate_limit_group(struct bufferevent *bev, + struct bufferevent_rate_limit_group *g); + +/** Remove 'bev' from its current rate-limit group (if any). */ +EVENT2_EXPORT_SYMBOL +int bufferevent_remove_from_rate_limit_group(struct bufferevent *bev); + +/** + Set the size limit for single read operation. + + Set to 0 for a reasonable default. + + Return 0 on success and -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_set_max_single_read(struct bufferevent *bev, size_t size); + +/** + Set the size limit for single write operation. + + Set to 0 for a reasonable default. + + Return 0 on success and -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_set_max_single_write(struct bufferevent *bev, size_t size); + +/** Get the current size limit for single read operation. */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_max_single_read(struct bufferevent *bev); + +/** Get the current size limit for single write operation. */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_max_single_write(struct bufferevent *bev); + +/** + @name Rate limit inspection + + Return the current read or write bucket size for a bufferevent. + If it is not configured with a per-bufferevent ratelimit, return + EV_SSIZE_MAX. This function does not inspect the group limit, if any. + Note that it can return a negative value if the bufferevent has been + made to read or write more than its limit. + + @{ + */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_read_limit(struct bufferevent *bev); +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_write_limit(struct bufferevent *bev); +/*@}*/ + +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_max_to_read(struct bufferevent *bev); +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_get_max_to_write(struct bufferevent *bev); + +EVENT2_EXPORT_SYMBOL +const struct ev_token_bucket_cfg *bufferevent_get_token_bucket_cfg(const struct bufferevent * bev); + +/** + @name Group Rate limit inspection + + Return the read or write bucket size for a bufferevent rate limit + group. Note that it can return a negative value if bufferevents in + the group have been made to read or write more than their limits. + + @{ + */ +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_rate_limit_group_get_read_limit( + struct bufferevent_rate_limit_group *); +EVENT2_EXPORT_SYMBOL +ev_ssize_t bufferevent_rate_limit_group_get_write_limit( + struct bufferevent_rate_limit_group *); +/*@}*/ + +/** + @name Rate limit manipulation + + Subtract a number of bytes from a bufferevent's read or write bucket. + The decrement value can be negative, if you want to manually refill + the bucket. If the change puts the bucket above or below zero, the + bufferevent will resume or suspend reading writing as appropriate. + These functions make no change in the buckets for the bufferevent's + group, if any. + + Returns 0 on success, -1 on internal error. + + @{ + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_decrement_read_limit(struct bufferevent *bev, ev_ssize_t decr); +EVENT2_EXPORT_SYMBOL +int bufferevent_decrement_write_limit(struct bufferevent *bev, ev_ssize_t decr); +/*@}*/ + +/** + @name Group rate limit manipulation + + Subtract a number of bytes from a bufferevent rate-limiting group's + read or write bucket. The decrement value can be negative, if you + want to manually refill the bucket. If the change puts the bucket + above or below zero, the bufferevents in the group will resume or + suspend reading writing as appropriate. + + Returns 0 on success, -1 on internal error. + + @{ + */ +EVENT2_EXPORT_SYMBOL +int bufferevent_rate_limit_group_decrement_read( + struct bufferevent_rate_limit_group *, ev_ssize_t); +EVENT2_EXPORT_SYMBOL +int bufferevent_rate_limit_group_decrement_write( + struct bufferevent_rate_limit_group *, ev_ssize_t); +/*@}*/ + + +/** + * Inspect the total bytes read/written on a group. + * + * Set the variable pointed to by total_read_out to the total number of bytes + * ever read on grp, and the variable pointed to by total_written_out to the + * total number of bytes ever written on grp. */ +EVENT2_EXPORT_SYMBOL +void bufferevent_rate_limit_group_get_totals( + struct bufferevent_rate_limit_group *grp, + ev_uint64_t *total_read_out, ev_uint64_t *total_written_out); + +/** + * Reset the total bytes read/written on a group. + * + * Reset the number of bytes read or written on grp as given by + * bufferevent_rate_limit_group_reset_totals(). */ +EVENT2_EXPORT_SYMBOL +void +bufferevent_rate_limit_group_reset_totals( + struct bufferevent_rate_limit_group *grp); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_BUFFEREVENT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/bufferevent_compat.h b/Source/Import/libevent/Includes/Windows/event2/bufferevent_compat.h new file mode 100644 index 0000000..6548204 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/bufferevent_compat.h @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2007-2012 Niels Provos, Nick Mathewson + * Copyright (c) 2000-2007 Niels Provos + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_BUFFEREVENT_COMPAT_H_INCLUDED_ +#define EVENT2_BUFFEREVENT_COMPAT_H_INCLUDED_ + +#define evbuffercb bufferevent_data_cb +#define everrorcb bufferevent_event_cb + +/** + Create a new bufferevent for an fd. + + This function is deprecated. Use bufferevent_socket_new and + bufferevent_set_callbacks instead. + + Libevent provides an abstraction on top of the regular event callbacks. + This abstraction is called a buffered event. A buffered event provides + input and output buffers that get filled and drained automatically. The + user of a buffered event no longer deals directly with the I/O, but + instead is reading from input and writing to output buffers. + + Once initialized, the bufferevent structure can be used repeatedly with + bufferevent_enable() and bufferevent_disable(). + + When read enabled the bufferevent will try to read from the file descriptor + and call the read callback. The write callback is executed whenever the + output buffer is drained below the write low watermark, which is 0 by + default. + + If multiple bases are in use, bufferevent_base_set() must be called before + enabling the bufferevent for the first time. + + @deprecated This function is deprecated because it uses the current + event base, and as such can be error prone for multithreaded programs. + Use bufferevent_socket_new() instead. + + @param fd the file descriptor from which data is read and written to. + This file descriptor is not allowed to be a pipe(2). + @param readcb callback to invoke when there is data to be read, or NULL if + no callback is desired + @param writecb callback to invoke when the file descriptor is ready for + writing, or NULL if no callback is desired + @param errorcb callback to invoke when there is an error on the file + descriptor + @param cbarg an argument that will be supplied to each of the callbacks + (readcb, writecb, and errorcb) + @return a pointer to a newly allocated bufferevent struct, or NULL if an + error occurred + @see bufferevent_base_set(), bufferevent_free() + */ +struct bufferevent *bufferevent_new(evutil_socket_t fd, + evbuffercb readcb, evbuffercb writecb, everrorcb errorcb, void *cbarg); + + +/** + Set the read and write timeout for a buffered event. + + @param bufev the bufferevent to be modified + @param timeout_read the read timeout + @param timeout_write the write timeout + */ +void bufferevent_settimeout(struct bufferevent *bufev, + int timeout_read, int timeout_write); + +#define EVBUFFER_READ BEV_EVENT_READING +#define EVBUFFER_WRITE BEV_EVENT_WRITING +#define EVBUFFER_EOF BEV_EVENT_EOF +#define EVBUFFER_ERROR BEV_EVENT_ERROR +#define EVBUFFER_TIMEOUT BEV_EVENT_TIMEOUT + +/** macro for getting access to the input buffer of a bufferevent */ +#define EVBUFFER_INPUT(x) bufferevent_get_input(x) +/** macro for getting access to the output buffer of a bufferevent */ +#define EVBUFFER_OUTPUT(x) bufferevent_get_output(x) + +#endif diff --git a/Source/Import/libevent/Includes/Windows/event2/bufferevent_ssl.h b/Source/Import/libevent/Includes/Windows/event2/bufferevent_ssl.h new file mode 100644 index 0000000..bf39b84 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/bufferevent_ssl.h @@ -0,0 +1,134 @@ +/* + * Copyright (c) 2009-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_BUFFEREVENT_SSL_H_INCLUDED_ +#define EVENT2_BUFFEREVENT_SSL_H_INCLUDED_ + +/** @file event2/bufferevent_ssl.h + + OpenSSL support for bufferevents. + */ +#include +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* This is what openssl's SSL objects are underneath. */ +struct ssl_st; + +/** + The state of an SSL object to be used when creating a new + SSL bufferevent. + */ +enum bufferevent_ssl_state { + BUFFEREVENT_SSL_OPEN = 0, + BUFFEREVENT_SSL_CONNECTING = 1, + BUFFEREVENT_SSL_ACCEPTING = 2 +}; + +#if defined(EVENT__HAVE_OPENSSL) || defined(EVENT_IN_DOXYGEN_) +/** + Create a new SSL bufferevent to send its data over another bufferevent. + + @param base An event_base to use to detect reading and writing. It + must also be the base for the underlying bufferevent. + @param underlying A socket to use for this SSL + @param ssl A SSL* object from openssl. + @param state The current state of the SSL connection + @param options One or more bufferevent_options + @return A new bufferevent on success, or NULL on failure +*/ +EVENT2_EXPORT_SYMBOL +struct bufferevent * +bufferevent_openssl_filter_new(struct event_base *base, + struct bufferevent *underlying, + struct ssl_st *ssl, + enum bufferevent_ssl_state state, + int options); + +/** + Create a new SSL bufferevent to send its data over an SSL * on a socket. + + @param base An event_base to use to detect reading and writing + @param fd A socket to use for this SSL + @param ssl A SSL* object from openssl. + @param state The current state of the SSL connection + @param options One or more bufferevent_options + @return A new bufferevent on success, or NULL on failure. +*/ +EVENT2_EXPORT_SYMBOL +struct bufferevent * +bufferevent_openssl_socket_new(struct event_base *base, + evutil_socket_t fd, + struct ssl_st *ssl, + enum bufferevent_ssl_state state, + int options); + +/** Control how to report dirty SSL shutdowns. + + If the peer (or the network, or an attacker) closes the TCP + connection before closing the SSL channel, and the protocol is SSL >= v3, + this is a "dirty" shutdown. If allow_dirty_shutdown is 0 (default), + this is reported as BEV_EVENT_ERROR. + + If instead allow_dirty_shutdown=1, a dirty shutdown is reported as + BEV_EVENT_EOF. + + (Note that if the protocol is < SSLv3, you will always receive + BEV_EVENT_EOF, since SSL 2 and earlier cannot distinguish a secure + connection close from a dirty one. This is one reason (among many) + not to use SSL 2.) +*/ + +EVENT2_EXPORT_SYMBOL +int bufferevent_openssl_get_allow_dirty_shutdown(struct bufferevent *bev); +EVENT2_EXPORT_SYMBOL +void bufferevent_openssl_set_allow_dirty_shutdown(struct bufferevent *bev, + int allow_dirty_shutdown); + +/** Return the underlying openssl SSL * object for an SSL bufferevent. */ +EVENT2_EXPORT_SYMBOL +struct ssl_st * +bufferevent_openssl_get_ssl(struct bufferevent *bufev); + +/** Tells a bufferevent to begin SSL renegotiation. */ +EVENT2_EXPORT_SYMBOL +int bufferevent_ssl_renegotiate(struct bufferevent *bev); + +/** Return the most recent OpenSSL error reported on an SSL bufferevent. */ +EVENT2_EXPORT_SYMBOL +unsigned long bufferevent_get_openssl_error(struct bufferevent *bev); + +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_BUFFEREVENT_SSL_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/bufferevent_struct.h b/Source/Import/libevent/Includes/Windows/event2/bufferevent_struct.h new file mode 100644 index 0000000..e84c082 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/bufferevent_struct.h @@ -0,0 +1,116 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_BUFFEREVENT_STRUCT_H_INCLUDED_ +#define EVENT2_BUFFEREVENT_STRUCT_H_INCLUDED_ + +/** @file event2/bufferevent_struct.h + + Data structures for bufferevents. Using these structures may hurt forward + compatibility with later versions of Libevent: be careful! + + @deprecated Use of bufferevent_struct.h is completely deprecated; these + structures are only exposed for backward compatibility with programs + written before Libevent 2.0 that used them. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include +/* For struct event */ +#include + +struct event_watermark { + size_t low; + size_t high; +}; + +/** + Shared implementation of a bufferevent. + + This type is exposed only because it was exposed in previous versions, + and some people's code may rely on manipulating it. Otherwise, you + should really not rely on the layout, size, or contents of this structure: + it is fairly volatile, and WILL change in future versions of the code. +**/ +struct bufferevent { + /** Event base for which this bufferevent was created. */ + struct event_base *ev_base; + /** Pointer to a table of function pointers to set up how this + bufferevent behaves. */ + const struct bufferevent_ops *be_ops; + + /** A read event that triggers when a timeout has happened or a socket + is ready to read data. Only used by some subtypes of + bufferevent. */ + struct event ev_read; + /** A write event that triggers when a timeout has happened or a socket + is ready to write data. Only used by some subtypes of + bufferevent. */ + struct event ev_write; + + /** An input buffer. Only the bufferevent is allowed to add data to + this buffer, though the user is allowed to drain it. */ + struct evbuffer *input; + + /** An input buffer. Only the bufferevent is allowed to drain data + from this buffer, though the user is allowed to add it. */ + struct evbuffer *output; + + struct event_watermark wm_read; + struct event_watermark wm_write; + + bufferevent_data_cb readcb; + bufferevent_data_cb writecb; + /* This should be called 'eventcb', but renaming it would break + * backward compatibility */ + bufferevent_event_cb errorcb; + void *cbarg; + + struct timeval timeout_read; + struct timeval timeout_write; + + /** Events that are currently enabled: currently EV_READ and EV_WRITE + are supported. */ + short enabled; +}; + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_BUFFEREVENT_STRUCT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/dns.h b/Source/Import/libevent/Includes/Windows/event2/dns.h new file mode 100644 index 0000000..17cd86a --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/dns.h @@ -0,0 +1,717 @@ +/* + * Copyright (c) 2006-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/* + * The original DNS code is due to Adam Langley with heavy + * modifications by Nick Mathewson. Adam put his DNS software in the + * public domain. You can find his original copyright below. Please, + * aware that the code as part of Libevent is governed by the 3-clause + * BSD license above. + * + * This software is Public Domain. To view a copy of the public domain dedication, + * visit http://creativecommons.org/licenses/publicdomain/ or send a letter to + * Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA. + * + * I ask and expect, but do not require, that all derivative works contain an + * attribution similar to: + * Parts developed by Adam Langley + * + * You may wish to replace the word "Parts" with something else depending on + * the amount of original code. + * + * (Derivative works does not include programs which link against, run or include + * the source verbatim in their source distributions) + */ + +/** @file event2/dns.h + * + * Welcome, gentle reader + * + * Async DNS lookups are really a whole lot harder than they should be, + * mostly stemming from the fact that the libc resolver has never been + * very good at them. Before you use this library you should see if libc + * can do the job for you with the modern async call getaddrinfo_a + * (see http://www.imperialviolet.org/page25.html#e498). Otherwise, + * please continue. + * + * The library keeps track of the state of nameservers and will avoid + * them when they go down. Otherwise it will round robin between them. + * + * Quick start guide: + * #include "evdns.h" + * void callback(int result, char type, int count, int ttl, + * void *addresses, void *arg); + * evdns_resolv_conf_parse(DNS_OPTIONS_ALL, "/etc/resolv.conf"); + * evdns_resolve("www.hostname.com", 0, callback, NULL); + * + * When the lookup is complete the callback function is called. The + * first argument will be one of the DNS_ERR_* defines in evdns.h. + * Hopefully it will be DNS_ERR_NONE, in which case type will be + * DNS_IPv4_A, count will be the number of IP addresses, ttl is the time + * which the data can be cached for (in seconds), addresses will point + * to an array of uint32_t's and arg will be whatever you passed to + * evdns_resolve. + * + * Searching: + * + * In order for this library to be a good replacement for glibc's resolver it + * supports searching. This involves setting a list of default domains, in + * which names will be queried for. The number of dots in the query name + * determines the order in which this list is used. + * + * Searching appears to be a single lookup from the point of view of the API, + * although many DNS queries may be generated from a single call to + * evdns_resolve. Searching can also drastically slow down the resolution + * of names. + * + * To disable searching: + * 1. Never set it up. If you never call evdns_resolv_conf_parse or + * evdns_search_add then no searching will occur. + * + * 2. If you do call evdns_resolv_conf_parse then don't pass + * DNS_OPTION_SEARCH (or DNS_OPTIONS_ALL, which implies it). + * + * 3. When calling evdns_resolve, pass the DNS_QUERY_NO_SEARCH flag. + * + * The order of searches depends on the number of dots in the name. If the + * number is greater than the ndots setting then the names is first tried + * globally. Otherwise each search domain is appended in turn. + * + * The ndots setting can either be set from a resolv.conf, or by calling + * evdns_search_ndots_set. + * + * For example, with ndots set to 1 (the default) and a search domain list of + * ["myhome.net"]: + * Query: www + * Order: www.myhome.net, www. + * + * Query: www.abc + * Order: www.abc., www.abc.myhome.net + * + * Internals: + * + * Requests are kept in two queues. The first is the inflight queue. In + * this queue requests have an allocated transaction id and nameserver. + * They will soon be transmitted if they haven't already been. + * + * The second is the waiting queue. The size of the inflight ring is + * limited and all other requests wait in waiting queue for space. This + * bounds the number of concurrent requests so that we don't flood the + * nameserver. Several algorithms require a full walk of the inflight + * queue and so bounding its size keeps thing going nicely under huge + * (many thousands of requests) loads. + * + * If a nameserver loses too many requests it is considered down and we + * try not to use it. After a while we send a probe to that nameserver + * (a lookup for google.com) and, if it replies, we consider it working + * again. If the nameserver fails a probe we wait longer to try again + * with the next probe. + */ + +#ifndef EVENT2_DNS_H_INCLUDED_ +#define EVENT2_DNS_H_INCLUDED_ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* For integer types. */ +#include + +/** Error codes 0-5 are as described in RFC 1035. */ +#define DNS_ERR_NONE 0 +/** The name server was unable to interpret the query */ +#define DNS_ERR_FORMAT 1 +/** The name server was unable to process this query due to a problem with the + * name server */ +#define DNS_ERR_SERVERFAILED 2 +/** The domain name does not exist */ +#define DNS_ERR_NOTEXIST 3 +/** The name server does not support the requested kind of query */ +#define DNS_ERR_NOTIMPL 4 +/** The name server refuses to reform the specified operation for policy + * reasons */ +#define DNS_ERR_REFUSED 5 +/** The reply was truncated or ill-formatted */ +#define DNS_ERR_TRUNCATED 65 +/** An unknown error occurred */ +#define DNS_ERR_UNKNOWN 66 +/** Communication with the server timed out */ +#define DNS_ERR_TIMEOUT 67 +/** The request was canceled because the DNS subsystem was shut down. */ +#define DNS_ERR_SHUTDOWN 68 +/** The request was canceled via a call to evdns_cancel_request */ +#define DNS_ERR_CANCEL 69 +/** There were no answers and no error condition in the DNS packet. + * This can happen when you ask for an address that exists, but a record + * type that doesn't. */ +#define DNS_ERR_NODATA 70 + +#define DNS_IPv4_A 1 +#define DNS_PTR 2 +#define DNS_IPv6_AAAA 3 + +#define DNS_QUERY_NO_SEARCH 1 + +#define DNS_OPTION_SEARCH 1 +#define DNS_OPTION_NAMESERVERS 2 +#define DNS_OPTION_MISC 4 +#define DNS_OPTION_HOSTSFILE 8 +#define DNS_OPTIONS_ALL 15 + +/* Obsolete name for DNS_QUERY_NO_SEARCH */ +#define DNS_NO_SEARCH DNS_QUERY_NO_SEARCH + +/** + * The callback that contains the results from a lookup. + * - result is one of the DNS_ERR_* values (DNS_ERR_NONE for success) + * - type is either DNS_IPv4_A or DNS_PTR or DNS_IPv6_AAAA + * - count contains the number of addresses of form type + * - ttl is the number of seconds the resolution may be cached for. + * - addresses needs to be cast according to type. It will be an array of + * 4-byte sequences for ipv4, or an array of 16-byte sequences for ipv6, + * or a nul-terminated string for PTR. + */ +typedef void (*evdns_callback_type) (int result, char type, int count, int ttl, void *addresses, void *arg); + +struct evdns_base; +struct event_base; + +/** Flag for evdns_base_new: process resolv.conf. */ +#define EVDNS_BASE_INITIALIZE_NAMESERVERS 1 +/** Flag for evdns_base_new: Do not prevent the libevent event loop from + * exiting when we have no active dns requests. */ +#define EVDNS_BASE_DISABLE_WHEN_INACTIVE 0x8000 + +/** + Initialize the asynchronous DNS library. + + This function initializes support for non-blocking name resolution by + calling evdns_resolv_conf_parse() on UNIX and + evdns_config_windows_nameservers() on Windows. + + @param event_base the event base to associate the dns client with + @param flags any of EVDNS_BASE_INITIALIZE_NAMESERVERS| + EVDNS_BASE_DISABLE_WHEN_INACTIVE + @return evdns_base object if successful, or NULL if an error occurred. + @see evdns_base_free() + */ +EVENT2_EXPORT_SYMBOL +struct evdns_base * evdns_base_new(struct event_base *event_base, int initialize_nameservers); + + +/** + Shut down the asynchronous DNS resolver and terminate all active requests. + + If the 'fail_requests' option is enabled, all active requests will return + an empty result with the error flag set to DNS_ERR_SHUTDOWN. Otherwise, + the requests will be silently discarded. + + @param evdns_base the evdns base to free + @param fail_requests if zero, active requests will be aborted; if non-zero, + active requests will return DNS_ERR_SHUTDOWN. + @see evdns_base_new() + */ +EVENT2_EXPORT_SYMBOL +void evdns_base_free(struct evdns_base *base, int fail_requests); + +/** + Remove all hosts entries that have been loaded into the event_base via + evdns_base_load_hosts or via event_base_resolv_conf_parse. + + @param evdns_base the evdns base to remove outdated host addresses from + */ +EVENT2_EXPORT_SYMBOL +void evdns_base_clear_host_addresses(struct evdns_base *base); + +/** + Convert a DNS error code to a string. + + @param err the DNS error code + @return a string containing an explanation of the error code +*/ +EVENT2_EXPORT_SYMBOL +const char *evdns_err_to_string(int err); + + +/** + Add a nameserver. + + The address should be an IPv4 address in network byte order. + The type of address is chosen so that it matches in_addr.s_addr. + + @param base the evdns_base to which to add the name server + @param address an IP address in network byte order + @return 0 if successful, or -1 if an error occurred + @see evdns_base_nameserver_ip_add() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_nameserver_add(struct evdns_base *base, + unsigned long int address); + +/** + Get the number of configured nameservers. + + This returns the number of configured nameservers (not necessarily the + number of running nameservers). This is useful for double-checking + whether our calls to the various nameserver configuration functions + have been successful. + + @param base the evdns_base to which to apply this operation + @return the number of configured nameservers + @see evdns_base_nameserver_add() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_count_nameservers(struct evdns_base *base); + +/** + Remove all configured nameservers, and suspend all pending resolves. + + Resolves will not necessarily be re-attempted until evdns_base_resume() is called. + + @param base the evdns_base to which to apply this operation + @return 0 if successful, or -1 if an error occurred + @see evdns_base_resume() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_clear_nameservers_and_suspend(struct evdns_base *base); + + +/** + Resume normal operation and continue any suspended resolve requests. + + Re-attempt resolves left in limbo after an earlier call to + evdns_base_clear_nameservers_and_suspend(). + + @param base the evdns_base to which to apply this operation + @return 0 if successful, or -1 if an error occurred + @see evdns_base_clear_nameservers_and_suspend() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_resume(struct evdns_base *base); + +/** + Add a nameserver by string address. + + This function parses a n IPv4 or IPv6 address from a string and adds it as a + nameserver. It supports the following formats: + - [IPv6Address]:port + - [IPv6Address] + - IPv6Address + - IPv4Address:port + - IPv4Address + + If no port is specified, it defaults to 53. + + @param base the evdns_base to which to apply this operation + @return 0 if successful, or -1 if an error occurred + @see evdns_base_nameserver_add() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_nameserver_ip_add(struct evdns_base *base, + const char *ip_as_string); + +/** + Add a nameserver by sockaddr. + **/ +EVENT2_EXPORT_SYMBOL +int +evdns_base_nameserver_sockaddr_add(struct evdns_base *base, + const struct sockaddr *sa, ev_socklen_t len, unsigned flags); + +struct evdns_request; + +/** + Lookup an A record for a given name. + + @param base the evdns_base to which to apply this operation + @param name a DNS hostname + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return an evdns_request object if successful, or NULL if an error occurred. + @see evdns_resolve_ipv6(), evdns_resolve_reverse(), evdns_resolve_reverse_ipv6(), evdns_cancel_request() + */ +EVENT2_EXPORT_SYMBOL +struct evdns_request *evdns_base_resolve_ipv4(struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr); + +/** + Lookup an AAAA record for a given name. + + @param base the evdns_base to which to apply this operation + @param name a DNS hostname + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return an evdns_request object if successful, or NULL if an error occurred. + @see evdns_resolve_ipv4(), evdns_resolve_reverse(), evdns_resolve_reverse_ipv6(), evdns_cancel_request() + */ +EVENT2_EXPORT_SYMBOL +struct evdns_request *evdns_base_resolve_ipv6(struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr); + +struct in_addr; +struct in6_addr; + +/** + Lookup a PTR record for a given IP address. + + @param base the evdns_base to which to apply this operation + @param in an IPv4 address + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return an evdns_request object if successful, or NULL if an error occurred. + @see evdns_resolve_reverse_ipv6(), evdns_cancel_request() + */ +EVENT2_EXPORT_SYMBOL +struct evdns_request *evdns_base_resolve_reverse(struct evdns_base *base, const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr); + + +/** + Lookup a PTR record for a given IPv6 address. + + @param base the evdns_base to which to apply this operation + @param in an IPv6 address + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return an evdns_request object if successful, or NULL if an error occurred. + @see evdns_resolve_reverse_ipv6(), evdns_cancel_request() + */ +EVENT2_EXPORT_SYMBOL +struct evdns_request *evdns_base_resolve_reverse_ipv6(struct evdns_base *base, const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr); + +/** + Cancels a pending DNS resolution request. + + @param base the evdns_base that was used to make the request + @param req the evdns_request that was returned by calling a resolve function + @see evdns_base_resolve_ipv4(), evdns_base_resolve_ipv6, evdns_base_resolve_reverse +*/ +EVENT2_EXPORT_SYMBOL +void evdns_cancel_request(struct evdns_base *base, struct evdns_request *req); + +/** + Set the value of a configuration option. + + The currently available configuration options are: + + ndots, timeout, max-timeouts, max-inflight, attempts, randomize-case, + bind-to, initial-probe-timeout, getaddrinfo-allow-skew. + + In versions before Libevent 2.0.3-alpha, the option name needed to end with + a colon. + + @param base the evdns_base to which to apply this operation + @param option the name of the configuration option to be modified + @param val the value to be set + @return 0 if successful, or -1 if an error occurred + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_set_option(struct evdns_base *base, const char *option, const char *val); + + +/** + Parse a resolv.conf file. + + The 'flags' parameter determines what information is parsed from the + resolv.conf file. See the man page for resolv.conf for the format of this + file. + + The following directives are not parsed from the file: sortlist, rotate, + no-check-names, inet6, debug. + + If this function encounters an error, the possible return values are: 1 = + failed to open file, 2 = failed to stat file, 3 = file too large, 4 = out of + memory, 5 = short read from file, 6 = no nameservers listed in the file + + @param base the evdns_base to which to apply this operation + @param flags any of DNS_OPTION_NAMESERVERS|DNS_OPTION_SEARCH|DNS_OPTION_MISC| + DNS_OPTION_HOSTSFILE|DNS_OPTIONS_ALL + @param filename the path to the resolv.conf file + @return 0 if successful, or various positive error codes if an error + occurred (see above) + @see resolv.conf(3), evdns_config_windows_nameservers() + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_resolv_conf_parse(struct evdns_base *base, int flags, const char *const filename); + +/** + Load an /etc/hosts-style file from 'hosts_fname' into 'base'. + + If hosts_fname is NULL, add minimal entries for localhost, and nothing + else. + + Note that only evdns_getaddrinfo uses the /etc/hosts entries. + + This function does not replace previously loaded hosts entries; to do that, + call evdns_base_clear_host_addresses first. + + Return 0 on success, negative on failure. +*/ +EVENT2_EXPORT_SYMBOL +int evdns_base_load_hosts(struct evdns_base *base, const char *hosts_fname); + +/** + Obtain nameserver information using the Windows API. + + Attempt to configure a set of nameservers based on platform settings on + a win32 host. Preferentially tries to use GetNetworkParams; if that fails, + looks in the registry. + + @return 0 if successful, or -1 if an error occurred + @see evdns_resolv_conf_parse() + */ +#ifdef _WIN32 +EVENT2_EXPORT_SYMBOL +int evdns_base_config_windows_nameservers(struct evdns_base *); +#define EVDNS_BASE_CONFIG_WINDOWS_NAMESERVERS_IMPLEMENTED +#endif + + +/** + Clear the list of search domains. + */ +EVENT2_EXPORT_SYMBOL +void evdns_base_search_clear(struct evdns_base *base); + + +/** + Add a domain to the list of search domains + + @param domain the domain to be added to the search list + */ +EVENT2_EXPORT_SYMBOL +void evdns_base_search_add(struct evdns_base *base, const char *domain); + + +/** + Set the 'ndots' parameter for searches. + + Sets the number of dots which, when found in a name, causes + the first query to be without any search domain. + + @param ndots the new ndots parameter + */ +EVENT2_EXPORT_SYMBOL +void evdns_base_search_ndots_set(struct evdns_base *base, const int ndots); + +/** + A callback that is invoked when a log message is generated + + @param is_warning indicates if the log message is a 'warning' + @param msg the content of the log message + */ +typedef void (*evdns_debug_log_fn_type)(int is_warning, const char *msg); + + +/** + Set the callback function to handle DNS log messages. If this + callback is not set, evdns log messages are handled with the regular + Libevent logging system. + + @param fn the callback to be invoked when a log message is generated + */ +EVENT2_EXPORT_SYMBOL +void evdns_set_log_fn(evdns_debug_log_fn_type fn); + +/** + Set a callback that will be invoked to generate transaction IDs. By + default, we pick transaction IDs based on the current clock time, which + is bad for security. + + @param fn the new callback, or NULL to use the default. + + NOTE: This function has no effect in Libevent 2.0.4-alpha and later, + since Libevent now provides its own secure RNG. + */ +EVENT2_EXPORT_SYMBOL +void evdns_set_transaction_id_fn(ev_uint16_t (*fn)(void)); + +/** + Set a callback used to generate random bytes. By default, we use + the same function as passed to evdns_set_transaction_id_fn to generate + bytes two at a time. If a function is provided here, it's also used + to generate transaction IDs. + + NOTE: This function has no effect in Libevent 2.0.4-alpha and later, + since Libevent now provides its own secure RNG. +*/ +EVENT2_EXPORT_SYMBOL +void evdns_set_random_bytes_fn(void (*fn)(char *, size_t)); + +/* + * Functions used to implement a DNS server. + */ + +struct evdns_server_request; +struct evdns_server_question; + +/** + A callback to implement a DNS server. The callback function receives a DNS + request. It should then optionally add a number of answers to the reply + using the evdns_server_request_add_*_reply functions, before calling either + evdns_server_request_respond to send the reply back, or + evdns_server_request_drop to decline to answer the request. + + @param req A newly received request + @param user_data A pointer that was passed to + evdns_add_server_port_with_base(). + */ +typedef void (*evdns_request_callback_fn_type)(struct evdns_server_request *, void *); +#define EVDNS_ANSWER_SECTION 0 +#define EVDNS_AUTHORITY_SECTION 1 +#define EVDNS_ADDITIONAL_SECTION 2 + +#define EVDNS_TYPE_A 1 +#define EVDNS_TYPE_NS 2 +#define EVDNS_TYPE_CNAME 5 +#define EVDNS_TYPE_SOA 6 +#define EVDNS_TYPE_PTR 12 +#define EVDNS_TYPE_MX 15 +#define EVDNS_TYPE_TXT 16 +#define EVDNS_TYPE_AAAA 28 + +#define EVDNS_QTYPE_AXFR 252 +#define EVDNS_QTYPE_ALL 255 + +#define EVDNS_CLASS_INET 1 + +/* flags that can be set in answers; as part of the err parameter */ +#define EVDNS_FLAGS_AA 0x400 +#define EVDNS_FLAGS_RD 0x080 + +/** Create a new DNS server port. + + @param base The event base to handle events for the server port. + @param socket A UDP socket to accept DNS requests. + @param flags Always 0 for now. + @param callback A function to invoke whenever we get a DNS request + on the socket. + @param user_data Data to pass to the callback. + @return an evdns_server_port structure for this server port. + */ +EVENT2_EXPORT_SYMBOL +struct evdns_server_port *evdns_add_server_port_with_base(struct event_base *base, evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data); +/** Close down a DNS server port, and free associated structures. */ +EVENT2_EXPORT_SYMBOL +void evdns_close_server_port(struct evdns_server_port *port); + +/** Sets some flags in a reply we're building. + Allows setting of the AA or RD flags + */ +EVENT2_EXPORT_SYMBOL +void evdns_server_request_set_flags(struct evdns_server_request *req, int flags); + +/* Functions to add an answer to an in-progress DNS reply. + */ +EVENT2_EXPORT_SYMBOL +int evdns_server_request_add_reply(struct evdns_server_request *req, int section, const char *name, int type, int dns_class, int ttl, int datalen, int is_name, const char *data); +EVENT2_EXPORT_SYMBOL +int evdns_server_request_add_a_reply(struct evdns_server_request *req, const char *name, int n, const void *addrs, int ttl); +EVENT2_EXPORT_SYMBOL +int evdns_server_request_add_aaaa_reply(struct evdns_server_request *req, const char *name, int n, const void *addrs, int ttl); +EVENT2_EXPORT_SYMBOL +int evdns_server_request_add_ptr_reply(struct evdns_server_request *req, struct in_addr *in, const char *inaddr_name, const char *hostname, int ttl); +EVENT2_EXPORT_SYMBOL +int evdns_server_request_add_cname_reply(struct evdns_server_request *req, const char *name, const char *cname, int ttl); + +/** + Send back a response to a DNS request, and free the request structure. +*/ +EVENT2_EXPORT_SYMBOL +int evdns_server_request_respond(struct evdns_server_request *req, int err); +/** + Free a DNS request without sending back a reply. +*/ +EVENT2_EXPORT_SYMBOL +int evdns_server_request_drop(struct evdns_server_request *req); +struct sockaddr; +/** + Get the address that made a DNS request. + */ +EVENT2_EXPORT_SYMBOL +int evdns_server_request_get_requesting_addr(struct evdns_server_request *req, struct sockaddr *sa, int addr_len); + +/** Callback for evdns_getaddrinfo. */ +typedef void (*evdns_getaddrinfo_cb)(int result, struct evutil_addrinfo *res, void *arg); + +struct evdns_base; +struct evdns_getaddrinfo_request; +/** Make a non-blocking getaddrinfo request using the dns_base in 'dns_base'. + * + * If we can answer the request immediately (with an error or not!), then we + * invoke cb immediately and return NULL. Otherwise we return + * an evdns_getaddrinfo_request and invoke cb later. + * + * When the callback is invoked, we pass as its first argument the error code + * that getaddrinfo would return (or 0 for no error). As its second argument, + * we pass the evutil_addrinfo structures we found (or NULL on error). We + * pass 'arg' as the third argument. + * + * Limitations: + * + * - The AI_V4MAPPED and AI_ALL flags are not currently implemented. + * - For ai_socktype, we only handle SOCKTYPE_STREAM, SOCKTYPE_UDP, and 0. + * - For ai_protocol, we only handle IPPROTO_TCP, IPPROTO_UDP, and 0. + */ +EVENT2_EXPORT_SYMBOL +struct evdns_getaddrinfo_request *evdns_getaddrinfo( + struct evdns_base *dns_base, + const char *nodename, const char *servname, + const struct evutil_addrinfo *hints_in, + evdns_getaddrinfo_cb cb, void *arg); + +/* Cancel an in-progress evdns_getaddrinfo. This MUST NOT be called after the + * getaddrinfo's callback has been invoked. The resolves will be canceled, + * and the callback will be invoked with the error EVUTIL_EAI_CANCEL. */ +EVENT2_EXPORT_SYMBOL +void evdns_getaddrinfo_cancel(struct evdns_getaddrinfo_request *req); + +/** + Retrieve the address of the 'idx'th configured nameserver. + + @param base The evdns_base to examine. + @param idx The index of the nameserver to get the address of. + @param sa A location to receive the server's address. + @param len The number of bytes available at sa. + + @return the number of bytes written into sa on success. On failure, returns + -1 if idx is greater than the number of configured nameservers, or a + value greater than 'len' if len was not high enough. + */ +EVENT2_EXPORT_SYMBOL +int evdns_base_get_nameserver_addr(struct evdns_base *base, int idx, + struct sockaddr *sa, ev_socklen_t len); + +#ifdef __cplusplus +} +#endif + +#endif /* !EVENT2_DNS_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/dns_compat.h b/Source/Import/libevent/Includes/Windows/event2/dns_compat.h new file mode 100644 index 0000000..965fd65 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/dns_compat.h @@ -0,0 +1,336 @@ +/* + * Copyright (c) 2006-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_DNS_COMPAT_H_INCLUDED_ +#define EVENT2_DNS_COMPAT_H_INCLUDED_ + +/** @file event2/dns_compat.h + + Potentially non-threadsafe versions of the functions in dns.h: provided + only for backwards compatibility. + + + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/** + Initialize the asynchronous DNS library. + + This function initializes support for non-blocking name resolution by + calling evdns_resolv_conf_parse() on UNIX and + evdns_config_windows_nameservers() on Windows. + + @deprecated This function is deprecated because it always uses the current + event base, and is easily confused by multiple calls to event_init(), and + so is not safe for multithreaded use. Additionally, it allocates a global + structure that only one thread can use. The replacement is + evdns_base_new(). + + @return 0 if successful, or -1 if an error occurred + @see evdns_shutdown() + */ +int evdns_init(void); + +struct evdns_base; +/** + Return the global evdns_base created by event_init() and used by the other + deprecated functions. + + @deprecated This function is deprecated because use of the global + evdns_base is error-prone. + */ +struct evdns_base *evdns_get_global_base(void); + +/** + Shut down the asynchronous DNS resolver and terminate all active requests. + + If the 'fail_requests' option is enabled, all active requests will return + an empty result with the error flag set to DNS_ERR_SHUTDOWN. Otherwise, + the requests will be silently discarded. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_shutdown(). + + @param fail_requests if zero, active requests will be aborted; if non-zero, + active requests will return DNS_ERR_SHUTDOWN. + @see evdns_init() + */ +void evdns_shutdown(int fail_requests); + +/** + Add a nameserver. + + The address should be an IPv4 address in network byte order. + The type of address is chosen so that it matches in_addr.s_addr. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_nameserver_add(). + + @param address an IP address in network byte order + @return 0 if successful, or -1 if an error occurred + @see evdns_nameserver_ip_add() + */ +int evdns_nameserver_add(unsigned long int address); + +/** + Get the number of configured nameservers. + + This returns the number of configured nameservers (not necessarily the + number of running nameservers). This is useful for double-checking + whether our calls to the various nameserver configuration functions + have been successful. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_count_nameservers(). + + @return the number of configured nameservers + @see evdns_nameserver_add() + */ +int evdns_count_nameservers(void); + +/** + Remove all configured nameservers, and suspend all pending resolves. + + Resolves will not necessarily be re-attempted until evdns_resume() is called. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_clear_nameservers_and_suspend(). + + @return 0 if successful, or -1 if an error occurred + @see evdns_resume() + */ +int evdns_clear_nameservers_and_suspend(void); + +/** + Resume normal operation and continue any suspended resolve requests. + + Re-attempt resolves left in limbo after an earlier call to + evdns_clear_nameservers_and_suspend(). + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_resume(). + + @return 0 if successful, or -1 if an error occurred + @see evdns_clear_nameservers_and_suspend() + */ +int evdns_resume(void); + +/** + Add a nameserver. + + This wraps the evdns_nameserver_add() function by parsing a string as an IP + address and adds it as a nameserver. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_nameserver_ip_add(). + + @return 0 if successful, or -1 if an error occurred + @see evdns_nameserver_add() + */ +int evdns_nameserver_ip_add(const char *ip_as_string); + +/** + Lookup an A record for a given name. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_resolve_ipv4(). + + @param name a DNS hostname + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return 0 if successful, or -1 if an error occurred + @see evdns_resolve_ipv6(), evdns_resolve_reverse(), evdns_resolve_reverse_ipv6() + */ +int evdns_resolve_ipv4(const char *name, int flags, evdns_callback_type callback, void *ptr); + +/** + Lookup an AAAA record for a given name. + + @param name a DNS hostname + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return 0 if successful, or -1 if an error occurred + @see evdns_resolve_ipv4(), evdns_resolve_reverse(), evdns_resolve_reverse_ipv6() + */ +int evdns_resolve_ipv6(const char *name, int flags, evdns_callback_type callback, void *ptr); + +struct in_addr; +struct in6_addr; + +/** + Lookup a PTR record for a given IP address. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_resolve_reverse(). + + @param in an IPv4 address + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return 0 if successful, or -1 if an error occurred + @see evdns_resolve_reverse_ipv6() + */ +int evdns_resolve_reverse(const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr); + +/** + Lookup a PTR record for a given IPv6 address. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_resolve_reverse_ipv6(). + + @param in an IPv6 address + @param flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. + @param callback a callback function to invoke when the request is completed + @param ptr an argument to pass to the callback function + @return 0 if successful, or -1 if an error occurred + @see evdns_resolve_reverse_ipv6() + */ +int evdns_resolve_reverse_ipv6(const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr); + +/** + Set the value of a configuration option. + + The currently available configuration options are: + + ndots, timeout, max-timeouts, max-inflight, and attempts + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_set_option(). + + @param option the name of the configuration option to be modified + @param val the value to be set + @param flags Ignored. + @return 0 if successful, or -1 if an error occurred + */ +int evdns_set_option(const char *option, const char *val, int flags); + +/** + Parse a resolv.conf file. + + The 'flags' parameter determines what information is parsed from the + resolv.conf file. See the man page for resolv.conf for the format of this + file. + + The following directives are not parsed from the file: sortlist, rotate, + no-check-names, inet6, debug. + + If this function encounters an error, the possible return values are: 1 = + failed to open file, 2 = failed to stat file, 3 = file too large, 4 = out of + memory, 5 = short read from file, 6 = no nameservers listed in the file + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_resolv_conf_parse(). + + @param flags any of DNS_OPTION_NAMESERVERS|DNS_OPTION_SEARCH|DNS_OPTION_MISC| + DNS_OPTIONS_ALL + @param filename the path to the resolv.conf file + @return 0 if successful, or various positive error codes if an error + occurred (see above) + @see resolv.conf(3), evdns_config_windows_nameservers() + */ +int evdns_resolv_conf_parse(int flags, const char *const filename); + +/** + Clear the list of search domains. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_search_clear(). + */ +void evdns_search_clear(void); + +/** + Add a domain to the list of search domains + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_search_add(). + + @param domain the domain to be added to the search list + */ +void evdns_search_add(const char *domain); + +/** + Set the 'ndots' parameter for searches. + + Sets the number of dots which, when found in a name, causes + the first query to be without any search domain. + + @deprecated This function is deprecated because it does not allow the + caller to specify which evdns_base it applies to. The recommended + function is evdns_base_search_ndots_set(). + + @param ndots the new ndots parameter + */ +void evdns_search_ndots_set(const int ndots); + +/** + As evdns_server_new_with_base. + + @deprecated This function is deprecated because it does not allow the + caller to specify which even_base it uses. The recommended + function is evdns_add_server_port_with_base(). + +*/ +struct evdns_server_port *evdns_add_server_port(evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data); + +#ifdef _WIN32 +int evdns_config_windows_nameservers(void); +#define EVDNS_CONFIG_WINDOWS_NAMESERVERS_IMPLEMENTED +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_COMPAT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/dns_struct.h b/Source/Import/libevent/Includes/Windows/event2/dns_struct.h new file mode 100644 index 0000000..593a8a7 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/dns_struct.h @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_DNS_STRUCT_H_INCLUDED_ +#define EVENT2_DNS_STRUCT_H_INCLUDED_ + +/** @file event2/dns_struct.h + + Data structures for dns. Using these structures may hurt forward + compatibility with later versions of Libevent: be careful! + + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/* + * Structures used to implement a DNS server. + */ + +struct evdns_server_request { + int flags; + int nquestions; + struct evdns_server_question **questions; +}; +struct evdns_server_question { + int type; +#ifdef __cplusplus + int dns_question_class; +#else + /* You should refer to this field as "dns_question_class". The + * name "class" works in C for backward compatibility, and will be + * removed in a future version. (1.5 or later). */ + int class; +#define dns_question_class class +#endif + char name[1]; +}; + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_DNS_STRUCT_H_INCLUDED_ */ + diff --git a/Source/Import/libevent/Includes/Windows/event2/event-config.h b/Source/Import/libevent/Includes/Windows/event2/event-config.h new file mode 100644 index 0000000..2c1b96f --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/event-config.h @@ -0,0 +1,545 @@ +/* event2/event-config.h + * + * This file was generated by autoconf when libevent was built, and post- + * processed by Libevent so that its macros would have a uniform prefix. + * + * DO NOT EDIT THIS FILE. + * + * Do not rely on macros in this file existing in later versions. + */ + +#ifndef EVENT2_EVENT_CONFIG_H_INCLUDED_ +#define EVENT2_EVENT_CONFIG_H_INCLUDED_ + +/* config.h. Generated from config.h.in by configure. */ +/* config.h.in. Generated from configure.ac by autoheader. */ + +/* Define if libevent should build without support for a debug mode */ +/* #undef EVENT__DISABLE_DEBUG_MODE */ + +/* Define if libevent should not allow replacing the mm functions */ +/* #undef EVENT__DISABLE_MM_REPLACEMENT */ + +/* Define if libevent should not be compiled with thread support */ +/* #undef EVENT__DISABLE_THREAD_SUPPORT */ + +/* Define to 1 if you have the `accept4' function. */ +/* #undef EVENT__HAVE_ACCEPT4 */ + +/* Define to 1 if you have the `arc4random' function. */ +/* #undef EVENT__HAVE_ARC4RANDOM */ + +/* Define to 1 if you have the `arc4random_buf' function. */ +/* #undef EVENT__HAVE_ARC4RANDOM_BUF */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_ARPA_INET_H */ + +/* Define to 1 if you have the `clock_gettime' function. */ +/* #undef EVENT__HAVE_CLOCK_GETTIME */ + +/* Define to 1 if you have the declaration of `CTL_KERN', and to 0 if you + don't. */ +/* #undef EVENT__HAVE_DECL_CTL_KERN */ + +/* Define to 1 if you have the declaration of `KERN_ARND', and to 0 if you + don't. */ +/* #undef EVENT__HAVE_DECL_KERN_ARND */ + +/* Define to 1 if you have the declaration of `KERN_RANDOM', and to 0 if you + don't. */ +/* #undef EVENT__HAVE_DECL_KERN_RANDOM */ + +/* Define to 1 if you have the declaration of `RANDOM_UUID', and to 0 if you + don't. */ +/* #undef EVENT__HAVE_DECL_RANDOM_UUID */ + +/* Define if /dev/poll is available */ +/* #undef EVENT__HAVE_DEVPOLL */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_DLFCN_H */ + +/* Define if your system supports the epoll system calls */ +/* #undef EVENT__HAVE_EPOLL */ + +/* Define to 1 if you have the `epoll_create1' function. */ +/* #undef EVENT__HAVE_EPOLL_CREATE1 */ + +/* Define to 1 if you have the `epoll_ctl' function. */ +/* #undef EVENT__HAVE_EPOLL_CTL */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_ERRNO_H 1 + +/* Define to 1 if you have ERR_remove_thread_stat(). */ +/* #undef EVENT__HAVE_ERR_REMOVE_THREAD_STATE */ + +/* Define to 1 if you have the `eventfd' function. */ +/* #undef EVENT__HAVE_EVENTFD */ + +/* Define if your system supports event ports */ +/* #undef EVENT__HAVE_EVENT_PORTS */ + +/* Define to 1 if you have the `fcntl' function. */ +/* #undef EVENT__HAVE_FCNTL */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_FCNTL_H 1 + +/* Define to 1 if the system has the type `fd_mask'. */ +/* #undef EVENT__HAVE_FD_MASK */ + +/* Do we have getaddrinfo()? */ +/* #undef EVENT__HAVE_GETADDRINFO */ + +/* Define to 1 if you have the `getegid' function. */ +/* #undef EVENT__HAVE_GETEGID */ + +/* Define to 1 if you have the `geteuid' function. */ +/* #undef EVENT__HAVE_GETEUID */ + +/* Define this if you have any gethostbyname_r() */ +/* #undef EVENT__HAVE_GETHOSTBYNAME_R */ + +/* Define this if gethostbyname_r takes 3 arguments */ +/* #undef EVENT__HAVE_GETHOSTBYNAME_R_3_ARG */ + +/* Define this if gethostbyname_r takes 5 arguments */ +/* #undef EVENT__HAVE_GETHOSTBYNAME_R_5_ARG */ + +/* Define this if gethostbyname_r takes 6 arguments */ +/* #undef EVENT__HAVE_GETHOSTBYNAME_R_6_ARG */ + +/* Define to 1 if you have the `getifaddrs' function. */ +/* #undef EVENT__HAVE_GETIFADDRS */ + +/* Define to 1 if you have the `getnameinfo' function. */ +#define EVENT__HAVE_GETNAMEINFO 1 + +/* Define to 1 if you have the `getprotobynumber' function. */ +#define EVENT__HAVE_GETPROTOBYNUMBER 1 + +/* Define to 1 if you have the `getservbyname' function. */ +#define EVENT__HAVE_GETSERVBYNAME 1 + +/* Define to 1 if you have the `gettimeofday' function. */ +#define EVENT__HAVE_GETTIMEOFDAY 1 + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_IFADDRS_H */ + +/* Define to 1 if you have the `inet_ntop' function. */ +#define EVENT__HAVE_INET_NTOP 1 + +/* Define to 1 if you have the `inet_pton' function. */ +#define EVENT__HAVE_INET_PTON 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_INTTYPES_H 1 + +/* Define to 1 if you have the `issetugid' function. */ +/* #undef EVENT__HAVE_ISSETUGID */ + +/* Define to 1 if you have the `kqueue' function. */ +/* #undef EVENT__HAVE_KQUEUE */ + +/* Define if the system has zlib */ +#define EVENT__HAVE_LIBZ 1 + +/* Define to 1 if you have the `mach_absolute_time' function. */ +/* #undef EVENT__HAVE_MACH_ABSOLUTE_TIME */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_MACH_MACH_TIME_H */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_MEMORY_H 1 + +/* Define to 1 if you have the `mmap' function. */ +/* #undef EVENT__HAVE_MMAP */ + +/* Define to 1 if you have the `nanosleep' function. */ +/* #undef EVENT__HAVE_NANOSLEEP */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_NETDB_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_NETINET_IN6_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_NETINET_IN_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_NETINET_TCP_H */ + +/* Define if the system has openssl */ +/* #undef EVENT__HAVE_OPENSSL */ + +/* Define to 1 if you have the `pipe' function. */ +/* #undef EVENT__HAVE_PIPE */ + +/* Define to 1 if you have the `pipe2' function. */ +/* #undef EVENT__HAVE_PIPE2 */ + +/* Define to 1 if you have the `poll' function. */ +/* #undef EVENT__HAVE_POLL */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_POLL_H */ + +/* Define to 1 if you have the `port_create' function. */ +/* #undef EVENT__HAVE_PORT_CREATE */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_PORT_H */ + +/* Define if you have POSIX threads libraries and header files. */ +/* #undef EVENT__HAVE_PTHREAD */ + +/* Define if we have pthreads on this system */ +/* #undef EVENT__HAVE_PTHREADS */ + +/* Define to 1 if you have the `putenv' function. */ +#define EVENT__HAVE_PUTENV 1 + +/* Define to 1 if the system has the type `sa_family_t'. */ +/* #undef EVENT__HAVE_SA_FAMILY_T */ + +/* Define to 1 if you have the `select' function. */ +/* #undef EVENT__HAVE_SELECT */ + +/* Define to 1 if you have the `sendfile' function. */ +/* #undef EVENT__HAVE_SENDFILE */ + +/* Define to 1 if you have the `setenv' function. */ +/* #undef EVENT__HAVE_SETENV */ + +/* Define if F_SETFD is defined in */ +/* #undef EVENT__HAVE_SETFD */ + +/* Define to 1 if you have the `setrlimit' function. */ +/* #undef EVENT__HAVE_SETRLIMIT */ + +/* Define to 1 if you have the `sigaction' function. */ +/* #undef EVENT__HAVE_SIGACTION */ + +/* Define to 1 if you have the `signal' function. */ +#define EVENT__HAVE_SIGNAL 1 + +/* Define to 1 if you have the `splice' function. */ +/* #undef EVENT__HAVE_SPLICE */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STDARG_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STDDEF_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STDINT_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STDLIB_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STRINGS_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_STRING_H 1 + +/* Define to 1 if you have the `strlcpy' function. */ +/* #undef EVENT__HAVE_STRLCPY */ + +/* Define to 1 if you have the `strsep' function. */ +/* #undef EVENT__HAVE_STRSEP */ + +/* Define to 1 if you have the `strtok_r' function. */ +#define EVENT__HAVE_STRTOK_R 1 + +/* Define to 1 if you have the `strtoll' function. */ +#define EVENT__HAVE_STRTOLL 1 + +/* Define to 1 if the system has the type `struct addrinfo'. */ +#define EVENT__HAVE_STRUCT_ADDRINFO 1 + +/* Define to 1 if the system has the type `struct in6_addr'. */ +#define EVENT__HAVE_STRUCT_IN6_ADDR 1 + +/* Define to 1 if `s6_addr16' is a member of `struct in6_addr'. */ +/* #undef EVENT__HAVE_STRUCT_IN6_ADDR_S6_ADDR16 */ + +/* Define to 1 if `s6_addr32' is a member of `struct in6_addr'. */ +/* #undef EVENT__HAVE_STRUCT_IN6_ADDR_S6_ADDR32 */ + +/* Define to 1 if the system has the type `struct sockaddr_in6'. */ +#define EVENT__HAVE_STRUCT_SOCKADDR_IN6 1 + +/* Define to 1 if `sin6_len' is a member of `struct sockaddr_in6'. */ +/* #undef EVENT__HAVE_STRUCT_SOCKADDR_IN6_SIN6_LEN */ + +/* Define to 1 if `sin_len' is a member of `struct sockaddr_in'. */ +/* #undef EVENT__HAVE_STRUCT_SOCKADDR_IN_SIN_LEN */ + +/* Define to 1 if the system has the type `struct sockaddr_storage'. */ +#define EVENT__HAVE_STRUCT_SOCKADDR_STORAGE 1 + +/* Define to 1 if `ss_family' is a member of `struct sockaddr_storage'. */ +#define EVENT__HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY 1 + +/* Define to 1 if `__ss_family' is a member of `struct sockaddr_storage'. */ +/* #undef EVENT__HAVE_STRUCT_SOCKADDR_STORAGE___SS_FAMILY */ + +/* Define to 1 if the system has the type `struct so_linger'. */ +/* #undef EVENT__HAVE_STRUCT_SO_LINGER */ + +/* Define to 1 if you have the `sysctl' function. */ +/* #undef EVENT__HAVE_SYSCTL */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_DEVPOLL_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_EPOLL_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_EVENTFD_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_EVENT_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_IOCTL_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_MMAN_H */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_SYS_PARAM_H 1 + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_QUEUE_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_RESOURCE_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_SELECT_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_SENDFILE_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_SOCKET_H */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_SYS_STAT_H 1 + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_SYSCTL_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_TIMERFD_H */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_SYS_TIME_H 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_SYS_TYPES_H 1 + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_UIO_H */ + +/* Define to 1 if you have the header file. */ +/* #undef EVENT__HAVE_SYS_WAIT_H */ + +/* Define if TAILQ_FOREACH is defined in */ +/* #undef EVENT__HAVE_TAILQFOREACH */ + +/* Define if timeradd is defined in */ +/* #undef EVENT__HAVE_TIMERADD */ + +/* Define if timerclear is defined in */ +#define EVENT__HAVE_TIMERCLEAR 1 + +/* Define if timercmp is defined in */ +#define EVENT__HAVE_TIMERCMP 1 + +/* Define to 1 if you have the `timerfd_create' function. */ +/* #undef EVENT__HAVE_TIMERFD_CREATE */ + +/* Define if timerisset is defined in */ +#define EVENT__HAVE_TIMERISSET 1 + +/* Define to 1 if the system has the type `uint16_t'. */ +#define EVENT__HAVE_UINT16_T 1 + +/* Define to 1 if the system has the type `uint32_t'. */ +#define EVENT__HAVE_UINT32_T 1 + +/* Define to 1 if the system has the type `uint64_t'. */ +#define EVENT__HAVE_UINT64_T 1 + +/* Define to 1 if the system has the type `uint8_t'. */ +#define EVENT__HAVE_UINT8_T 1 + +/* Define to 1 if the system has the type `uintptr_t'. */ +#define EVENT__HAVE_UINTPTR_T 1 + +/* Define to 1 if you have the `umask' function. */ +#define EVENT__HAVE_UMASK 1 + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_UNISTD_H 1 + +/* Define to 1 if you have the `unsetenv' function. */ +/* #undef EVENT__HAVE_UNSETENV */ + +/* Define to 1 if you have the `usleep' function. */ +#define EVENT__HAVE_USLEEP 1 + +/* Define to 1 if you have the `vasprintf' function. */ +#define EVENT__HAVE_VASPRINTF 1 + +/* Define if waitpid() supports WNOWAIT */ +/* #undef EVENT__HAVE_WAITPID_WITH_WNOWAIT */ + +/* Define if kqueue works correctly with pipes */ +/* #undef EVENT__HAVE_WORKING_KQUEUE */ + +/* Define to 1 if you have the header file. */ +#define EVENT__HAVE_ZLIB_H 1 + +/* Define to the sub-directory where libtool stores uninstalled libraries. */ +#define EVENT__LT_OBJDIR ".libs/" + +/* Numeric representation of the version */ +#define EVENT__NUMERIC_VERSION 0x02010800 + +/* Name of package */ +#define EVENT__PACKAGE "libevent" + +/* Define to the address where bug reports for this package should be sent. */ +#define EVENT__PACKAGE_BUGREPORT "" + +/* Define to the full name of this package. */ +#define EVENT__PACKAGE_NAME "libevent" + +/* Define to the full name and version of this package. */ +#define EVENT__PACKAGE_STRING "libevent 2.1.8-stable" + +/* Define to the one symbol short name of this package. */ +#define EVENT__PACKAGE_TARNAME "libevent" + +/* Define to the home page for this package. */ +#define EVENT__PACKAGE_URL "" + +/* Define to the version of this package. */ +#define EVENT__PACKAGE_VERSION "2.1.8-stable" + +/* Define to necessary symbol if this constant uses a non-standard name on + your system. */ +/* #undef EVENT__PTHREAD_CREATE_JOINABLE */ + +/* The size of `int', as computed by sizeof. */ +#define EVENT__SIZEOF_INT 4 + +/* The size of `long', as computed by sizeof. */ +#define EVENT__SIZEOF_LONG 4 + +/* The size of `long long', as computed by sizeof. */ +#define EVENT__SIZEOF_LONG_LONG 8 + +/* The size of `off_t', as computed by sizeof. */ +#define EVENT__SIZEOF_OFF_T 8 + +/* The size of `pthread_t', as computed by sizeof. */ +/* #undef EVENT__SIZEOF_PTHREAD_T */ + +/* The size of `short', as computed by sizeof. */ +#define EVENT__SIZEOF_SHORT 2 + +/* The size of `size_t', as computed by sizeof. */ +#define EVENT__SIZEOF_SIZE_T 8 + +/* The size of `void *', as computed by sizeof. */ +#define EVENT__SIZEOF_VOID_P 8 + +/* Define to 1 if you have the ANSI C header files. */ +#define EVENT__STDC_HEADERS 1 + +/* Define to 1 if you can safely include both and . */ +#define EVENT__TIME_WITH_SYS_TIME 1 + +/* Enable extensions on AIX 3, Interix. */ +#ifndef EVENT___ALL_SOURCE +# define EVENT___ALL_SOURCE 1 +#endif +/* Enable GNU extensions on systems that have them. */ +#ifndef EVENT___GNU_SOURCE +# define EVENT___GNU_SOURCE 1 +#endif +/* Enable threading extensions on Solaris. */ +#ifndef EVENT___POSIX_PTHREAD_SEMANTICS +# define EVENT___POSIX_PTHREAD_SEMANTICS 1 +#endif +/* Enable extensions on HP NonStop. */ +#ifndef EVENT___TANDEM_SOURCE +# define EVENT___TANDEM_SOURCE 1 +#endif +/* Enable general extensions on Solaris. */ +#ifndef EVENT____EXTENSIONS__ +# define EVENT____EXTENSIONS__ 1 +#endif + + +/* Version number of package */ +#define EVENT__VERSION "2.1.8-stable" + +/* Enable large inode numbers on Mac OS X 10.5. */ +#ifndef EVENT___DARWIN_USE_64_BIT_INODE +# define EVENT___DARWIN_USE_64_BIT_INODE 1 +#endif + +/* Number of bits in a file offset, on hosts where this is settable. */ +#define EVENT___FILE_OFFSET_BITS 64 + +/* Define for large files, on AIX-style hosts. */ +/* #undef EVENT___LARGE_FILES */ + +/* Define to 1 if on MINIX. */ +/* #undef EVENT___MINIX */ + +/* Define to 2 if the system does not provide POSIX.1 features except with + this defined. */ +/* #undef EVENT___POSIX_1_SOURCE */ + +/* Define to 1 if you need to in order for `stat' and other things to work. */ +/* #undef EVENT___POSIX_SOURCE */ + +/* Define to appropriate substitue if compiler doesnt have __func__ */ +/* #undef EVENT____func__ */ + +/* Define to empty if `const' does not conform to ANSI C. */ +/* #undef EVENT__const */ + +/* Define to `__inline__' or `__inline' if that's what the C compiler + calls it, or to nothing if 'inline' is not supported under any name. */ +#ifndef EVENT____cplusplus +/* #undef EVENT__inline */ +#endif + +/* Define to `int' if does not define. */ +/* #undef EVENT__pid_t */ + +/* Define to `unsigned int' if does not define. */ +/* #undef EVENT__size_t */ + +/* Define to unsigned int if you dont have it */ +#define EVENT__socklen_t unsigned int + +/* Define to `int' if does not define. */ +/* #undef EVENT__ssize_t */ + +#endif /* event2/event-config.h */ diff --git a/Source/Import/libevent/Includes/Windows/event2/event.h b/Source/Import/libevent/Includes/Windows/event2/event.h new file mode 100644 index 0000000..6e0a4f0 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/event.h @@ -0,0 +1,1675 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_EVENT_H_INCLUDED_ +#define EVENT2_EVENT_H_INCLUDED_ + +/** + @mainpage + + @section intro Introduction + + Libevent is an event notification library for developing scalable network + servers. The Libevent API provides a mechanism to execute a callback + function when a specific event occurs on a file descriptor or after a + timeout has been reached. Furthermore, Libevent also support callbacks due + to signals or regular timeouts. + + Libevent is meant to replace the event loop found in event driven network + servers. An application just needs to call event_base_dispatch() and then add or + remove events dynamically without having to change the event loop. + + + Currently, Libevent supports /dev/poll, kqueue(2), select(2), poll(2), + epoll(4), and evports. The internal event mechanism is completely + independent of the exposed event API, and a simple update of Libevent can + provide new functionality without having to redesign the applications. As a + result, Libevent allows for portable application development and provides + the most scalable event notification mechanism available on an operating + system. Libevent can also be used for multithreaded programs. Libevent + should compile on Linux, *BSD, Mac OS X, Solaris and, Windows. + + @section usage Standard usage + + Every program that uses Libevent must include the + header, and pass the -levent flag to the linker. (You can instead link + -levent_core if you only want the main event and buffered IO-based code, + and don't want to link any protocol code.) + + @section setup Library setup + + Before you call any other Libevent functions, you need to set up the + library. If you're going to use Libevent from multiple threads in a + multithreaded application, you need to initialize thread support -- + typically by using evthread_use_pthreads() or + evthread_use_windows_threads(). See for more + information. + + This is also the point where you can replace Libevent's memory + management functions with event_set_mem_functions, and enable debug mode + with event_enable_debug_mode(). + + @section base Creating an event base + + Next, you need to create an event_base structure, using event_base_new() + or event_base_new_with_config(). The event_base is responsible for + keeping track of which events are "pending" (that is to say, being + watched to see if they become active) and which events are "active". + Every event is associated with a single event_base. + + @section event Event notification + + For each file descriptor that you wish to monitor, you must create an + event structure with event_new(). (You may also declare an event + structure and call event_assign() to initialize the members of the + structure.) To enable notification, you add the structure to the list + of monitored events by calling event_add(). The event structure must + remain allocated as long as it is active, so it should generally be + allocated on the heap. + + @section loop Dispatching events. + + Finally, you call event_base_dispatch() to loop and dispatch events. + You can also use event_base_loop() for more fine-grained control. + + Currently, only one thread can be dispatching a given event_base at a + time. If you want to run events in multiple threads at once, you can + either have a single event_base whose events add work to a work queue, + or you can create multiple event_base objects. + + @section bufferevent I/O Buffers + + Libevent provides a buffered I/O abstraction on top of the regular event + callbacks. This abstraction is called a bufferevent. A bufferevent + provides input and output buffers that get filled and drained + automatically. The user of a buffered event no longer deals directly + with the I/O, but instead is reading from input and writing to output + buffers. + + Once initialized via bufferevent_socket_new(), the bufferevent structure + can be used repeatedly with bufferevent_enable() and + bufferevent_disable(). Instead of reading and writing directly to a + socket, you would call bufferevent_read() and bufferevent_write(). + + When read enabled the bufferevent will try to read from the file descriptor + and call the read callback. The write callback is executed whenever the + output buffer is drained below the write low watermark, which is 0 by + default. + + See for more information. + + @section timers Timers + + Libevent can also be used to create timers that invoke a callback after a + certain amount of time has expired. The evtimer_new() macro returns + an event struct to use as a timer. To activate the timer, call + evtimer_add(). Timers can be deactivated by calling evtimer_del(). + (These macros are thin wrappers around event_new(), event_add(), + and event_del(); you can also use those instead.) + + @section evdns Asynchronous DNS resolution + + Libevent provides an asynchronous DNS resolver that should be used instead + of the standard DNS resolver functions. See the + functions for more detail. + + @section evhttp Event-driven HTTP servers + + Libevent provides a very simple event-driven HTTP server that can be + embedded in your program and used to service HTTP requests. + + To use this capability, you need to include the header in your + program. See that header for more information. + + @section evrpc A framework for RPC servers and clients + + Libevent provides a framework for creating RPC servers and clients. It + takes care of marshaling and unmarshaling all data structures. + + @section api API Reference + + To browse the complete documentation of the libevent API, click on any of + the following links. + + event2/event.h + The primary libevent header + + event2/thread.h + Functions for use by multithreaded programs + + event2/buffer.h and event2/bufferevent.h + Buffer management for network reading and writing + + event2/util.h + Utility functions for portable nonblocking network code + + event2/dns.h + Asynchronous DNS resolution + + event2/http.h + An embedded libevent-based HTTP server + + event2/rpc.h + A framework for creating RPC servers and clients + + */ + +/** @file event2/event.h + + Core functions for waiting for and receiving events, and using event bases. +*/ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +#include + +/* For int types. */ +#include + +/** + * Structure to hold information and state for a Libevent dispatch loop. + * + * The event_base lies at the center of Libevent; every application will + * have one. It keeps track of all pending and active events, and + * notifies your application of the active ones. + * + * This is an opaque structure; you can allocate one using + * event_base_new() or event_base_new_with_config(). + * + * @see event_base_new(), event_base_free(), event_base_loop(), + * event_base_new_with_config() + */ +struct event_base +#ifdef EVENT_IN_DOXYGEN_ +{/*Empty body so that doxygen will generate documentation here.*/} +#endif +; + +/** + * @struct event + * + * Structure to represent a single event. + * + * An event can have some underlying condition it represents: a socket + * becoming readable or writeable (or both), or a signal becoming raised. + * (An event that represents no underlying condition is still useful: you + * can use one to implement a timer, or to communicate between threads.) + * + * Generally, you can create events with event_new(), then make them + * pending with event_add(). As your event_base runs, it will run the + * callbacks of an events whose conditions are triggered. When you + * longer want the event, free it with event_free(). + * + * In more depth: + * + * An event may be "pending" (one whose condition we are watching), + * "active" (one whose condition has triggered and whose callback is about + * to run), neither, or both. Events come into existence via + * event_assign() or event_new(), and are then neither active nor pending. + * + * To make an event pending, pass it to event_add(). When doing so, you + * can also set a timeout for the event. + * + * Events become active during an event_base_loop() call when either their + * condition has triggered, or when their timeout has elapsed. You can + * also activate an event manually using event_active(). The even_base + * loop will run the callbacks of active events; after it has done so, it + * marks them as no longer active. + * + * You can make an event non-pending by passing it to event_del(). This + * also makes the event non-active. + * + * Events can be "persistent" or "non-persistent". A non-persistent event + * becomes non-pending as soon as it is triggered: thus, it only runs at + * most once per call to event_add(). A persistent event remains pending + * even when it becomes active: you'll need to event_del() it manually in + * order to make it non-pending. When a persistent event with a timeout + * becomes active, its timeout is reset: this means you can use persistent + * events to implement periodic timeouts. + * + * This should be treated as an opaque structure; you should never read or + * write any of its fields directly. For backward compatibility with old + * code, it is defined in the event2/event_struct.h header; including this + * header may make your code incompatible with other versions of Libevent. + * + * @see event_new(), event_free(), event_assign(), event_get_assignment(), + * event_add(), event_del(), event_active(), event_pending(), + * event_get_fd(), event_get_base(), event_get_events(), + * event_get_callback(), event_get_callback_arg(), + * event_priority_set() + */ +struct event +#ifdef EVENT_IN_DOXYGEN_ +{/*Empty body so that doxygen will generate documentation here.*/} +#endif +; + +/** + * Configuration for an event_base. + * + * There are many options that can be used to alter the behavior and + * implementation of an event_base. To avoid having to pass them all in a + * complex many-argument constructor, we provide an abstract data type + * wrhere you set up configation information before passing it to + * event_base_new_with_config(). + * + * @see event_config_new(), event_config_free(), event_base_new_with_config(), + * event_config_avoid_method(), event_config_require_features(), + * event_config_set_flag(), event_config_set_num_cpus_hint() + */ +struct event_config +#ifdef EVENT_IN_DOXYGEN_ +{/*Empty body so that doxygen will generate documentation here.*/} +#endif +; + +/** + * Enable some relatively expensive debugging checks in Libevent that + * would normally be turned off. Generally, these checks cause code that + * would otherwise crash mysteriously to fail earlier with an assertion + * failure. Note that this method MUST be called before any events or + * event_bases have been created. + * + * Debug mode can currently catch the following errors: + * An event is re-assigned while it is added + * Any function is called on a non-assigned event + * + * Note that debugging mode uses memory to track every event that has been + * initialized (via event_assign, event_set, or event_new) but not yet + * released (via event_free or event_debug_unassign). If you want to use + * debug mode, and you find yourself running out of memory, you will need + * to use event_debug_unassign to explicitly stop tracking events that + * are no longer considered set-up. + * + * @see event_debug_unassign() + */ +EVENT2_EXPORT_SYMBOL +void event_enable_debug_mode(void); + +/** + * When debugging mode is enabled, informs Libevent that an event should no + * longer be considered as assigned. When debugging mode is not enabled, does + * nothing. + * + * This function must only be called on a non-added event. + * + * @see event_enable_debug_mode() + */ +EVENT2_EXPORT_SYMBOL +void event_debug_unassign(struct event *); + +/** + * Create and return a new event_base to use with the rest of Libevent. + * + * @return a new event_base on success, or NULL on failure. + * + * @see event_base_free(), event_base_new_with_config() + */ +EVENT2_EXPORT_SYMBOL +struct event_base *event_base_new(void); + +/** + Reinitialize the event base after a fork + + Some event mechanisms do not survive across fork. The event base needs + to be reinitialized with the event_reinit() function. + + @param base the event base that needs to be re-initialized + @return 0 if successful, or -1 if some events could not be re-added. + @see event_base_new() +*/ +EVENT2_EXPORT_SYMBOL +int event_reinit(struct event_base *base); + +/** + Event dispatching loop + + This loop will run the event base until either there are no more pending or + active, or until something calls event_base_loopbreak() or + event_base_loopexit(). + + @param base the event_base structure returned by event_base_new() or + event_base_new_with_config() + @return 0 if successful, -1 if an error occurred, or 1 if we exited because + no events were pending or active. + @see event_base_loop() + */ +EVENT2_EXPORT_SYMBOL +int event_base_dispatch(struct event_base *); + +/** + Get the kernel event notification mechanism used by Libevent. + + @param eb the event_base structure returned by event_base_new() + @return a string identifying the kernel event mechanism (kqueue, epoll, etc.) + */ +EVENT2_EXPORT_SYMBOL +const char *event_base_get_method(const struct event_base *); + +/** + Gets all event notification mechanisms supported by Libevent. + + This functions returns the event mechanism in order preferred by + Libevent. Note that this list will include all backends that + Libevent has compiled-in support for, and will not necessarily check + your OS to see whether it has the required resources. + + @return an array with pointers to the names of support methods. + The end of the array is indicated by a NULL pointer. If an + error is encountered NULL is returned. +*/ +EVENT2_EXPORT_SYMBOL +const char **event_get_supported_methods(void); + +/** Query the current monotonic time from a the timer for a struct + * event_base. + */ +EVENT2_EXPORT_SYMBOL +int event_gettime_monotonic(struct event_base *base, struct timeval *tp); + +/** + @name event type flag + + Flags to pass to event_base_get_num_events() to specify the kinds of events + we want to aggregate counts for +*/ +/**@{*/ +/** count the number of active events, which have been triggered.*/ +#define EVENT_BASE_COUNT_ACTIVE 1U +/** count the number of virtual events, which is used to represent an internal + * condition, other than a pending event, that keeps the loop from exiting. */ +#define EVENT_BASE_COUNT_VIRTUAL 2U +/** count the number of events which have been added to event base, including + * internal events. */ +#define EVENT_BASE_COUNT_ADDED 4U +/**@}*/ + +/** + Gets the number of events in event_base, as specified in the flags. + + Since event base has some internal events added to make some of its + functionalities work, EVENT_BASE_COUNT_ADDED may return more than the + number of events you added using event_add(). + + If you pass EVENT_BASE_COUNT_ACTIVE and EVENT_BASE_COUNT_ADDED together, an + active event will be counted twice. However, this might not be the case in + future libevent versions. The return value is an indication of the work + load, but the user shouldn't rely on the exact value as this may change in + the future. + + @param eb the event_base structure returned by event_base_new() + @param flags a bitwise combination of the kinds of events to aggregate + counts for + @return the number of events specified in the flags +*/ +EVENT2_EXPORT_SYMBOL +int event_base_get_num_events(struct event_base *, unsigned int); + +/** + Get the maximum number of events in a given event_base as specified in the + flags. + + @param eb the event_base structure returned by event_base_new() + @param flags a bitwise combination of the kinds of events to aggregate + counts for + @param clear option used to reset the maximum count. + @return the number of events specified in the flags + */ +EVENT2_EXPORT_SYMBOL +int event_base_get_max_events(struct event_base *, unsigned int, int); + +/** + Allocates a new event configuration object. + + The event configuration object can be used to change the behavior of + an event base. + + @return an event_config object that can be used to store configuration, or + NULL if an error is encountered. + @see event_base_new_with_config(), event_config_free(), event_config +*/ +EVENT2_EXPORT_SYMBOL +struct event_config *event_config_new(void); + +/** + Deallocates all memory associated with an event configuration object + + @param cfg the event configuration object to be freed. +*/ +EVENT2_EXPORT_SYMBOL +void event_config_free(struct event_config *cfg); + +/** + Enters an event method that should be avoided into the configuration. + + This can be used to avoid event mechanisms that do not support certain + file descriptor types, or for debugging to avoid certain event + mechanisms. An application can make use of multiple event bases to + accommodate incompatible file descriptor types. + + @param cfg the event configuration object + @param method the name of the event method to avoid + @return 0 on success, -1 on failure. +*/ +EVENT2_EXPORT_SYMBOL +int event_config_avoid_method(struct event_config *cfg, const char *method); + +/** + A flag used to describe which features an event_base (must) provide. + + Because of OS limitations, not every Libevent backend supports every + possible feature. You can use this type with + event_config_require_features() to tell Libevent to only proceed if your + event_base implements a given feature, and you can receive this type from + event_base_get_features() to see which features are available. +*/ +enum event_method_feature { + /** Require an event method that allows edge-triggered events with EV_ET. */ + EV_FEATURE_ET = 0x01, + /** Require an event method where having one event triggered among + * many is [approximately] an O(1) operation. This excludes (for + * example) select and poll, which are approximately O(N) for N + * equal to the total number of possible events. */ + EV_FEATURE_O1 = 0x02, + /** Require an event method that allows file descriptors as well as + * sockets. */ + EV_FEATURE_FDS = 0x04, + /** Require an event method that allows you to use EV_CLOSED to detect + * connection close without the necessity of reading all the pending data. + * + * Methods that do support EV_CLOSED may not be able to provide support on + * all kernel versions. + **/ + EV_FEATURE_EARLY_CLOSE = 0x08 +}; + +/** + A flag passed to event_config_set_flag(). + + These flags change the behavior of an allocated event_base. + + @see event_config_set_flag(), event_base_new_with_config(), + event_method_feature + */ +enum event_base_config_flag { + /** Do not allocate a lock for the event base, even if we have + locking set up. + + Setting this option will make it unsafe and nonfunctional to call + functions on the base concurrently from multiple threads. + */ + EVENT_BASE_FLAG_NOLOCK = 0x01, + /** Do not check the EVENT_* environment variables when configuring + an event_base */ + EVENT_BASE_FLAG_IGNORE_ENV = 0x02, + /** Windows only: enable the IOCP dispatcher at startup + + If this flag is set then bufferevent_socket_new() and + evconn_listener_new() will use IOCP-backed implementations + instead of the usual select-based one on Windows. + */ + EVENT_BASE_FLAG_STARTUP_IOCP = 0x04, + /** Instead of checking the current time every time the event loop is + ready to run timeout callbacks, check after each timeout callback. + */ + EVENT_BASE_FLAG_NO_CACHE_TIME = 0x08, + + /** If we are using the epoll backend, this flag says that it is + safe to use Libevent's internal change-list code to batch up + adds and deletes in order to try to do as few syscalls as + possible. Setting this flag can make your code run faster, but + it may trigger a Linux bug: it is not safe to use this flag + if you have any fds cloned by dup() or its variants. Doing so + will produce strange and hard-to-diagnose bugs. + + This flag can also be activated by setting the + EVENT_EPOLL_USE_CHANGELIST environment variable. + + This flag has no effect if you wind up using a backend other than + epoll. + */ + EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST = 0x10, + + /** Ordinarily, Libevent implements its time and timeout code using + the fastest monotonic timer that we have. If this flag is set, + however, we use less efficient more precise timer, assuming one is + present. + */ + EVENT_BASE_FLAG_PRECISE_TIMER = 0x20 +}; + +/** + Return a bitmask of the features implemented by an event base. This + will be a bitwise OR of one or more of the values of + event_method_feature + + @see event_method_feature + */ +EVENT2_EXPORT_SYMBOL +int event_base_get_features(const struct event_base *base); + +/** + Enters a required event method feature that the application demands. + + Note that not every feature or combination of features is supported + on every platform. Code that requests features should be prepared + to handle the case where event_base_new_with_config() returns NULL, as in: + 
+     event_config_require_features(cfg, EV_FEATURE_ET);
+     base = event_base_new_with_config(cfg);
+     if (base == NULL) {
+       // We can't get edge-triggered behavior here.
+       event_config_require_features(cfg, 0);
+       base = event_base_new_with_config(cfg);
+     }
+
+ + @param cfg the event configuration object + @param feature a bitfield of one or more event_method_feature values. + Replaces values from previous calls to this function. + @return 0 on success, -1 on failure. + @see event_method_feature, event_base_new_with_config() +*/ +EVENT2_EXPORT_SYMBOL +int event_config_require_features(struct event_config *cfg, int feature); + +/** + * Sets one or more flags to configure what parts of the eventual event_base + * will be initialized, and how they'll work. + * + * @see event_base_config_flags, event_base_new_with_config() + **/ +EVENT2_EXPORT_SYMBOL +int event_config_set_flag(struct event_config *cfg, int flag); + +/** + * Records a hint for the number of CPUs in the system. This is used for + * tuning thread pools, etc, for optimal performance. In Libevent 2.0, + * it is only on Windows, and only when IOCP is in use. + * + * @param cfg the event configuration object + * @param cpus the number of cpus + * @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int event_config_set_num_cpus_hint(struct event_config *cfg, int cpus); + +/** + * Record an interval and/or a number of callbacks after which the event base + * should check for new events. By default, the event base will run as many + * events are as activated at the higest activated priority before checking + * for new events. If you configure it by setting max_interval, it will check + * the time after each callback, and not allow more than max_interval to + * elapse before checking for new events. If you configure it by setting + * max_callbacks to a value >= 0, it will run no more than max_callbacks + * callbacks before checking for new events. + * + * This option can decrease the latency of high-priority events, and + * avoid priority inversions where multiple low-priority events keep us from + * polling for high-priority events, but at the expense of slightly decreasing + * the throughput. Use it with caution! + * + * @param cfg The event_base configuration object. + * @param max_interval An interval after which Libevent should stop running + * callbacks and check for more events, or NULL if there should be + * no such interval. + * @param max_callbacks A number of callbacks after which Libevent should + * stop running callbacks and check for more events, or -1 if there + * should be no such limit. + * @param min_priority A priority below which max_interval and max_callbacks + * should not be enforced. If this is set to 0, they are enforced + * for events of every priority; if it's set to 1, they're enforced + * for events of priority 1 and above, and so on. + * @return 0 on success, -1 on failure. + **/ +EVENT2_EXPORT_SYMBOL +int event_config_set_max_dispatch_interval(struct event_config *cfg, + const struct timeval *max_interval, int max_callbacks, + int min_priority); + +/** + Initialize the event API. + + Use event_base_new_with_config() to initialize a new event base, taking + the specified configuration under consideration. The configuration object + can currently be used to avoid certain event notification mechanisms. + + @param cfg the event configuration object + @return an initialized event_base that can be used to registering events, + or NULL if no event base can be created with the requested event_config. + @see event_base_new(), event_base_free(), event_init(), event_assign() +*/ +EVENT2_EXPORT_SYMBOL +struct event_base *event_base_new_with_config(const struct event_config *); + +/** + Deallocate all memory associated with an event_base, and free the base. + + Note that this function will not close any fds or free any memory passed + to event_new as the argument to callback. + + If there are any pending finalizer callbacks, this function will invoke + them. + + @param eb an event_base to be freed + */ +EVENT2_EXPORT_SYMBOL +void event_base_free(struct event_base *); + +/** + As event_free, but do not run finalizers. + + THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + BECOMES STABLE. + */ +EVENT2_EXPORT_SYMBOL +void event_base_free_nofinalize(struct event_base *); + +/** @name Log severities + */ +/**@{*/ +#define EVENT_LOG_DEBUG 0 +#define EVENT_LOG_MSG 1 +#define EVENT_LOG_WARN 2 +#define EVENT_LOG_ERR 3 +/**@}*/ + +/* Obsolete names: these are deprecated, but older programs might use them. + * They violate the reserved-identifier namespace. */ +#define _EVENT_LOG_DEBUG EVENT_LOG_DEBUG +#define _EVENT_LOG_MSG EVENT_LOG_MSG +#define _EVENT_LOG_WARN EVENT_LOG_WARN +#define _EVENT_LOG_ERR EVENT_LOG_ERR + +/** + A callback function used to intercept Libevent's log messages. + + @see event_set_log_callback + */ +typedef void (*event_log_cb)(int severity, const char *msg); +/** + Redirect Libevent's log messages. + + @param cb a function taking two arguments: an integer severity between + EVENT_LOG_DEBUG and EVENT_LOG_ERR, and a string. If cb is NULL, + then the default log is used. + + NOTE: The function you provide *must not* call any other libevent + functionality. Doing so can produce undefined behavior. + */ +EVENT2_EXPORT_SYMBOL +void event_set_log_callback(event_log_cb cb); + +/** + A function to be called if Libevent encounters a fatal internal error. + + @see event_set_fatal_callback + */ +typedef void (*event_fatal_cb)(int err); + +/** + Override Libevent's behavior in the event of a fatal internal error. + + By default, Libevent will call exit(1) if a programming error makes it + impossible to continue correct operation. This function allows you to supply + another callback instead. Note that if the function is ever invoked, + something is wrong with your program, or with Libevent: any subsequent calls + to Libevent may result in undefined behavior. + + Libevent will (almost) always log an EVENT_LOG_ERR message before calling + this function; look at the last log message to see why Libevent has died. + */ +EVENT2_EXPORT_SYMBOL +void event_set_fatal_callback(event_fatal_cb cb); + +#define EVENT_DBG_ALL 0xffffffffu +#define EVENT_DBG_NONE 0 + +/** + Turn on debugging logs and have them sent to the default log handler. + + This is a global setting; if you are going to call it, you must call this + before any calls that create an event-base. You must call it before any + multithreaded use of Libevent. + + Debug logs are verbose. + + @param which Controls which debug messages are turned on. This option is + unused for now; for forward compatibility, you must pass in the constant + "EVENT_DBG_ALL" to turn debugging logs on, or "EVENT_DBG_NONE" to turn + debugging logs off. + */ +EVENT2_EXPORT_SYMBOL +void event_enable_debug_logging(ev_uint32_t which); + +/** + Associate a different event base with an event. + + The event to be associated must not be currently active or pending. + + @param eb the event base + @param ev the event + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int event_base_set(struct event_base *, struct event *); + +/** @name Loop flags + + These flags control the behavior of event_base_loop(). + */ +/**@{*/ +/** Block until we have an active event, then exit once all active events + * have had their callbacks run. */ +#define EVLOOP_ONCE 0x01 +/** Do not block: see which events are ready now, run the callbacks + * of the highest-priority ones, then exit. */ +#define EVLOOP_NONBLOCK 0x02 +/** Do not exit the loop because we have no pending events. Instead, keep + * running until event_base_loopexit() or event_base_loopbreak() makes us + * stop. + */ +#define EVLOOP_NO_EXIT_ON_EMPTY 0x04 +/**@}*/ + +/** + Wait for events to become active, and run their callbacks. + + This is a more flexible version of event_base_dispatch(). + + By default, this loop will run the event base until either there are no more + pending or active events, or until something calls event_base_loopbreak() or + event_base_loopexit(). You can override this behavior with the 'flags' + argument. + + @param eb the event_base structure returned by event_base_new() or + event_base_new_with_config() + @param flags any combination of EVLOOP_ONCE | EVLOOP_NONBLOCK + @return 0 if successful, -1 if an error occurred, or 1 if we exited because + no events were pending or active. + @see event_base_loopexit(), event_base_dispatch(), EVLOOP_ONCE, + EVLOOP_NONBLOCK + */ +EVENT2_EXPORT_SYMBOL +int event_base_loop(struct event_base *, int); + +/** + Exit the event loop after the specified time + + The next event_base_loop() iteration after the given timer expires will + complete normally (handling all queued events) then exit without + blocking for events again. + + Subsequent invocations of event_base_loop() will proceed normally. + + @param eb the event_base structure returned by event_init() + @param tv the amount of time after which the loop should terminate, + or NULL to exit after running all currently active events. + @return 0 if successful, or -1 if an error occurred + @see event_base_loopbreak() + */ +EVENT2_EXPORT_SYMBOL +int event_base_loopexit(struct event_base *, const struct timeval *); + +/** + Abort the active event_base_loop() immediately. + + event_base_loop() will abort the loop after the next event is completed; + event_base_loopbreak() is typically invoked from this event's callback. + This behavior is analogous to the "break;" statement. + + Subsequent invocations of event_base_loop() will proceed normally. + + @param eb the event_base structure returned by event_init() + @return 0 if successful, or -1 if an error occurred + @see event_base_loopexit() + */ +EVENT2_EXPORT_SYMBOL +int event_base_loopbreak(struct event_base *); + +/** + Tell the active event_base_loop() to scan for new events immediately. + + Calling this function makes the currently active event_base_loop() + start the loop over again (scanning for new events) after the current + event callback finishes. If the event loop is not running, this + function has no effect. + + event_base_loopbreak() is typically invoked from this event's callback. + This behavior is analogous to the "continue;" statement. + + Subsequent invocations of event loop will proceed normally. + + @param eb the event_base structure returned by event_init() + @return 0 if successful, or -1 if an error occurred + @see event_base_loopbreak() + */ +EVENT2_EXPORT_SYMBOL +int event_base_loopcontinue(struct event_base *); + +/** + Checks if the event loop was told to exit by event_base_loopexit(). + + This function will return true for an event_base at every point after + event_loopexit() is called, until the event loop is next entered. + + @param eb the event_base structure returned by event_init() + @return true if event_base_loopexit() was called on this event base, + or 0 otherwise + @see event_base_loopexit() + @see event_base_got_break() + */ +EVENT2_EXPORT_SYMBOL +int event_base_got_exit(struct event_base *); + +/** + Checks if the event loop was told to abort immediately by event_base_loopbreak(). + + This function will return true for an event_base at every point after + event_base_loopbreak() is called, until the event loop is next entered. + + @param eb the event_base structure returned by event_init() + @return true if event_base_loopbreak() was called on this event base, + or 0 otherwise + @see event_base_loopbreak() + @see event_base_got_exit() + */ +EVENT2_EXPORT_SYMBOL +int event_base_got_break(struct event_base *); + +/** + * @name event flags + * + * Flags to pass to event_new(), event_assign(), event_pending(), and + * anything else with an argument of the form "short events" + */ +/**@{*/ +/** Indicates that a timeout has occurred. It's not necessary to pass + * this flag to event_for new()/event_assign() to get a timeout. */ +#define EV_TIMEOUT 0x01 +/** Wait for a socket or FD to become readable */ +#define EV_READ 0x02 +/** Wait for a socket or FD to become writeable */ +#define EV_WRITE 0x04 +/** Wait for a POSIX signal to be raised*/ +#define EV_SIGNAL 0x08 +/** + * Persistent event: won't get removed automatically when activated. + * + * When a persistent event with a timeout becomes activated, its timeout + * is reset to 0. + */ +#define EV_PERSIST 0x10 +/** Select edge-triggered behavior, if supported by the backend. */ +#define EV_ET 0x20 +/** + * If this option is provided, then event_del() will not block in one thread + * while waiting for the event callback to complete in another thread. + * + * To use this option safely, you may need to use event_finalize() or + * event_free_finalize() in order to safely tear down an event in a + * multithreaded application. See those functions for more information. + * + * THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + * BECOMES STABLE. + **/ +#define EV_FINALIZE 0x40 +/** + * Detects connection close events. You can use this to detect when a + * connection has been closed, without having to read all the pending data + * from a connection. + * + * Not all backends support EV_CLOSED. To detect or require it, use the + * feature flag EV_FEATURE_EARLY_CLOSE. + **/ +#define EV_CLOSED 0x80 +/**@}*/ + +/** + @name evtimer_* macros + + Aliases for working with one-shot timer events */ +/**@{*/ +#define evtimer_assign(ev, b, cb, arg) \ + event_assign((ev), (b), -1, 0, (cb), (arg)) +#define evtimer_new(b, cb, arg) event_new((b), -1, 0, (cb), (arg)) +#define evtimer_add(ev, tv) event_add((ev), (tv)) +#define evtimer_del(ev) event_del(ev) +#define evtimer_pending(ev, tv) event_pending((ev), EV_TIMEOUT, (tv)) +#define evtimer_initialized(ev) event_initialized(ev) +/**@}*/ + +/** + @name evsignal_* macros + + Aliases for working with signal events + */ +/**@{*/ +#define evsignal_add(ev, tv) event_add((ev), (tv)) +#define evsignal_assign(ev, b, x, cb, arg) \ + event_assign((ev), (b), (x), EV_SIGNAL|EV_PERSIST, cb, (arg)) +#define evsignal_new(b, x, cb, arg) \ + event_new((b), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg)) +#define evsignal_del(ev) event_del(ev) +#define evsignal_pending(ev, tv) event_pending((ev), EV_SIGNAL, (tv)) +#define evsignal_initialized(ev) event_initialized(ev) +/**@}*/ + +/** + A callback function for an event. + + It receives three arguments: + + @param fd An fd or signal + @param events One or more EV_* flags + @param arg A user-supplied argument. + + @see event_new() + */ +typedef void (*event_callback_fn)(evutil_socket_t, short, void *); + +/** + Return a value used to specify that the event itself must be used as the callback argument. + + The function event_new() takes a callback argument which is passed + to the event's callback function. To specify that the argument to be + passed to the callback function is the event that event_new() returns, + pass in the return value of event_self_cbarg() as the callback argument + for event_new(). + + For example: + 
+      struct event *ev = event_new(base, sock, events, callback, %event_self_cbarg());
+
+ + For consistency with event_new(), it is possible to pass the return value + of this function as the callback argument for event_assign() – this + achieves the same result as passing the event in directly. + + @return a value to be passed as the callback argument to event_new() or + event_assign(). + @see event_new(), event_assign() + */ +EVENT2_EXPORT_SYMBOL +void *event_self_cbarg(void); + +/** + Allocate and asssign a new event structure, ready to be added. + + The function event_new() returns a new event that can be used in + future calls to event_add() and event_del(). The fd and events + arguments determine which conditions will trigger the event; the + callback and callback_arg arguments tell Libevent what to do when the + event becomes active. + + If events contains one of EV_READ, EV_WRITE, or EV_READ|EV_WRITE, then + fd is a file descriptor or socket that should get monitored for + readiness to read, readiness to write, or readiness for either operation + (respectively). If events contains EV_SIGNAL, then fd is a signal + number to wait for. If events contains none of those flags, then the + event can be triggered only by a timeout or by manual activation with + event_active(): In this case, fd must be -1. + + The EV_PERSIST flag can also be passed in the events argument: it makes + event_add() persistent until event_del() is called. + + The EV_ET flag is compatible with EV_READ and EV_WRITE, and supported + only by certain backends. It tells Libevent to use edge-triggered + events. + + The EV_TIMEOUT flag has no effect here. + + It is okay to have multiple events all listening on the same fds; but + they must either all be edge-triggered, or all not be edge triggerd. + + When the event becomes active, the event loop will run the provided + callbuck function, with three arguments. The first will be the provided + fd value. The second will be a bitfield of the events that triggered: + EV_READ, EV_WRITE, or EV_SIGNAL. Here the EV_TIMEOUT flag indicates + that a timeout occurred, and EV_ET indicates that an edge-triggered + event occurred. The third event will be the callback_arg pointer that + you provide. + + @param base the event base to which the event should be attached. + @param fd the file descriptor or signal to be monitored, or -1. + @param events desired events to monitor: bitfield of EV_READ, EV_WRITE, + EV_SIGNAL, EV_PERSIST, EV_ET. + @param callback callback function to be invoked when the event occurs + @param callback_arg an argument to be passed to the callback function + + @return a newly allocated struct event that must later be freed with + event_free(). + @see event_free(), event_add(), event_del(), event_assign() + */ +EVENT2_EXPORT_SYMBOL +struct event *event_new(struct event_base *, evutil_socket_t, short, event_callback_fn, void *); + + +/** + Prepare a new, already-allocated event structure to be added. + + The function event_assign() prepares the event structure ev to be used + in future calls to event_add() and event_del(). Unlike event_new(), it + doesn't allocate memory itself: it requires that you have already + allocated a struct event, probably on the heap. Doing this will + typically make your code depend on the size of the event structure, and + thereby create incompatibility with future versions of Libevent. + + The easiest way to avoid this problem is just to use event_new() and + event_free() instead. + + A slightly harder way to future-proof your code is to use + event_get_struct_event_size() to determine the required size of an event + at runtime. + + Note that it is NOT safe to call this function on an event that is + active or pending. Doing so WILL corrupt internal data structures in + Libevent, and lead to strange, hard-to-diagnose bugs. You _can_ use + event_assign to change an existing event, but only if it is not active + or pending! + + The arguments for this function, and the behavior of the events that it + makes, are as for event_new(). + + @param ev an event struct to be modified + @param base the event base to which ev should be attached. + @param fd the file descriptor to be monitored + @param events desired events to monitor; can be EV_READ and/or EV_WRITE + @param callback callback function to be invoked when the event occurs + @param callback_arg an argument to be passed to the callback function + + @return 0 if success, or -1 on invalid arguments. + + @see event_new(), event_add(), event_del(), event_base_once(), + event_get_struct_event_size() + */ +EVENT2_EXPORT_SYMBOL +int event_assign(struct event *, struct event_base *, evutil_socket_t, short, event_callback_fn, void *); + +/** + Deallocate a struct event * returned by event_new(). + + If the event is pending or active, first make it non-pending and + non-active. + */ +EVENT2_EXPORT_SYMBOL +void event_free(struct event *); + +/** + * Callback type for event_finalize and event_free_finalize(). + * + * THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + * BECOMES STABLE. + * + **/ +typedef void (*event_finalize_callback_fn)(struct event *, void *); +/** + @name Finalization functions + + These functions are used to safely tear down an event in a multithreaded + application. If you construct your events with EV_FINALIZE to avoid + deadlocks, you will need a way to remove an event in the certainty that + it will definitely not be running its callback when you deallocate it + and its callback argument. + + To do this, call one of event_finalize() or event_free_finalize with + 0 for its first argument, the event to tear down as its second argument, + and a callback function as its third argument. The callback will be + invoked as part of the event loop, with the event's priority. + + After you call a finalizer function, event_add() and event_active() will + no longer work on the event, and event_del() will produce a no-op. You + must not try to change the event's fields with event_assign() or + event_set() while the finalize callback is in progress. Once the + callback has been invoked, you should treat the event structure as + containing uninitialized memory. + + The event_free_finalize() function frees the event after it's finalized; + event_finalize() does not. + + A finalizer callback must not make events pending or active. It must not + add events, activate events, or attempt to "resucitate" the event being + finalized in any way. + + THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + BECOMES STABLE. + + @return 0 on succes, -1 on failure. + */ +/**@{*/ +EVENT2_EXPORT_SYMBOL +int event_finalize(unsigned, struct event *, event_finalize_callback_fn); +EVENT2_EXPORT_SYMBOL +int event_free_finalize(unsigned, struct event *, event_finalize_callback_fn); +/**@}*/ + +/** + Schedule a one-time event + + The function event_base_once() is similar to event_new(). However, it + schedules a callback to be called exactly once, and does not require the + caller to prepare an event structure. + + Note that in Libevent 2.0 and earlier, if the event is never triggered, the + internal memory used to hold it will never be freed. In Libevent 2.1, + the internal memory will get freed by event_base_free() if the event + is never triggered. The 'arg' value, however, will not get freed in either + case--you'll need to free that on your own if you want it to go away. + + @param base an event_base + @param fd a file descriptor to monitor, or -1 for no fd. + @param events event(s) to monitor; can be any of EV_READ | + EV_WRITE, or EV_TIMEOUT + @param callback callback function to be invoked when the event occurs + @param arg an argument to be passed to the callback function + @param timeout the maximum amount of time to wait for the event. NULL + makes an EV_READ/EV_WRITE event make forever; NULL makes an + EV_TIMEOUT event succees immediately. + @return 0 if successful, or -1 if an error occurred + */ +EVENT2_EXPORT_SYMBOL +int event_base_once(struct event_base *, evutil_socket_t, short, event_callback_fn, void *, const struct timeval *); + +/** + Add an event to the set of pending events. + + The function event_add() schedules the execution of the event 'ev' when the + condition specified by event_assign() or event_new() occurs, or when the time + specified in timeout has elapesed. If atimeout is NULL, no timeout + occurs and the function will only be + called if a matching event occurs. The event in the + ev argument must be already initialized by event_assign() or event_new() + and may not be used + in calls to event_assign() until it is no longer pending. + + If the event in the ev argument already has a scheduled timeout, calling + event_add() replaces the old timeout with the new one if tv is non-NULL. + + @param ev an event struct initialized via event_assign() or event_new() + @param timeout the maximum amount of time to wait for the event, or NULL + to wait forever + @return 0 if successful, or -1 if an error occurred + @see event_del(), event_assign(), event_new() + */ +EVENT2_EXPORT_SYMBOL +int event_add(struct event *ev, const struct timeval *timeout); + +/** + Remove a timer from a pending event without removing the event itself. + + If the event has a scheduled timeout, this function unschedules it but + leaves the event otherwise pending. + + @param ev an event struct initialized via event_assign() or event_new() + @return 0 on success, or -1 if an error occurrect. +*/ +EVENT2_EXPORT_SYMBOL +int event_remove_timer(struct event *ev); + +/** + Remove an event from the set of monitored events. + + The function event_del() will cancel the event in the argument ev. If the + event has already executed or has never been added the call will have no + effect. + + @param ev an event struct to be removed from the working set + @return 0 if successful, or -1 if an error occurred + @see event_add() + */ +EVENT2_EXPORT_SYMBOL +int event_del(struct event *); + +/** + As event_del(), but never blocks while the event's callback is running + in another thread, even if the event was constructed without the + EV_FINALIZE flag. + + THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + BECOMES STABLE. + */ +EVENT2_EXPORT_SYMBOL +int event_del_noblock(struct event *ev); +/** + As event_del(), but always blocks while the event's callback is running + in another thread, even if the event was constructed with the + EV_FINALIZE flag. + + THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES + BECOMES STABLE. + */ +EVENT2_EXPORT_SYMBOL +int event_del_block(struct event *ev); + +/** + Make an event active. + + You can use this function on a pending or a non-pending event to make it + active, so that its callback will be run by event_base_dispatch() or + event_base_loop(). + + One common use in multithreaded programs is to wake the thread running + event_base_loop() from another thread. + + @param ev an event to make active. + @param res a set of flags to pass to the event's callback. + @param ncalls an obsolete argument: this is ignored. + **/ +EVENT2_EXPORT_SYMBOL +void event_active(struct event *ev, int res, short ncalls); + +/** + Checks if a specific event is pending or scheduled. + + @param ev an event struct previously passed to event_add() + @param events the requested event type; any of EV_TIMEOUT|EV_READ| + EV_WRITE|EV_SIGNAL + @param tv if this field is not NULL, and the event has a timeout, + this field is set to hold the time at which the timeout will + expire. + + @return true if the event is pending on any of the events in 'what', (that + is to say, it has been added), or 0 if the event is not added. + */ +EVENT2_EXPORT_SYMBOL +int event_pending(const struct event *ev, short events, struct timeval *tv); + +/** + If called from within the callback for an event, returns that event. + + The behavior of this function is not defined when called from outside the + callback function for an event. + */ +EVENT2_EXPORT_SYMBOL +struct event *event_base_get_running_event(struct event_base *base); + +/** + Test if an event structure might be initialized. + + The event_initialized() function can be used to check if an event has been + initialized. + + Warning: This function is only useful for distinguishing a a zeroed-out + piece of memory from an initialized event, it can easily be confused by + uninitialized memory. Thus, it should ONLY be used to distinguish an + initialized event from zero. + + @param ev an event structure to be tested + @return 1 if the structure might be initialized, or 0 if it has not been + initialized + */ +EVENT2_EXPORT_SYMBOL +int event_initialized(const struct event *ev); + +/** + Get the signal number assigned to a signal event +*/ +#define event_get_signal(ev) ((int)event_get_fd(ev)) + +/** + Get the socket or signal assigned to an event, or -1 if the event has + no socket. +*/ +EVENT2_EXPORT_SYMBOL +evutil_socket_t event_get_fd(const struct event *ev); + +/** + Get the event_base associated with an event. +*/ +EVENT2_EXPORT_SYMBOL +struct event_base *event_get_base(const struct event *ev); + +/** + Return the events (EV_READ, EV_WRITE, etc) assigned to an event. +*/ +EVENT2_EXPORT_SYMBOL +short event_get_events(const struct event *ev); + +/** + Return the callback assigned to an event. +*/ +EVENT2_EXPORT_SYMBOL +event_callback_fn event_get_callback(const struct event *ev); + +/** + Return the callback argument assigned to an event. +*/ +EVENT2_EXPORT_SYMBOL +void *event_get_callback_arg(const struct event *ev); + +/** + Return the priority of an event. + @see event_priority_init(), event_get_priority() +*/ +EVENT2_EXPORT_SYMBOL +int event_get_priority(const struct event *ev); + +/** + Extract _all_ of arguments given to construct a given event. The + event_base is copied into *base_out, the fd is copied into *fd_out, and so + on. + + If any of the "_out" arguments is NULL, it will be ignored. + */ +EVENT2_EXPORT_SYMBOL +void event_get_assignment(const struct event *event, + struct event_base **base_out, evutil_socket_t *fd_out, short *events_out, + event_callback_fn *callback_out, void **arg_out); + +/** + Return the size of struct event that the Libevent library was compiled + with. + + This will be NO GREATER than sizeof(struct event) if you're running with + the same version of Libevent that your application was built with, but + otherwise might not. + + Note that it might be SMALLER than sizeof(struct event) if some future + version of Libevent adds extra padding to the end of struct event. + We might do this to help ensure ABI-compatibility between different + versions of Libevent. + */ +EVENT2_EXPORT_SYMBOL +size_t event_get_struct_event_size(void); + +/** + Get the Libevent version. + + Note that this will give you the version of the library that you're + currently linked against, not the version of the headers that you've + compiled against. + + @return a string containing the version number of Libevent +*/ +EVENT2_EXPORT_SYMBOL +const char *event_get_version(void); + +/** + Return a numeric representation of Libevent's version. + + Note that this will give you the version of the library that you're + currently linked against, not the version of the headers you've used to + compile. + + The format uses one byte each for the major, minor, and patchlevel parts of + the version number. The low-order byte is unused. For example, version + 2.0.1-alpha has a numeric representation of 0x02000100 +*/ +EVENT2_EXPORT_SYMBOL +ev_uint32_t event_get_version_number(void); + +/** As event_get_version, but gives the version of Libevent's headers. */ +#define LIBEVENT_VERSION EVENT__VERSION +/** As event_get_version_number, but gives the version number of Libevent's + * headers. */ +#define LIBEVENT_VERSION_NUMBER EVENT__NUMERIC_VERSION + +/** Largest number of priorities that Libevent can support. */ +#define EVENT_MAX_PRIORITIES 256 +/** + Set the number of different event priorities + + By default Libevent schedules all active events with the same priority. + However, some time it is desirable to process some events with a higher + priority than others. For that reason, Libevent supports strict priority + queues. Active events with a lower priority are always processed before + events with a higher priority. + + The number of different priorities can be set initially with the + event_base_priority_init() function. This function should be called + before the first call to event_base_dispatch(). The + event_priority_set() function can be used to assign a priority to an + event. By default, Libevent assigns the middle priority to all events + unless their priority is explicitly set. + + Note that urgent-priority events can starve less-urgent events: after + running all urgent-priority callbacks, Libevent checks for more urgent + events again, before running less-urgent events. Less-urgent events + will not have their callbacks run until there are no events more urgent + than them that want to be active. + + @param eb the event_base structure returned by event_base_new() + @param npriorities the maximum number of priorities + @return 0 if successful, or -1 if an error occurred + @see event_priority_set() + */ +EVENT2_EXPORT_SYMBOL +int event_base_priority_init(struct event_base *, int); + +/** + Get the number of different event priorities. + + @param eb the event_base structure returned by event_base_new() + @return Number of different event priorities + @see event_base_priority_init() +*/ +EVENT2_EXPORT_SYMBOL +int event_base_get_npriorities(struct event_base *eb); + +/** + Assign a priority to an event. + + @param ev an event struct + @param priority the new priority to be assigned + @return 0 if successful, or -1 if an error occurred + @see event_priority_init(), event_get_priority() + */ +EVENT2_EXPORT_SYMBOL +int event_priority_set(struct event *, int); + +/** + Prepare an event_base to use a large number of timeouts with the same + duration. + + Libevent's default scheduling algorithm is optimized for having a large + number of timeouts with their durations more or less randomly + distributed. But if you have a large number of timeouts that all have + the same duration (for example, if you have a large number of + connections that all have a 10-second timeout), then you can improve + Libevent's performance by telling Libevent about it. + + To do this, call this function with the common duration. It will return a + pointer to a different, opaque timeout value. (Don't depend on its actual + contents!) When you use this timeout value in event_add(), Libevent will + schedule the event more efficiently. + + (This optimization probably will not be worthwhile until you have thousands + or tens of thousands of events with the same timeout.) + */ +EVENT2_EXPORT_SYMBOL +const struct timeval *event_base_init_common_timeout(struct event_base *base, + const struct timeval *duration); + +#if !defined(EVENT__DISABLE_MM_REPLACEMENT) || defined(EVENT_IN_DOXYGEN_) +/** + Override the functions that Libevent uses for memory management. + + Usually, Libevent uses the standard libc functions malloc, realloc, and + free to allocate memory. Passing replacements for those functions to + event_set_mem_functions() overrides this behavior. + + Note that all memory returned from Libevent will be allocated by the + replacement functions rather than by malloc() and realloc(). Thus, if you + have replaced those functions, it will not be appropriate to free() memory + that you get from Libevent. Instead, you must use the free_fn replacement + that you provided. + + Note also that if you are going to call this function, you should do so + before any call to any Libevent function that does allocation. + Otherwise, those funtions will allocate their memory using malloc(), but + then later free it using your provided free_fn. + + @param malloc_fn A replacement for malloc. + @param realloc_fn A replacement for realloc + @param free_fn A replacement for free. + **/ +EVENT2_EXPORT_SYMBOL +void event_set_mem_functions( + void *(*malloc_fn)(size_t sz), + void *(*realloc_fn)(void *ptr, size_t sz), + void (*free_fn)(void *ptr)); +/** This definition is present if Libevent was built with support for + event_set_mem_functions() */ +#define EVENT_SET_MEM_FUNCTIONS_IMPLEMENTED +#endif + +/** + Writes a human-readable description of all inserted and/or active + events to a provided stdio stream. + + This is intended for debugging; its format is not guaranteed to be the same + between libevent versions. + + @param base An event_base on which to scan the events. + @param output A stdio file to write on. + */ +EVENT2_EXPORT_SYMBOL +void event_base_dump_events(struct event_base *, FILE *); + + +/** + Activates all pending events for the given fd and event mask. + + This function activates pending events only. Events which have not been + added will not become active. + + @param base the event_base on which to activate the events. + @param fd An fd to active events on. + @param events One or more of EV_{READ,WRITE}. + */ +EVENT2_EXPORT_SYMBOL +void event_base_active_by_fd(struct event_base *base, evutil_socket_t fd, short events); + +/** + Activates all pending signals with a given signal number + + This function activates pending events only. Events which have not been + added will not become active. + + @param base the event_base on which to activate the events. + @param fd The signal to active events on. + */ +EVENT2_EXPORT_SYMBOL +void event_base_active_by_signal(struct event_base *base, int sig); + +/** + * Callback for iterating events in an event base via event_base_foreach_event + */ +typedef int (*event_base_foreach_event_cb)(const struct event_base *, const struct event *, void *); + +/** + Iterate over all added or active events events in an event loop, and invoke + a given callback on each one. + + The callback must not call any function that modifies the event base, that + modifies any event in the event base, or that adds or removes any event to + the event base. Doing so is unsupported and will lead to undefined + behavior -- likely, to crashes. + + event_base_foreach_event() holds a lock on the event_base() for the whole + time it's running: slow callbacks are not advisable. + + Note that Libevent adds some events of its own to make pieces of its + functionality work. You must not assume that the only events you'll + encounter will be the ones you added yourself. + + The callback function must return 0 to continue iteration, or some other + integer to stop iterating. + + @param base An event_base on which to scan the events. + @param fn A callback function to receive the events. + @param arg An argument passed to the callback function. + @return 0 if we iterated over every event, or the value returned by the + callback function if the loop exited early. +*/ +EVENT2_EXPORT_SYMBOL +int event_base_foreach_event(struct event_base *base, event_base_foreach_event_cb fn, void *arg); + + +/** Sets 'tv' to the current time (as returned by gettimeofday()), + looking at the cached value in 'base' if possible, and calling + gettimeofday() or clock_gettime() as appropriate if there is no + cached time. + + Generally, this value will only be cached while actually + processing event callbacks, and may be very inaccuate if your + callbacks take a long time to execute. + + Returns 0 on success, negative on failure. + */ +EVENT2_EXPORT_SYMBOL +int event_base_gettimeofday_cached(struct event_base *base, + struct timeval *tv); + +/** Update cached_tv in the 'base' to the current time + * + * You can use this function is useful for selectively increasing + * the accuracy of the cached time value in 'base' during callbacks + * that take a long time to execute. + * + * This function has no effect if the base is currently not in its + * event loop, or if timeval caching is disabled via + * EVENT_BASE_FLAG_NO_CACHE_TIME. + * + * @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int event_base_update_cache_time(struct event_base *base); + +/** Release up all globally-allocated resources allocated by Libevent. + + This function does not free developer-controlled resources like + event_bases, events, bufferevents, listeners, and so on. It only releases + resources like global locks that there is no other way to free. + + It is not actually necessary to call this function before exit: every + resource that it frees would be released anyway on exit. It mainly exists + so that resource-leak debugging tools don't see Libevent as holding + resources at exit. + + You should only call this function when no other Libevent functions will + be invoked -- e.g., when cleanly exiting a program. + */ +EVENT2_EXPORT_SYMBOL +void libevent_global_shutdown(void); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/event_compat.h b/Source/Import/libevent/Includes/Windows/event2/event_compat.h new file mode 100644 index 0000000..5110175 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/event_compat.h @@ -0,0 +1,230 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_EVENT_COMPAT_H_INCLUDED_ +#define EVENT2_EVENT_COMPAT_H_INCLUDED_ + +/** @file event2/event_compat.h + + Potentially non-threadsafe versions of the functions in event.h: provided + only for backwards compatibility. + + In the oldest versions of Libevent, event_base was not a first-class + structure. Instead, there was a single event base that every function + manipulated. Later, when separate event bases were added, the old functions + that didn't take an event_base argument needed to work by manipulating the + "current" event base. This could lead to thread-safety issues, and obscure, + hard-to-diagnose bugs. + + @deprecated All functions in this file are by definition deprecated. + */ +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/** + Initialize the event API. + + The event API needs to be initialized with event_init() before it can be + used. Sets the global current base that gets used for events that have no + base associated with them. + + @deprecated This function is deprecated because it replaces the "current" + event_base, and is totally unsafe for multithreaded use. The replacement + is event_base_new(). + + @see event_base_set(), event_base_new() + */ +EVENT2_EXPORT_SYMBOL +struct event_base *event_init(void); + +/** + Loop to process events. + + Like event_base_dispatch(), but uses the "current" base. + + @deprecated This function is deprecated because it is easily confused by + multiple calls to event_init(), and because it is not safe for + multithreaded use. The replacement is event_base_dispatch(). + + @see event_base_dispatch(), event_init() + */ +EVENT2_EXPORT_SYMBOL +int event_dispatch(void); + +/** + Handle events. + + This function behaves like event_base_loop(), but uses the "current" base + + @deprecated This function is deprecated because it uses the event base from + the last call to event_init, and is therefore not safe for multithreaded + use. The replacement is event_base_loop(). + + @see event_base_loop(), event_init() +*/ +EVENT2_EXPORT_SYMBOL +int event_loop(int); + + +/** + Exit the event loop after the specified time. + + This function behaves like event_base_loopexit(), except that it uses the + "current" base. + + @deprecated This function is deprecated because it uses the event base from + the last call to event_init, and is therefore not safe for multithreaded + use. The replacement is event_base_loopexit(). + + @see event_init, event_base_loopexit() + */ +EVENT2_EXPORT_SYMBOL +int event_loopexit(const struct timeval *); + + +/** + Abort the active event_loop() immediately. + + This function behaves like event_base_loopbreakt(), except that it uses the + "current" base. + + @deprecated This function is deprecated because it uses the event base from + the last call to event_init, and is therefore not safe for multithreaded + use. The replacement is event_base_loopbreak(). + + @see event_base_loopbreak(), event_init() + */ +EVENT2_EXPORT_SYMBOL +int event_loopbreak(void); + +/** + Schedule a one-time event to occur. + + @deprecated This function is obsolete, and has been replaced by + event_base_once(). Its use is deprecated because it relies on the + "current" base configured by event_init(). + + @see event_base_once() + */ +EVENT2_EXPORT_SYMBOL +int event_once(evutil_socket_t , short, + void (*)(evutil_socket_t, short, void *), void *, const struct timeval *); + + +/** + Get the kernel event notification mechanism used by Libevent. + + @deprecated This function is obsolete, and has been replaced by + event_base_get_method(). Its use is deprecated because it relies on the + "current" base configured by event_init(). + + @see event_base_get_method() + */ +EVENT2_EXPORT_SYMBOL +const char *event_get_method(void); + + +/** + Set the number of different event priorities. + + @deprecated This function is deprecated because it is easily confused by + multiple calls to event_init(), and because it is not safe for + multithreaded use. The replacement is event_base_priority_init(). + + @see event_base_priority_init() + */ +EVENT2_EXPORT_SYMBOL +int event_priority_init(int); + +/** + Prepare an event structure to be added. + + @deprecated event_set() is not recommended for new code, because it requires + a subsequent call to event_base_set() to be safe under most circumstances. + Use event_assign() or event_new() instead. + */ +EVENT2_EXPORT_SYMBOL +void event_set(struct event *, evutil_socket_t, short, void (*)(evutil_socket_t, short, void *), void *); + +#define evtimer_set(ev, cb, arg) event_set((ev), -1, 0, (cb), (arg)) +#define evsignal_set(ev, x, cb, arg) \ + event_set((ev), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg)) + + +/** + @name timeout_* macros + + @deprecated These macros are deprecated because their naming is inconsistent + with the rest of Libevent. Use the evtimer_* macros instead. + @{ + */ +#define timeout_add(ev, tv) event_add((ev), (tv)) +#define timeout_set(ev, cb, arg) event_set((ev), -1, 0, (cb), (arg)) +#define timeout_del(ev) event_del(ev) +#define timeout_pending(ev, tv) event_pending((ev), EV_TIMEOUT, (tv)) +#define timeout_initialized(ev) event_initialized(ev) +/**@}*/ + +/** + @name signal_* macros + + @deprecated These macros are deprecated because their naming is inconsistent + with the rest of Libevent. Use the evsignal_* macros instead. + @{ + */ +#define signal_add(ev, tv) event_add((ev), (tv)) +#define signal_set(ev, x, cb, arg) \ + event_set((ev), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg)) +#define signal_del(ev) event_del(ev) +#define signal_pending(ev, tv) event_pending((ev), EV_SIGNAL, (tv)) +#define signal_initialized(ev) event_initialized(ev) +/**@}*/ + +#ifndef EVENT_FD +/* These macros are obsolete; use event_get_fd and event_get_signal instead. */ +#define EVENT_FD(ev) ((int)event_get_fd(ev)) +#define EVENT_SIGNAL(ev) event_get_signal(ev) +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_COMPAT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/event_struct.h b/Source/Import/libevent/Includes/Windows/event2/event_struct.h new file mode 100644 index 0000000..1c8b71b --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/event_struct.h @@ -0,0 +1,180 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_EVENT_STRUCT_H_INCLUDED_ +#define EVENT2_EVENT_STRUCT_H_INCLUDED_ + +/** @file event2/event_struct.h + + Structures used by event.h. Using these structures directly WILL harm + forward compatibility: be careful. + + No field declared in this file should be used directly in user code. Except + for historical reasons, these fields would not be exposed at all. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/* For evkeyvalq */ +#include + +#define EVLIST_TIMEOUT 0x01 +#define EVLIST_INSERTED 0x02 +#define EVLIST_SIGNAL 0x04 +#define EVLIST_ACTIVE 0x08 +#define EVLIST_INTERNAL 0x10 +#define EVLIST_ACTIVE_LATER 0x20 +#define EVLIST_FINALIZING 0x40 +#define EVLIST_INIT 0x80 + +#define EVLIST_ALL 0xff + +/* Fix so that people don't have to run with */ +#ifndef TAILQ_ENTRY +#define EVENT_DEFINED_TQENTRY_ +#define TAILQ_ENTRY(type) \ +struct { \ + struct type *tqe_next; /* next element */ \ + struct type **tqe_prev; /* address of previous next element */ \ +} +#endif /* !TAILQ_ENTRY */ + +#ifndef TAILQ_HEAD +#define EVENT_DEFINED_TQHEAD_ +#define TAILQ_HEAD(name, type) \ +struct name { \ + struct type *tqh_first; \ + struct type **tqh_last; \ +} +#endif + +/* Fix so that people don't have to run with */ +#ifndef LIST_ENTRY +#define EVENT_DEFINED_LISTENTRY_ +#define LIST_ENTRY(type) \ +struct { \ + struct type *le_next; /* next element */ \ + struct type **le_prev; /* address of previous next element */ \ +} +#endif /* !LIST_ENTRY */ + +#ifndef LIST_HEAD +#define EVENT_DEFINED_LISTHEAD_ +#define LIST_HEAD(name, type) \ +struct name { \ + struct type *lh_first; /* first element */ \ + } +#endif /* !LIST_HEAD */ + +struct event; + +struct event_callback { + TAILQ_ENTRY(event_callback) evcb_active_next; + short evcb_flags; + ev_uint8_t evcb_pri; /* smaller numbers are higher priority */ + ev_uint8_t evcb_closure; + /* allows us to adopt for different types of events */ + union { + void (*evcb_callback)(evutil_socket_t, short, void *); + void (*evcb_selfcb)(struct event_callback *, void *); + void (*evcb_evfinalize)(struct event *, void *); + void (*evcb_cbfinalize)(struct event_callback *, void *); + } evcb_cb_union; + void *evcb_arg; +}; + +struct event_base; +struct event { + struct event_callback ev_evcallback; + + /* for managing timeouts */ + union { + TAILQ_ENTRY(event) ev_next_with_common_timeout; + int min_heap_idx; + } ev_timeout_pos; + evutil_socket_t ev_fd; + + struct event_base *ev_base; + + union { + /* used for io events */ + struct { + LIST_ENTRY (event) ev_io_next; + struct timeval ev_timeout; + } ev_io; + + /* used by signal events */ + struct { + LIST_ENTRY (event) ev_signal_next; + short ev_ncalls; + /* Allows deletes in callback */ + short *ev_pncalls; + } ev_signal; + } ev_; + + short ev_events; + short ev_res; /* result passed to event callback */ + struct timeval ev_timeout; +}; + +TAILQ_HEAD (event_list, event); + +#ifdef EVENT_DEFINED_TQENTRY_ +#undef TAILQ_ENTRY +#endif + +#ifdef EVENT_DEFINED_TQHEAD_ +#undef TAILQ_HEAD +#endif + +LIST_HEAD (event_dlist, event); + +#ifdef EVENT_DEFINED_LISTENTRY_ +#undef LIST_ENTRY +#endif + +#ifdef EVENT_DEFINED_LISTHEAD_ +#undef LIST_HEAD +#endif + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_STRUCT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/http.h b/Source/Import/libevent/Includes/Windows/event2/http.h new file mode 100644 index 0000000..8fb5642 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/http.h @@ -0,0 +1,1189 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_HTTP_H_INCLUDED_ +#define EVENT2_HTTP_H_INCLUDED_ + +/* For int types. */ +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* In case we haven't included the right headers yet. */ +struct evbuffer; +struct event_base; +struct bufferevent; +struct evhttp_connection; + +/** @file event2/http.h + * + * Basic support for HTTP serving. + * + * As Libevent is a library for dealing with event notification and most + * interesting applications are networked today, I have often found the + * need to write HTTP code. The following prototypes and definitions provide + * an application with a minimal interface for making HTTP requests and for + * creating a very simple HTTP server. + */ + +/* Response codes */ +#define HTTP_OK 200 /**< request completed ok */ +#define HTTP_NOCONTENT 204 /**< request does not have content */ +#define HTTP_MOVEPERM 301 /**< the uri moved permanently */ +#define HTTP_MOVETEMP 302 /**< the uri moved temporarily */ +#define HTTP_NOTMODIFIED 304 /**< page was not modified from last */ +#define HTTP_BADREQUEST 400 /**< invalid http request was made */ +#define HTTP_NOTFOUND 404 /**< could not find content for uri */ +#define HTTP_BADMETHOD 405 /**< method not allowed for this uri */ +#define HTTP_ENTITYTOOLARGE 413 /**< */ +#define HTTP_EXPECTATIONFAILED 417 /**< we can't handle this expectation */ +#define HTTP_INTERNAL 500 /**< internal error */ +#define HTTP_NOTIMPLEMENTED 501 /**< not implemented */ +#define HTTP_SERVUNAVAIL 503 /**< the server is not available */ + +struct evhttp; +struct evhttp_request; +struct evkeyvalq; +struct evhttp_bound_socket; +struct evconnlistener; +struct evdns_base; + +/** + * Create a new HTTP server. + * + * @param base (optional) the event base to receive the HTTP events + * @return a pointer to a newly initialized evhttp server structure + * @see evhttp_free() + */ +EVENT2_EXPORT_SYMBOL +struct evhttp *evhttp_new(struct event_base *base); + +/** + * Binds an HTTP server on the specified address and port. + * + * Can be called multiple times to bind the same http server + * to multiple different ports. + * + * @param http a pointer to an evhttp object + * @param address a string containing the IP address to listen(2) on + * @param port the port number to listen on + * @return 0 on success, -1 on failure. + * @see evhttp_accept_socket() + */ +EVENT2_EXPORT_SYMBOL +int evhttp_bind_socket(struct evhttp *http, const char *address, ev_uint16_t port); + +/** + * Like evhttp_bind_socket(), but returns a handle for referencing the socket. + * + * The returned pointer is not valid after \a http is freed. + * + * @param http a pointer to an evhttp object + * @param address a string containing the IP address to listen(2) on + * @param port the port number to listen on + * @return Handle for the socket on success, NULL on failure. + * @see evhttp_bind_socket(), evhttp_del_accept_socket() + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_bound_socket *evhttp_bind_socket_with_handle(struct evhttp *http, const char *address, ev_uint16_t port); + +/** + * Makes an HTTP server accept connections on the specified socket. + * + * This may be useful to create a socket and then fork multiple instances + * of an http server, or when a socket has been communicated via file + * descriptor passing in situations where an http servers does not have + * permissions to bind to a low-numbered port. + * + * Can be called multiple times to have the http server listen to + * multiple different sockets. + * + * @param http a pointer to an evhttp object + * @param fd a socket fd that is ready for accepting connections + * @return 0 on success, -1 on failure. + * @see evhttp_bind_socket() + */ +EVENT2_EXPORT_SYMBOL +int evhttp_accept_socket(struct evhttp *http, evutil_socket_t fd); + +/** + * Like evhttp_accept_socket(), but returns a handle for referencing the socket. + * + * The returned pointer is not valid after \a http is freed. + * + * @param http a pointer to an evhttp object + * @param fd a socket fd that is ready for accepting connections + * @return Handle for the socket on success, NULL on failure. + * @see evhttp_accept_socket(), evhttp_del_accept_socket() + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_bound_socket *evhttp_accept_socket_with_handle(struct evhttp *http, evutil_socket_t fd); + +/** + * The most low-level evhttp_bind/accept method: takes an evconnlistener, and + * returns an evhttp_bound_socket. The listener will be freed when the bound + * socket is freed. + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_bound_socket *evhttp_bind_listener(struct evhttp *http, struct evconnlistener *listener); + +/** + * Return the listener used to implement a bound socket. + */ +EVENT2_EXPORT_SYMBOL +struct evconnlistener *evhttp_bound_socket_get_listener(struct evhttp_bound_socket *bound); + +typedef void evhttp_bound_socket_foreach_fn(struct evhttp_bound_socket *, void *); +/** + * Applies the function specified in the first argument to all + * evhttp_bound_sockets associated with "http". The user must not + * attempt to free or remove any connections, sockets or listeners + * in the callback "function". + * + * @param http pointer to an evhttp object + * @param function function to apply to every bound socket + * @param argument pointer value passed to function for every socket iterated + */ +EVENT2_EXPORT_SYMBOL +void evhttp_foreach_bound_socket(struct evhttp *http, evhttp_bound_socket_foreach_fn *function, void *argument); + +/** + * Makes an HTTP server stop accepting connections on the specified socket + * + * This may be useful when a socket has been sent via file descriptor passing + * and is no longer needed by the current process. + * + * If you created this bound socket with evhttp_bind_socket_with_handle or + * evhttp_accept_socket_with_handle, this function closes the fd you provided. + * If you created this bound socket with evhttp_bind_listener, this function + * frees the listener you provided. + * + * \a bound_socket is an invalid pointer after this call returns. + * + * @param http a pointer to an evhttp object + * @param bound_socket a handle returned by evhttp_{bind,accept}_socket_with_handle + * @see evhttp_bind_socket_with_handle(), evhttp_accept_socket_with_handle() + */ +EVENT2_EXPORT_SYMBOL +void evhttp_del_accept_socket(struct evhttp *http, struct evhttp_bound_socket *bound_socket); + +/** + * Get the raw file descriptor referenced by an evhttp_bound_socket. + * + * @param bound_socket a handle returned by evhttp_{bind,accept}_socket_with_handle + * @return the file descriptor used by the bound socket + * @see evhttp_bind_socket_with_handle(), evhttp_accept_socket_with_handle() + */ +EVENT2_EXPORT_SYMBOL +evutil_socket_t evhttp_bound_socket_get_fd(struct evhttp_bound_socket *bound_socket); + +/** + * Free the previously created HTTP server. + * + * Works only if no requests are currently being served. + * + * @param http the evhttp server object to be freed + * @see evhttp_start() + */ +EVENT2_EXPORT_SYMBOL +void evhttp_free(struct evhttp* http); + +/** XXX Document. */ +EVENT2_EXPORT_SYMBOL +void evhttp_set_max_headers_size(struct evhttp* http, ev_ssize_t max_headers_size); +/** XXX Document. */ +EVENT2_EXPORT_SYMBOL +void evhttp_set_max_body_size(struct evhttp* http, ev_ssize_t max_body_size); + +/** + Set the value to use for the Content-Type header when none was provided. If + the content type string is NULL, the Content-Type header will not be + automatically added. + + @param http the http server on which to set the default content type + @param content_type the value for the Content-Type header +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_set_default_content_type(struct evhttp *http, + const char *content_type); + +/** + Sets the what HTTP methods are supported in requests accepted by this + server, and passed to user callbacks. + + If not supported they will generate a "405 Method not allowed" response. + + By default this includes the following methods: GET, POST, HEAD, PUT, DELETE + + @param http the http server on which to set the methods + @param methods bit mask constructed from evhttp_cmd_type values +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_set_allowed_methods(struct evhttp* http, ev_uint16_t methods); + +/** + Set a callback for a specified URI + + @param http the http sever on which to set the callback + @param path the path for which to invoke the callback + @param cb the callback function that gets invoked on requesting path + @param cb_arg an additional context argument for the callback + @return 0 on success, -1 if the callback existed already, -2 on failure +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_set_cb(struct evhttp *http, const char *path, + void (*cb)(struct evhttp_request *, void *), void *cb_arg); + +/** Removes the callback for a specified URI */ +EVENT2_EXPORT_SYMBOL +int evhttp_del_cb(struct evhttp *, const char *); + +/** + Set a callback for all requests that are not caught by specific callbacks + + Invokes the specified callback for all requests that do not match any of + the previously specified request paths. This is catchall for requests not + specifically configured with evhttp_set_cb(). + + @param http the evhttp server object for which to set the callback + @param cb the callback to invoke for any unmatched requests + @param arg an context argument for the callback +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_set_gencb(struct evhttp *http, + void (*cb)(struct evhttp_request *, void *), void *arg); + +/** + Set a callback used to create new bufferevents for connections + to a given evhttp object. + + You can use this to override the default bufferevent type -- for example, + to make this evhttp object use SSL bufferevents rather than unencrypted + ones. + + New bufferevents must be allocated with no fd set on them. + + @param http the evhttp server object for which to set the callback + @param cb the callback to invoke for incoming connections + @param arg an context argument for the callback + */ +EVENT2_EXPORT_SYMBOL +void evhttp_set_bevcb(struct evhttp *http, + struct bufferevent *(*cb)(struct event_base *, void *), void *arg); + +/** + Adds a virtual host to the http server. + + A virtual host is a newly initialized evhttp object that has request + callbacks set on it via evhttp_set_cb() or evhttp_set_gencb(). It + most not have any listing sockets associated with it. + + If the virtual host has not been removed by the time that evhttp_free() + is called on the main http server, it will be automatically freed, too. + + It is possible to have hierarchical vhosts. For example: A vhost + with the pattern *.example.com may have other vhosts with patterns + foo.example.com and bar.example.com associated with it. + + @param http the evhttp object to which to add a virtual host + @param pattern the glob pattern against which the hostname is matched. + The match is case insensitive and follows otherwise regular shell + matching. + @param vhost the virtual host to add the regular http server. + @return 0 on success, -1 on failure + @see evhttp_remove_virtual_host() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_add_virtual_host(struct evhttp* http, const char *pattern, + struct evhttp* vhost); + +/** + Removes a virtual host from the http server. + + @param http the evhttp object from which to remove the virtual host + @param vhost the virtual host to remove from the regular http server. + @return 0 on success, -1 on failure + @see evhttp_add_virtual_host() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_remove_virtual_host(struct evhttp* http, struct evhttp* vhost); + +/** + Add a server alias to an http object. The http object can be a virtual + host or the main server. + + @param http the evhttp object + @param alias the alias to add + @see evhttp_add_remove_alias() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_add_server_alias(struct evhttp *http, const char *alias); + +/** + Remove a server alias from an http object. + + @param http the evhttp object + @param alias the alias to remove + @see evhttp_add_server_alias() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_remove_server_alias(struct evhttp *http, const char *alias); + +/** + * Set the timeout for an HTTP request. + * + * @param http an evhttp object + * @param timeout_in_secs the timeout, in seconds + */ +EVENT2_EXPORT_SYMBOL +void evhttp_set_timeout(struct evhttp *http, int timeout_in_secs); + +/** + * Set the timeout for an HTTP request. + * + * @param http an evhttp object + * @param tv the timeout, or NULL + */ +EVENT2_EXPORT_SYMBOL +void evhttp_set_timeout_tv(struct evhttp *http, const struct timeval* tv); + +/* Read all the clients body, and only after this respond with an error if the + * clients body exceed max_body_size */ +#define EVHTTP_SERVER_LINGERING_CLOSE 0x0001 +/** + * Set connection flags for HTTP server. + * + * @see EVHTTP_SERVER_* + * @return 0 on success, otherwise non zero (for example if flag doesn't + * supported). + */ +EVENT2_EXPORT_SYMBOL +int evhttp_set_flags(struct evhttp *http, int flags); + +/* Request/Response functionality */ + +/** + * Send an HTML error message to the client. + * + * @param req a request object + * @param error the HTTP error code + * @param reason a brief explanation of the error. If this is NULL, we'll + * just use the standard meaning of the error code. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_send_error(struct evhttp_request *req, int error, + const char *reason); + +/** + * Send an HTML reply to the client. + * + * The body of the reply consists of the data in databuf. After calling + * evhttp_send_reply() databuf will be empty, but the buffer is still + * owned by the caller and needs to be deallocated by the caller if + * necessary. + * + * @param req a request object + * @param code the HTTP response code to send + * @param reason a brief message to send with the response code + * @param databuf the body of the response + */ +EVENT2_EXPORT_SYMBOL +void evhttp_send_reply(struct evhttp_request *req, int code, + const char *reason, struct evbuffer *databuf); + +/* Low-level response interface, for streaming/chunked replies */ + +/** + Initiate a reply that uses Transfer-Encoding chunked. + + This allows the caller to stream the reply back to the client and is + useful when either not all of the reply data is immediately available + or when sending very large replies. + + The caller needs to supply data chunks with evhttp_send_reply_chunk() + and complete the reply by calling evhttp_send_reply_end(). + + @param req a request object + @param code the HTTP response code to send + @param reason a brief message to send with the response code +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_send_reply_start(struct evhttp_request *req, int code, + const char *reason); + +/** + Send another data chunk as part of an ongoing chunked reply. + + The reply chunk consists of the data in databuf. After calling + evhttp_send_reply_chunk() databuf will be empty, but the buffer is + still owned by the caller and needs to be deallocated by the caller + if necessary. + + @param req a request object + @param databuf the data chunk to send as part of the reply. +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_send_reply_chunk(struct evhttp_request *req, + struct evbuffer *databuf); + +/** + Send another data chunk as part of an ongoing chunked reply. + + The reply chunk consists of the data in databuf. After calling + evhttp_send_reply_chunk() databuf will be empty, but the buffer is + still owned by the caller and needs to be deallocated by the caller + if necessary. + + @param req a request object + @param databuf the data chunk to send as part of the reply. + @param cb callback funcion + @param call back's argument. +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_send_reply_chunk_with_cb(struct evhttp_request *, struct evbuffer *, + void (*cb)(struct evhttp_connection *, void *), void *arg); + +/** + Complete a chunked reply, freeing the request as appropriate. + + @param req a request object +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_send_reply_end(struct evhttp_request *req); + +/* + * Interfaces for making requests + */ + +/** The different request types supported by evhttp. These are as specified + * in RFC2616, except for PATCH which is specified by RFC5789. + * + * By default, only some of these methods are accepted and passed to user + * callbacks; use evhttp_set_allowed_methods() to change which methods + * are allowed. + */ +enum evhttp_cmd_type { + EVHTTP_REQ_GET = 1 << 0, + EVHTTP_REQ_POST = 1 << 1, + EVHTTP_REQ_HEAD = 1 << 2, + EVHTTP_REQ_PUT = 1 << 3, + EVHTTP_REQ_DELETE = 1 << 4, + EVHTTP_REQ_OPTIONS = 1 << 5, + EVHTTP_REQ_TRACE = 1 << 6, + EVHTTP_REQ_CONNECT = 1 << 7, + EVHTTP_REQ_PATCH = 1 << 8 +}; + +/** a request object can represent either a request or a reply */ +enum evhttp_request_kind { EVHTTP_REQUEST, EVHTTP_RESPONSE }; + +/** + * Create and return a connection object that can be used to for making HTTP + * requests. The connection object tries to resolve address and establish the + * connection when it is given an http request object. + * + * @param base the event_base to use for handling the connection + * @param dnsbase the dns_base to use for resolving host names; if not + * specified host name resolution will block. + * @param bev a bufferevent to use for connecting to the server; if NULL, a + * socket-based bufferevent will be created. This buffrevent will be freed + * when the connection closes. It must have no fd set on it. + * @param address the address to which to connect + * @param port the port to connect to + * @return an evhttp_connection object that can be used for making requests + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_connection *evhttp_connection_base_bufferevent_new( + struct event_base *base, struct evdns_base *dnsbase, struct bufferevent* bev, const char *address, ev_uint16_t port); + +/** + * Return the bufferevent that an evhttp_connection is using. + */ +EVENT2_EXPORT_SYMBOL +struct bufferevent* evhttp_connection_get_bufferevent(struct evhttp_connection *evcon); + +/** + * Return the HTTP server associated with this connection, or NULL. + */ +EVENT2_EXPORT_SYMBOL +struct evhttp *evhttp_connection_get_server(struct evhttp_connection *evcon); + +/** + * Creates a new request object that needs to be filled in with the request + * parameters. The callback is executed when the request completed or an + * error occurred. + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_request *evhttp_request_new( + void (*cb)(struct evhttp_request *, void *), void *arg); + +/** + * Enable delivery of chunks to requestor. + * @param cb will be called after every read of data with the same argument + * as the completion callback. Will never be called on an empty + * response. May drain the input buffer; it will be drained + * automatically on return. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_request_set_chunked_cb(struct evhttp_request *, + void (*cb)(struct evhttp_request *, void *)); + +/** + * Register callback for additional parsing of request headers. + * @param cb will be called after receiving and parsing the full header. + * It allows analyzing the header and possibly closing the connection + * by returning a value < 0. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_request_set_header_cb(struct evhttp_request *, + int (*cb)(struct evhttp_request *, void *)); + +/** + * The different error types supported by evhttp + * + * @see evhttp_request_set_error_cb() + */ +enum evhttp_request_error { + /** + * Timeout reached, also @see evhttp_connection_set_timeout() + */ + EVREQ_HTTP_TIMEOUT, + /** + * EOF reached + */ + EVREQ_HTTP_EOF, + /** + * Error while reading header, or invalid header + */ + EVREQ_HTTP_INVALID_HEADER, + /** + * Error encountered while reading or writing + */ + EVREQ_HTTP_BUFFER_ERROR, + /** + * The evhttp_cancel_request() called on this request. + */ + EVREQ_HTTP_REQUEST_CANCEL, + /** + * Body is greater then evhttp_connection_set_max_body_size() + */ + EVREQ_HTTP_DATA_TOO_LONG +}; +/** + * Set a callback for errors + * @see evhttp_request_error for error types. + * + * On error, both the error callback and the regular callback will be called, + * error callback is called before the regular callback. + **/ +EVENT2_EXPORT_SYMBOL +void evhttp_request_set_error_cb(struct evhttp_request *, + void (*)(enum evhttp_request_error, void *)); + +/** + * Set a callback to be called on request completion of evhttp_send_* function. + * + * The callback function will be called on the completion of the request after + * the output data has been written and before the evhttp_request object + * is destroyed. This can be useful for tracking resources associated with a + * request (ex: timing metrics). + * + * @param req a request object + * @param cb callback function that will be called on request completion + * @param cb_arg an additional context argument for the callback + */ +EVENT2_EXPORT_SYMBOL +void evhttp_request_set_on_complete_cb(struct evhttp_request *req, + void (*cb)(struct evhttp_request *, void *), void *cb_arg); + +/** Frees the request object and removes associated events. */ +EVENT2_EXPORT_SYMBOL +void evhttp_request_free(struct evhttp_request *req); + +/** + * Create and return a connection object that can be used to for making HTTP + * requests. The connection object tries to resolve address and establish the + * connection when it is given an http request object. + * + * @param base the event_base to use for handling the connection + * @param dnsbase the dns_base to use for resolving host names; if not + * specified host name resolution will block. + * @param address the address to which to connect + * @param port the port to connect to + * @return an evhttp_connection object that can be used for making requests + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_connection *evhttp_connection_base_new( + struct event_base *base, struct evdns_base *dnsbase, + const char *address, ev_uint16_t port); + +/** + * Set family hint for DNS requests. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_family(struct evhttp_connection *evcon, + int family); + +/* reuse connection address on retry */ +#define EVHTTP_CON_REUSE_CONNECTED_ADDR 0x0008 +/* Try to read error, since server may already send and close + * connection, but if at that time we have some data to send then we + * can send get EPIPE and fail, while we can read that HTTP error. */ +#define EVHTTP_CON_READ_ON_WRITE_ERROR 0x0010 +/* @see EVHTTP_SERVER_LINGERING_CLOSE */ +#define EVHTTP_CON_LINGERING_CLOSE 0x0020 +/* Padding for public flags, @see EVHTTP_CON_* in http-internal.h */ +#define EVHTTP_CON_PUBLIC_FLAGS_END 0x100000 +/** + * Set connection flags. + * + * @see EVHTTP_CON_* + * @return 0 on success, otherwise non zero (for example if flag doesn't + * supported). + */ +EVENT2_EXPORT_SYMBOL +int evhttp_connection_set_flags(struct evhttp_connection *evcon, + int flags); + +/** Takes ownership of the request object + * + * Can be used in a request callback to keep onto the request until + * evhttp_request_free() is explicitly called by the user. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_request_own(struct evhttp_request *req); + +/** Returns 1 if the request is owned by the user */ +EVENT2_EXPORT_SYMBOL +int evhttp_request_is_owned(struct evhttp_request *req); + +/** + * Returns the connection object associated with the request or NULL + * + * The user needs to either free the request explicitly or call + * evhttp_send_reply_end(). + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_connection *evhttp_request_get_connection(struct evhttp_request *req); + +/** + * Returns the underlying event_base for this connection + */ +EVENT2_EXPORT_SYMBOL +struct event_base *evhttp_connection_get_base(struct evhttp_connection *req); + +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_max_headers_size(struct evhttp_connection *evcon, + ev_ssize_t new_max_headers_size); + +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_max_body_size(struct evhttp_connection* evcon, + ev_ssize_t new_max_body_size); + +/** Frees an http connection */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_free(struct evhttp_connection *evcon); + +/** Disowns a given connection object + * + * Can be used to tell libevent to free the connection object after + * the last request has completed or failed. + */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_free_on_completion(struct evhttp_connection *evcon); + +/** sets the ip address from which http connections are made */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_local_address(struct evhttp_connection *evcon, + const char *address); + +/** sets the local port from which http connections are made */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_local_port(struct evhttp_connection *evcon, + ev_uint16_t port); + +/** Sets the timeout in seconds for events related to this connection */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_timeout(struct evhttp_connection *evcon, + int timeout_in_secs); + +/** Sets the timeout for events related to this connection. Takes a struct + * timeval. */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_timeout_tv(struct evhttp_connection *evcon, + const struct timeval *tv); + +/** Sets the delay before retrying requests on this connection. This is only + * used if evhttp_connection_set_retries is used to make the number of retries + * at least one. Each retry after the first is twice as long as the one before + * it. */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_initial_retry_tv(struct evhttp_connection *evcon, + const struct timeval *tv); + +/** Sets the retry limit for this connection - -1 repeats indefinitely */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_retries(struct evhttp_connection *evcon, + int retry_max); + +/** Set a callback for connection close. */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_set_closecb(struct evhttp_connection *evcon, + void (*)(struct evhttp_connection *, void *), void *); + +/** Get the remote address and port associated with this connection. */ +EVENT2_EXPORT_SYMBOL +void evhttp_connection_get_peer(struct evhttp_connection *evcon, + char **address, ev_uint16_t *port); + +/** Get the remote address associated with this connection. + * extracted from getpeername() OR from nameserver. + * + * @return NULL if getpeername() return non success, + * or connection is not connected, + * otherwise it return pointer to struct sockaddr_storage */ +EVENT2_EXPORT_SYMBOL +const struct sockaddr* +evhttp_connection_get_addr(struct evhttp_connection *evcon); + +/** + Make an HTTP request over the specified connection. + + The connection gets ownership of the request. On failure, the + request object is no longer valid as it has been freed. + + @param evcon the evhttp_connection object over which to send the request + @param req the previously created and configured request object + @param type the request type EVHTTP_REQ_GET, EVHTTP_REQ_POST, etc. + @param uri the URI associated with the request + @return 0 on success, -1 on failure + @see evhttp_cancel_request() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_make_request(struct evhttp_connection *evcon, + struct evhttp_request *req, + enum evhttp_cmd_type type, const char *uri); + +/** + Cancels a pending HTTP request. + + Cancels an ongoing HTTP request. The callback associated with this request + is not executed and the request object is freed. If the request is + currently being processed, e.g. it is ongoing, the corresponding + evhttp_connection object is going to get reset. + + A request cannot be canceled if its callback has executed already. A request + may be canceled reentrantly from its chunked callback. + + @param req the evhttp_request to cancel; req becomes invalid after this call. +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_cancel_request(struct evhttp_request *req); + +/** + * A structure to hold a parsed URI or Relative-Ref conforming to RFC3986. + */ +struct evhttp_uri; + +/** Returns the request URI */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_request_get_uri(const struct evhttp_request *req); +/** Returns the request URI (parsed) */ +EVENT2_EXPORT_SYMBOL +const struct evhttp_uri *evhttp_request_get_evhttp_uri(const struct evhttp_request *req); +/** Returns the request command */ +EVENT2_EXPORT_SYMBOL +enum evhttp_cmd_type evhttp_request_get_command(const struct evhttp_request *req); + +EVENT2_EXPORT_SYMBOL +int evhttp_request_get_response_code(const struct evhttp_request *req); +EVENT2_EXPORT_SYMBOL +const char * evhttp_request_get_response_code_line(const struct evhttp_request *req); + +/** Returns the input headers */ +EVENT2_EXPORT_SYMBOL +struct evkeyvalq *evhttp_request_get_input_headers(struct evhttp_request *req); +/** Returns the output headers */ +EVENT2_EXPORT_SYMBOL +struct evkeyvalq *evhttp_request_get_output_headers(struct evhttp_request *req); +/** Returns the input buffer */ +EVENT2_EXPORT_SYMBOL +struct evbuffer *evhttp_request_get_input_buffer(struct evhttp_request *req); +/** Returns the output buffer */ +EVENT2_EXPORT_SYMBOL +struct evbuffer *evhttp_request_get_output_buffer(struct evhttp_request *req); +/** Returns the host associated with the request. If a client sends an absolute + URI, the host part of that is preferred. Otherwise, the input headers are + searched for a Host: header. NULL is returned if no absolute URI or Host: + header is provided. */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_request_get_host(struct evhttp_request *req); + +/* Interfaces for dealing with HTTP headers */ + +/** + Finds the value belonging to a header. + + @param headers the evkeyvalq object in which to find the header + @param key the name of the header to find + @returns a pointer to the value for the header or NULL if the header + could not be found. + @see evhttp_add_header(), evhttp_remove_header() +*/ +EVENT2_EXPORT_SYMBOL +const char *evhttp_find_header(const struct evkeyvalq *headers, + const char *key); + +/** + Removes a header from a list of existing headers. + + @param headers the evkeyvalq object from which to remove a header + @param key the name of the header to remove + @returns 0 if the header was removed, -1 otherwise. + @see evhttp_find_header(), evhttp_add_header() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_remove_header(struct evkeyvalq *headers, const char *key); + +/** + Adds a header to a list of existing headers. + + @param headers the evkeyvalq object to which to add a header + @param key the name of the header + @param value the value belonging to the header + @returns 0 on success, -1 otherwise. + @see evhttp_find_header(), evhttp_clear_headers() +*/ +EVENT2_EXPORT_SYMBOL +int evhttp_add_header(struct evkeyvalq *headers, const char *key, const char *value); + +/** + Removes all headers from the header list. + + @param headers the evkeyvalq object from which to remove all headers +*/ +EVENT2_EXPORT_SYMBOL +void evhttp_clear_headers(struct evkeyvalq *headers); + +/* Miscellaneous utility functions */ + + +/** + Helper function to encode a string for inclusion in a URI. All + characters are replaced by their hex-escaped (%22) equivalents, + except for characters explicitly unreserved by RFC3986 -- that is, + ASCII alphanumeric characters, hyphen, dot, underscore, and tilde. + + The returned string must be freed by the caller. + + @param str an unencoded string + @return a newly allocated URI-encoded string or NULL on failure + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_encode_uri(const char *str); + +/** + As evhttp_encode_uri, but if 'size' is nonnegative, treat the string + as being 'size' bytes long. This allows you to encode strings that + may contain 0-valued bytes. + + The returned string must be freed by the caller. + + @param str an unencoded string + @param size the length of the string to encode, or -1 if the string + is NUL-terminated + @param space_to_plus if true, space characters in 'str' are encoded + as +, not %20. + @return a newly allocate URI-encoded string, or NULL on failure. + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_uriencode(const char *str, ev_ssize_t size, int space_to_plus); + +/** + Helper function to sort of decode a URI-encoded string. Unlike + evhttp_get_decoded_uri, it decodes all plus characters that appear + _after_ the first question mark character, but no plusses that occur + before. This is not a good way to decode URIs in whole or in part. + + The returned string must be freed by the caller + + @deprecated This function is deprecated; you probably want to use + evhttp_get_decoded_uri instead. + + @param uri an encoded URI + @return a newly allocated unencoded URI or NULL on failure + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_decode_uri(const char *uri); + +/** + Helper function to decode a URI-escaped string or HTTP parameter. + + If 'decode_plus' is 1, then we decode the string as an HTTP parameter + value, and convert all plus ('+') characters to spaces. If + 'decode_plus' is 0, we leave all plus characters unchanged. + + The returned string must be freed by the caller. + + @param uri a URI-encode encoded URI + @param decode_plus determines whether we convert '+' to space. + @param size_out if size_out is not NULL, *size_out is set to the size of the + returned string + @return a newly allocated unencoded URI or NULL on failure + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_uridecode(const char *uri, int decode_plus, + size_t *size_out); + +/** + Helper function to parse out arguments in a query. + + Parsing a URI like + + http://foo.com/?q=test&s=some+thing + + will result in two entries in the key value queue. + + The first entry is: key="q", value="test" + The second entry is: key="s", value="some thing" + + @deprecated This function is deprecated as of Libevent 2.0.9. Use + evhttp_uri_parse and evhttp_parse_query_str instead. + + @param uri the request URI + @param headers the head of the evkeyval queue + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evhttp_parse_query(const char *uri, struct evkeyvalq *headers); + +/** + Helper function to parse out arguments from the query portion of an + HTTP URI. + + Parsing a query string like + + q=test&s=some+thing + + will result in two entries in the key value queue. + + The first entry is: key="q", value="test" + The second entry is: key="s", value="some thing" + + @param query_parse the query portion of the URI + @param headers the head of the evkeyval queue + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evhttp_parse_query_str(const char *uri, struct evkeyvalq *headers); + +/** + * Escape HTML character entities in a string. + * + * Replaces <, >, ", ' and & with <, >, ", + * ' and & correspondingly. + * + * The returned string needs to be freed by the caller. + * + * @param html an unescaped HTML string + * @return an escaped HTML string or NULL on error + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_htmlescape(const char *html); + +/** + * Return a new empty evhttp_uri with no fields set. + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_uri *evhttp_uri_new(void); + +/** + * Changes the flags set on a given URI. See EVHTTP_URI_* for + * a list of flags. + **/ +EVENT2_EXPORT_SYMBOL +void evhttp_uri_set_flags(struct evhttp_uri *uri, unsigned flags); + +/** Return the scheme of an evhttp_uri, or NULL if there is no scheme has + * been set and the evhttp_uri contains a Relative-Ref. */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_scheme(const struct evhttp_uri *uri); +/** + * Return the userinfo part of an evhttp_uri, or NULL if it has no userinfo + * set. + */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_userinfo(const struct evhttp_uri *uri); +/** + * Return the host part of an evhttp_uri, or NULL if it has no host set. + * The host may either be a regular hostname (conforming to the RFC 3986 + * "regname" production), or an IPv4 address, or the empty string, or a + * bracketed IPv6 address, or a bracketed 'IP-Future' address. + * + * Note that having a NULL host means that the URI has no authority + * section, but having an empty-string host means that the URI has an + * authority section with no host part. For example, + * "mailto:user@example.com" has a host of NULL, but "file:///etc/motd" + * has a host of "". + */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_host(const struct evhttp_uri *uri); +/** Return the port part of an evhttp_uri, or -1 if there is no port set. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_get_port(const struct evhttp_uri *uri); +/** Return the path part of an evhttp_uri, or NULL if it has no path set */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_path(const struct evhttp_uri *uri); +/** Return the query part of an evhttp_uri (excluding the leading "?"), or + * NULL if it has no query set */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_query(const struct evhttp_uri *uri); +/** Return the fragment part of an evhttp_uri (excluding the leading "#"), + * or NULL if it has no fragment set */ +EVENT2_EXPORT_SYMBOL +const char *evhttp_uri_get_fragment(const struct evhttp_uri *uri); + +/** Set the scheme of an evhttp_uri, or clear the scheme if scheme==NULL. + * Returns 0 on success, -1 if scheme is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_scheme(struct evhttp_uri *uri, const char *scheme); +/** Set the userinfo of an evhttp_uri, or clear the userinfo if userinfo==NULL. + * Returns 0 on success, -1 if userinfo is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_userinfo(struct evhttp_uri *uri, const char *userinfo); +/** Set the host of an evhttp_uri, or clear the host if host==NULL. + * Returns 0 on success, -1 if host is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_host(struct evhttp_uri *uri, const char *host); +/** Set the port of an evhttp_uri, or clear the port if port==-1. + * Returns 0 on success, -1 if port is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_port(struct evhttp_uri *uri, int port); +/** Set the path of an evhttp_uri, or clear the path if path==NULL. + * Returns 0 on success, -1 if path is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_path(struct evhttp_uri *uri, const char *path); +/** Set the query of an evhttp_uri, or clear the query if query==NULL. + * The query should not include a leading "?". + * Returns 0 on success, -1 if query is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_query(struct evhttp_uri *uri, const char *query); +/** Set the fragment of an evhttp_uri, or clear the fragment if fragment==NULL. + * The fragment should not include a leading "#". + * Returns 0 on success, -1 if fragment is not well-formed. */ +EVENT2_EXPORT_SYMBOL +int evhttp_uri_set_fragment(struct evhttp_uri *uri, const char *fragment); + +/** + * Helper function to parse a URI-Reference as specified by RFC3986. + * + * This function matches the URI-Reference production from RFC3986, + * which includes both URIs like + * + * scheme://[[userinfo]@]foo.com[:port]]/[path][?query][#fragment] + * + * and relative-refs like + * + * [path][?query][#fragment] + * + * Any optional elements portions not present in the original URI are + * left set to NULL in the resulting evhttp_uri. If no port is + * specified, the port is set to -1. + * + * Note that no decoding is performed on percent-escaped characters in + * the string; if you want to parse them, use evhttp_uridecode or + * evhttp_parse_query_str as appropriate. + * + * Note also that most URI schemes will have additional constraints that + * this function does not know about, and cannot check. For example, + * mailto://www.example.com/cgi-bin/fortune.pl is not a reasonable + * mailto url, http://www.example.com:99999/ is not a reasonable HTTP + * URL, and ftp:username@example.com is not a reasonable FTP URL. + * Nevertheless, all of these URLs conform to RFC3986, and this function + * accepts all of them as valid. + * + * @param source_uri the request URI + * @param flags Zero or more EVHTTP_URI_* flags to affect the behavior + * of the parser. + * @return uri container to hold parsed data, or NULL if there is error + * @see evhttp_uri_free() + */ +EVENT2_EXPORT_SYMBOL +struct evhttp_uri *evhttp_uri_parse_with_flags(const char *source_uri, + unsigned flags); + +/** Tolerate URIs that do not conform to RFC3986. + * + * Unfortunately, some HTTP clients generate URIs that, according to RFC3986, + * are not conformant URIs. If you need to support these URIs, you can + * do so by passing this flag to evhttp_uri_parse_with_flags. + * + * Currently, these changes are: + *
    + *
  • Nonconformant URIs are allowed to contain otherwise unreasonable + * characters in their path, query, and fragment components. + *
+ */ +#define EVHTTP_URI_NONCONFORMANT 0x01 + +/** Alias for evhttp_uri_parse_with_flags(source_uri, 0) */ +EVENT2_EXPORT_SYMBOL +struct evhttp_uri *evhttp_uri_parse(const char *source_uri); + +/** + * Free all memory allocated for a parsed uri. Only use this for URIs + * generated by evhttp_uri_parse. + * + * @param uri container with parsed data + * @see evhttp_uri_parse() + */ +EVENT2_EXPORT_SYMBOL +void evhttp_uri_free(struct evhttp_uri *uri); + +/** + * Join together the uri parts from parsed data to form a URI-Reference. + * + * Note that no escaping of reserved characters is done on the members + * of the evhttp_uri, so the generated string might not be a valid URI + * unless the members of evhttp_uri are themselves valid. + * + * @param uri container with parsed data + * @param buf destination buffer + * @param limit destination buffer size + * @return an joined uri as string or NULL on error + * @see evhttp_uri_parse() + */ +EVENT2_EXPORT_SYMBOL +char *evhttp_uri_join(struct evhttp_uri *uri, char *buf, size_t limit); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_HTTP_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/http_compat.h b/Source/Import/libevent/Includes/Windows/event2/http_compat.h new file mode 100644 index 0000000..43c2c43 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/http_compat.h @@ -0,0 +1,90 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_HTTP_COMPAT_H_INCLUDED_ +#define EVENT2_HTTP_COMPAT_H_INCLUDED_ + +/** @file event2/http_compat.h + + Potentially non-threadsafe versions of the functions in http.h: provided + only for backwards compatibility. + + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/** + * Start an HTTP server on the specified address and port + * + * @deprecated It does not allow an event base to be specified + * + * @param address the address to which the HTTP server should be bound + * @param port the port number on which the HTTP server should listen + * @return an struct evhttp object + */ +struct evhttp *evhttp_start(const char *address, ev_uint16_t port); + +/** + * A connection object that can be used to for making HTTP requests. The + * connection object tries to establish the connection when it is given an + * http request object. + * + * @deprecated It does not allow an event base to be specified + */ +struct evhttp_connection *evhttp_connection_new( + const char *address, ev_uint16_t port); + +/** + * Associates an event base with the connection - can only be called + * on a freshly created connection object that has not been used yet. + * + * @deprecated XXXX Why? + */ +void evhttp_connection_set_base(struct evhttp_connection *evcon, + struct event_base *base); + + +/** Returns the request URI */ +#define evhttp_request_uri evhttp_request_get_uri + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_COMPAT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/http_struct.h b/Source/Import/libevent/Includes/Windows/event2/http_struct.h new file mode 100644 index 0000000..4bf5b1f --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/http_struct.h @@ -0,0 +1,152 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_HTTP_STRUCT_H_INCLUDED_ +#define EVENT2_HTTP_STRUCT_H_INCLUDED_ + +/** @file event2/http_struct.h + + Data structures for http. Using these structures may hurt forward + compatibility with later versions of Libevent: be careful! + + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +/** + * the request structure that a server receives. + * WARNING: expect this structure to change. I will try to provide + * reasonable accessors. + */ +struct evhttp_request { +#if defined(TAILQ_ENTRY) + TAILQ_ENTRY(evhttp_request) next; +#else +struct { + struct evhttp_request *tqe_next; + struct evhttp_request **tqe_prev; +} next; +#endif + + /* the connection object that this request belongs to */ + struct evhttp_connection *evcon; + int flags; +/** The request obj owns the evhttp connection and needs to free it */ +#define EVHTTP_REQ_OWN_CONNECTION 0x0001 +/** Request was made via a proxy */ +#define EVHTTP_PROXY_REQUEST 0x0002 +/** The request object is owned by the user; the user must free it */ +#define EVHTTP_USER_OWNED 0x0004 +/** The request will be used again upstack; freeing must be deferred */ +#define EVHTTP_REQ_DEFER_FREE 0x0008 +/** The request should be freed upstack */ +#define EVHTTP_REQ_NEEDS_FREE 0x0010 + + struct evkeyvalq *input_headers; + struct evkeyvalq *output_headers; + + /* address of the remote host and the port connection came from */ + char *remote_host; + ev_uint16_t remote_port; + + /* cache of the hostname for evhttp_request_get_host */ + char *host_cache; + + enum evhttp_request_kind kind; + enum evhttp_cmd_type type; + + size_t headers_size; + size_t body_size; + + char *uri; /* uri after HTTP request was parsed */ + struct evhttp_uri *uri_elems; /* uri elements */ + + char major; /* HTTP Major number */ + char minor; /* HTTP Minor number */ + + int response_code; /* HTTP Response code */ + char *response_code_line; /* Readable response */ + + struct evbuffer *input_buffer; /* read data */ + ev_int64_t ntoread; + unsigned chunked:1, /* a chunked request */ + userdone:1; /* the user has sent all data */ + + struct evbuffer *output_buffer; /* outgoing post or data */ + + /* Callback */ + void (*cb)(struct evhttp_request *, void *); + void *cb_arg; + + /* + * Chunked data callback - call for each completed chunk if + * specified. If not specified, all the data is delivered via + * the regular callback. + */ + void (*chunk_cb)(struct evhttp_request *, void *); + + /* + * Callback added for forked-daapd so they can collect ICY + * (shoutcast) metadata from the http header. If return + * int is negative the connection will be closed. + */ + int (*header_cb)(struct evhttp_request *, void *); + + /* + * Error callback - called when error is occured. + * @see evhttp_request_error for error types. + * + * @see evhttp_request_set_error_cb() + */ + void (*error_cb)(enum evhttp_request_error, void *); + + /* + * Send complete callback - called when the request is actually + * sent and completed. + */ + void (*on_complete_cb)(struct evhttp_request *, void *); + void *on_complete_cb_arg; +}; + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_HTTP_STRUCT_H_INCLUDED_ */ + diff --git a/Source/Import/libevent/Includes/Windows/event2/keyvalq_struct.h b/Source/Import/libevent/Includes/Windows/event2/keyvalq_struct.h new file mode 100644 index 0000000..bffa54b --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/keyvalq_struct.h @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_KEYVALQ_STRUCT_H_INCLUDED_ +#define EVENT2_KEYVALQ_STRUCT_H_INCLUDED_ + +#ifdef __cplusplus +extern "C" { +#endif + +/* Fix so that people don't have to run with */ +/* XXXX This code is duplicated with event_struct.h */ +#ifndef TAILQ_ENTRY +#define EVENT_DEFINED_TQENTRY_ +#define TAILQ_ENTRY(type) \ +struct { \ + struct type *tqe_next; /* next element */ \ + struct type **tqe_prev; /* address of previous next element */ \ +} +#endif /* !TAILQ_ENTRY */ + +#ifndef TAILQ_HEAD +#define EVENT_DEFINED_TQHEAD_ +#define TAILQ_HEAD(name, type) \ +struct name { \ + struct type *tqh_first; \ + struct type **tqh_last; \ +} +#endif + +/* + * Key-Value pairs. Can be used for HTTP headers but also for + * query argument parsing. + */ +struct evkeyval { + TAILQ_ENTRY(evkeyval) next; + + char *key; + char *value; +}; + +TAILQ_HEAD (evkeyvalq, evkeyval); + +/* XXXX This code is duplicated with event_struct.h */ +#ifdef EVENT_DEFINED_TQENTRY_ +#undef TAILQ_ENTRY +#endif + +#ifdef EVENT_DEFINED_TQHEAD_ +#undef TAILQ_HEAD +#endif + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/libevent/Includes/Windows/event2/listener.h b/Source/Import/libevent/Includes/Windows/event2/listener.h new file mode 100644 index 0000000..84b4da0 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/listener.h @@ -0,0 +1,180 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_LISTENER_H_INCLUDED_ +#define EVENT2_LISTENER_H_INCLUDED_ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +struct sockaddr; +struct evconnlistener; + +/** + A callback that we invoke when a listener has a new connection. + + @param listener The evconnlistener + @param fd The new file descriptor + @param addr The source address of the connection + @param socklen The length of addr + @param user_arg the pointer passed to evconnlistener_new() + */ +typedef void (*evconnlistener_cb)(struct evconnlistener *, evutil_socket_t, struct sockaddr *, int socklen, void *); + +/** + A callback that we invoke when a listener encounters a non-retriable error. + + @param listener The evconnlistener + @param user_arg the pointer passed to evconnlistener_new() + */ +typedef void (*evconnlistener_errorcb)(struct evconnlistener *, void *); + +/** Flag: Indicates that we should not make incoming sockets nonblocking + * before passing them to the callback. */ +#define LEV_OPT_LEAVE_SOCKETS_BLOCKING (1u<<0) +/** Flag: Indicates that freeing the listener should close the underlying + * socket. */ +#define LEV_OPT_CLOSE_ON_FREE (1u<<1) +/** Flag: Indicates that we should set the close-on-exec flag, if possible */ +#define LEV_OPT_CLOSE_ON_EXEC (1u<<2) +/** Flag: Indicates that we should disable the timeout (if any) between when + * this socket is closed and when we can listen again on the same port. */ +#define LEV_OPT_REUSEABLE (1u<<3) +/** Flag: Indicates that the listener should be locked so it's safe to use + * from multiple threadcs at once. */ +#define LEV_OPT_THREADSAFE (1u<<4) +/** Flag: Indicates that the listener should be created in disabled + * state. Use evconnlistener_enable() to enable it later. */ +#define LEV_OPT_DISABLED (1u<<5) +/** Flag: Indicates that the listener should defer accept() until data is + * available, if possible. Ignored on platforms that do not support this. + * + * This option can help performance for protocols where the client transmits + * immediately after connecting. Do not use this option if your protocol + * _doesn't_ start out with the client transmitting data, since in that case + * this option will sometimes cause the kernel to never tell you about the + * connection. + * + * This option is only supported by evconnlistener_new_bind(): it can't + * work with evconnlistener_new_fd(), since the listener needs to be told + * to use the option before it is actually bound. + */ +#define LEV_OPT_DEFERRED_ACCEPT (1u<<6) +/** Flag: Indicates that we ask to allow multiple servers (processes or + * threads) to bind to the same port if they each set the option. + * + * SO_REUSEPORT is what most people would expect SO_REUSEADDR to be, however + * SO_REUSEPORT does not imply SO_REUSEADDR. + * + * This is only available on Linux and kernel 3.9+ + */ +#define LEV_OPT_REUSEABLE_PORT (1u<<7) + +/** + Allocate a new evconnlistener object to listen for incoming TCP connections + on a given file descriptor. + + @param base The event base to associate the listener with. + @param cb A callback to be invoked when a new connection arrives. If the + callback is NULL, the listener will be treated as disabled until the + callback is set. + @param ptr A user-supplied pointer to give to the callback. + @param flags Any number of LEV_OPT_* flags + @param backlog Passed to the listen() call to determine the length of the + acceptable connection backlog. Set to -1 for a reasonable default. + Set to 0 if the socket is already listening. + @param fd The file descriptor to listen on. It must be a nonblocking + file descriptor, and it should already be bound to an appropriate + port and address. +*/ +EVENT2_EXPORT_SYMBOL +struct evconnlistener *evconnlistener_new(struct event_base *base, + evconnlistener_cb cb, void *ptr, unsigned flags, int backlog, + evutil_socket_t fd); +/** + Allocate a new evconnlistener object to listen for incoming TCP connections + on a given address. + + @param base The event base to associate the listener with. + @param cb A callback to be invoked when a new connection arrives. If the + callback is NULL, the listener will be treated as disabled until the + callback is set. + @param ptr A user-supplied pointer to give to the callback. + @param flags Any number of LEV_OPT_* flags + @param backlog Passed to the listen() call to determine the length of the + acceptable connection backlog. Set to -1 for a reasonable default. + @param addr The address to listen for connections on. + @param socklen The length of the address. + */ +EVENT2_EXPORT_SYMBOL +struct evconnlistener *evconnlistener_new_bind(struct event_base *base, + evconnlistener_cb cb, void *ptr, unsigned flags, int backlog, + const struct sockaddr *sa, int socklen); +/** + Disable and deallocate an evconnlistener. + */ +EVENT2_EXPORT_SYMBOL +void evconnlistener_free(struct evconnlistener *lev); +/** + Re-enable an evconnlistener that has been disabled. + */ +EVENT2_EXPORT_SYMBOL +int evconnlistener_enable(struct evconnlistener *lev); +/** + Stop listening for connections on an evconnlistener. + */ +EVENT2_EXPORT_SYMBOL +int evconnlistener_disable(struct evconnlistener *lev); + +/** Return an evconnlistener's associated event_base. */ +EVENT2_EXPORT_SYMBOL +struct event_base *evconnlistener_get_base(struct evconnlistener *lev); + +/** Return the socket that an evconnlistner is listening on. */ +EVENT2_EXPORT_SYMBOL +evutil_socket_t evconnlistener_get_fd(struct evconnlistener *lev); + +/** Change the callback on the listener to cb and its user_data to arg. + */ +EVENT2_EXPORT_SYMBOL +void evconnlistener_set_cb(struct evconnlistener *lev, + evconnlistener_cb cb, void *arg); + +/** Set an evconnlistener's error callback. */ +EVENT2_EXPORT_SYMBOL +void evconnlistener_set_error_cb(struct evconnlistener *lev, + evconnlistener_errorcb errorcb); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/Import/libevent/Includes/Windows/event2/rpc.h b/Source/Import/libevent/Includes/Windows/event2/rpc.h new file mode 100644 index 0000000..dd43df2 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/rpc.h @@ -0,0 +1,596 @@ +/* + * Copyright (c) 2006-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_RPC_H_INCLUDED_ +#define EVENT2_RPC_H_INCLUDED_ + +#ifdef __cplusplus +extern "C" { +#endif + +/** @file rpc.h + * + * This header files provides basic support for an RPC server and client. + * + * To support RPCs in a server, every supported RPC command needs to be + * defined and registered. + * + * EVRPC_HEADER(SendCommand, Request, Reply); + * + * SendCommand is the name of the RPC command. + * Request is the name of a structure generated by event_rpcgen.py. + * It contains all parameters relating to the SendCommand RPC. The + * server needs to fill in the Reply structure. + * Reply is the name of a structure generated by event_rpcgen.py. It + * contains the answer to the RPC. + * + * To register an RPC with an HTTP server, you need to first create an RPC + * base with: + * + * struct evrpc_base *base = evrpc_init(http); + * + * A specific RPC can then be registered with + * + * EVRPC_REGISTER(base, SendCommand, Request, Reply, FunctionCB, arg); + * + * when the server receives an appropriately formatted RPC, the user callback + * is invoked. The callback needs to fill in the reply structure. + * + * void FunctionCB(EVRPC_STRUCT(SendCommand)* rpc, void *arg); + * + * To send the reply, call EVRPC_REQUEST_DONE(rpc); + * + * See the regression test for an example. + */ + +/** + Determines if the member has been set in the message + + @param msg the message to inspect + @param member the member variable to test for presences + @return 1 if it's present or 0 otherwise. +*/ +#define EVTAG_HAS(msg, member) \ + ((msg)->member##_set == 1) + +#ifndef EVENT2_RPC_COMPAT_H_INCLUDED_ + +/** + Assigns a value to the member in the message. + + @param msg the message to which to assign a value + @param member the name of the member variable + @param value the value to assign +*/ +#define EVTAG_ASSIGN(msg, member, value) \ + (*(msg)->base->member##_assign)((msg), (value)) +/** + Assigns a value to the member in the message. + + @param msg the message to which to assign a value + @param member the name of the member variable + @param value the value to assign + @param len the length of the value +*/ +#define EVTAG_ASSIGN_WITH_LEN(msg, member, value, len) \ + (*(msg)->base->member##_assign)((msg), (value), (len)) +/** + Returns the value for a member. + + @param msg the message from which to get the value + @param member the name of the member variable + @param pvalue a pointer to the variable to hold the value + @return 0 on success, -1 otherwise. +*/ +#define EVTAG_GET(msg, member, pvalue) \ + (*(msg)->base->member##_get)((msg), (pvalue)) +/** + Returns the value for a member. + + @param msg the message from which to get the value + @param member the name of the member variable + @param pvalue a pointer to the variable to hold the value + @param plen a pointer to the length of the value + @return 0 on success, -1 otherwise. +*/ +#define EVTAG_GET_WITH_LEN(msg, member, pvalue, plen) \ + (*(msg)->base->member##_get)((msg), (pvalue), (plen)) + +#endif /* EVENT2_RPC_COMPAT_H_INCLUDED_ */ + +/** + Adds a value to an array. +*/ +#define EVTAG_ARRAY_ADD_VALUE(msg, member, value) \ + (*(msg)->base->member##_add)((msg), (value)) +/** + Allocates a new entry in the array and returns it. +*/ +#define EVTAG_ARRAY_ADD(msg, member) \ + (*(msg)->base->member##_add)(msg) +/** + Gets a variable at the specified offset from the array. +*/ +#define EVTAG_ARRAY_GET(msg, member, offset, pvalue) \ + (*(msg)->base->member##_get)((msg), (offset), (pvalue)) +/** + Returns the number of entries in the array. +*/ +#define EVTAG_ARRAY_LEN(msg, member) ((msg)->member##_length) + + +struct evbuffer; +struct event_base; +struct evrpc_req_generic; +struct evrpc_request_wrapper; +struct evrpc; + +/** The type of a specific RPC Message + * + * @param rpcname the name of the RPC message + */ +#define EVRPC_STRUCT(rpcname) struct evrpc_req__##rpcname + +struct evhttp_request; +struct evrpc_status; +struct evrpc_hook_meta; + +/** Creates the definitions and prototypes for an RPC + * + * You need to use EVRPC_HEADER to create structures and function prototypes + * needed by the server and client implementation. The structures have to be + * defined in an .rpc file and converted to source code via event_rpcgen.py + * + * @param rpcname the name of the RPC + * @param reqstruct the name of the RPC request structure + * @param replystruct the name of the RPC reply structure + * @see EVRPC_GENERATE() + */ +#define EVRPC_HEADER(rpcname, reqstruct, rplystruct) \ +EVRPC_STRUCT(rpcname) { \ + struct evrpc_hook_meta *hook_meta; \ + struct reqstruct* request; \ + struct rplystruct* reply; \ + struct evrpc* rpc; \ + struct evhttp_request* http_req; \ + struct evbuffer* rpc_data; \ +}; \ +int evrpc_send_request_##rpcname(struct evrpc_pool *, \ + struct reqstruct *, struct rplystruct *, \ + void (*)(struct evrpc_status *, \ + struct reqstruct *, struct rplystruct *, void *cbarg), \ + void *); + +struct evrpc_pool; + +/** use EVRPC_GENERATE instead */ +struct evrpc_request_wrapper *evrpc_make_request_ctx( + struct evrpc_pool *pool, void *request, void *reply, + const char *rpcname, + void (*req_marshal)(struct evbuffer*, void *), + void (*rpl_clear)(void *), + int (*rpl_unmarshal)(void *, struct evbuffer *), + void (*cb)(struct evrpc_status *, void *, void *, void *), + void *cbarg); + +/** Creates a context structure that contains rpc specific information. + * + * EVRPC_MAKE_CTX is used to populate a RPC specific context that + * contains information about marshaling the RPC data types. + * + * @param rpcname the name of the RPC + * @param reqstruct the name of the RPC request structure + * @param replystruct the name of the RPC reply structure + * @param pool the evrpc_pool over which to make the request + * @param request a pointer to the RPC request structure object + * @param reply a pointer to the RPC reply structure object + * @param cb the callback function to call when the RPC has completed + * @param cbarg the argument to supply to the callback + */ +#define EVRPC_MAKE_CTX(rpcname, reqstruct, rplystruct, \ + pool, request, reply, cb, cbarg) \ + evrpc_make_request_ctx(pool, request, reply, \ + #rpcname, \ + (void (*)(struct evbuffer *, void *))reqstruct##_marshal, \ + (void (*)(void *))rplystruct##_clear, \ + (int (*)(void *, struct evbuffer *))rplystruct##_unmarshal, \ + (void (*)(struct evrpc_status *, void *, void *, void *))cb, \ + cbarg) + +/** Generates the code for receiving and sending an RPC message + * + * EVRPC_GENERATE is used to create the code corresponding to sending + * and receiving a particular RPC message + * + * @param rpcname the name of the RPC + * @param reqstruct the name of the RPC request structure + * @param replystruct the name of the RPC reply structure + * @see EVRPC_HEADER() + */ +#define EVRPC_GENERATE(rpcname, reqstruct, rplystruct) \ + int evrpc_send_request_##rpcname(struct evrpc_pool *pool, \ + struct reqstruct *request, struct rplystruct *reply, \ + void (*cb)(struct evrpc_status *, \ + struct reqstruct *, struct rplystruct *, void *cbarg), \ + void *cbarg) { \ + return evrpc_send_request_generic(pool, request, reply, \ + (void (*)(struct evrpc_status *, void *, void *, void *))cb, \ + cbarg, \ + #rpcname, \ + (void (*)(struct evbuffer *, void *))reqstruct##_marshal, \ + (void (*)(void *))rplystruct##_clear, \ + (int (*)(void *, struct evbuffer *))rplystruct##_unmarshal); \ +} + +/** Provides access to the HTTP request object underlying an RPC + * + * Access to the underlying http object; can be used to look at headers or + * for getting the remote ip address + * + * @param rpc_req the rpc request structure provided to the server callback + * @return an struct evhttp_request object that can be inspected for + * HTTP headers or sender information. + */ +#define EVRPC_REQUEST_HTTP(rpc_req) (rpc_req)->http_req + +/** completes the server response to an rpc request */ +void evrpc_request_done(struct evrpc_req_generic *req); + +/** accessors for request and reply */ +void *evrpc_get_request(struct evrpc_req_generic *req); +void *evrpc_get_reply(struct evrpc_req_generic *req); + +/** Creates the reply to an RPC request + * + * EVRPC_REQUEST_DONE is used to answer a request; the reply is expected + * to have been filled in. The request and reply pointers become invalid + * after this call has finished. + * + * @param rpc_req the rpc request structure provided to the server callback + */ +#define EVRPC_REQUEST_DONE(rpc_req) do { \ + struct evrpc_req_generic *req_ = (struct evrpc_req_generic *)(rpc_req); \ + evrpc_request_done(req_); \ +} while (0) + + +struct evrpc_base; +struct evhttp; + +/* functions to start up the rpc system */ + +/** Creates a new rpc base from which RPC requests can be received + * + * @param server a pointer to an existing HTTP server + * @return a newly allocated evrpc_base struct + * @see evrpc_free() + */ +struct evrpc_base *evrpc_init(struct evhttp *server); + +/** + * Frees the evrpc base + * + * For now, you are responsible for making sure that no rpcs are ongoing. + * + * @param base the evrpc_base object to be freed + * @see evrpc_init + */ +void evrpc_free(struct evrpc_base *base); + +/** register RPCs with the HTTP Server + * + * registers a new RPC with the HTTP server, each RPC needs to have + * a unique name under which it can be identified. + * + * @param base the evrpc_base structure in which the RPC should be + * registered. + * @param name the name of the RPC + * @param request the name of the RPC request structure + * @param reply the name of the RPC reply structure + * @param callback the callback that should be invoked when the RPC + * is received. The callback has the following prototype + * void (*callback)(EVRPC_STRUCT(Message)* rpc, void *arg) + * @param cbarg an additional parameter that can be passed to the callback. + * The parameter can be used to carry around state. + */ +#define EVRPC_REGISTER(base, name, request, reply, callback, cbarg) \ + evrpc_register_generic(base, #name, \ + (void (*)(struct evrpc_req_generic *, void *))callback, cbarg, \ + (void *(*)(void *))request##_new, NULL, \ + (void (*)(void *))request##_free, \ + (int (*)(void *, struct evbuffer *))request##_unmarshal, \ + (void *(*)(void *))reply##_new, NULL, \ + (void (*)(void *))reply##_free, \ + (int (*)(void *))reply##_complete, \ + (void (*)(struct evbuffer *, void *))reply##_marshal) + +/** + Low level function for registering an RPC with a server. + + Use EVRPC_REGISTER() instead. + + @see EVRPC_REGISTER() +*/ +int evrpc_register_rpc(struct evrpc_base *, struct evrpc *, + void (*)(struct evrpc_req_generic*, void *), void *); + +/** + * Unregisters an already registered RPC + * + * @param base the evrpc_base object from which to unregister an RPC + * @param name the name of the rpc to unregister + * @return -1 on error or 0 when successful. + * @see EVRPC_REGISTER() + */ +#define EVRPC_UNREGISTER(base, name) evrpc_unregister_rpc((base), #name) + +int evrpc_unregister_rpc(struct evrpc_base *base, const char *name); + +/* + * Client-side RPC support + */ + +struct evhttp_connection; +struct evrpc_status; + +/** launches an RPC and sends it to the server + * + * EVRPC_MAKE_REQUEST() is used by the client to send an RPC to the server. + * + * @param name the name of the RPC + * @param pool the evrpc_pool that contains the connection objects over which + * the request should be sent. + * @param request a pointer to the RPC request structure - it contains the + * data to be sent to the server. + * @param reply a pointer to the RPC reply structure. It is going to be filled + * if the request was answered successfully + * @param cb the callback to invoke when the RPC request has been answered + * @param cbarg an additional argument to be passed to the client + * @return 0 on success, -1 on failure + */ +#define EVRPC_MAKE_REQUEST(name, pool, request, reply, cb, cbarg) \ + evrpc_send_request_##name((pool), (request), (reply), (cb), (cbarg)) + +/** + Makes an RPC request based on the provided context. + + This is a low-level function and should not be used directly + unless a custom context object is provided. Use EVRPC_MAKE_REQUEST() + instead. + + @param ctx a context from EVRPC_MAKE_CTX() + @returns 0 on success, -1 otherwise. + @see EVRPC_MAKE_REQUEST(), EVRPC_MAKE_CTX() +*/ +int evrpc_make_request(struct evrpc_request_wrapper *ctx); + +/** creates an rpc connection pool + * + * a pool has a number of connections associated with it. + * rpc requests are always made via a pool. + * + * @param base a pointer to an struct event_based object; can be left NULL + * in singled-threaded applications + * @return a newly allocated struct evrpc_pool object + * @see evrpc_pool_free() + */ +struct evrpc_pool *evrpc_pool_new(struct event_base *base); +/** frees an rpc connection pool + * + * @param pool a pointer to an evrpc_pool allocated via evrpc_pool_new() + * @see evrpc_pool_new() + */ +void evrpc_pool_free(struct evrpc_pool *pool); + +/** + * Adds a connection over which rpc can be dispatched to the pool. + * + * The connection object must have been newly created. + * + * @param pool the pool to which to add the connection + * @param evcon the connection to add to the pool. + */ +void evrpc_pool_add_connection(struct evrpc_pool *pool, + struct evhttp_connection *evcon); + +/** + * Removes a connection from the pool. + * + * The connection object must have been newly created. + * + * @param pool the pool from which to remove the connection + * @param evcon the connection to remove from the pool. + */ +void evrpc_pool_remove_connection(struct evrpc_pool *pool, + struct evhttp_connection *evcon); + +/** + * Sets the timeout in secs after which a request has to complete. The + * RPC is completely aborted if it does not complete by then. Setting + * the timeout to 0 means that it never timeouts and can be used to + * implement callback type RPCs. + * + * Any connection already in the pool will be updated with the new + * timeout. Connections added to the pool after set_timeout has be + * called receive the pool timeout only if no timeout has been set + * for the connection itself. + * + * @param pool a pointer to a struct evrpc_pool object + * @param timeout_in_secs the number of seconds after which a request should + * timeout and a failure be returned to the callback. + */ +void evrpc_pool_set_timeout(struct evrpc_pool *pool, int timeout_in_secs); + +/** + * Hooks for changing the input and output of RPCs; this can be used to + * implement compression, authentication, encryption, ... + */ + +enum EVRPC_HOOK_TYPE { + EVRPC_INPUT, /**< apply the function to an input hook */ + EVRPC_OUTPUT /**< apply the function to an output hook */ +}; + +#ifndef _WIN32 +/** Deprecated alias for EVRPC_INPUT. Not available on windows, where it + * conflicts with platform headers. */ +#define INPUT EVRPC_INPUT +/** Deprecated alias for EVRPC_OUTPUT. Not available on windows, where it + * conflicts with platform headers. */ +#define OUTPUT EVRPC_OUTPUT +#endif + +/** + * Return value from hook processing functions + */ + +enum EVRPC_HOOK_RESULT { + EVRPC_TERMINATE = -1, /**< indicates the rpc should be terminated */ + EVRPC_CONTINUE = 0, /**< continue processing the rpc */ + EVRPC_PAUSE = 1 /**< pause processing request until resumed */ +}; + +/** adds a processing hook to either an rpc base or rpc pool + * + * If a hook returns TERMINATE, the processing is aborted. On CONTINUE, + * the request is immediately processed after the hook returns. If the + * hook returns PAUSE, request processing stops until evrpc_resume_request() + * has been called. + * + * The add functions return handles that can be used for removing hooks. + * + * @param vbase a pointer to either struct evrpc_base or struct evrpc_pool + * @param hook_type either INPUT or OUTPUT + * @param cb the callback to call when the hook is activated + * @param cb_arg an additional argument for the callback + * @return a handle to the hook so it can be removed later + * @see evrpc_remove_hook() + */ +void *evrpc_add_hook(void *vbase, + enum EVRPC_HOOK_TYPE hook_type, + int (*cb)(void *, struct evhttp_request *, struct evbuffer *, void *), + void *cb_arg); + +/** removes a previously added hook + * + * @param vbase a pointer to either struct evrpc_base or struct evrpc_pool + * @param hook_type either INPUT or OUTPUT + * @param handle a handle returned by evrpc_add_hook() + * @return 1 on success or 0 on failure + * @see evrpc_add_hook() + */ +int evrpc_remove_hook(void *vbase, + enum EVRPC_HOOK_TYPE hook_type, + void *handle); + +/** resume a paused request + * + * @param vbase a pointer to either struct evrpc_base or struct evrpc_pool + * @param ctx the context pointer provided to the original hook call + */ +int +evrpc_resume_request(void *vbase, void *ctx, enum EVRPC_HOOK_RESULT res); + +/** adds meta data to request + * + * evrpc_hook_add_meta() allows hooks to add meta data to a request. for + * a client request, the meta data can be inserted by an outgoing request hook + * and retrieved by the incoming request hook. + * + * @param ctx the context provided to the hook call + * @param key a NUL-terminated c-string + * @param data the data to be associated with the key + * @param data_size the size of the data + */ +void evrpc_hook_add_meta(void *ctx, const char *key, + const void *data, size_t data_size); + +/** retrieves meta data previously associated + * + * evrpc_hook_find_meta() can be used to retrieve meta data associated to a + * request by a previous hook. + * @param ctx the context provided to the hook call + * @param key a NUL-terminated c-string + * @param data pointer to a data pointer that will contain the retrieved data + * @param data_size pointer to the size of the data + * @return 0 on success or -1 on failure + */ +int evrpc_hook_find_meta(void *ctx, const char *key, + void **data, size_t *data_size); + +/** + * returns the connection object associated with the request + * + * @param ctx the context provided to the hook call + * @return a pointer to the evhttp_connection object + */ +struct evhttp_connection *evrpc_hook_get_connection(void *ctx); + +/** + Function for sending a generic RPC request. + + Do not call this function directly, use EVRPC_MAKE_REQUEST() instead. + + @see EVRPC_MAKE_REQUEST() + */ +int evrpc_send_request_generic(struct evrpc_pool *pool, + void *request, void *reply, + void (*cb)(struct evrpc_status *, void *, void *, void *), + void *cb_arg, + const char *rpcname, + void (*req_marshal)(struct evbuffer *, void *), + void (*rpl_clear)(void *), + int (*rpl_unmarshal)(void *, struct evbuffer *)); + +/** + Function for registering a generic RPC with the RPC base. + + Do not call this function directly, use EVRPC_REGISTER() instead. + + @see EVRPC_REGISTER() + */ +int +evrpc_register_generic(struct evrpc_base *base, const char *name, + void (*callback)(struct evrpc_req_generic *, void *), void *cbarg, + void *(*req_new)(void *), void *req_new_arg, void (*req_free)(void *), + int (*req_unmarshal)(void *, struct evbuffer *), + void *(*rpl_new)(void *), void *rpl_new_arg, void (*rpl_free)(void *), + int (*rpl_complete)(void *), + void (*rpl_marshal)(struct evbuffer *, void *)); + +/** accessors for obscure and undocumented functionality */ +struct evrpc_pool* evrpc_request_get_pool(struct evrpc_request_wrapper *ctx); +void evrpc_request_set_pool(struct evrpc_request_wrapper *ctx, + struct evrpc_pool *pool); +void evrpc_request_set_cb(struct evrpc_request_wrapper *ctx, + void (*cb)(struct evrpc_status*, void *request, void *reply, void *arg), + void *cb_arg); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_RPC_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/rpc_compat.h b/Source/Import/libevent/Includes/Windows/event2/rpc_compat.h new file mode 100644 index 0000000..8d8334d --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/rpc_compat.h @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2006-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_RPC_COMPAT_H_INCLUDED_ +#define EVENT2_RPC_COMPAT_H_INCLUDED_ + +/** @file event2/rpc_compat.h + + Deprecated versions of the functions in rpc.h: provided only for + backwards compatibility. + + */ + +#ifdef __cplusplus +extern "C" { +#endif + +/** backwards compatible accessors that work only with gcc */ +#if defined(__GNUC__) && !defined(__STRICT_ANSI__) + +#undef EVTAG_ASSIGN +#undef EVTAG_GET +#undef EVTAG_ADD + +#define EVTAG_ASSIGN(msg, member, args...) \ + (*(msg)->base->member##_assign)(msg, ## args) +#define EVTAG_GET(msg, member, args...) \ + (*(msg)->base->member##_get)(msg, ## args) +#define EVTAG_ADD(msg, member, args...) \ + (*(msg)->base->member##_add)(msg, ## args) +#endif +#define EVTAG_LEN(msg, member) ((msg)->member##_length) + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_EVENT_COMPAT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/rpc_struct.h b/Source/Import/libevent/Includes/Windows/event2/rpc_struct.h new file mode 100644 index 0000000..8f691f4 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/rpc_struct.h @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2006-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_RPC_STRUCT_H_INCLUDED_ +#define EVENT2_RPC_STRUCT_H_INCLUDED_ + +#ifdef __cplusplus +extern "C" { +#endif + +/** @file event2/rpc_struct.h + + Structures used by rpc.h. Using these structures directly may harm + forward compatibility: be careful! + + */ + +/** + * provides information about the completed RPC request. + */ +struct evrpc_status { +#define EVRPC_STATUS_ERR_NONE 0 +#define EVRPC_STATUS_ERR_TIMEOUT 1 +#define EVRPC_STATUS_ERR_BADPAYLOAD 2 +#define EVRPC_STATUS_ERR_UNSTARTED 3 +#define EVRPC_STATUS_ERR_HOOKABORTED 4 + int error; + + /* for looking at headers or other information */ + struct evhttp_request *http_req; +}; + +/* the structure below needs to be synchronized with evrpc_req_generic */ + +/* Encapsulates a request */ +struct evrpc { + TAILQ_ENTRY(evrpc) next; + + /* the URI at which the request handler lives */ + const char* uri; + + /* creates a new request structure */ + void *(*request_new)(void *); + void *request_new_arg; + + /* frees the request structure */ + void (*request_free)(void *); + + /* unmarshals the buffer into the proper request structure */ + int (*request_unmarshal)(void *, struct evbuffer *); + + /* creates a new reply structure */ + void *(*reply_new)(void *); + void *reply_new_arg; + + /* frees the reply structure */ + void (*reply_free)(void *); + + /* verifies that the reply is valid */ + int (*reply_complete)(void *); + + /* marshals the reply into a buffer */ + void (*reply_marshal)(struct evbuffer*, void *); + + /* the callback invoked for each received rpc */ + void (*cb)(struct evrpc_req_generic *, void *); + void *cb_arg; + + /* reference for further configuration */ + struct evrpc_base *base; +}; + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_RPC_STRUCT_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/tag.h b/Source/Import/libevent/Includes/Windows/event2/tag.h new file mode 100644 index 0000000..2f73bfc --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/tag.h @@ -0,0 +1,146 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_TAG_H_INCLUDED_ +#define EVENT2_TAG_H_INCLUDED_ + +/** @file event2/tag.h + + Helper functions for reading and writing tagged data onto buffers. + + */ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif + +/* For int types. */ +#include + +struct evbuffer; + +/* + * Marshaling tagged data - We assume that all tags are inserted in their + * numeric order - so that unknown tags will always be higher than the + * known ones - and we can just ignore the end of an event buffer. + */ + +EVENT2_EXPORT_SYMBOL +void evtag_init(void); + +/** + Unmarshals the header and returns the length of the payload + + @param evbuf the buffer from which to unmarshal data + @param ptag a pointer in which the tag id is being stored + @returns -1 on failure or the number of bytes in the remaining payload. +*/ +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_header(struct evbuffer *evbuf, ev_uint32_t *ptag); + +EVENT2_EXPORT_SYMBOL +void evtag_marshal(struct evbuffer *evbuf, ev_uint32_t tag, const void *data, + ev_uint32_t len); +EVENT2_EXPORT_SYMBOL +void evtag_marshal_buffer(struct evbuffer *evbuf, ev_uint32_t tag, + struct evbuffer *data); + +/** + Encode an integer and store it in an evbuffer. + + We encode integers by nybbles; the first nibble contains the number + of significant nibbles - 1; this allows us to encode up to 64-bit + integers. This function is byte-order independent. + + @param evbuf evbuffer to store the encoded number + @param number a 32-bit integer + */ +EVENT2_EXPORT_SYMBOL +void evtag_encode_int(struct evbuffer *evbuf, ev_uint32_t number); +EVENT2_EXPORT_SYMBOL +void evtag_encode_int64(struct evbuffer *evbuf, ev_uint64_t number); + +EVENT2_EXPORT_SYMBOL +void evtag_marshal_int(struct evbuffer *evbuf, ev_uint32_t tag, + ev_uint32_t integer); +EVENT2_EXPORT_SYMBOL +void evtag_marshal_int64(struct evbuffer *evbuf, ev_uint32_t tag, + ev_uint64_t integer); + +EVENT2_EXPORT_SYMBOL +void evtag_marshal_string(struct evbuffer *buf, ev_uint32_t tag, + const char *string); + +EVENT2_EXPORT_SYMBOL +void evtag_marshal_timeval(struct evbuffer *evbuf, ev_uint32_t tag, + struct timeval *tv); + +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal(struct evbuffer *src, ev_uint32_t *ptag, + struct evbuffer *dst); +EVENT2_EXPORT_SYMBOL +int evtag_peek(struct evbuffer *evbuf, ev_uint32_t *ptag); +EVENT2_EXPORT_SYMBOL +int evtag_peek_length(struct evbuffer *evbuf, ev_uint32_t *plength); +EVENT2_EXPORT_SYMBOL +int evtag_payload_length(struct evbuffer *evbuf, ev_uint32_t *plength); +EVENT2_EXPORT_SYMBOL +int evtag_consume(struct evbuffer *evbuf); + +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_int(struct evbuffer *evbuf, ev_uint32_t need_tag, + ev_uint32_t *pinteger); +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_int64(struct evbuffer *evbuf, ev_uint32_t need_tag, + ev_uint64_t *pinteger); + +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_fixed(struct evbuffer *src, ev_uint32_t need_tag, + void *data, size_t len); + +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_string(struct evbuffer *evbuf, ev_uint32_t need_tag, + char **pstring); + +EVENT2_EXPORT_SYMBOL +int evtag_unmarshal_timeval(struct evbuffer *evbuf, ev_uint32_t need_tag, + struct timeval *ptv); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_TAG_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/tag_compat.h b/Source/Import/libevent/Includes/Windows/event2/tag_compat.h new file mode 100644 index 0000000..a276c0d --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/tag_compat.h @@ -0,0 +1,49 @@ +/* + * Copyright (c) 2000-2007 Niels Provos + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_TAG_COMPAT_H_INCLUDED_ +#define EVENT2_TAG_COMPAT_H_INCLUDED_ + +/** @file event2/tag_compat.h + + Obsolete/deprecated functions from tag.h; provided only for backwards + compatibility. + */ + +/** + @name Misnamed functions + + @deprecated These macros are deprecated because their names don't follow + Libevent's naming conventions. Use evtag_encode_int and + evtag_encode_int64 instead. + + @{ +*/ +#define encode_int(evbuf, number) evtag_encode_int((evbuf), (number)) +#define encode_int64(evbuf, number) evtag_encode_int64((evbuf), (number)) +/**@}*/ + +#endif /* EVENT2_TAG_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/thread.h b/Source/Import/libevent/Includes/Windows/event2/thread.h new file mode 100644 index 0000000..b519986 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/thread.h @@ -0,0 +1,253 @@ +/* + * Copyright (c) 2008-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_THREAD_H_INCLUDED_ +#define EVENT2_THREAD_H_INCLUDED_ + +/** @file event2/thread.h + + Functions for multi-threaded applications using Libevent. + + When using a multi-threaded application in which multiple threads + add and delete events from a single event base, Libevent needs to + lock its data structures. + + Like the memory-management function hooks, all of the threading functions + _must_ be set up before an event_base is created if you want the base to + use them. + + Most programs will either be using Windows threads or Posix threads. You + can configure Libevent to use one of these event_use_windows_threads() or + event_use_pthreads() respectively. If you're using another threading + library, you'll need to configure threading functions manually using + evthread_set_lock_callbacks() and evthread_set_condition_callbacks(). + + */ + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +/** + @name Flags passed to lock functions + + @{ +*/ +/** A flag passed to a locking callback when the lock was allocated as a + * read-write lock, and we want to acquire or release the lock for writing. */ +#define EVTHREAD_WRITE 0x04 +/** A flag passed to a locking callback when the lock was allocated as a + * read-write lock, and we want to acquire or release the lock for reading. */ +#define EVTHREAD_READ 0x08 +/** A flag passed to a locking callback when we don't want to block waiting + * for the lock; if we can't get the lock immediately, we will instead + * return nonzero from the locking callback. */ +#define EVTHREAD_TRY 0x10 +/**@}*/ + +#if !defined(EVENT__DISABLE_THREAD_SUPPORT) || defined(EVENT_IN_DOXYGEN_) + +#define EVTHREAD_LOCK_API_VERSION 1 + +/** + @name Types of locks + + @{*/ +/** A recursive lock is one that can be acquired multiple times at once by the + * same thread. No other process can allocate the lock until the thread that + * has been holding it has unlocked it as many times as it locked it. */ +#define EVTHREAD_LOCKTYPE_RECURSIVE 1 +/* A read-write lock is one that allows multiple simultaneous readers, but + * where any one writer excludes all other writers and readers. */ +#define EVTHREAD_LOCKTYPE_READWRITE 2 +/**@}*/ + +/** This structure describes the interface a threading library uses for + * locking. It's used to tell evthread_set_lock_callbacks() how to use + * locking on this platform. + */ +struct evthread_lock_callbacks { + /** The current version of the locking API. Set this to + * EVTHREAD_LOCK_API_VERSION */ + int lock_api_version; + /** Which kinds of locks does this version of the locking API + * support? A bitfield of EVTHREAD_LOCKTYPE_RECURSIVE and + * EVTHREAD_LOCKTYPE_READWRITE. + * + * (Note that RECURSIVE locks are currently mandatory, and + * READWRITE locks are not currently used.) + **/ + unsigned supported_locktypes; + /** Function to allocate and initialize new lock of type 'locktype'. + * Returns NULL on failure. */ + void *(*alloc)(unsigned locktype); + /** Funtion to release all storage held in 'lock', which was created + * with type 'locktype'. */ + void (*free)(void *lock, unsigned locktype); + /** Acquire an already-allocated lock at 'lock' with mode 'mode'. + * Returns 0 on success, and nonzero on failure. */ + int (*lock)(unsigned mode, void *lock); + /** Release a lock at 'lock' using mode 'mode'. Returns 0 on success, + * and nonzero on failure. */ + int (*unlock)(unsigned mode, void *lock); +}; + +/** Sets a group of functions that Libevent should use for locking. + * For full information on the required callback API, see the + * documentation for the individual members of evthread_lock_callbacks. + * + * Note that if you're using Windows or the Pthreads threading library, you + * probably shouldn't call this function; instead, use + * evthread_use_windows_threads() or evthread_use_posix_threads() if you can. + */ +EVENT2_EXPORT_SYMBOL +int evthread_set_lock_callbacks(const struct evthread_lock_callbacks *); + +#define EVTHREAD_CONDITION_API_VERSION 1 + +struct timeval; + +/** This structure describes the interface a threading library uses for + * condition variables. It's used to tell evthread_set_condition_callbacks + * how to use locking on this platform. + */ +struct evthread_condition_callbacks { + /** The current version of the conditions API. Set this to + * EVTHREAD_CONDITION_API_VERSION */ + int condition_api_version; + /** Function to allocate and initialize a new condition variable. + * Returns the condition variable on success, and NULL on failure. + * The 'condtype' argument will be 0 with this API version. + */ + void *(*alloc_condition)(unsigned condtype); + /** Function to free a condition variable. */ + void (*free_condition)(void *cond); + /** Function to signal a condition variable. If 'broadcast' is 1, all + * threads waiting on 'cond' should be woken; otherwise, only on one + * thread is worken. Should return 0 on success, -1 on failure. + * This function will only be called while holding the associated + * lock for the condition. + */ + int (*signal_condition)(void *cond, int broadcast); + /** Function to wait for a condition variable. The lock 'lock' + * will be held when this function is called; should be released + * while waiting for the condition to be come signalled, and + * should be held again when this function returns. + * If timeout is provided, it is interval of seconds to wait for + * the event to become signalled; if it is NULL, the function + * should wait indefinitely. + * + * The function should return -1 on error; 0 if the condition + * was signalled, or 1 on a timeout. */ + int (*wait_condition)(void *cond, void *lock, + const struct timeval *timeout); +}; + +/** Sets a group of functions that Libevent should use for condition variables. + * For full information on the required callback API, see the + * documentation for the individual members of evthread_condition_callbacks. + * + * Note that if you're using Windows or the Pthreads threading library, you + * probably shouldn't call this function; instead, use + * evthread_use_windows_threads() or evthread_use_pthreads() if you can. + */ +EVENT2_EXPORT_SYMBOL +int evthread_set_condition_callbacks( + const struct evthread_condition_callbacks *); + +/** + Sets the function for determining the thread id. + + @param base the event base for which to set the id function + @param id_fn the identify function Libevent should invoke to + determine the identity of a thread. +*/ +EVENT2_EXPORT_SYMBOL +void evthread_set_id_callback( + unsigned long (*id_fn)(void)); + +#if (defined(_WIN32) && !defined(EVENT__DISABLE_THREAD_SUPPORT)) || defined(EVENT_IN_DOXYGEN_) +/** Sets up Libevent for use with Windows builtin locking and thread ID + functions. Unavailable if Libevent is not built for Windows. + + @return 0 on success, -1 on failure. */ +EVENT2_EXPORT_SYMBOL +int evthread_use_windows_threads(void); +/** + Defined if Libevent was built with support for evthread_use_windows_threads() +*/ +#define EVTHREAD_USE_WINDOWS_THREADS_IMPLEMENTED 1 +#endif + +#if defined(EVENT__HAVE_PTHREADS) || defined(EVENT_IN_DOXYGEN_) +/** Sets up Libevent for use with Pthreads locking and thread ID functions. + Unavailable if Libevent is not build for use with pthreads. Requires + libraries to link against Libevent_pthreads as well as Libevent. + + @return 0 on success, -1 on failure. */ +EVENT2_EXPORT_SYMBOL +int evthread_use_pthreads(void); +/** Defined if Libevent was built with support for evthread_use_pthreads() */ +#define EVTHREAD_USE_PTHREADS_IMPLEMENTED 1 + +#endif + +/** Enable debugging wrappers around the current lock callbacks. If Libevent + * makes one of several common locking errors, exit with an assertion failure. + * + * If you're going to call this function, you must do so before any locks are + * allocated. + **/ +EVENT2_EXPORT_SYMBOL +void evthread_enable_lock_debugging(void); + +/* Old (misspelled) version: This is deprecated; use + * evthread_enable_log_debugging instead. */ +EVENT2_EXPORT_SYMBOL +void evthread_enable_lock_debuging(void); + +#endif /* EVENT__DISABLE_THREAD_SUPPORT */ + +struct event_base; +/** Make sure it's safe to tell an event base to wake up from another thread + or a signal handler. + + You shouldn't need to call this by hand; configuring the base with thread + support should be necessary and sufficient. + + @return 0 on success, -1 on failure. + */ +EVENT2_EXPORT_SYMBOL +int evthread_make_base_notifiable(struct event_base *base); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT2_THREAD_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/util.h b/Source/Import/libevent/Includes/Windows/event2/util.h new file mode 100644 index 0000000..dd4bbb6 --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/util.h @@ -0,0 +1,866 @@ +/* + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_UTIL_H_INCLUDED_ +#define EVENT2_UTIL_H_INCLUDED_ + +/** @file event2/util.h + + Common convenience functions for cross-platform portability and + related socket manipulations. + + */ +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#ifdef EVENT__HAVE_SYS_TIME_H +#include +#endif +#ifdef EVENT__HAVE_STDINT_H +#include +#elif defined(EVENT__HAVE_INTTYPES_H) +#include +#endif +#ifdef EVENT__HAVE_SYS_TYPES_H +#include +#endif +#ifdef EVENT__HAVE_STDDEF_H +#include +#endif +#ifdef _MSC_VER +#include +#endif +#include +#ifdef EVENT__HAVE_NETDB_H +#if !defined(_GNU_SOURCE) +#define _GNU_SOURCE +#endif +#include +#endif + +#ifdef _WIN32 +#include +#ifdef EVENT__HAVE_GETADDRINFO +/* for EAI_* definitions. */ +#include +#endif +#else +#ifdef EVENT__HAVE_ERRNO_H +#include +#endif +#include +#endif + +#include + +/* Some openbsd autoconf versions get the name of this macro wrong. */ +#if defined(EVENT__SIZEOF_VOID__) && !defined(EVENT__SIZEOF_VOID_P) +#define EVENT__SIZEOF_VOID_P EVENT__SIZEOF_VOID__ +#endif + +/** + * @name Standard integer types. + * + * Integer type definitions for types that are supposed to be defined in the + * C99-specified stdint.h. Shamefully, some platforms do not include + * stdint.h, so we need to replace it. (If you are on a platform like this, + * your C headers are now over 10 years out of date. You should bug them to + * do something about this.) + * + * We define: + * + *
+ *
ev_uint64_t, ev_uint32_t, ev_uint16_t, ev_uint8_t
+ *
unsigned integer types of exactly 64, 32, 16, and 8 bits + * respectively.
+ *
ev_int64_t, ev_int32_t, ev_int16_t, ev_int8_t
+ *
signed integer types of exactly 64, 32, 16, and 8 bits + * respectively.
+ *
ev_uintptr_t, ev_intptr_t
+ *
unsigned/signed integers large enough + * to hold a pointer without loss of bits.
+ *
ev_ssize_t
+ *
A signed type of the same size as size_t
+ *
ev_off_t
+ *
A signed type typically used to represent offsets within a + * (potentially large) file
+ * + * @{ + */ +#ifdef EVENT__HAVE_UINT64_T +#define ev_uint64_t uint64_t +#define ev_int64_t int64_t +#elif defined(_WIN32) +#define ev_uint64_t unsigned __int64 +#define ev_int64_t signed __int64 +#elif EVENT__SIZEOF_LONG_LONG == 8 +#define ev_uint64_t unsigned long long +#define ev_int64_t long long +#elif EVENT__SIZEOF_LONG == 8 +#define ev_uint64_t unsigned long +#define ev_int64_t long +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_uint64_t ... +#define ev_int64_t ... +#else +#error "No way to define ev_uint64_t" +#endif + +#ifdef EVENT__HAVE_UINT32_T +#define ev_uint32_t uint32_t +#define ev_int32_t int32_t +#elif defined(_WIN32) +#define ev_uint32_t unsigned int +#define ev_int32_t signed int +#elif EVENT__SIZEOF_LONG == 4 +#define ev_uint32_t unsigned long +#define ev_int32_t signed long +#elif EVENT__SIZEOF_INT == 4 +#define ev_uint32_t unsigned int +#define ev_int32_t signed int +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_uint32_t ... +#define ev_int32_t ... +#else +#error "No way to define ev_uint32_t" +#endif + +#ifdef EVENT__HAVE_UINT16_T +#define ev_uint16_t uint16_t +#define ev_int16_t int16_t +#elif defined(_WIN32) +#define ev_uint16_t unsigned short +#define ev_int16_t signed short +#elif EVENT__SIZEOF_INT == 2 +#define ev_uint16_t unsigned int +#define ev_int16_t signed int +#elif EVENT__SIZEOF_SHORT == 2 +#define ev_uint16_t unsigned short +#define ev_int16_t signed short +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_uint16_t ... +#define ev_int16_t ... +#else +#error "No way to define ev_uint16_t" +#endif + +#ifdef EVENT__HAVE_UINT8_T +#define ev_uint8_t uint8_t +#define ev_int8_t int8_t +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_uint8_t ... +#define ev_int8_t ... +#else +#define ev_uint8_t unsigned char +#define ev_int8_t signed char +#endif + +#ifdef EVENT__HAVE_UINTPTR_T +#define ev_uintptr_t uintptr_t +#define ev_intptr_t intptr_t +#elif EVENT__SIZEOF_VOID_P <= 4 +#define ev_uintptr_t ev_uint32_t +#define ev_intptr_t ev_int32_t +#elif EVENT__SIZEOF_VOID_P <= 8 +#define ev_uintptr_t ev_uint64_t +#define ev_intptr_t ev_int64_t +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_uintptr_t ... +#define ev_intptr_t ... +#else +#error "No way to define ev_uintptr_t" +#endif + +#ifdef EVENT__ssize_t +#define ev_ssize_t EVENT__ssize_t +#else +#define ev_ssize_t ssize_t +#endif + +/* Note that we define ev_off_t based on the compile-time size of off_t that + * we used to build Libevent, and not based on the current size of off_t. + * (For example, we don't define ev_off_t to off_t.). We do this because + * some systems let you build your software with different off_t sizes + * at runtime, and so putting in any dependency on off_t would risk API + * mismatch. + */ +#ifdef _WIN32 +#define ev_off_t ev_int64_t +#elif EVENT__SIZEOF_OFF_T == 8 +#define ev_off_t ev_int64_t +#elif EVENT__SIZEOF_OFF_T == 4 +#define ev_off_t ev_int32_t +#elif defined(EVENT_IN_DOXYGEN_) +#define ev_off_t ... +#else +#define ev_off_t off_t +#endif +/**@}*/ + +/* Limits for integer types. + + We're making two assumptions here: + - The compiler does constant folding properly. + - The platform does signed arithmetic in two's complement. +*/ + +/** + @name Limits for integer types + + These macros hold the largest or smallest values possible for the + ev_[u]int*_t types. + + @{ +*/ +#ifndef EVENT__HAVE_STDINT_H +#define EV_UINT64_MAX ((((ev_uint64_t)0xffffffffUL) << 32) | 0xffffffffUL) +#define EV_INT64_MAX ((((ev_int64_t) 0x7fffffffL) << 32) | 0xffffffffL) +#define EV_INT64_MIN ((-EV_INT64_MAX) - 1) +#define EV_UINT32_MAX ((ev_uint32_t)0xffffffffUL) +#define EV_INT32_MAX ((ev_int32_t) 0x7fffffffL) +#define EV_INT32_MIN ((-EV_INT32_MAX) - 1) +#define EV_UINT16_MAX ((ev_uint16_t)0xffffUL) +#define EV_INT16_MAX ((ev_int16_t) 0x7fffL) +#define EV_INT16_MIN ((-EV_INT16_MAX) - 1) +#define EV_UINT8_MAX 255 +#define EV_INT8_MAX 127 +#define EV_INT8_MIN ((-EV_INT8_MAX) - 1) +#else +#define EV_UINT64_MAX UINT64_MAX +#define EV_INT64_MAX INT64_MAX +#define EV_INT64_MIN INT64_MIN +#define EV_UINT32_MAX UINT32_MAX +#define EV_INT32_MAX INT32_MAX +#define EV_INT32_MIN INT32_MIN +#define EV_UINT16_MAX UINT16_MAX +#define EV_INT16_MAX INT16_MAX +#define EV_UINT8_MAX UINT8_MAX +#define EV_INT8_MAX INT8_MAX +#define EV_INT8_MIN INT8_MIN +/** @} */ +#endif + + +/** + @name Limits for SIZE_T and SSIZE_T + + @{ +*/ +#if EVENT__SIZEOF_SIZE_T == 8 +#define EV_SIZE_MAX EV_UINT64_MAX +#define EV_SSIZE_MAX EV_INT64_MAX +#elif EVENT__SIZEOF_SIZE_T == 4 +#define EV_SIZE_MAX EV_UINT32_MAX +#define EV_SSIZE_MAX EV_INT32_MAX +#elif defined(EVENT_IN_DOXYGEN_) +#define EV_SIZE_MAX ... +#define EV_SSIZE_MAX ... +#else +#error "No way to define SIZE_MAX" +#endif + +#define EV_SSIZE_MIN ((-EV_SSIZE_MAX) - 1) +/**@}*/ + +#ifdef _WIN32 +#define ev_socklen_t int +#elif defined(EVENT__socklen_t) +#define ev_socklen_t EVENT__socklen_t +#else +#define ev_socklen_t socklen_t +#endif + +#ifdef EVENT__HAVE_STRUCT_SOCKADDR_STORAGE___SS_FAMILY +#if !defined(EVENT__HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY) \ + && !defined(ss_family) +#define ss_family __ss_family +#endif +#endif + +/** + * A type wide enough to hold the output of "socket()" or "accept()". On + * Windows, this is an intptr_t; elsewhere, it is an int. */ +#ifdef _WIN32 +#define evutil_socket_t intptr_t +#else +#define evutil_socket_t int +#endif + +/** + * Structure to hold information about a monotonic timer + * + * Use this with evutil_configure_monotonic_time() and + * evutil_gettime_monotonic(). + * + * This is an opaque structure; you can allocate one using + * evutil_monotonic_timer_new(). + * + * @see evutil_monotonic_timer_new(), evutil_monotonic_timer_free(), + * evutil_configure_monotonic_time(), evutil_gettime_monotonic() + */ +struct evutil_monotonic_timer +#ifdef EVENT_IN_DOXYGEN_ +{/*Empty body so that doxygen will generate documentation here.*/} +#endif +; + +#define EV_MONOT_PRECISE 1 +#define EV_MONOT_FALLBACK 2 + +/** Format a date string using RFC 1123 format (used in HTTP). + * If `tm` is NULL, current system's time will be used. + * The number of characters written will be returned. + * One should check if the return value is smaller than `datelen` to check if + * the result is truncated or not. + */ +EVENT2_EXPORT_SYMBOL int +evutil_date_rfc1123(char *date, const size_t datelen, const struct tm *tm); + +/** Allocate a new struct evutil_monotonic_timer for use with the + * evutil_configure_monotonic_time() and evutil_gettime_monotonic() + * functions. You must configure the timer with + * evutil_configure_monotonic_time() before using it. + */ +EVENT2_EXPORT_SYMBOL +struct evutil_monotonic_timer * evutil_monotonic_timer_new(void); + +/** Free a struct evutil_monotonic_timer that was allocated using + * evutil_monotonic_timer_new(). + */ +EVENT2_EXPORT_SYMBOL +void evutil_monotonic_timer_free(struct evutil_monotonic_timer *timer); + +/** Set up a struct evutil_monotonic_timer; flags can include + * EV_MONOT_PRECISE and EV_MONOT_FALLBACK. + */ +EVENT2_EXPORT_SYMBOL +int evutil_configure_monotonic_time(struct evutil_monotonic_timer *timer, + int flags); + +/** Query the current monotonic time from a struct evutil_monotonic_timer + * previously configured with evutil_configure_monotonic_time(). Monotonic + * time is guaranteed never to run in reverse, but is not necessarily epoch- + * based, or relative to any other definite point. Use it to make reliable + * measurements of elapsed time between events even when the system time + * may be changed. + * + * It is not safe to use this funtion on the same timer from multiple + * threads. + */ +EVENT2_EXPORT_SYMBOL +int evutil_gettime_monotonic(struct evutil_monotonic_timer *timer, + struct timeval *tp); + +/** Create two new sockets that are connected to each other. + + On Unix, this simply calls socketpair(). On Windows, it uses the + loopback network interface on 127.0.0.1, and only + AF_INET,SOCK_STREAM are supported. + + (This may fail on some Windows hosts where firewall software has cleverly + decided to keep 127.0.0.1 from talking to itself.) + + Parameters and return values are as for socketpair() +*/ +EVENT2_EXPORT_SYMBOL +int evutil_socketpair(int d, int type, int protocol, evutil_socket_t sv[2]); +/** Do platform-specific operations as needed to make a socket nonblocking. + + @param sock The socket to make nonblocking + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evutil_make_socket_nonblocking(evutil_socket_t sock); + +/** Do platform-specific operations to make a listener socket reusable. + + Specifically, we want to make sure that another program will be able + to bind this address right after we've closed the listener. + + This differs from Windows's interpretation of "reusable", which + allows multiple listeners to bind the same address at the same time. + + @param sock The socket to make reusable + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evutil_make_listen_socket_reuseable(evutil_socket_t sock); + +/** Do platform-specific operations to make a listener port reusable. + + Specifically, we want to make sure that multiple programs which also + set the same socket option will be able to bind, listen at the same time. + + This is a feature available only to Linux 3.9+ + + @param sock The socket to make reusable + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evutil_make_listen_socket_reuseable_port(evutil_socket_t sock); + +/** Do platform-specific operations as needed to close a socket upon a + successful execution of one of the exec*() functions. + + @param sock The socket to be closed + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evutil_make_socket_closeonexec(evutil_socket_t sock); + +/** Do the platform-specific call needed to close a socket returned from + socket() or accept(). + + @param sock The socket to be closed + @return 0 on success, -1 on failure + */ +EVENT2_EXPORT_SYMBOL +int evutil_closesocket(evutil_socket_t sock); +#define EVUTIL_CLOSESOCKET(s) evutil_closesocket(s) + +/** Do platform-specific operations, if possible, to make a tcp listener + * socket defer accept()s until there is data to read. + * + * Not all platforms support this. You don't want to do this for every + * listener socket: only the ones that implement a protocol where the + * client transmits before the server needs to respond. + * + * @param sock The listening socket to to make deferred + * @return 0 on success (whether the operation is supported or not), + * -1 on failure +*/ +EVENT2_EXPORT_SYMBOL +int evutil_make_tcp_listen_socket_deferred(evutil_socket_t sock); + +#ifdef _WIN32 +/** Return the most recent socket error. Not idempotent on all platforms. */ +#define EVUTIL_SOCKET_ERROR() WSAGetLastError() +/** Replace the most recent socket error with errcode */ +#define EVUTIL_SET_SOCKET_ERROR(errcode) \ + do { WSASetLastError(errcode); } while (0) +/** Return the most recent socket error to occur on sock. */ +EVENT2_EXPORT_SYMBOL +int evutil_socket_geterror(evutil_socket_t sock); +/** Convert a socket error to a string. */ +EVENT2_EXPORT_SYMBOL +const char *evutil_socket_error_to_string(int errcode); +#elif defined(EVENT_IN_DOXYGEN_) +/** + @name Socket error functions + + These functions are needed for making programs compatible between + Windows and Unix-like platforms. + + You see, Winsock handles socket errors differently from the rest of + the world. Elsewhere, a socket error is like any other error and is + stored in errno. But winsock functions require you to retrieve the + error with a special function, and don't let you use strerror for + the error codes. And handling EWOULDBLOCK is ... different. + + @{ +*/ +/** Return the most recent socket error. Not idempotent on all platforms. */ +#define EVUTIL_SOCKET_ERROR() ... +/** Replace the most recent socket error with errcode */ +#define EVUTIL_SET_SOCKET_ERROR(errcode) ... +/** Return the most recent socket error to occur on sock. */ +#define evutil_socket_geterror(sock) ... +/** Convert a socket error to a string. */ +#define evutil_socket_error_to_string(errcode) ... +/**@}*/ +#else +#define EVUTIL_SOCKET_ERROR() (errno) +#define EVUTIL_SET_SOCKET_ERROR(errcode) \ + do { errno = (errcode); } while (0) +#define evutil_socket_geterror(sock) (errno) +#define evutil_socket_error_to_string(errcode) (strerror(errcode)) +#endif + + +/** + * @name Manipulation macros for struct timeval. + * + * We define replacements + * for timeradd, timersub, timerclear, timercmp, and timerisset. + * + * @{ + */ +#ifdef EVENT__HAVE_TIMERADD +#define evutil_timeradd(tvp, uvp, vvp) timeradd((tvp), (uvp), (vvp)) +#define evutil_timersub(tvp, uvp, vvp) timersub((tvp), (uvp), (vvp)) +#else +#define evutil_timeradd(tvp, uvp, vvp) \ + do { \ + (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \ + (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \ + if ((vvp)->tv_usec >= 1000000) { \ + (vvp)->tv_sec++; \ + (vvp)->tv_usec -= 1000000; \ + } \ + } while (0) +#define evutil_timersub(tvp, uvp, vvp) \ + do { \ + (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \ + (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \ + if ((vvp)->tv_usec < 0) { \ + (vvp)->tv_sec--; \ + (vvp)->tv_usec += 1000000; \ + } \ + } while (0) +#endif /* !EVENT__HAVE_TIMERADD */ + +#ifdef EVENT__HAVE_TIMERCLEAR +#define evutil_timerclear(tvp) timerclear(tvp) +#else +#define evutil_timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0 +#endif +/**@}*/ + +/** Return true iff the tvp is related to uvp according to the relational + * operator cmp. Recognized values for cmp are ==, <=, <, >=, and >. */ +#define evutil_timercmp(tvp, uvp, cmp) \ + (((tvp)->tv_sec == (uvp)->tv_sec) ? \ + ((tvp)->tv_usec cmp (uvp)->tv_usec) : \ + ((tvp)->tv_sec cmp (uvp)->tv_sec)) + +#ifdef EVENT__HAVE_TIMERISSET +#define evutil_timerisset(tvp) timerisset(tvp) +#else +#define evutil_timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec) +#endif + +/** Replacement for offsetof on platforms that don't define it. */ +#ifdef offsetof +#define evutil_offsetof(type, field) offsetof(type, field) +#else +#define evutil_offsetof(type, field) ((off_t)(&((type *)0)->field)) +#endif + +/* big-int related functions */ +/** Parse a 64-bit value from a string. Arguments are as for strtol. */ +EVENT2_EXPORT_SYMBOL +ev_int64_t evutil_strtoll(const char *s, char **endptr, int base); + +/** Replacement for gettimeofday on platforms that lack it. */ +#ifdef EVENT__HAVE_GETTIMEOFDAY +#define evutil_gettimeofday(tv, tz) gettimeofday((tv), (tz)) +#else +struct timezone; +EVENT2_EXPORT_SYMBOL +int evutil_gettimeofday(struct timeval *tv, struct timezone *tz); +#endif + +/** Replacement for snprintf to get consistent behavior on platforms for + which the return value of snprintf does not conform to C99. + */ +EVENT2_EXPORT_SYMBOL +int evutil_snprintf(char *buf, size_t buflen, const char *format, ...) +#ifdef __GNUC__ + __attribute__((format(printf, 3, 4))) +#endif +; +/** Replacement for vsnprintf to get consistent behavior on platforms for + which the return value of snprintf does not conform to C99. + */ +EVENT2_EXPORT_SYMBOL +int evutil_vsnprintf(char *buf, size_t buflen, const char *format, va_list ap) +#ifdef __GNUC__ + __attribute__((format(printf, 3, 0))) +#endif +; + +/** Replacement for inet_ntop for platforms which lack it. */ +EVENT2_EXPORT_SYMBOL +const char *evutil_inet_ntop(int af, const void *src, char *dst, size_t len); +/** Replacement for inet_pton for platforms which lack it. */ +EVENT2_EXPORT_SYMBOL +int evutil_inet_pton(int af, const char *src, void *dst); +struct sockaddr; + +/** Parse an IPv4 or IPv6 address, with optional port, from a string. + + Recognized formats are: + - [IPv6Address]:port + - [IPv6Address] + - IPv6Address + - IPv4Address:port + - IPv4Address + + If no port is specified, the port in the output is set to 0. + + @param str The string to parse. + @param out A struct sockaddr to hold the result. This should probably be + a struct sockaddr_storage. + @param outlen A pointer to the number of bytes that that 'out' can safely + hold. Set to the number of bytes used in 'out' on success. + @return -1 if the address is not well-formed, if the port is out of range, + or if out is not large enough to hold the result. Otherwise returns + 0 on success. +*/ +EVENT2_EXPORT_SYMBOL +int evutil_parse_sockaddr_port(const char *str, struct sockaddr *out, int *outlen); + +/** Compare two sockaddrs; return 0 if they are equal, or less than 0 if sa1 + * preceeds sa2, or greater than 0 if sa1 follows sa2. If include_port is + * true, consider the port as well as the address. Only implemented for + * AF_INET and AF_INET6 addresses. The ordering is not guaranteed to remain + * the same between Libevent versions. */ +EVENT2_EXPORT_SYMBOL +int evutil_sockaddr_cmp(const struct sockaddr *sa1, const struct sockaddr *sa2, + int include_port); + +/** As strcasecmp, but always compares the characters in locale-independent + ASCII. That's useful if you're handling data in ASCII-based protocols. + */ +EVENT2_EXPORT_SYMBOL +int evutil_ascii_strcasecmp(const char *str1, const char *str2); +/** As strncasecmp, but always compares the characters in locale-independent + ASCII. That's useful if you're handling data in ASCII-based protocols. + */ +EVENT2_EXPORT_SYMBOL +int evutil_ascii_strncasecmp(const char *str1, const char *str2, size_t n); + +/* Here we define evutil_addrinfo to the native addrinfo type, or redefine it + * if this system has no getaddrinfo(). */ +#ifdef EVENT__HAVE_STRUCT_ADDRINFO +#define evutil_addrinfo addrinfo +#else +/** A definition of struct addrinfo for systems that lack it. + + (This is just an alias for struct addrinfo if the system defines + struct addrinfo.) +*/ +struct evutil_addrinfo { + int ai_flags; /* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */ + int ai_family; /* PF_xxx */ + int ai_socktype; /* SOCK_xxx */ + int ai_protocol; /* 0 or IPPROTO_xxx for IPv4 and IPv6 */ + size_t ai_addrlen; /* length of ai_addr */ + char *ai_canonname; /* canonical name for nodename */ + struct sockaddr *ai_addr; /* binary address */ + struct evutil_addrinfo *ai_next; /* next structure in linked list */ +}; +#endif +/** @name evutil_getaddrinfo() error codes + + These values are possible error codes for evutil_getaddrinfo() and + related functions. + + @{ +*/ +#if defined(EAI_ADDRFAMILY) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_ADDRFAMILY EAI_ADDRFAMILY +#else +#define EVUTIL_EAI_ADDRFAMILY -901 +#endif +#if defined(EAI_AGAIN) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_AGAIN EAI_AGAIN +#else +#define EVUTIL_EAI_AGAIN -902 +#endif +#if defined(EAI_BADFLAGS) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_BADFLAGS EAI_BADFLAGS +#else +#define EVUTIL_EAI_BADFLAGS -903 +#endif +#if defined(EAI_FAIL) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_FAIL EAI_FAIL +#else +#define EVUTIL_EAI_FAIL -904 +#endif +#if defined(EAI_FAMILY) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_FAMILY EAI_FAMILY +#else +#define EVUTIL_EAI_FAMILY -905 +#endif +#if defined(EAI_MEMORY) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_MEMORY EAI_MEMORY +#else +#define EVUTIL_EAI_MEMORY -906 +#endif +/* This test is a bit complicated, since some MS SDKs decide to + * remove NODATA or redefine it to be the same as NONAME, in a + * fun interpretation of RFC 2553 and RFC 3493. */ +#if defined(EAI_NODATA) && defined(EVENT__HAVE_GETADDRINFO) && (!defined(EAI_NONAME) || EAI_NODATA != EAI_NONAME) +#define EVUTIL_EAI_NODATA EAI_NODATA +#else +#define EVUTIL_EAI_NODATA -907 +#endif +#if defined(EAI_NONAME) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_NONAME EAI_NONAME +#else +#define EVUTIL_EAI_NONAME -908 +#endif +#if defined(EAI_SERVICE) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_SERVICE EAI_SERVICE +#else +#define EVUTIL_EAI_SERVICE -909 +#endif +#if defined(EAI_SOCKTYPE) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_SOCKTYPE EAI_SOCKTYPE +#else +#define EVUTIL_EAI_SOCKTYPE -910 +#endif +#if defined(EAI_SYSTEM) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_EAI_SYSTEM EAI_SYSTEM +#else +#define EVUTIL_EAI_SYSTEM -911 +#endif + +#define EVUTIL_EAI_CANCEL -90001 + +#if defined(AI_PASSIVE) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_PASSIVE AI_PASSIVE +#else +#define EVUTIL_AI_PASSIVE 0x1000 +#endif +#if defined(AI_CANONNAME) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_CANONNAME AI_CANONNAME +#else +#define EVUTIL_AI_CANONNAME 0x2000 +#endif +#if defined(AI_NUMERICHOST) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_NUMERICHOST AI_NUMERICHOST +#else +#define EVUTIL_AI_NUMERICHOST 0x4000 +#endif +#if defined(AI_NUMERICSERV) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_NUMERICSERV AI_NUMERICSERV +#else +#define EVUTIL_AI_NUMERICSERV 0x8000 +#endif +#if defined(AI_V4MAPPED) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_V4MAPPED AI_V4MAPPED +#else +#define EVUTIL_AI_V4MAPPED 0x10000 +#endif +#if defined(AI_ALL) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_ALL AI_ALL +#else +#define EVUTIL_AI_ALL 0x20000 +#endif +#if defined(AI_ADDRCONFIG) && defined(EVENT__HAVE_GETADDRINFO) +#define EVUTIL_AI_ADDRCONFIG AI_ADDRCONFIG +#else +#define EVUTIL_AI_ADDRCONFIG 0x40000 +#endif +/**@}*/ + +struct evutil_addrinfo; +/** + * This function clones getaddrinfo for systems that don't have it. For full + * details, see RFC 3493, section 6.1. + * + * Limitations: + * - When the system has no getaddrinfo, we fall back to gethostbyname_r or + * gethostbyname, with their attendant issues. + * - The AI_V4MAPPED and AI_ALL flags are not currently implemented. + * + * For a nonblocking variant, see evdns_getaddrinfo. + */ +EVENT2_EXPORT_SYMBOL +int evutil_getaddrinfo(const char *nodename, const char *servname, + const struct evutil_addrinfo *hints_in, struct evutil_addrinfo **res); + +/** Release storage allocated by evutil_getaddrinfo or evdns_getaddrinfo. */ +EVENT2_EXPORT_SYMBOL +void evutil_freeaddrinfo(struct evutil_addrinfo *ai); + +EVENT2_EXPORT_SYMBOL +const char *evutil_gai_strerror(int err); + +/** Generate n bytes of secure pseudorandom data, and store them in buf. + * + * Current versions of Libevent use an ARC4-based random number generator, + * seeded using the platform's entropy source (/dev/urandom on Unix-like + * systems; CryptGenRandom on Windows). This is not actually as secure as it + * should be: ARC4 is a pretty lousy cipher, and the current implementation + * provides only rudimentary prediction- and backtracking-resistance. Don't + * use this for serious cryptographic applications. + */ +EVENT2_EXPORT_SYMBOL +void evutil_secure_rng_get_bytes(void *buf, size_t n); + +/** + * Seed the secure random number generator if needed, and return 0 on + * success or -1 on failure. + * + * It is okay to call this function more than once; it will still return + * 0 if the RNG has been successfully seeded and -1 if it can't be + * seeded. + * + * Ordinarily you don't need to call this function from your own code; + * Libevent will seed the RNG itself the first time it needs good random + * numbers. You only need to call it if (a) you want to double-check + * that one of the seeding methods did succeed, or (b) you plan to drop + * the capability to seed (by chrooting, or dropping capabilities, or + * whatever), and you want to make sure that seeding happens before your + * program loses the ability to do it. + */ +EVENT2_EXPORT_SYMBOL +int evutil_secure_rng_init(void); + +/** + * Set a filename to use in place of /dev/urandom for seeding the secure + * PRNG. Return 0 on success, -1 on failure. + * + * Call this function BEFORE calling any other initialization or RNG + * functions. + * + * (This string will _NOT_ be copied internally. Do not free it while any + * user of the secure RNG might be running. Don't pass anything other than a + * real /dev/...random device file here, or you might lose security.) + * + * This API is unstable, and might change in a future libevent version. + */ +EVENT2_EXPORT_SYMBOL +int evutil_secure_rng_set_urandom_device_file(char *fname); + +/** Seed the random number generator with extra random bytes. + + You should almost never need to call this function; it should be + sufficient to invoke evutil_secure_rng_init(), or let Libevent take + care of calling evutil_secure_rng_init() on its own. + + If you call this function as a _replacement_ for the regular + entropy sources, then you need to be sure that your input + contains a fairly large amount of strong entropy. Doing so is + notoriously hard: most people who try get it wrong. Watch out! + + @param dat a buffer full of a strong source of random numbers + @param datlen the number of bytes to read from datlen + */ +EVENT2_EXPORT_SYMBOL +void evutil_secure_rng_add_bytes(const char *dat, size_t datlen); + +#ifdef __cplusplus +} +#endif + +#endif /* EVENT1_EVUTIL_H_INCLUDED_ */ diff --git a/Source/Import/libevent/Includes/Windows/event2/visibility.h b/Source/Import/libevent/Includes/Windows/event2/visibility.h new file mode 100644 index 0000000..fb16dbe --- /dev/null +++ b/Source/Import/libevent/Includes/Windows/event2/visibility.h @@ -0,0 +1,50 @@ +/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */ +/* + * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#ifndef EVENT2_VISIBILITY_H_INCLUDED_ +#define EVENT2_VISIBILITY_H_INCLUDED_ + +#include + +#if defined(event_EXPORTS) || defined(event_extra_EXPORTS) || defined(event_core_EXPORTS) +# if defined (__SUNPRO_C) && (__SUNPRO_C >= 0x550) +# define EVENT2_EXPORT_SYMBOL __global +# elif defined __GNUC__ +# define EVENT2_EXPORT_SYMBOL __attribute__ ((visibility("default"))) +# elif defined(_MSC_VER) +# define EVENT2_EXPORT_SYMBOL extern __declspec(dllexport) +# else +# define EVENT2_EXPORT_SYMBOL /* unknown compiler */ +# endif +#else +# if defined(EVENT__NEED_DLLIMPORT) && defined(_MSC_VER) && !defined(EVENT_BUILDING_REGRESS_TEST) +# define EVENT2_EXPORT_SYMBOL extern __declspec(dllimport) +# else +# define EVENT2_EXPORT_SYMBOL +# endif +#endif + +#endif /* EVENT2_VISIBILITY_H_INCLUDED_ */ diff --git a/Source/Import/libevent/LICENSE b/Source/Import/libevent/LICENSE new file mode 100644 index 0000000..70d76b3 --- /dev/null +++ b/Source/Import/libevent/LICENSE @@ -0,0 +1,74 @@ +Libevent is available for use under the following license, commonly known +as the 3-clause (or "modified") BSD license: + +============================== +Copyright (c) 2000-2007 Niels Provos +Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. +3. The name of the author may not be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +============================== + +Portions of Libevent are based on works by others, also made available by +them under the three-clause BSD license above. The copyright notices are +available in the corresponding source files; the license is as above. Here's +a list: + +log.c: + Copyright (c) 2000 Dug Song + Copyright (c) 1993 The Regents of the University of California. + +strlcpy.c: + Copyright (c) 1998 Todd C. Miller + +win32select.c: + Copyright (c) 2003 Michael A. Davis + +evport.c: + Copyright (c) 2007 Sun Microsystems + +ht-internal.h: + Copyright (c) 2002 Christopher Clark + +minheap-internal.h: + Copyright (c) 2006 Maxim Yegorushkin + +============================== + +The arc4module is available under the following, sometimes called the +"OpenBSD" license: + + Copyright (c) 1996, David Mazieres + Copyright (c) 2008, Damien Miller + + Permission to use, copy, modify, and distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + diff --git a/Source/Import/libevent/Prebuild/Linux/amd64/libevent-2.0.so.5 b/Source/Import/libevent/Prebuild/Linux/amd64/libevent-2.0.so.5 new file mode 100644 index 0000000..75a2b87 --- /dev/null +++ b/Source/Import/libevent/Prebuild/Linux/amd64/libevent-2.0.so.5 @@ -0,0 +1 @@ +libevent-2.0.so.5.1.9 \ No newline at end of file diff --git a/Source/Import/libevent/Prebuild/Linux/amd64/libevent-2.0.so.5.1.9 b/Source/Import/libevent/Prebuild/Linux/amd64/libevent-2.0.so.5.1.9 new file mode 100644 index 0000000..a2881ce Binary files /dev/null and b/Source/Import/libevent/Prebuild/Linux/amd64/libevent-2.0.so.5.1.9 differ diff --git a/Source/Import/libevent/Prebuild/Linux/amd64/libevent-static.a b/Source/Import/libevent/Prebuild/Linux/amd64/libevent-static.a new file mode 100644 index 0000000..3d3b2ee Binary files /dev/null and b/Source/Import/libevent/Prebuild/Linux/amd64/libevent-static.a differ diff --git a/Source/Import/libevent/Prebuild/Linux/amd64/libevent.so b/Source/Import/libevent/Prebuild/Linux/amd64/libevent.so new file mode 100644 index 0000000..75a2b87 --- /dev/null +++ b/Source/Import/libevent/Prebuild/Linux/amd64/libevent.so @@ -0,0 +1 @@ +libevent-2.0.so.5.1.9 \ No newline at end of file diff --git a/Source/Import/libevent/Prebuild/Linux/amd64/libevent_pthreads-2.0.so.5 b/Source/Import/libevent/Prebuild/Linux/amd64/libevent_pthreads-2.0.so.5 new file mode 100644 index 0000000..7aa9d15 --- /dev/null +++ b/Source/Import/libevent/Prebuild/Linux/amd64/libevent_pthreads-2.0.so.5 @@ -0,0 +1 @@ +libevent_pthreads-2.0.so.5.1.9 \ No newline at end of file diff --git a/Source/Import/libevent/Prebuild/Linux/amd64/libevent_pthreads-2.0.so.5.1.9 b/Source/Import/libevent/Prebuild/Linux/amd64/libevent_pthreads-2.0.so.5.1.9 new file mode 100644 index 0000000..50760ca Binary files /dev/null and b/Source/Import/libevent/Prebuild/Linux/amd64/libevent_pthreads-2.0.so.5.1.9 differ diff --git a/Source/Import/libevent/Prebuild/Linux/amd64/libevent_pthreads.so b/Source/Import/libevent/Prebuild/Linux/amd64/libevent_pthreads.so new file mode 100644 index 0000000..7aa9d15 --- /dev/null +++ b/Source/Import/libevent/Prebuild/Linux/amd64/libevent_pthreads.so @@ -0,0 +1 @@ +libevent_pthreads-2.0.so.5.1.9 \ No newline at end of file diff --git a/Source/Import/libevent/Prebuild/Linux/i386/libevent-2.0.so.5 b/Source/Import/libevent/Prebuild/Linux/i386/libevent-2.0.so.5 new file mode 100644 index 0000000..75a2b87 --- /dev/null +++ b/Source/Import/libevent/Prebuild/Linux/i386/libevent-2.0.so.5 @@ -0,0 +1 @@ +libevent-2.0.so.5.1.9 \ No newline at end of file diff --git a/Source/Import/libevent/Prebuild/Linux/i386/libevent-2.0.so.5.1.9 b/Source/Import/libevent/Prebuild/Linux/i386/libevent-2.0.so.5.1.9 new file mode 100644 index 0000000..62a931a Binary files /dev/null and b/Source/Import/libevent/Prebuild/Linux/i386/libevent-2.0.so.5.1.9 differ diff --git a/Source/Import/libevent/Prebuild/Linux/i386/libevent-static.a b/Source/Import/libevent/Prebuild/Linux/i386/libevent-static.a new file mode 100644 index 0000000..a667302 Binary files /dev/null and b/Source/Import/libevent/Prebuild/Linux/i386/libevent-static.a differ diff --git a/Source/Import/libevent/Prebuild/Linux/i386/libevent.so b/Source/Import/libevent/Prebuild/Linux/i386/libevent.so new file mode 100644 index 0000000..75a2b87 --- /dev/null +++ b/Source/Import/libevent/Prebuild/Linux/i386/libevent.so @@ -0,0 +1 @@ +libevent-2.0.so.5.1.9 \ No newline at end of file diff --git a/Source/Import/libevent/Prebuild/Linux/i386/libevent_pthreads-2.0.so.5 b/Source/Import/libevent/Prebuild/Linux/i386/libevent_pthreads-2.0.so.5 new file mode 100644 index 0000000..7aa9d15 --- /dev/null +++ b/Source/Import/libevent/Prebuild/Linux/i386/libevent_pthreads-2.0.so.5 @@ -0,0 +1 @@ +libevent_pthreads-2.0.so.5.1.9 \ No newline at end of file diff --git a/Source/Import/libevent/Prebuild/Linux/i386/libevent_pthreads-2.0.so.5.1.9 b/Source/Import/libevent/Prebuild/Linux/i386/libevent_pthreads-2.0.so.5.1.9 new file mode 100644 index 0000000..0fdc942 Binary files /dev/null and b/Source/Import/libevent/Prebuild/Linux/i386/libevent_pthreads-2.0.so.5.1.9 differ diff --git a/Source/Import/libevent/Prebuild/Linux/i386/libevent_pthreads.so b/Source/Import/libevent/Prebuild/Linux/i386/libevent_pthreads.so new file mode 100644 index 0000000..7aa9d15 --- /dev/null +++ b/Source/Import/libevent/Prebuild/Linux/i386/libevent_pthreads.so @@ -0,0 +1 @@ +libevent_pthreads-2.0.so.5.1.9 \ No newline at end of file diff --git a/Source/Import/libevent/Prebuild/Windows/amd64/libevent-2-1-6.dll b/Source/Import/libevent/Prebuild/Windows/amd64/libevent-2-1-6.dll new file mode 100644 index 0000000..4ef65e5 Binary files /dev/null and b/Source/Import/libevent/Prebuild/Windows/amd64/libevent-2-1-6.dll differ diff --git a/Source/Import/libevent/Prebuild/Windows/amd64/libevent-static.a b/Source/Import/libevent/Prebuild/Windows/amd64/libevent-static.a new file mode 100644 index 0000000..3a3adba Binary files /dev/null and b/Source/Import/libevent/Prebuild/Windows/amd64/libevent-static.a differ diff --git a/Source/Import/libevent/Prebuild/Windows/amd64/libevent.a b/Source/Import/libevent/Prebuild/Windows/amd64/libevent.a new file mode 100644 index 0000000..0500bf3 Binary files /dev/null and b/Source/Import/libevent/Prebuild/Windows/amd64/libevent.a differ diff --git a/Source/Import/libevent/Prebuild/Windows/i386/libevent-2-0-5.dll b/Source/Import/libevent/Prebuild/Windows/i386/libevent-2-0-5.dll new file mode 100644 index 0000000..d5bd732 Binary files /dev/null and b/Source/Import/libevent/Prebuild/Windows/i386/libevent-2-0-5.dll differ diff --git a/Source/Import/libevent/Prebuild/Windows/i386/libevent-static.a b/Source/Import/libevent/Prebuild/Windows/i386/libevent-static.a new file mode 100644 index 0000000..df1883a Binary files /dev/null and b/Source/Import/libevent/Prebuild/Windows/i386/libevent-static.a differ diff --git a/Source/Import/libevent/Prebuild/Windows/i386/libevent.a b/Source/Import/libevent/Prebuild/Windows/i386/libevent.a new file mode 100644 index 0000000..508a8d7 Binary files /dev/null and b/Source/Import/libevent/Prebuild/Windows/i386/libevent.a differ diff --git a/Source/Import/libevent/Sources/libevent-2.1.8-stable.tar.gz b/Source/Import/libevent/Sources/libevent-2.1.8-stable.tar.gz new file mode 100644 index 0000000..2004f84 Binary files /dev/null and b/Source/Import/libevent/Sources/libevent-2.1.8-stable.tar.gz differ diff --git a/Source/Import/libevent/qcbuild.src b/Source/Import/libevent/qcbuild.src new file mode 100644 index 0000000..2618327 --- /dev/null +++ b/Source/Import/libevent/qcbuild.src @@ -0,0 +1,63 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = libevent +PURPOSE = OS Independend toolkit to catch events on FD descriptors. +AUTHOR = Niels Provos and Nick Mathewson + +COPYRIGHT = Copyright (c) 2000-2007 Niels Provos , +COPYRIGHT += Copyright (c) 2007-2012 Niels Provos and Nick Mathewson + +DESC = Prebuild only. +LICENSE = BSD +VERSION = 2.0.21 + +# +# Linux only prebuild. +# + +.section Linux + ISRC = Includes/Linux/event2 + + PREBUILD_LIBS = Prebuild/Linux/$(ARCH)/libevent-static.a + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libevent.so + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libevent-2.0.so.5 + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libevent-2.0.so.5.1.9 + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libevent_pthreads.so + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libevent_pthreads-2.0.so.5 + PREBUILD_LIBS += Prebuild/Linux/$(ARCH)/libevent_pthreads-2.0.so.5.1.9 +.endsection + +# +# Windows only prebuild. +# + +.section MinGW + ISRC = Includes/Windows/event2 + + PREBUILD_LIBS = Prebuild/Windows/amd64/libevent.a + PREBUILD_LIBS += Prebuild/Windows/amd64/libevent-2-1-6.dll + PREBUILD_LIBS += Prebuild/Windows/amd64/libevent-static.a +.endsection diff --git a/Source/Import/libintl/Prebuild/Windows/libintl-8.dll b/Source/Import/libintl/Prebuild/Windows/libintl-8.dll new file mode 100644 index 0000000..cb96a93 Binary files /dev/null and b/Source/Import/libintl/Prebuild/Windows/libintl-8.dll differ diff --git a/Source/Import/libintl/Prebuild/Windows/libintl.a b/Source/Import/libintl/Prebuild/Windows/libintl.a new file mode 100644 index 0000000..1a58863 Binary files /dev/null and b/Source/Import/libintl/Prebuild/Windows/libintl.a differ diff --git a/Source/Import/libintl/qcbuild.src b/Source/Import/libintl/qcbuild.src new file mode 100644 index 0000000..52c64a1 --- /dev/null +++ b/Source/Import/libintl/qcbuild.src @@ -0,0 +1,41 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = libintl +PURPOSE = Provides native language support to programs, part of Gettext. +COPYRIGHT = Copyright (C) 1995-1997, 2000-2004 Free Software Foundation, Inc. +AUTHOR = Ulrich Drepper, Peter Miller, Bruno Haible, Karl Eichwalder + +DESC = Prebuild only. Needed by GLib. +LICENSE = LGPL + +# +# Windows only prebuild. +# + +.section MinGW + PREBUILD_LIBS = Prebuild/Windows/libintl-8.dll + PREBUILD_LIBS += Prebuild/Windows/libintl.a +.endsection diff --git a/Source/Import/strptime/qcbuild.src b/Source/Import/strptime/qcbuild.src new file mode 100644 index 0000000..951f1c5 --- /dev/null +++ b/Source/Import/strptime/qcbuild.src @@ -0,0 +1,42 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = libstrptime + +AUTHOR = Kungliga Tekniska Hiogskolan +COPYRIGHT = Copyright (c) 1999 Kungliga Tekniska Hiogskolan + +PURPOSE = Convert time/date strings into tm struct. + +DESC = Windows implementation of unix strptime() function. + +# +# Windows only. +# + +.section MinGW +CSRC = strptime.c +ISRC = strptime.h +.endsection diff --git a/Source/Import/strptime/strptime.c b/Source/Import/strptime/strptime.c new file mode 100644 index 0000000..92e707a --- /dev/null +++ b/Source/Import/strptime/strptime.c @@ -0,0 +1,444 @@ +/* + * Copyright (c) 1999 Kungliga Tekniska Hi?ogskolan + * (Royal Institute of Technology, Stockholm, Sweden). + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * 3. Neither the name of KTH nor the names of its contributors may be + * used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY KTH AND ITS CONTRIBUTORS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL KTH OR ITS CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR + * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, + * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR + * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ + +#ifdef WIN32 + +#include +#include +#include + +static const char *abb_weekdays[] = { + "Sun", + "Mon", + "Tue", + "Wed", + "Thu", + "Fri", + "Sat", + NULL +}; + +static const char *full_weekdays[] = { + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + NULL +}; + +static const char *abb_month[] = { + "Jan", + "Feb", + "Mar", + "Apr", + "May", + "Jun", + "Jul", + "Aug", + "Sep", + "Oct", + "Nov", + "Dec", + NULL +}; + +static const char *full_month[] = { + "January", + "February", + "Mars", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December", + NULL, +}; + +static const char *ampm[] = { + "am", + "pm", + NULL +}; + +/* + * Try to match `*buf' to one of the strings in `strs'. Return the + * index of the matching string (or -1 if none). Also advance buf. + */ + +static int +match_string (const char **buf, const char **strs) +{ + int i = 0; + + for (i = 0; strs[i] != NULL; ++i) { + int len = strlen (strs[i]); + + if (strncasecmp (*buf, strs[i], len) == 0) { + *buf += len; + return i; + } + } + return -1; +} + +/* + * tm_year is relative this year */ + +const int tm_year_base = 1900; + +/* + * Return TRUE iff `year' was a leap year. + */ + +static int +is_leap_year (int year) +{ + return (year % 4) == 0 && ((year % 100) != 0 || (year % 400) == 0); +} + +/* + * Return the weekday [0,6] (0 = Sunday) of the first day of `year' + */ + +static int +first_day (int year) +{ + int ret = 4; + + for (; year > 1970; --year) + ret = (ret + 365 + is_leap_year (year) ? 1 : 0) % 7; + return ret; +} + +/* + * Set `timeptr' given `wnum' (week number [0, 53]) + */ + +static void +set_week_number_sun (struct tm *timeptr, int wnum) +{ + int fday = first_day (timeptr->tm_year + tm_year_base); + + timeptr->tm_yday = wnum * 7 + timeptr->tm_wday - fday; + if (timeptr->tm_yday < 0) { + timeptr->tm_wday = fday; + timeptr->tm_yday = 0; + } +} + +/* + * Set `timeptr' given `wnum' (week number [0, 53]) + */ + +static void +set_week_number_mon (struct tm *timeptr, int wnum) +{ + int fday = (first_day (timeptr->tm_year + tm_year_base) + 6) % 7; + + timeptr->tm_yday = wnum * 7 + (timeptr->tm_wday + 6) % 7 - fday; + if (timeptr->tm_yday < 0) { + timeptr->tm_wday = (fday + 1) % 7; + timeptr->tm_yday = 0; + } +} + +/* + * Set `timeptr' given `wnum' (week number [0, 53]) + */ + +static void +set_week_number_mon4 (struct tm *timeptr, int wnum) +{ + int fday = (first_day (timeptr->tm_year + tm_year_base) + 6) % 7; + int offset = 0; + + if (fday < 4) + offset += 7; + + timeptr->tm_yday = offset + (wnum - 1) * 7 + timeptr->tm_wday - fday; + if (timeptr->tm_yday < 0) { + timeptr->tm_wday = fday; + timeptr->tm_yday = 0; + } +} + +/* + * + */ + +char * +strptime (const char *buf, const char *format, struct tm *timeptr) +{ + char c; + + for (; (c = *format) != '\0'; ++format) { + char *s; + int ret; + + if (isspace (c)) { + while (isspace (*buf)) + ++buf; + } else if (c == '%' && format[1] != '\0') { + c = *++format; + if (c == 'E' || c == 'O') + c = *++format; + switch (c) { + case 'A' : + ret = match_string (&buf, full_weekdays); + if (ret < 0) + return NULL; + timeptr->tm_wday = ret; + break; + case 'a' : + ret = match_string (&buf, abb_weekdays); + if (ret < 0) + return NULL; + timeptr->tm_wday = ret; + break; + case 'B' : + ret = match_string (&buf, full_month); + if (ret < 0) + return NULL; + timeptr->tm_mon = ret; + break; + case 'b' : + case 'h' : + ret = match_string (&buf, abb_month); + if (ret < 0) + return NULL; + timeptr->tm_mon = ret; + break; + case 'C' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + timeptr->tm_year = (ret * 100) - tm_year_base; + buf = s; + break; + case 'c' : + abort (); + case 'D' : /* %m/%d/%y */ + s = strptime (buf, "%m/%d/%y", timeptr); + if (s == NULL) + return NULL; + buf = s; + break; + case 'd' : + case 'e' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + timeptr->tm_mday = ret; + buf = s; + break; + case 'H' : + case 'k' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + timeptr->tm_hour = ret; + buf = s; + break; + case 'I' : + case 'l' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + if (ret == 12) + timeptr->tm_hour = 0; + else + timeptr->tm_hour = ret; + buf = s; + break; + case 'j' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + timeptr->tm_yday = ret - 1; + buf = s; + break; + case 'm' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + timeptr->tm_mon = ret - 1; + buf = s; + break; + case 'M' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + timeptr->tm_min = ret; + buf = s; + break; + case 'n' : + if (*buf == '\n') + ++buf; + else + return NULL; + break; + case 'p' : + ret = match_string (&buf, ampm); + if (ret < 0) + return NULL; + if (timeptr->tm_hour == 0) { + if (ret == 1) + timeptr->tm_hour = 12; + } else + timeptr->tm_hour += 12; + break; + case 'r' : /* %I:%M:%S %p */ + s = strptime (buf, "%I:%M:%S %p", timeptr); + if (s == NULL) + return NULL; + buf = s; + break; + case 'R' : /* %H:%M */ + s = strptime (buf, "%H:%M", timeptr); + if (s == NULL) + return NULL; + buf = s; + break; + case 'S' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + timeptr->tm_sec = ret; + buf = s; + break; + case 't' : + if (*buf == '\t') + ++buf; + else + return NULL; + break; + case 'T' : /* %H:%M:%S */ + case 'X' : + s = strptime (buf, "%H:%M:%S", timeptr); + if (s == NULL) + return NULL; + buf = s; + break; + case 'u' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + timeptr->tm_wday = ret - 1; + buf = s; + break; + case 'w' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + timeptr->tm_wday = ret; + buf = s; + break; + case 'U' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + set_week_number_sun (timeptr, ret); + buf = s; + break; + case 'V' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + set_week_number_mon4 (timeptr, ret); + buf = s; + break; + case 'W' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + set_week_number_mon (timeptr, ret); + buf = s; + break; + case 'x' : + s = strptime (buf, "%Y:%m:%d", timeptr); + if (s == NULL) + return NULL; + buf = s; + break; + case 'y' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + if (ret < 70) + timeptr->tm_year = 100 + ret; + else + timeptr->tm_year = ret; + buf = s; + break; + case 'Y' : + ret = strtol (buf, &s, 10); + if (s == buf) + return NULL; + timeptr->tm_year = ret - tm_year_base; + buf = s; + break; + case 'Z' : + abort (); + case '\0' : + --format; + /* FALLTHROUGH */ + case '%' : + if (*buf == '%') + ++buf; + else + return NULL; + break; + default : + if (*buf == '%' || *++buf == c) + ++buf; + else + return NULL; + break; + } + } else { + if (*buf == c) + ++buf; + else + return NULL; + } + } + return (char *)buf; +} + +#endif /* WIN32 */ diff --git a/Source/Import/strptime/strptime.h b/Source/Import/strptime/strptime.h new file mode 100644 index 0000000..16fcf55 --- /dev/null +++ b/Source/Import/strptime/strptime.h @@ -0,0 +1,44 @@ +/* + * Copyright (c) 1999 Kungliga Tekniska Hi?ogskolan + * (Royal Institute of Technology, Stockholm, Sweden). + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * 3. Neither the name of KTH nor the names of its contributors may be + * used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY KTH AND ITS CONTRIBUTORS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL KTH OR ITS CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR + * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, + * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR + * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ + +#ifndef strptime_H +#define strptime_H + +// +// BSD strptime() function for Windows. +// + +#ifdef WIN32 +extern "C" char *strptime(const char *buf, const char *fmt, struct tm *tm); +#endif + +#endif /* strptime_H */ diff --git a/Source/Net/LibCGI/CGI.cpp b/Source/Net/LibCGI/CGI.cpp new file mode 100644 index 0000000..7722719 --- /dev/null +++ b/Source/Net/LibCGI/CGI.cpp @@ -0,0 +1,572 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include "CGI.h" + +namespace Tegenaria +{ + // + // Global variables. + // + + SSMap _GET; + SSMap _COOKIE; + + static int InitOK = 0; + + // + // Converts a hex character to its integer value. + // + + static char _from_hex(char ch) + { + #pragma qcbuild_set_private(1) + + return isdigit(ch) ? ch - '0' : tolower(ch) - 'a' + 10; + } + + // + // Converts an integer value to its hex character. + // + + static char _to_hex(char code) + { + #pragma qcbuild_set_private(1) + + static char hex[] = "0123456789abcdef"; + + return hex[code & 15]; + } + + // + // Decode URL string. + // + // SRC - URL encoded string (IN). + // + // RETURNS: Decoded string. + // + + string CgiUrlDecode(string SRC) + { + DBG_ENTER3("CgiUrlDecode"); + + string ret; + + char ch; + + int i, ii; + + for (i = 0; i < SRC.length(); i++) + { + if (int(SRC[i]) == 37) + { + sscanf(SRC.substr(i + 1, 2).c_str(), "%x", &ii); + + ch = static_cast(ii); + + ret += ch; + + i = i + 2; + } + else if (SRC[i] == '+') + { + ret += ' '; + } + else + { + ret += SRC[i]; + } + } + + DBG_LEAVE3("CgiUrlDecode"); + + return (ret); + } + + // + // Encode arbitral string to URL. + // + // str - string to encode (IN). + // + // RETURNS: URL encoded string. + // + + string CgiUrlEncode(string str) + { + DBG_ENTER3("CgiUrlEncode"); + + string ret; + + char *pstr = (char *) str.c_str(); + + ret.resize(str.size() * 3 + 1); + + char *buf = (char *) ret.c_str(); + + char *pbuf = buf; + + while (*pstr) + { + if (isalnum(*pstr) || *pstr == '-' || *pstr == '_' || *pstr == '.' || *pstr == '~') + { + *pbuf++ = *pstr; + } + else if (*pstr == ' ') + { + *pbuf++ = '+'; + } + else + { + *pbuf++ = '%', *pbuf++ = _to_hex(*pstr >> 4); + + *pbuf++ = _to_hex(*pstr & 15); + } + + pstr++; + } + + *pbuf = '\0'; + + ret.resize(strlen(buf)); + + DBG_LEAVE3("CgiUrlEncode"); + + return ret; + } + + // + // Decode QUERY string to {lvalue |-> rvalue} map. + // + // ssmap - {lvalue |-> rvalue} map with decoded variables (OUT) + // userData - raw url encoded query get string (IN). + // delim - what is delim char to use (default '&') (IN/OPT). + // + // RETURNS: 0 if OK. + // + + int CgiDecodeUserVars(SSMap &ssmap, char *userData, const char delim) + { + DBG_ENTER3("CgiDecodeUserVars"); + + int exitCode = -1; + + char *field = NULL; + char *fieldEnd = NULL; + char *value = NULL; + char *valueEnd = NULL; + + char fieldEndZero = 0; + char valueEndZero = 0; + + string lvalue; + string rvalue; + + DBG_MSG("[%s]\n", userData); + + FAIL(userData == NULL); + + field = userData; + + while(fieldEnd = strchr(field, '=')) + { + swap(*fieldEnd, fieldEndZero); + + value = fieldEnd + 1; + + if (valueEnd = strchr(value, delim)) + { + swap(*valueEnd, valueEndZero); + } + + if (value && value[0] && strcmp(value, "0") != 0) + { + lvalue = CgiUrlDecode(field); + rvalue = CgiUrlDecode(value); + + ssmap[lvalue] = rvalue; + + DBG_MSG("[%s] : [%s]\n", lvalue.c_str(), rvalue.c_str()); + } + + swap(*fieldEnd, fieldEndZero); + + if (valueEndZero) + { + swap(*valueEnd, valueEndZero); + + field = valueEnd + 1; + } + else + { + break; + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot parse user data.\n"); + } + + DBG_LEAVE3("CgiDecodeUserVars"); + + return exitCode; + } + + // + // Create QUERY string from string |-> string map. + // + + string CgiEncodeUserVars(SSMap &ssmap) + { + DBG_ENTER3("CgiEncodeUserVars"); + + string ret; + + map::iterator it; + + for (it = ssmap.begin(); it != ssmap.end(); it ++) + { + if (it -> second != "0") + { + if (!ret.empty()) + { + ret += "&"; + } + + ret += CgiUrlEncode(it -> first); + ret += "="; + ret += CgiUrlEncode(it -> second); + } + } + + DBG_MSG3("EncodeUserVars : [%s]\n", ret.c_str()); + + DBG_LEAVE3("CgiEncodeUserVars"); + + return ret; + } + + // + // Init CGI library. + // MUST be called one time before first use. + // + // RETURNS: 0 if OK. + // + + int CgiInit() + { + DBG_ENTER("CgiInit"); + + int exitCode = -1; + + char *getData = NULL; + char *cookieData = NULL; + + if (InitOK == 0) + { + // + // Decode Get variables. + // + + getData = getenv("QUERY_STRING"); + + if (getData && getData[0]) + { + DBG_MSG("CgiInit : Parsing QUERY_STRING [%s]...\n", getData); + + FAIL(CgiDecodeUserVars(_GET, getData)); + } + + // + // Decode Cookie variables. + // + + cookieData = getenv("HTTP_COOKIE"); + + if (cookieData && cookieData[0]) + { + DBG_MSG("CgiInit : Parsing HTTP_COOKIE [%s]...\n", cookieData); + + FAIL(CgiDecodeUserVars(_COOKIE, cookieData, ';')); + } + + InitOK = 1; + } + else + { + DBG_MSG("CgiInit : CGI is already initiated.\n"); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot init CGI interface.\n"); + } + + DBG_LEAVE("CgiInit"); + + return exitCode; + }; + + // + // Retrieve value of given GET variable. + // + // lvalue - name of variable to found (IN). + // + // RETURNS: Pointer to variable value or NULL if not found. + // + + const char *CgiGet(const char *lvalue) + { + if (lvalue == NULL) + { + return NULL; + } + + SSMap::iterator it = _GET.find(lvalue); + + if (it == _GET.end()) + { + return NULL; + } + + return it -> second.c_str(); + } + + // + // + // + + void CgiHashAdd(string &hash, const string &str) + { + DBG_ENTER3("CgiHashAdd"); + + char tmp[16]; + + DBG_MSG3("Adding string [%s] to hash...\n", str.c_str()); + + // + // Add string to hash letter by letter, but + // convert special characters into hex. + // + + for (int i = 0; i < str.size(); i++) + { + unsigned char uc = (unsigned char) str[i]; + + // + // Allowed char. Add to hash directly. + // + + switch(uc) + { + // + // Concert PL chars into pure ASCII. + // + + case 0xc4: + { + i ++; + + uc = (unsigned char) str[i]; + + switch(uc) + { + case 0x84: + case 0x85: hash += 'a'; break; + + case 0x86: + case 0x87: hash += 'c'; break; + + case 0x98: + case 0x99: hash += 'e'; break; + } + + break; + } + + case 0xc5: + { + i ++; + + uc = (unsigned char) str[i]; + + switch(uc) + { + case 0x81: + case 0x82: hash += 'l'; break; + + case 0x83: + case 0x84: hash += 'n'; break; + + case 0x9a: + case 0x9b: hash += 's'; break; + + case 0xb9: + case 0xba: hash += 'z'; break; + + case 0xbb: + case 0xbc: hash += 'z'; break; + } + + break; + } + + case 0xc3: + { + i ++; + + uc = (unsigned char) (str[i]); + + switch(uc) + { + case 0x93: + case 0xb3: hash += 'o'; break; + } + + break; + } + + // + // Lowerize big letters. + // + + case 'A'...'Z': + { + hash += str[i] + 32; + + break; + } + + // + // Low letters and digits go without change. + // + + case 'a'...'z': + case '0'...'9': + { + hash += str[i]; + + break; + } + + // + // Unallowed. Add hex dump. + // + + default: + { + char tmp[8]; + + snprintf(tmp, 3, "%02x", (unsigned char) str[i]); + + hash += tmp; + } + } + } + + hash += '#'; + + DBG_LEAVE3("CgiHashAdd"); + } + + void CgiHashAdd(string &hash, int value) + { + DBG_ENTER3("CgiHashAdd"); + + DBG_MSG("Adding integer [%d] to hash...\n", value); + + char tmp[16 + 1]; + + snprintf(tmp, 16, "%x", value); + + hash += tmp; + + hash += '#'; + + DBG_LEAVE3("CgiHashAdd"); + } + + // + // Default hash function. + // Works always, but may be ineficient in general case. + // Should be reimplemented in derived to fit case sensitive, + // local characters, arguments order etc. + // + // RETURNS: none. + // + + void CgiHashArgs(string &hash) + { + DBG_ENTER("CgiHashArgs"); + + SSMap::iterator it; + + hash.clear(); + + for (it = _GET.begin(); it != _GET.end(); it++) + { + // + // If argument's value is empty, tt's unuset from CGI point of view, so + // don't add it to hash. + // + + if (!it -> second.empty()) + { + CgiHashAdd(hash, it -> first); + CgiHashAdd(hash, it -> second); + } + else + { + DBG_MSG("CgiHashArgs : Skipped empty variable [%s].\n", it -> first.c_str()); + } + } + + if (hash.empty()) + { + hash = "#"; + } + + DBG_MSG("Hashed args to [%s].\n", hash.c_str()); + + DBG_LEAVE("CgiHashArgs"); + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibCGI/CGI.h b/Source/Net/LibCGI/CGI.h new file mode 100644 index 0000000..80604b3 --- /dev/null +++ b/Source/Net/LibCGI/CGI.h @@ -0,0 +1,60 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Net_CGI_H +#define Tegenaria_Net_CGI_H + +#include + +namespace Tegenaria +{ + // + // Exported variables. + // + + extern SSMap _GET; + extern SSMap _COOKIE; + + // + // Exported functions. + // + + string CgiUrlDecode(string SRC); + string CgiUrlEncode(string str); + + int CgiDecodeUserVars(SSMap &ssmap, char *userData, const char delim = '&'); + + string CgiEncodeUserVars(SSMap &ssmap); + + const char *CgiGet(const char *lvalue); + + void CgiHashAdd(string &hash, const string &str); + void CgiHashAdd(string &hash, int value); + void CgiHashArgs(string &hash); + + int CgiInit(); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Net_CGI_H */ diff --git a/Source/Net/LibCGI/qcbuild.src b/Source/Net/LibCGI/qcbuild.src new file mode 100644 index 0000000..6f25d60 --- /dev/null +++ b/Source/Net/LibCGI/qcbuild.src @@ -0,0 +1,38 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibCGI +AUTHOR = Sylwester Wysocki + +PURPOSE = Set up environment for CGI/C++ program. +DESC = It handles _GET[], _POST[] and _COOKIE[] arrays like PHP. + +INC_DIR = Tegenaria + +CXXSRC = CGI.cpp +ISRC = CGI.h +LIBS = -lssmap -lstr -lfile -ldebug + +DEPENDS = LibSSMap LibStr LibFile LibDebug \ No newline at end of file diff --git a/Source/Net/LibNet/Client.cpp b/Source/Net/LibNet/Client.cpp new file mode 100644 index 0000000..f2f1b59 --- /dev/null +++ b/Source/Net/LibNet/Client.cpp @@ -0,0 +1,581 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: TCP/IP4 client. +// +// Usage: +// +// NetConection *nc = NetConnect(ip, port) +// nc -> write(...) +// nc -> read(...) +// nc -> request(...) +// delete nc +// + +#pragma qcbuild_set_file_title("Client side API"); + +#include "Net.h" +#include "NetInternal.h" +#include "NetTcpConnection.h" + +namespace Tegenaria +{ + // + // Open connection to server. + // + // host - server's ip address or hostname eg. "google.pl" (IN). + // port - port, on which server is listening (IN). + // timeout - timeout in miliseconds (IN/OPT). + // + // RETURNS: Pointer to new allocated NetConnection or + // NULL if error. + // + // WARNING: Caller MUST delete returned NetConnection object. + // + // TIP: Use read/write method fro NetConnection to communicate with + // remote host. + // + + NetConnection *NetConnect(const char *host, int port, int timeout) + { + DBG_ENTER("NetConnect"); + + int exitCode = -1; + + SOCKET sock = -1; + + struct sockaddr_in sa = {0}; + + NetConnection *nc = NULL; + + int connected = 0; + + vector ip; + + // + // Check args. + // + + FAILEX(host == NULL, "ERROR: Host cannot be NULL in NetConnect().\n"); + FAILEX(port == 0, "ERROR: Port cannot be 0 in NetConnect().\n"); + + // + // Initialize WinSock 2.2 on windows. + // + + FAIL(_NetInit()); + + // + // Resolve hostname. + // + + FAIL(NetResolveIp(ip, host)); + + // + // Create socket. + // + + sock = socket(AF_INET, SOCK_STREAM, 0); + + DBG_SET_ADD("socket", sock, "OUT"); + + // + // Set socket to non-block mode. + // + + FAIL(NetSetNonBlockMode(sock)); + + // + // Async connect. + // + + sa.sin_family = AF_INET; + sa.sin_addr.s_addr = inet_addr(ip[0].c_str()); + sa.sin_port = htons(port); + + DBG_MSG3("NetConnect : Connecting to '%s:%d' on SOCKET #%d...\n", host, port, sock); + + if (connect(sock, (struct sockaddr *) &sa, sizeof(sa)) < 0) + { + // + // Windows. + // + + #ifdef WIN32 + { + int lastError = WSAGetLastError(); + + switch(lastError) + { + // + // Already connected. + // + + case WSAEISCONN: + { + connected = 1; + + break; + } + + // + // Work in progress. + // Handle in select below. + // + + case WSAEWOULDBLOCK: + case WSAEINPROGRESS: + { + break; + } + + // + // Unexpected error. + // + + default: + { + Error("ERROR: Unexpected connect() error code '%d'.\n", lastError); + + goto fail; + } + } + } + + // + // Linux, MacOS. + // + + #else + { + switch(errno) + { + // + // Already connected. + // + + case EISCONN: + { + connected = 1; + + break; + } + + // + // Work in progress. + // Handle in select below. + // + + case EINPROGRESS: + case EAGAIN: + { + break; + } + + // + // Unexpected error. + // + + default: + { + Error("ERROR: Unexpected connect() error code '%d'.\n", errno); + + goto fail; + } + } + } + #endif + + // + // If still not connected. + // + + if (connected == 0) + { + fd_set fdset; + + struct timeval tv; + + int valopt = 0; + + socklen_t len = sizeof(valopt); + + tv.tv_sec = timeout / 1000; + tv.tv_usec = timeout % 1000 * 1000; + + FD_ZERO(&fdset); + + FD_SET(sock, &fdset); + + FAILEX(select(sock + 1, NULL, &fdset, NULL, &tv) <= 0, + "ERROR: Timeout while connecting to '%s':'%d'.\n", host, port); + + len = sizeof(int); + + getsockopt(sock, SOL_SOCKET, SO_ERROR, (char *) (&valopt), &len); + + FAILEX(valopt, "ERROR: connect() failed with error %d.\n", valopt); + + connected = 1; + } + } + else + { + connected = 1; + } + + FAIL(connected == 0); + + // + // Set back to block mode. + // + + FAIL(NetSetBlockMode(sock)); + + // + // Wrap connected socket into connection object. + // + + nc = new NetTcpConnection(NULL, sock, NULL, sa); + + nc -> setState(NET_STATE_ESTABLISHED); + + DBG_SET_RENAME("NetTcpConnection", nc, "OUT"); + + DEBUG1("NetConnect : Connected to '%s:%d' on SOCKET #%d...\n", host, port, sock); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot connect to '%s:%d'.\n" + "Error code is : %d.\n", host, port, GetLastError()); + + if (int(sock) != -1) + { + if (nc) + { + nc -> release(); + + nc = NULL; + } + else + { + shutdown(sock, SD_BOTH); + + closesocket(sock); + + DBG_SET_DEL("socket", sock); + } + + sock = -1; + } + } + + DBG_LEAVE("NetConnect"); + + return nc; + } + + // + // - Send single, printf like formatted request to server + // - read answer in format 'XYZ > message' + // - split answer to code and parts. + // + // Example usage: + // + // NetRequest(fd, &serverCode, serverMsg, sizeof(serverMsg), + // "share --alias %s --path %s", alias, path); + // + // TIP: If only exit code is needed can be set to NULL. + // + // fd - CRT FDs IN/OUT pair connected to the server (IN). + // serverCode - exit code returned by server (OUT). + // serverMsg - ASCIZ message returned by server (OUT/OPT). + // serverMsgSize - size of answer buffer in bytes (IN). + // fmt - printf like parameters to format command to send (IN). + // + // RETURNS: 0 if request sucessfuly sent and asnwer from server received. + // -1 otherwise. + // + // WARNING!: Request could still failed on server side. + // To get server's side exit code use 'answerCode' parameter. + // + + int _NetRequestWorker(NetRequestData *req) + { + #pragma qcbuild_set_private(1) + + DBG_ENTER("_NetRequestWorker"); + + int exitCode = -1; + + char buf[1024]; + + int cmdLen = 0; + + char *dst = NULL; + + int readed = 0; + int total = 0; + + int len = 0; + + int endReached = 0; + + va_list ap; + + // + // Check args. + // + + FAILEX(req -> fd_[0] < 0, "ERROR: Wrong FD #%d in NetRequestData.", req -> fd_[0]); + FAILEX(req -> fd_[1] < 0, "ERROR: Wrong FD #%d in NetRequestData.", req -> fd_[1]); + FAILEX(req -> serverCode_ == NULL, "ERROR: 'serverCode' cannot be NULL in NetRequestData."); + FAILEX(req -> data_ == NULL, "ERROR: 'data' cannot be NULL in NetRequestData."); + FAILEX(req -> dataSize_ <= 0, "ERROR: 'dataSize' cannot be NULL in NetRequestData."); + + // + // Send command to server INCLUDING zero terminator byte. + // + + FAILEX(write(req -> fd_[1], req -> data_, req -> dataSize_ + 1) < 0, + "ERROR: Cannot send NetRequest to FD [%d].\n", req -> fd_[1]); + + // + // Read answer from server in below format: + // 'XYZ> ' + // + // Where is 3 decimal server side code e.g. "871". + // + + // + // Read 'XYZ >' prefix first. + // where XYZ is 3 decimal exit code returned by server. + // + + FAILEX(read(req -> fd_[0], buf, 5) != 5, + "ERROR: Cannot read 'XYZ> ' prefix from FD [%d].", req -> fd_[0]); + + buf[4] = 0; + + *(req -> serverCode_) = atoi(buf); + + // + // Read ASCIZ message part if needed. + // + + if (req -> serverMsg_ && req -> serverMsgSize_ > 0) + { + dst = req -> serverMsg_; + + total = 0; + + // + // FIXME: Avoid reading byte by byte. + // + + while(read(req -> fd_[0], dst, 1) == 1) + { + // + // Zero terminator reached. + // All message sent. + // + + if (dst[0] == 0) + { + endReached = 1; + + break; + } + + // + // No space in caller buffer. + // + + if (total == req -> serverMsgSize_) + { + Error("ERROR: Caller buffer too small.\n"); + + // + // Eat remaining packet data to make transfer consistent. + // + + char byte = 0; + + int bytesEated = 0; + + while(read(req -> fd_[0], &byte, 1) == 1 && byte != 0) + { + bytesEated ++; + } + + Error("ERROR: Eated %d not catched bytes.\n", bytesEated); + + goto fail; + } + + total ++; + + dst ++; + } + + req -> serverMsg_[total] = 0; + } + + exitCode = 0; + + // + // Clean up. + // + + fail: + + if (exitCode) + { + Error("Cannot send NET request to FDs [%d/%d].\n" + "Error code is : %d.\n", req -> fd_[0], req -> fd_[1], GetLastError()); + } + + DBG_LEAVE("_NetRequestWorker"); + + return exitCode; + + }; + + int NetRequest(int fd[2], int *serverCode, char *serverMsg, + int serverMsgSize, const char *fmt, ...) + { + DBG_ENTER("NetRequest"); + + int exitCode = -1; + + char buf[1024]; + + int len = 0; + + va_list ap; + + NetRequestData req = {0}; + + ThreadHandle_t *thread = NULL; + + int result = -1; + + // + // Check args. + // + + FAILEX(fd[0] < 0, "ERROR: Wrong FD #%d in NetRequest.", fd[0]); + FAILEX(fd[1] < 0, "ERROR: Wrong FD #%d in NetRequest.", fd[1]); + FAILEX(serverCode == NULL, "ERROR: 'serverCode' cannot be NULL in NetRequest."); + FAILEX(fmt == NULL, "ERROR: 'fmt' cannot be NULL in NetRequest."); + + // + // Format printf like message. + // + + va_start(ap, fmt); + + len = vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + + va_end(ap); + + // + // Run request in background thread. + // + + req.fd_[0] = fd[0]; + req.fd_[1] = fd[1]; + req.serverCode_ = serverCode; + req.serverMsg_ = serverMsg; + req.serverMsgSize_ = serverMsgSize; + req.data_ = buf; + req.dataSize_ = len; + + thread = ThreadCreate(_NetRequestWorker, &req); + + DBG_SET_RENAME("thread", thread, "NET Request FDs #%d/%d", fd[0], fd[1]); + + if (ThreadWait(thread, &result, 10000) == 0) + { + Error("Timeout reached while sending NET request to FDs [%d/%d].", fd[0], fd[1]); + + ThreadKill(thread); + + goto fail; + } + + FAIL(result != 0); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot send NET request to FDs [%d/%d].\n" + "Error code is : %d.\n", fd[0], fd[1], GetLastError()); + + #ifdef WIN32 + { + if (CancelIo(HANDLE(_get_osfhandle(fd[0])))) + { + DBG_MSG("NetRequest : IO canceled on FD [%d].\n", fd[0]); + } + else + { + DBG_MSG("WARNING: Cannot cancel pending I/O on FD [%d].", fd[0]); + } + + if (CancelIo(HANDLE(_get_osfhandle(fd[1])))) + { + DBG_MSG("NetRequest : IO canceled on FD [%d].\n", fd[1]); + } + else + { + DBG_MSG("WARNING: Cannot cancel pending I/O on FD [%d].", fd[1]); + } + } + #endif + } + + ThreadClose(thread); + + DBG_LEAVE("NetRequest"); + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/Example01-thread-server/Example01.cpp b/Source/Net/LibNet/Example01-thread-server/Example01.cpp new file mode 100644 index 0000000..fbeacbf --- /dev/null +++ b/Source/Net/LibNet/Example01-thread-server/Example01.cpp @@ -0,0 +1,137 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include +#include + +#include + +using namespace Tegenaria; + +static int CountConnections = 0; + +// +// Callback handler to process one incoming connection. +// +// This function is runned in another thred created +// by main server loop. +// + +int ServeClient(NetConnection *nc) +{ + char msg[64] = {0}; + + //nc -> read(msg, sizeof(msg)); + + int readed = recv(nc -> getSocket(), msg, sizeof(msg), 0); + + #ifdef WIN32 + int lastError = GetLastError(); + #else + int lastError = errno; + #endif + + printf("--------------------\n"); + printf(" Connection no : [%d]\n", CountConnections); + printf(" Connection socket : [%d]\n", nc -> getSocket()); + printf(" Client info : [%s]\n", nc -> getClientInfo()); + printf(" Bytes readed : [%d]\n", readed); + printf(" Clent message : [%s]\n", msg); + printf(" Errno : [%d]\n", lastError); + printf("--------------------\n"); + + CountConnections ++; + + nc -> release(); + + return 0; +}; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + // + // No arguments. + // Create server in background thread, which: + // + // - uses our ServerClient() routine to process incoming connections. + // - listens on port 6666 + // + + if (argc < 3) + { + DBG_HEAD("DIRLIGO-SERVER-0.1\nBuild [%s, %s]\n", __DATE__, __TIME__); + + NetConnection *nc = NetServerCreate(6666, ServeClient); + + FAIL(nc == NULL); + + printf("Server created with handle [%p].\n", nc); + + // + // Fall into loop. + // + + nc -> join(); + } + + // + // 'libnet-example '. + // Client mode. + // + + else + { + DBG_HEAD("DIRLIGO-CLIENT-0.1\nBuild [%s, %s]\n", __DATE__, __TIME__); + + const char *ip = argv[1]; + + int port = atoi(argv[2]); + + int written = 0; + + NetConnection *nc = NetConnect(ip, port); + + FAIL(nc == NULL); + + written = nc -> write("HELLO FROM CLIENT!", 18); + + printf("Bytes written : [%d].\n", written); + + nc -> release(); + } + + // + // Clean Up. + // + + fail: + + return 0; +} diff --git a/Source/Net/LibNet/Example01-thread-server/qcbuild.src b/Source/Net/LibNet/Example01-thread-server/qcbuild.src new file mode 100644 index 0000000..fbacafb --- /dev/null +++ b/Source/Net/LibNet/Example01-thread-server/qcbuild.src @@ -0,0 +1,47 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibNet-example01-thread-server +CXXSRC = Example01.cpp + +LIBS = -lnet -ldebug -lthread -lprocess -lstr -llock + +DEPENDS = LibDebug LibNet LibProcess LibThread LibLock + +# +# Windows specific. +# + +.section MinGW + LIBS += -lws2_32 +.endsection + +# +# Linux specific. +# + +.section Linux + LIBS += -lpthread +.endsection diff --git a/Source/Net/LibNet/Example02-single/Example02.cpp b/Source/Net/LibNet/Example02-single/Example02.cpp new file mode 100644 index 0000000..0fef1e1 --- /dev/null +++ b/Source/Net/LibNet/Example02-single/Example02.cpp @@ -0,0 +1,88 @@ +/**************************************************************************/ +/* */ +/* This file is part of Tegenaria project. */ +/* Copyright (c) 2010, 2015 Sylwester Wysocki (sw143@wp.pl). */ +/* */ +/* The Tegenaria library and any derived work however based on this */ +/* software are copyright of Sylwester Wysocki. Redistribution and use of */ +/* the present software is allowed according to terms specified in the */ +/* file LICENSE which comes in the source distribution. */ +/* */ +/* All rights reserved. */ +/* */ +/**************************************************************************/ + +#include +#include +#include +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + // + // No arguments. + // + // - Wait for connection on 0.0.0.0:6666. + // + + if (argc < 3) + { + char buf[64] = {0}; + + int readed = 0; + + DBG_HEAD("DIRLIGO-SERVER-0.1\nBuild [%s, %s]\n", __DATE__, __TIME__); + + NetConnection *nc = NetAccept(6666); + + FAIL(nc == NULL); + + readed = nc -> read(buf, sizeof(buf)); + + nc -> release(); + + printf("Readed [%d] bytes [%s].\n", readed, buf); + } + + // + // 'libnet-example-single '. + // Connect to server listening on ip:port. + // + + else + { + char buf[64] = "Hello from client.\n"; + + DBG_HEAD("DIRLIGO-CLIENT-0.1\nBuild [%s, %s]\n", __DATE__, __TIME__); + + const char *ip = argv[1]; + + int port = atoi(argv[2]); + + int written = 0; + + NetConnection *nc = NetConnect(ip, port); + + FAIL(nc == NULL); + + written = nc -> write(buf, strlen(buf)); + + printf("Written [%d] bytes [%s].\n", written, buf); + + nc -> release(); + } + + // + // Clean Up. + // + + fail: + + return 0; +} diff --git a/Source/Net/LibNet/Example02-single/qcbuild.src b/Source/Net/LibNet/Example02-single/qcbuild.src new file mode 100644 index 0000000..f186b5f --- /dev/null +++ b/Source/Net/LibNet/Example02-single/qcbuild.src @@ -0,0 +1,47 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibNet-example02-single +CXXSRC = Example02.cpp + +LIBS = -lnet -ldebug -lthread -lprocess -lstr -llock + +DEPENDS = LibDebug LibNet LibProcess LibThread LibLock + +# +# Windows specific. +# + +.section MinGW + LIBS += -lws2_32 +.endsection + +# +# Linux specific. +# + +.section Linux + LIBS += -lpthread +.endsection diff --git a/Source/Net/LibNet/Example03-epoll-server/Example03.cpp b/Source/Net/LibNet/Example03-epoll-server/Example03.cpp new file mode 100644 index 0000000..0a1008f --- /dev/null +++ b/Source/Net/LibNet/Example03-epoll-server/Example03.cpp @@ -0,0 +1,89 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to set up echo epoll server. +// Code works on Linux only. +// + +#include +#include +#include +#include + +using namespace Tegenaria; + +// +// Handler called when new connection arrived. +// + +void OpenHandler(NetEpollContext *ctx, int fd) +{ + printf("Opened connection on FD #%d.\n", fd); +} + +// +// Handler called when existing connection closed. +// + +void CloseHandler(NetEpollContext *ctx, int fd) +{ + printf("Closed connection on FD #%d.\n", fd); +} + +// +// Handler called when something to read on given fd. +// + +void DataHandler(NetEpollContext *ctx, int fd, void *buf, int len) +{ + printf("Readed %d bytes from FD #%d.\n", len, fd); + + // + // Write back readed data to client. + // + // !WARNING! Don't use raw write here. + // + + int written = NetEpollWrite(ctx, fd, buf, len); + + printf("Written %d bytes to FD #%d.\n", written, fd); +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_HEAD("DIRLIGO-EPOLL-SERVER\nBuild [%s, %s]\n", __DATE__, __TIME__); + + // + // Start epoll server waiting on TCP port 6666. + // + + NetEpollServerLoop(6666, OpenHandler, CloseHandler, DataHandler); + + return 0; +} diff --git a/Source/Net/LibNet/Example03-epoll-server/qcbuild.src-disabled b/Source/Net/LibNet/Example03-epoll-server/qcbuild.src-disabled new file mode 100644 index 0000000..e4654f6 --- /dev/null +++ b/Source/Net/LibNet/Example03-epoll-server/qcbuild.src-disabled @@ -0,0 +1,37 @@ +########################################################################### +# # +# This file is part of Tegenaria project. # +# Copyright (c) 2010, 2015 Sylwester Wysocki (sw143@wp.pl). # +# # +# The Tegenaria library and any derived work however based on this # +# software are copyright of Sylwester Wysocki. Redistribution and use of # +# the present software is allowed according to terms specified in the # +# file LICENSE which comes in the source distribution. # +# # +# All rights reserved. # +# # +########################################################################### + +TYPE = PROGRAM +TITLE = LibNet-example03-epoll-server +CXXSRC = Example03.cpp + +LIBS = -lnet -ldebug -lthread -llock + +DEPENDS = LibDebug LibNet LibThread LibLock + +# +# Windows specific. +# + +.section MinGW + LIBS += -lws2_32 +.endsection + +# +# Linux specific. +# + +.section Linux + LIBS += -lpthread +.endsection diff --git a/Source/Net/LibNet/Example04-IOCP-server/Example04.cpp b/Source/Net/LibNet/Example04-IOCP-server/Example04.cpp new file mode 100644 index 0000000..6ffc5bf --- /dev/null +++ b/Source/Net/LibNet/Example04-IOCP-server/Example04.cpp @@ -0,0 +1,89 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to set up echo IO Completion Port server. +// Code works on Windows only. +// + +#include +#include +#include +#include + +using namespace Tegenaria; + +// +// Handler called when new connection arrived. +// + +void OpenHandler(NetIocpContext *ctx, int fd) +{ + printf("Opened connection on FD #%d.\n", fd); +} + +// +// Handler called when existing connection closed. +// + +void CloseHandler(NetIocpContext *ctx, int fd) +{ + printf("Closed connection on FD #%d.\n", fd); +} + +// +// Handler called when something to read on given fd. +// + +void DataHandler(NetIocpContext *ctx, int fd, void *buf, int len) +{ + printf("Readed %d bytes from FD #%d.\n", len, fd); + + // + // Write back readed data to client. + // + // !WARNING! Don't use raw write here. + // + + int written = NetIocpWrite(ctx, fd, buf, len); + + printf("Written %d bytes to FD #%d.\n", written, fd); +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_HEAD("DIRLIGO-IOCP-SERVER\nBuild [%s, %s]\n", __DATE__, __TIME__); + + // + // Start IOCP server waiting on TCP port 6666. + // + + NetIocpServerLoop(6666, OpenHandler, CloseHandler, DataHandler); + + return 0; +} diff --git a/Source/Net/LibNet/Example04-IOCP-server/qcbuild.src-disabled b/Source/Net/LibNet/Example04-IOCP-server/qcbuild.src-disabled new file mode 100644 index 0000000..6b81b3a --- /dev/null +++ b/Source/Net/LibNet/Example04-IOCP-server/qcbuild.src-disabled @@ -0,0 +1,37 @@ +########################################################################### +# # +# This file is part of Tegenaria project. # +# Copyright (c) 2010, 2015 Sylwester Wysocki (sw143@wp.pl). # +# # +# The Tegenaria library and any derived work however based on this # +# software are copyright of Sylwester Wysocki. Redistribution and use of # +# the present software is allowed according to terms specified in the # +# file LICENSE which comes in the source distribution. # +# # +# All rights reserved. # +# # +########################################################################### + +TYPE = PROGRAM +TITLE = LibNet-example04-IOCP-server +CXXSRC = Example04.cpp + +LIBS = -lnet -ldebug -lthread -llock + +DEPENDS = LibDebug LibNet LibThread LibLock + +# +# Windows specific. +# + +.section MinGW + LIBS += -lws2_32 +.endsection + +# +# Linux specific. +# + +.section Linux + LIBS += -lpthread +.endsection diff --git a/Source/Net/LibNet/Example05-HP-server/Example05.cpp b/Source/Net/LibNet/Example05-HP-server/Example05.cpp new file mode 100644 index 0000000..56ac012 --- /dev/null +++ b/Source/Net/LibNet/Example05-HP-server/Example05.cpp @@ -0,0 +1,138 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to set up handler based server. +// Code should works on Windows and Linux without modifications. +// + +#include +#include +#include +#include + +using namespace std; +using namespace Tegenaria; + +// +// Custom, optional object related with incoming connections. +// + +class ConnectionContext +{ + string name_; + + public: + + ConnectionContext(const char *name) + { + name_ = name; + } + + const char *getName() + { + return name_.c_str(); + } + + // + // ... + // +}; + +// +// Handler called when new connection arrived. +// + +void OpenHandler(NetHpContext *ctx, int fd) +{ + printf("Opened connection on FD #%d.\n", fd); + + // + // Initialize some connection related object e.g. user context. + // + + ConnectionContext *connection = new ConnectionContext("Marian"); + + // + // And associate it with opened connection. + // We will get it back in further close and data handlers. + // + + ctx -> custom_ = (void *) connection; +} + +// +// Handler called when existing connection closed. +// + +void CloseHandler(NetHpContext *ctx, int fd) +{ + ConnectionContext *this_ = (ConnectionContext *) ctx -> custom_; + + printf("Closed connection on FD #%d for user %s.\n", fd, this_ -> getName()); + + // + // Free related connection object. + // + + delete this_; +} + +// +// Handler called when something to read on given fd. +// + +void DataHandler(NetHpContext *ctx, int fd, void *buf, int len) +{ + ConnectionContext *this_ = (ConnectionContext *) ctx -> custom_; + + printf("%s: Readed %d bytes from FD #%d.\n", this_ -> getName(), len, fd); + + // + // Write back readed data to client. + // + // !WARNING! Don't use raw write here. + // + + int written = NetHpWrite(ctx, fd, buf, len); + + printf("%s: Written %d bytes to FD #%d.\n", this_ -> getName(), written, fd); +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_HEAD("DIRLIGO-HP-SERVER\nBuild [%s, %s]\n", __DATE__, __TIME__); + + // + // Start HP server waiting on TCP port 6666. + // + + NetHpServerLoop(6666, OpenHandler, CloseHandler, DataHandler); + + return 0; +} diff --git a/Source/Net/LibNet/Example05-HP-server/qcbuild.src b/Source/Net/LibNet/Example05-HP-server/qcbuild.src new file mode 100644 index 0000000..d9b0341 --- /dev/null +++ b/Source/Net/LibNet/Example05-HP-server/qcbuild.src @@ -0,0 +1,47 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibNet-example05-HP-server +CXXSRC = Example05.cpp + +LIBS = -lnet -ldebug -lthread -llock + +DEPENDS = LibDebug LibNet LibThread LibLock + +# +# Windows specific. +# + +.section MinGW + LIBS += -lws2_32 +.endsection + +# +# Linux specific. +# + +.section Linux + LIBS += -lpthread +.endsection diff --git a/Source/Net/LibNet/Example06-echo-server/Main.cpp b/Source/Net/LibNet/Example06-echo-server/Main.cpp new file mode 100644 index 0000000..f5af702 --- /dev/null +++ b/Source/Net/LibNet/Example06-echo-server/Main.cpp @@ -0,0 +1,141 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char *argv[]) +{ + char buf[1024 * 32] = {0}; + + int readed = 0; + int written = 0; + + int totalReaded = 0; + int totalWritten = 0; + + int writtenSum = 0; + + int count = 0; + int goOn = 1; + + int port = -1; + + NetConnection *nc = NULL; + + // + // Init log. + // + + DBG_INIT_EX(NULL, "info", -1); + + // + // Parse arguments + // + + if (argc < 2) + { + Fatal("Usage: %s \n", argv[0]); + } + + port = atoi(argv[1]); + + // + // Wait for connection on given port. + // + + nc = NetAccept(port); + + FAILEX(nc == NULL, "ERROR: Cannot accept connection.\n"); + + printf("Connected!\n"); + + // + // Fall into main echo loop. + // + + printf("Falling into server loop...\n"); + + while(goOn) + { + // + // Read packet. + // + + readed = nc -> read(buf, sizeof(buf)); + + if (readed <= 0) + { + fprintf(stderr, "ERROR: Readed [%d] bytes.\n", readed); + + goOn = 0; + } + + // + // Write back packet. + // + + writtenSum = 0; + + while(writtenSum < readed) + { + written = nc -> write(buf + writtenSum, readed - writtenSum); + + if (written > 0) + { + writtenSum += written; + } + } + + written = writtenSum; + + if (written != readed) + { + fprintf(stderr, "ERROR: Written [%d] bytes but readed [%d].\n", written, readed); + + goOn = 0; + } + + totalReaded += readed; + totalWritten += written; + } + + printf("Exited.\n"); + + fail: + + getchar(); + + if (nc) + { + nc -> release(); + } + + return 0; +} diff --git a/Source/Net/LibNet/Example06-echo-server/qcbuild.src b/Source/Net/LibNet/Example06-echo-server/qcbuild.src new file mode 100644 index 0000000..fd50726 --- /dev/null +++ b/Source/Net/LibNet/Example06-echo-server/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = libnet-example07-echo-server +AUTHOR = Sylwester Wysocki + +# +# Sources. +# + +CXXSRC = Main.cpp + +LIBS = -lnet -lthread -llock -ldebug + +DEPENDS = LibNet LibDebug diff --git a/Source/Net/LibNet/Example07-echo-client/Main.cpp b/Source/Net/LibNet/Example07-echo-client/Main.cpp new file mode 100644 index 0000000..f102f77 --- /dev/null +++ b/Source/Net/LibNet/Example07-echo-client/Main.cpp @@ -0,0 +1,225 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include + +using namespace Tegenaria; + +// +// Get current time in ms. +// + +inline double GetTimeMs() +{ + struct timeval tv; + + gettimeofday(&tv, NULL); + + return tv.tv_sec * 1000.0 + tv.tv_usec / 1000.0; +} + +// +// Entry point. +// + +int main(int argc, char *argv[]) +{ + const char *ip = NULL; + + int port = 0; + + char buf1[1024 * 32] = {0}; + char buf2[1024 * 32] = {0}; + + int readed = 0; + int written = 0; + + int readedSum = 0; + int writtenSum = 0; + + double totalReaded = 0.0; + double totalWritten = 0.0; + double delayTotal = 0.0; + double rate = 0.0; + + int goOn = 1; + + double t0 = GetTimeMs(); + double dt = 0.0; + + double lastStatTime = 0; + + NetConnection *nc = NULL; + + // + // Init log. + // + + DBG_INIT_EX(NULL, "info", -1); + + // + // Parse arguments + // + + if (argc < 3) + { + Fatal("Usage: %s \n", argv[0]); + } + + ip = argv[1]; + + port = atoi(argv[2]); + + // + // Connect to echo server. + // + + nc = NetConnect(ip, port); + + FAILEX(nc == NULL, "ERROR: Cannot connect to server.\n"); + + // + // Set no delay. + // + + nc -> setNoDelay(1); + + printf("Connected!\n"); + + // + // Fall into main echo loop. + // + + printf("Falling into client loop...\n"); + + lastStatTime = GetTimeMs(); + + while(goOn) + { + // + // Generate random buffer. + // + + for (int i = 0; i < sizeof(buf1); i++) + { + buf1[i] = rand() % 256; + } + + // + // Send buffer. + // + + writtenSum = 0; + written = 1; + + while(writtenSum < sizeof(buf1) && written > 0) + { + written = nc -> write(buf1 + writtenSum, sizeof(buf1) - writtenSum); + + if (written > 0) + { + writtenSum += written; + } + } + + written = writtenSum; + + // + // Read back buffer. + // + + readedSum = 0; + readed = 1; + + while(readed > 0 && readedSum < written) + { + readed = nc -> read(buf2 + readedSum, sizeof(buf2) - readedSum); + + if (readed <= 0) + { + fprintf(stderr, "ERROR: Readed [%d] bytes.\n", readed); + + goOn = 0; + } + else + { + readedSum += readed; + } + } + + readed = readedSum; + + // + // Compare readed and written buffers. + // + + if (readed != written) + { + fprintf(stderr, "ERROR: Written [%d] bytes, but only [%d] received.\n", written, readed); + + goOn = 0; + } + + if (memcmp(buf1, buf2, sizeof(buf1)) != 0) + { + fprintf(stderr, "ERROR: Written and received buffers mismatch.\n"); + + goOn = 0; + } + + totalReaded += readed / 1024.0 / 1024.0; + totalWritten += written / 1024.0 / 1024.0; + + // + // Statistics every 1s. + // + + dt = (GetTimeMs() - lastStatTime) / 1000.0; + + if (dt > 1.0) + { + lastStatTime = GetTimeMs(); + + dt = (GetTimeMs() - t0) / 1000.0; + + rate = totalReaded / dt; + + printf("total sent = %lf MB, avg rate = %lf MB/s\n", totalReaded, rate); + } + } + + printf("Exited.\n"); + + fail: + + getchar(); + + if (nc) + { + nc -> release(); + } + + return 0; +} diff --git a/Source/Net/LibNet/Example07-echo-client/qcbuild.src b/Source/Net/LibNet/Example07-echo-client/qcbuild.src new file mode 100644 index 0000000..8f5d7f9 --- /dev/null +++ b/Source/Net/LibNet/Example07-echo-client/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = libnet-example08-echo-client +AUTHOR = Sylwester Wysocki + +# +# Sources. +# + +CXXSRC = Main.cpp + +LIBS = -lnet -lthread -llock -ldebug + +DEPENDS = LibNet LibDebug diff --git a/Source/Net/LibNet/Example08-smtp-client/Main.cpp b/Source/Net/LibNet/Example08-smtp-client/Main.cpp new file mode 100644 index 0000000..e3f1c1f --- /dev/null +++ b/Source/Net/LibNet/Example08-smtp-client/Main.cpp @@ -0,0 +1,103 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include + +using namespace Tegenaria; + +void ReadField(char *dst, int dstSize, const char *prompt) +{ + printf("%s: ", prompt); + + fgets(dst, dstSize, stdin); + + for (int i = 0; dst[i]; i++) + { + if (dst[i] == 10 || dst[i] == 13) + { + dst[i] = 0; + } + } +} + +// +// Entry point. +// + +int main(int argc, char *argv[]) +{ + DBG_INIT_EX(NULL, "debug2", -1); + + char smtpHost[128]; + char smtpPort[32]; + char smtpLogin[64]; + char smtpPass[64]; + char message[128]; + char subject[128]; + char fromFull[128]; + char from[128]; + char to[128]; + + int ret = -1; + + vector receivers; + + // + // Read fields from stdin. + // + + ReadField(smtpHost, sizeof(smtpHost), "SMTP Host (e.g. smtp.wp.pl)"); + ReadField(smtpPort, sizeof(smtpPort), "SMTP Port (default is 25)"); + ReadField(smtpLogin, sizeof(smtpLogin), "SMTP Login"); + + SecureReadPassword(smtpPass, sizeof(smtpPass), "SMTP Password: "); + + ReadField(fromFull, sizeof(fromFull), "From full name (e.g. John Smith)"); + ReadField(from, sizeof(from), "From address"); + ReadField(to, sizeof(to), "To address"); + ReadField(subject, sizeof(subject), "Subject"); + ReadField(message, sizeof(message), "Message"); + + // + // Put one receiver to list. + // + + receivers.push_back(to); + + // + // Send mail. + // + + ret = NetSmtpSendMail(smtpHost, atoi(smtpPort), from, fromFull, + subject, receivers, message, smtpLogin, smtpPass); + + if (ret == 0) + { + printf("Success.\n"); + } + + return ret; +} diff --git a/Source/Net/LibNet/Example08-smtp-client/qcbuild.src b/Source/Net/LibNet/Example08-smtp-client/qcbuild.src new file mode 100644 index 0000000..e61dda0 --- /dev/null +++ b/Source/Net/LibNet/Example08-smtp-client/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = libnet-example09-smtp-client +AUTHOR = Sylwester Wysocki + +# +# Sources. +# + +CXXSRC = Main.cpp + +LIBS = -lnet -lthread -llock -lsecure -ldebug -lssl -lcrypto + +DEPENDS = LibNet LibDebug LibSecure diff --git a/Source/Net/LibNet/Example09-statistics/Main.cpp b/Source/Net/LibNet/Example09-statistics/Main.cpp new file mode 100644 index 0000000..7a3592f --- /dev/null +++ b/Source/Net/LibNet/Example09-statistics/Main.cpp @@ -0,0 +1,83 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char *argv[]) +{ + NetStatistics ns; + + // + // Some packets sent. + // + + ns.insertOutcomingPacket(1024); + ns.insertOutcomingPacket(1024); + ns.insertOutcomingPacket(1024); + + // + // Some packets arrived. + // + + ns.insertIncomingPacket(1024); + ns.insertIncomingPacket(1024); + ns.insertIncomingPacket(1024); + ns.insertIncomingPacket(1024); + + // + // Some network requests executed. + // + + ns.insertRequest(1024, 10); + ns.insertRequest(1024, 20); + ns.insertRequest(1024, 30); + ns.insertRequest(1024, 40); + ns.insertRequest(1024, 50); + + // + // Perform some download and upload tasks. + // + + ns.insertUploadEvent(1024 * 64, 100); + ns.insertUploadEvent(1024 * 64, 200); + ns.insertUploadEvent(1024 * 64, 300); + + ns.insertDownloadEvent(1024 * 32, 100); + ns.insertDownloadEvent(1024 * 32, 200); + ns.insertDownloadEvent(1024 * 32, 300); + + // + // Print statistics. + // + + printf("%s", ns.toString().c_str()); + + return 0; +} diff --git a/Source/Net/LibNet/Example09-statistics/qcbuild.src b/Source/Net/LibNet/Example09-statistics/qcbuild.src new file mode 100644 index 0000000..0f6bf01 --- /dev/null +++ b/Source/Net/LibNet/Example09-statistics/qcbuild.src @@ -0,0 +1,37 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = libnet-example10-statistics +AUTHOR = Sylwester Wysocki + +# +# Sources. +# + +CXXSRC = Main.cpp + +LIBS = -lnet -lthread -llock -ldebug + +DEPENDS = LibNet diff --git a/Source/Net/LibNet/Firewall.cpp b/Source/Net/LibNet/Firewall.cpp new file mode 100644 index 0000000..93169fb --- /dev/null +++ b/Source/Net/LibNet/Firewall.cpp @@ -0,0 +1,434 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Includes. +// + +#pragma qcbuild_set_file_title("Manage firewall rules (Windows only)"); + +#include "Net.h" +#include "Firewall.h" + +namespace Tegenaria +{ + #ifdef WIN32 + + // + // Defines. + // + + #define HFAIL(X) if ((hresult = (X))) goto fail + + #define HFAILEX(X, ...) if ((hresult = (X))) {Error(__VA_ARGS__); goto fail;} + + #define COM_FREE(X) if ((X) != NULL) {(X) -> Release(); X = NULL;} + + // + // Define guids to import NetFW interfaces. + // + + const unsigned char CLSID_NetFwPolicy2_raw[] = + { + 0x7f, 0xc9, 0xb3, 0xe2, + 0xe1, 0x6a, 0xac, 0x41, + 0x81, 0x7a, 0xf6, 0xf9, + 0x21, 0x66, 0xd7, 0xdd + }; + + const unsigned char CLSID_NetFwRule_raw[] = + { + 0x3e, 0xc4, 0x5b, 0x2c, + 0x69, 0x33, 0x33, 0x4c, + 0xab, 0x0c, 0xbe, 0x94, + 0x69, 0x67, 0x7a, 0xf4 + }; + + const unsigned char CLSID_NetFwRule2_raw[] = + { + 0xda, 0xc8, 0x27, 0x9c, + 0x9b, 0x18, 0xde, 0x4d, + 0x89, 0xf7, 0x8b, 0x39, + 0xa3, 0x16, 0x78, 0x2c, + }; + + const unsigned char IID_INetFwPolicy2_raw[] = + { + 0x47, 0x50, 0x32, 0x98, + 0x71, 0xc6, 0x74, 0x41, + 0x8d, 0x81, 0xde, 0xfc, + 0xd3, 0xf0, 0x31, 0x86 + }; + + const unsigned char IID_INetFwRule_raw[] = + { + 0x27, 0x0d, 0x23, 0xaf, + 0xba, 0xba, 0x42, 0x4e, + 0xac, 0xed, 0xf5, 0x24, + 0xf2, 0x2c, 0xfc, 0xe2 + }; + + const unsigned char IID_INetFwRule2_raw[] = + { + 0xda, 0xc8, 0x27, 0x9c, + 0x9b, 0x18, 0xde, 0x4d, + 0x89, 0xf7, 0x8b, 0x39, + 0xa3, 0x16, 0x78, 0x2c + }; + + const CLSID &CLSID_NetFwPolicy2 = (CLSID &) CLSID_NetFwPolicy2_raw; + const CLSID &CLSID_NetFwRule = (CLSID &) CLSID_NetFwRule_raw; + const CLSID &CLSID_NetFwRule2 = (CLSID &) CLSID_NetFwRule2_raw; + + const IID &IID_INetFwPolicy2 = (IID &) IID_INetFwPolicy2_raw; + const IID &IID_INetFwRule = (IID &) IID_INetFwRule_raw; + const IID &IID_INetFwRule2 = (IID &) IID_INetFwRule2_raw; + + #endif + + // + // Add firewall rule. + // + // WARNING: Function needs admin privileges. + // + // name - name of rule (IN). + // group - name of rule's group (IN). + // desc - rule's description (IN). + // appPath - full path to target application (IN). + // + // RETURNS: 0 if OK. + // + + int NetFirewallRuleAdd(const char *name, const char *group, + const char *desc, const char *appPath, int protocol) + { + DBG_ENTER("NetFirewallRuleAdd"); + + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + HRESULT hresult = S_OK; + + INetFwRules *rulesSet = NULL; + INetFwRule *rule = NULL; + INetFwRule2 *rule2 = NULL; + + BSTR nameBstr = NULL; + BSTR groupBstr = NULL; + BSTR descBstr = NULL; + BSTR appPathBstr = NULL; + + wchar_t nameW[1024] = {0}; + wchar_t groupW[1024] = {0}; + wchar_t descW[1024] = {0}; + wchar_t appPathW[1024] = {0}; + + INetFwPolicy2 *policy = NULL; + + // + // Initialize COM API. + // + + hresult = CoInitializeEx(0, COINIT_APARTMENTTHREADED); + + FAILEX(hresult && hresult != RPC_E_CHANGED_MODE, + "ERROR: Cannot initialize COM API.\n"); + + // + // Import NetFwPolicy2 class via COM. + // + + HFAILEX(CoCreateInstance(CLSID_NetFwPolicy2, NULL, CLSCTX_INPROC_SERVER, + IID_INetFwPolicy2, (void **) &policy), + "ERROR: Cannot import NetFwPolicy2 class.\n"); + + // + // NetFW classes needs dynamic BSTR UTF16 strings. + // Convert from ASCII to static UTF16 first. + // + + _snwprintf(nameW, sizeof(nameW) / sizeof(nameW[0]), L"%hs", name); + _snwprintf(groupW, sizeof(groupW) / sizeof(groupW[0]), L"%hs", group); + _snwprintf(descW, sizeof(descW) / sizeof(descW[0]), L"%hs", desc); + _snwprintf(appPathW, sizeof(appPathW) / sizeof(appPathW[0]), L"%hs", appPath); + + DBG_MSG("Name : [%ls]\n", nameW); + DBG_MSG("Group : [%ls]\n", groupW); + DBG_MSG("Description : [%ls]\n", descW); + DBG_MSG("Application : [%ls]\n", appPathW); + DBG_MSG("Protocol : [%d]\n", protocol); + + // + // Create dynamic BSTR UTF16 strings from static UTF16. + // + + nameBstr = SysAllocString(nameW); + groupBstr = SysAllocString(groupW); + descBstr = SysAllocString(descW); + appPathBstr = SysAllocString(appPathW); + + FAILEX(nameBstr == NULL, "ERROR: Out of memory.\n"); + FAILEX(groupBstr == NULL, "ERROR: Out of memory.\n"); + FAILEX(descBstr == NULL, "ERROR: Out of memory.\n"); + FAILEX(appPathBstr == NULL, "ERROR: Out of memory.\n"); + + // + // Get rules collection from policy. + // + + HFAILEX(policy -> get_Rules(&rulesSet), + "ERROR: Cannot to retrieve firewall rules collection"); + + // + // Create new, empty rule. + // + + HFAILEX(CoCreateInstance(CLSID_NetFwRule, NULL, CLSCTX_INPROC_SERVER, + IID_INetFwRule, (void **) &rule), + "ERROR: Cannot create NetFwRule object.\n"); + + // + // Fill empty rule with target name, group, desc, app. + // + + HFAILEX(rule -> put_Name(nameBstr), + "ERROR: Cannot to set rule's name.\n"); + /* + HFAILEX(rule -> put_Grouping(groupBstr), + "ERROR: Cannot to set rule's group.\n"); + */ + + HFAILEX(rule -> put_Description(descBstr), + "ERROR: Cannot to set rule's description.\n"); + + HFAILEX(rule -> put_Direction(NET_FW_RULE_DIR_IN), + "ERROR: Cannot to set rule's direction.\n"); + + HFAILEX(rule -> put_Action(NET_FW_ACTION_ALLOW), + "ERROR: Cannot to set rule's action.\n"); + + HFAILEX(rule -> put_ApplicationName(appPathBstr), + "ERROR: Cannot to set rule's' application.\n"); + + HFAILEX(rule -> put_Protocol(protocol), + "ERROR: Cannot to set rule's protocol.\n"); + + HFAILEX(rule -> put_Profiles(NET_FW_PROFILE2_DOMAIN | NET_FW_PROFILE2_PRIVATE), + "ERROR: Cannot to set rule's profiles.\n"); + + // + // Switch rule to enable state. + // + + HFAILEX(rule -> put_Enabled(VARIANT_TRUE), + "ERROR: Cannot to enable rule.\n"); + + // + // Check if INetFwRule2 interface is available (i.e Windows7+) + // If supported, then use EdgeTraversalOptions + // Else use the EdgeTraversal boolean flag. + // + + if (SUCCEEDED(rule -> QueryInterface(IID_INetFwRule2, (void **) &rule2))) + { + HFAILEX(rule2 -> put_EdgeTraversalOptions(NET_FW_EDGE_TRAVERSAL_TYPE_DEFER_TO_APP), + "ERROR: Cannot to set edge traversal.\n"); + } + else + { + HFAILEX(rule -> put_EdgeTraversal(VARIANT_TRUE), + "ERROR: Cannot to set edge traversal.\n"); + } + + // + // Add rule to rules collection. + // + + HFAIL(rulesSet -> Add(rule)); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot add firewall rule.\n" + "Error code is : 0x%x\n", (unsigned int) hresult); + } + + SysFreeString(nameBstr); + SysFreeString(groupBstr); + SysFreeString(descBstr); + SysFreeString(appPathBstr); + + COM_FREE(policy); + COM_FREE(rulesSet); + COM_FREE(rule); + COM_FREE(rule2); + + CoUninitialize(); + } + + // + // Linux, MacOS. + // + + #else + { + Error("ERROR: NetFirewallRuleAdd() not implemented on this OS.\n"); + + exitCode = -1; + } + #endif + + DBG_LEAVE("NetFirewallRuleAdd"); + + return exitCode; + } + + // + // Remove firewall rule. + // + // WARNING: Function needs admin privileges. + // + // name - name of rule to remove (IN). + // + // RETURNS: 0 if OK. + // + + int NetFirewallRuleDel(const char *name) + { + DBG_ENTER("NetFirewallRuleDel"); + + int exitCode = -1; + + // + // Windows + // + + #ifdef WIN32 + { + HRESULT hresult = S_OK; + + INetFwRules *rulesSet = NULL; + + BSTR nameBstr = NULL; + + wchar_t nameW[1024] = {0}; + + INetFwPolicy2 *policy = NULL; + + // + // Initialize COM API. + // + + hresult = CoInitializeEx(0, COINIT_APARTMENTTHREADED); + + FAILEX(hresult && hresult != RPC_E_CHANGED_MODE, + "ERROR: Cannot initialize COM API.\n"); + + // + // Import NetFwPolicy2 class via COM. + // + + HFAILEX(CoCreateInstance(CLSID_NetFwPolicy2, NULL, CLSCTX_INPROC_SERVER, + IID_INetFwPolicy2, (void **) &policy), + "ERROR: Cannot import NetFwPolicy2 class.\n"); + + // + // NetFW classes needs dynamic BSTR UTF16 strings. + // Convert from ASCII to static UTF16 first. + // + + _snwprintf(nameW, sizeof(nameW) / sizeof(nameW[0]), L"%hs", name); + + // + // Create dynamic BSTR UTF16 strings from static UTF16. + // + + nameBstr = SysAllocString(nameW); + + FAILEX(nameBstr == NULL, "ERROR: Out of memory.\n"); + + // + // Get rules collection from policy. + // + + HFAILEX(policy -> get_Rules(&rulesSet), + "ERROR: Cannot to retrieve firewall rules collection"); + + // + // Remove rule from rules collection. + // + + HFAIL(rulesSet -> Remove(nameBstr)); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot remove firewall rule '%s'.\n" + "Error code is : 0x%x\n", name, (unsigned int) hresult); + } + + SysFreeString(nameBstr); + + COM_FREE(policy); + COM_FREE(rulesSet); + + CoUninitialize(); + } + + // + // Linux, MacOS. + // + + #else + { + Error("ERROR: NetFirewallRuleDel() not implemented on this OS.\n"); + + exitCode = -1; + } + #endif + + DBG_LEAVE("NetFirewallRuleDel"); + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/Firewall.h b/Source/Net/LibNet/Firewall.h new file mode 100644 index 0000000..0fb96f0 --- /dev/null +++ b/Source/Net/LibNet/Firewall.h @@ -0,0 +1,502 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Firewall_H +#define Tegenaria_Core_Firewall_H + +// +// ---------------------------------------------------------------------------- +// +// Windows only definitions +// +// ---------------------------------------------------------------------------- +// + +#ifdef WIN32 + +#include +#include +#include + +namespace Tegenaria +{ + // + // INetworkListManager structs. + // + + typedef enum NLM_CONNECTION_PROPERTY_CHANGE + { + NLM_CONNECTION_PROPERTY_CHANGE_AUTHENTICATION = 0x01 + } NLM_CONNECTION_PROPERTY_CHANGE; + + typedef enum NLM_CONNECTIVITY + { + NLM_CONNECTIVITY_DISCONNECTED = 0x0000, + NLM_CONNECTIVITY_IPV4_NOTRAFFIC = 0x0001, + NLM_CONNECTIVITY_IPV6_NOTRAFFIC = 0x0002, + NLM_CONNECTIVITY_IPV4_SUBNET = 0x0010, + NLM_CONNECTIVITY_IPV4_LOCALNETWORK = 0x0020, + NLM_CONNECTIVITY_IPV4_INTERNET = 0x0040, + NLM_CONNECTIVITY_IPV6_SUBNET = 0x0100, + NLM_CONNECTIVITY_IPV6_LOCALNETWORK = 0x0200, + NLM_CONNECTIVITY_IPV6_INTERNET = 0x0400 + } NLM_CONNECTIVITY; + + typedef enum NLM_DOMAIN_TYPE + { + NLM_DOMAIN_TYPE_NON_DOMAIN_NETWORK = 0x0, + NLM_DOMAIN_TYPE_DOMAIN_NETWORK = 0x01, + NLM_DOMAIN_TYPE_DOMAIN_AUTHENTICATED = 0x02 + } NLM_DOMAIN_TYPE; + + typedef enum NLM_ENUM_NETWORK + { + NLM_ENUM_NETWORK_CONNECTED = 0x01, + NLM_ENUM_NETWORK_DISCONNECTED = 0x02, + NLM_ENUM_NETWORK_ALL = 0x03 + } NLM_ENUM_NETWORK; + + typedef enum NLM_NETWORK_CATEGORY + { + NLM_NETWORK_CATEGORY_PUBLIC = 0x00, + NLM_NETWORK_CATEGORY_PRIVATE = 0x01, + NLM_NETWORK_CATEGORY_DOMAIN_AUTHENTICATED = 0x02 + } NLM_NETWORK_CATEGORY; + + typedef enum _NLM_NETWORK_CLASS + { + NLM_NETWORK_IDENTIFYING = 0x01, + NLM_NETWORK_IDENTIFIED = 0x02, + NLM_NETWORK_UNIDENTIFIED = 0x03 + } NLM_NETWORK_CLASS; + + typedef enum NLM_NETWORK_PROPERTY_CHANGE + { + NLM_NETWORK_PROPERTY_CHANGE_CONNECTION = 0x01, + NLM_NETWORK_PROPERTY_CHANGE_DESCRIPTION = 0x02, + NLM_NETWORK_PROPERTY_CHANGE_NAME = 0x04, + NLM_NETWORK_PROPERTY_CHANGE_CATEGORY_VALUE = 0x10 + } NLM_NETWORK_PROPERTY_CHANGE; + + // + // INetworkListManager COM API. + // + + interface IEnumNetworkConnections; + + interface INetwork : public IDispatch + { + public: + + virtual HRESULT STDMETHODCALLTYPE GetName(BSTR *pszNetworkName) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetName(BSTR szNetworkNewName) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetDescription(BSTR *pszDescription) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetDescription(BSTR szDescription) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetNetworkId(GUID *pgdGuidNetworkId) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetDomainType(NLM_DOMAIN_TYPE *pNetworkType) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetNetworkConnections(IEnumNetworkConnections **ppEnumNetworkConnection) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetTimeCreatedAndConnected(DWORD *pdwLowDateTimeCreated, + DWORD *pdwHighDateTimeCreated, + DWORD *pdwLowDateTimeConnected, + DWORD *pdwHighDateTimeConnected) = 0; + + virtual HRESULT STDMETHODCALLTYPE get_IsConnectedToInternet(VARIANT_BOOL *pbIsConnected) = 0; + + virtual HRESULT STDMETHODCALLTYPE get_IsConnected(VARIANT_BOOL *pbIsConnected) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetConnectivity(NLM_CONNECTIVITY *pConnectivity) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetCategory(NLM_NETWORK_CATEGORY *pCategory) = 0; + + virtual HRESULT STDMETHODCALLTYPE SetCategory(NLM_NETWORK_CATEGORY NewCategory) = 0; + }; + + interface IEnumNetworks : public IDispatch + { + public: + + virtual HRESULT STDMETHODCALLTYPE get__NewEnum(IEnumVARIANT **ppEnumVar) = 0; + + virtual HRESULT STDMETHODCALLTYPE Next(ULONG celt, INetwork **rgelt, + ULONG *pceltFetched) = 0; + + virtual HRESULT STDMETHODCALLTYPE Skip(ULONG celt) = 0; + + virtual HRESULT STDMETHODCALLTYPE Reset(void) = 0; + + virtual HRESULT STDMETHODCALLTYPE Clone(IEnumNetworks **ppEnumNetwork) = 0; + }; + + interface INetworkConnection : public IDispatch + { + public: + + virtual HRESULT STDMETHODCALLTYPE GetNetwork(INetwork **ppNetwork) = 0; + + virtual HRESULT STDMETHODCALLTYPE get_IsConnectedToInternet(VARIANT_BOOL *pbIsConnected) = 0; + + virtual HRESULT STDMETHODCALLTYPE get_IsConnected(VARIANT_BOOL *pbIsConnected) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetConnectivity(NLM_CONNECTIVITY *pConnectivity) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetConnectionId(GUID *pgdConnectionId) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetAdapterId(GUID *pgdAdapterId) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetDomainType(NLM_DOMAIN_TYPE *pDomainType) = 0; + }; + + interface IEnumNetworkConnections : public IDispatch + { + public: + + virtual HRESULT STDMETHODCALLTYPE get__NewEnum(IEnumVARIANT **ppEnumVar) = 0; + + virtual HRESULT STDMETHODCALLTYPE Next(ULONG celt, INetworkConnection **rgelt, + ULONG *pceltFetched) = 0; + + virtual HRESULT STDMETHODCALLTYPE Skip(ULONG celt) = 0; + + virtual HRESULT STDMETHODCALLTYPE Reset(void) = 0; + + virtual HRESULT STDMETHODCALLTYPE Clone(IEnumNetworkConnections **ppEnumNetwork) = 0; + }; + + interface INetworkListManager : public IDispatch + { + public: + + virtual HRESULT GetNetworks(NLM_ENUM_NETWORK Flags, IEnumNetworks **ppEnumNetwork) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetNetwork(GUID gdNetworkId, INetwork **ppNetwork) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetNetworkConnections(IEnumNetworkConnections **ppEnum) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetNetworkConnection(GUID gdNetworkConnectionId, INetworkConnection **ppNetworkConnection) = 0; + + virtual HRESULT STDMETHODCALLTYPE get_IsConnectedToInternet(VARIANT_BOOL *pbIsConnected) = 0; + + virtual HRESULT STDMETHODCALLTYPE get_IsConnected(VARIANT_BOOL *pbIsConnected) = 0; + + virtual HRESULT STDMETHODCALLTYPE GetConnectivity(NLM_CONNECTIVITY *pConnectivity) = 0; + }; + + // + // Import FWNet classes. + // + + // + // Defines. + // + + #define WBEM_CALL virtual HRESULT STDMETHODCALLTYPE + + // + // Forward declarations. + // + + class INetFwPolicy2; + class INetFwRules; + class INetFwRule; + class NetFwRule; + class NetFwPolicy2; + + // + // Typedef. + // + + typedef enum NET_FW_PROFILE_TYPE2_ + { + NET_FW_PROFILE2_DOMAIN = 0x1, + NET_FW_PROFILE2_PRIVATE = 0x2, + NET_FW_PROFILE2_PUBLIC = 0x4, + NET_FW_PROFILE2_ALL = 0x7fffffff + } + NET_FW_PROFILE_TYPE2; + + typedef enum NET_FW_ACTION_ + { + NET_FW_ACTION_BLOCK = 0, + NET_FW_ACTION_ALLOW = (NET_FW_ACTION_BLOCK + 1), + NET_FW_ACTION_MAX = (NET_FW_ACTION_ALLOW + 1) + } + NET_FW_ACTION; + + typedef enum NET_FW_RULE_DIRECTION_ + { + NET_FW_RULE_DIR_IN = 1, + NET_FW_RULE_DIR_OUT = (NET_FW_RULE_DIR_IN + 1), + NET_FW_RULE_DIR_MAX = (NET_FW_RULE_DIR_OUT + 1) + } + NET_FW_RULE_DIRECTION; + + typedef enum NET_FW_MODIFY_STATE_ + { + NET_FW_MODIFY_STATE_OK = 0, + NET_FW_MODIFY_STATE_GP_OVERRIDE = (NET_FW_MODIFY_STATE_OK + 1), + NET_FW_MODIFY_STATE_INBOUND_BLOCKED = (NET_FW_MODIFY_STATE_GP_OVERRIDE + 1) + } + NET_FW_MODIFY_STATE; + + typedef enum NET_FW_EDGE_TRAVERSAL_TYPE_ + { + NET_FW_EDGE_TRAVERSAL_TYPE_DENY, + NET_FW_EDGE_TRAVERSAL_TYPE_ALLOW, + NET_FW_EDGE_TRAVERSAL_TYPE_DEFER_TO_APP, + NET_FW_EDGE_TRAVERSAL_TYPE_DEFER_TO_USER + } + NET_FW_EDGE_TRAVERSAL_TYPE; + + // + // Interfaces. + // + + MIDL_INTERFACE("8267BBE3-F890-491C-B7B6-2DB1EF0E5D2B") + INetFwServiceRestriction : public IDispatch + { + public: + + WBEM_CALL RestrictService(BSTR, BSTR, VARIANT_BOOL, VARIANT_BOOL) = 0; + + WBEM_CALL ServiceRestricted(BSTR, BSTR, VARIANT_BOOL *) = 0; + + WBEM_CALL get_Rules(INetFwRules **) = 0; + }; + + MIDL_INTERFACE("AF230D27-BABA-4E42-ACED-F524F22CFCE2") + INetFwRule : public IDispatch + { + public: + + WBEM_CALL get_Name(BSTR *) = 0; + + WBEM_CALL put_Name(BSTR) = 0; + + WBEM_CALL get_Description(BSTR *) = 0; + + WBEM_CALL put_Description(BSTR) = 0; + + WBEM_CALL get_ApplicationName(BSTR *) = 0; + + WBEM_CALL put_ApplicationName(BSTR) = 0; + + WBEM_CALL get_ServiceName(BSTR *) = 0; + + WBEM_CALL put_ServiceName(BSTR) = 0; + + WBEM_CALL get_Protocol(LONG *) = 0; + + WBEM_CALL put_Protocol(LONG) = 0; + + WBEM_CALL get_LocalPorts(BSTR *) = 0; + + WBEM_CALL put_LocalPorts(BSTR) = 0; + + WBEM_CALL get_RemotePorts(BSTR *) = 0; + + WBEM_CALL put_RemotePorts(BSTR) = 0; + + WBEM_CALL get_LocalAddresses(BSTR *) = 0; + + WBEM_CALL put_LocalAddresses(BSTR) = 0; + + WBEM_CALL get_RemoteAddresses(BSTR *) = 0; + + WBEM_CALL put_RemoteAddresses(BSTR) = 0; + + WBEM_CALL get_IcmpTypesAndCodes(BSTR *) = 0; + + WBEM_CALL put_IcmpTypesAndCodes(BSTR) = 0; + + WBEM_CALL get_Direction(NET_FW_RULE_DIRECTION *) = 0; + + WBEM_CALL put_Direction(NET_FW_RULE_DIRECTION) = 0; + + WBEM_CALL get_Interfaces(VARIANT *) = 0; + + WBEM_CALL put_Interfaces(VARIANT) = 0; + + WBEM_CALL get_InterfaceTypes(BSTR *) = 0; + + WBEM_CALL put_InterfaceTypes(BSTR) = 0; + + WBEM_CALL get_Enabled(VARIANT_BOOL *) = 0; + + WBEM_CALL put_Enabled(VARIANT_BOOL) = 0; + + WBEM_CALL get_Grouping(BSTR *) = 0; + + WBEM_CALL put_Grouping(BSTR) = 0; + + WBEM_CALL get_Profiles(long *) = 0; + + WBEM_CALL put_Profiles(long) = 0; + + WBEM_CALL get_EdgeTraversal(VARIANT_BOOL *) = 0; + + WBEM_CALL put_EdgeTraversal(VARIANT_BOOL) = 0; + + WBEM_CALL get_Action(NET_FW_ACTION *) = 0; + + WBEM_CALL put_Action(NET_FW_ACTION) = 0; + }; + + MIDL_INTERFACE("9C27C8DA-189B-4DDE-89F7-8B39A316782C") + INetFwRule2 : public INetFwRule + { + public: + + WBEM_CALL get_EdgeTraversalOptions(long *) = 0; + + WBEM_CALL put_EdgeTraversalOptions(long) = 0; + }; + + MIDL_INTERFACE("9C4C6277-5027-441E-AFAE-CA1F542DA009") + INetFwRules : public IDispatch + { + public: + + WBEM_CALL get_Count(long *) = 0; + + WBEM_CALL Add(INetFwRule *) = 0; + + WBEM_CALL Remove(BSTR) = 0; + + WBEM_CALL Item(BSTR, INetFwRule **) = 0; + + WBEM_CALL get__NewEnum(IUnknown **) = 0; + }; + + MIDL_INTERFACE("98325047-C671-4174-8D81-DEFCD3F03186") + IWbemClassObject : public IUnknown + { + public: + + WBEM_CALL get_CurrentProfileTypes(long *) = 0; + + WBEM_CALL get_FirewallEnabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL *) = 0; + + WBEM_CALL put_FirewallEnabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL) = 0; + + WBEM_CALL get_ExcludedInterfaces(NET_FW_PROFILE_TYPE2, VARIANT *) = 0; + + WBEM_CALL put_ExcludedInterfaces(NET_FW_PROFILE_TYPE2, VARIANT) = 0; + + WBEM_CALL get_BlockAllInboundTraffic(NET_FW_PROFILE_TYPE2, VARIANT_BOOL *) = 0; + + WBEM_CALL put_BlockAllInboundTraffic(NET_FW_PROFILE_TYPE2, VARIANT_BOOL) = 0; + + WBEM_CALL get_NotificationsDisabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL *) = 0; + + WBEM_CALL put_NotificationsDisabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL) = 0; + + WBEM_CALL get_UnicastResponsesToMulticastBroadcastDisabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL *) = 0; + + WBEM_CALL put_UnicastResponsesToMulticastBroadcastDisabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL) = 0; + + WBEM_CALL get_Rules(INetFwRules **) = 0; + + WBEM_CALL get_ServiceRestriction(INetFwServiceRestriction **) = 0; + + WBEM_CALL EnableRuleGroup(long, BSTR, VARIANT_BOOL) = 0; + + WBEM_CALL IsRuleGroupEnabled(long, BSTR, VARIANT_BOOL *) = 0; + + WBEM_CALL RestoreLocalFirewallDefaults() = 0; + + WBEM_CALL get_DefaultInboundAction(NET_FW_PROFILE_TYPE2, NET_FW_ACTION *) = 0; + + WBEM_CALL put_DefaultInboundAction(NET_FW_PROFILE_TYPE2, NET_FW_ACTION) = 0; + + WBEM_CALL get_DefaultOutboundAction(NET_FW_PROFILE_TYPE2, NET_FW_ACTION *) = 0; + + WBEM_CALL put_DefaultOutboundAction(NET_FW_PROFILE_TYPE2, NET_FW_ACTION) = 0; + + WBEM_CALL get_IsRuleGroupCurrentlyEnabled(BSTR, VARIANT_BOOL *) = 0; + + WBEM_CALL get_LocalPolicyModifyState(NET_FW_MODIFY_STATE *) = 0; + }; + + MIDL_INTERFACE("98325047-C671-4174-8D81-DEFCD3F03186") + INetFwPolicy2 : public IDispatch + { + public: + + WBEM_CALL get_CurrentProfileTypes(long *) = 0; + + WBEM_CALL get_FirewallEnabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL *) = 0; + + WBEM_CALL put_FirewallEnabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL) = 0; + + WBEM_CALL get_ExcludedInterfaces(NET_FW_PROFILE_TYPE2, VARIANT *) = 0; + + WBEM_CALL put_ExcludedInterfaces(NET_FW_PROFILE_TYPE2, VARIANT) = 0; + + WBEM_CALL get_BlockAllInboundTraffic(NET_FW_PROFILE_TYPE2, VARIANT_BOOL *) = 0; + + WBEM_CALL put_BlockAllInboundTraffic(NET_FW_PROFILE_TYPE2, VARIANT_BOOL) = 0; + + WBEM_CALL get_NotificationsDisabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL *) = 0; + + WBEM_CALL put_NotificationsDisabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL) = 0; + + WBEM_CALL get_UnicastResponsesToMulticastBroadcastDisabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL *) = 0; + + WBEM_CALL put_UnicastResponsesToMulticastBroadcastDisabled(NET_FW_PROFILE_TYPE2, VARIANT_BOOL) = 0; + + WBEM_CALL get_Rules(INetFwRules **rules) = 0; + + WBEM_CALL get_ServiceRestriction(INetFwServiceRestriction **ServiceRestriction) = 0; + + WBEM_CALL EnableRuleGroup(long, BSTR, VARIANT_BOOL) = 0; + + WBEM_CALL IsRuleGroupEnabled(long, BSTR, VARIANT_BOOL *) = 0; + + WBEM_CALL RestoreLocalFirewallDefaults() = 0; + + WBEM_CALL get_DefaultInboundAction(NET_FW_PROFILE_TYPE2, NET_FW_ACTION *) = 0; + + WBEM_CALL put_DefaultInboundAction(NET_FW_PROFILE_TYPE2, NET_FW_ACTION) = 0; + + WBEM_CALL get_DefaultOutboundAction(NET_FW_PROFILE_TYPE2, NET_FW_ACTION *) = 0; + + WBEM_CALL put_DefaultOutboundAction(NET_FW_PROFILE_TYPE2, NET_FW_ACTION) = 0; + + WBEM_CALL get_IsRuleGroupCurrentlyEnabled(BSTR, VARIANT_BOOL *) = 0; + + WBEM_CALL get_LocalPolicyModifyState(NET_FW_MODIFY_STATE *) = 0; + }; + +} /* namespace Tegenaria */ + +#endif /* WIN32 */ + +#endif /* Tegenaria_Core_Firewall_H */ diff --git a/Source/Net/LibNet/Net.h b/Source/Net/LibNet/Net.h new file mode 100644 index 0000000..f3bc4e7 --- /dev/null +++ b/Source/Net/LibNet/Net.h @@ -0,0 +1,219 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Net_H +#define Tegenaria_Core_Net_H + +// +// Includes. +// + +#include +#include +#include +#include +#include + +#include +#include + +#include "NetHpServer.h" +#include "NetStatistics.h" + +#ifndef WIN32 +# include +# include +# include +#endif + +using std::string; +using std::vector; + +// +// Defines. +// + +#define NET_STATE_DEAD -1 +#define NET_STATE_PENDING 1 +#define NET_STATE_LISTENING 2 +#define NET_STATE_ESTABLISHED 3 + +// +// Typedef. +// + +namespace Tegenaria +{ + class NetConnection; + + typedef int (*NetHandleConnProto)(NetConnection *nc); + + // + // Structs. + // + + struct NetUpnpInfo + { + char localIp_[32]; + char publicIp_[32]; + char gatewayIp_[32]; + + int port_; + }; + +} /* namespace Tegenaria */ + +// +// Windows includes. +// + +#ifdef WIN32 + + #include + #include + #include + + // + // Hide differences beetwen WinSock and BSD defines. + // + + #define SHUT_RDWR SD_BOTH + #define SHUT_RD SD_RECEIVE + #define SHUT_WR SD_SEND + + typedef int socklen_t; + +// +// Linux, MacOS includes. +// + +#else + + typedef int SOCKET; + + // + // Hide differences beetwen WinSock and BSD defines. + // + + #define SD_BOTH SHUT_RDWR + #define SD_RECEIVE SHUT_RD + #define SD_SEND SHUT_WR + #define closesocket(X) close(X) + + #include + #include + #include + #include + #include + +#endif + +#include "NetConnection.h" + +namespace Tegenaria +{ + // + // Server side functions. + // + + NetConnection *NetServerCreate(int port, NetHandleConnProto handler, + void *custom = NULL); + + int NetServerTerminate(NetConnection *serverConn); + + int NetServerLoop(NetConnection *serverConn); + + NetConnection *NetAccept(int port, int timeout = -1); + + // + // Client side functions. + // + + NetConnection *NetConnect(const char *ip, int port, int timeout = 10000); + + int NetRequest(int fd[2], int *serverCode, char *serverMsg, + int serverMsgSize, const char *fmt, ...); + + // + // Universal Plug and play (upnp). + // + + int NetUpnpGetInfo(NetUpnpInfo *info); + + int NetUpnpOpenPort(NetUpnpInfo *info, int port); + + int NetUpnpClosePort(int port); + + int NetUpnpGetFreePort(); + + // + // General. + // + + int NetParseAddress(char *ip1, char *ip2, int *port, const char *address); + + const string NetGetPortState(int port, const char *protocol); + + int NetIsPortOpen(int port, const char *protocol); + + int NetIsPortClosed(int port, const char *protocol); + + int NetGetLocalIp(char *ip, int ipSize); + + int NetGetFreePort(const char *protocol); + + int NetResolveIp(vector &ips, const char *host); + + // + // SMTP client. + // + + int NetSmtpSendMail(const char *smtpHost, int smtpPort, const char *from, + const char *fromFull, const char *subject, + vector receivers, const char *message, + const char *login, const char *password); + + // + // Firewall rules. + // + + int NetFirewallRuleAdd(const char *name, const char *group, + const char *desc, const char *appPath, int protocol); + + int NetFirewallRuleDel(const char *name); + + // + // General utils functions. + // + + int NetTryBind(int port); + + int NetSetBlockMode(int sock); + int NetSetNonBlockMode(int sock); + + string NetBase64(const char *data, int size); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_LibNet_H */ diff --git a/Source/Net/LibNet/NetConnection.cpp b/Source/Net/LibNet/NetConnection.cpp new file mode 100644 index 0000000..dca6983 --- /dev/null +++ b/Source/Net/LibNet/NetConnection.cpp @@ -0,0 +1,736 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: abstract network connection. +// +// Server does : NetworkConnection *nc = NetAccept(...) +// nc -> write(...) +// nc -> read(...) +// nc -> release() +// +// Client does : NetworkConnection *nc = NetConnect(...) +// nc -> write(...) +// nc -> read(...) +// nc -> release() +// +// To add new connection type (e.g. tcp/ip4): +// +// 1. Create class derived from NetConnection (e.g. NetTcpConnection). +// Derived class MUST implement at least read() and write() methods. +// +// 2. Implement NetAccept() or NetServerCreate() like function +// for server side. +// +// 3. Implement NetConnect() like function for client side. +// + +#pragma qcbuild_set_file_title("NetConnection class"); + +#include "NetConnection.h" + +namespace Tegenaria +{ + // + // Static variables. + // + + set NetConnection::instances_; + + Mutex NetConnection::instancesMutex_("NetConnection::instances_"); + + // + // Constructor. + // + // ctx - caller specified context (IN). + // protocol - artbitrary protocol name e.g. "TCP/IP" (IN). + // socket - asociatet socket number, can be -1 if not needed (IN/OPT). + // handler - callback to handle incoming connections (IN/OPT). + // thread - asociated thread handle (IN/OPT). + // + + NetConnection::NetConnection(const void *ctx, const char *protocol, + int socket, NetHandleConnProto handler, + ThreadHandle_t *thread) + { + DBG_ENTER3("NetConnection"); + + DBG_SET_ADD("NetConnection", this); + + DBG_MSG3("NetConnection : Creating net connection..."); + DBG_MSG3(" this : [%p]\n", this); + DBG_MSG3(" context : [%p]\n", ctx); + DBG_MSG3(" protocol : [%s]\n", protocol); + DBG_MSG3(" socket : [%d]\n", int(socket)); + DBG_MSG3(" handler : [%p]\n", handler); + DBG_MSG3(" ref count : [%d]\n", 1); + DBG_MSG3(" thread : [%p]\n", thread); + + ctx_ = ctx; + socket_ = socket; + handler_ = handler; + refCount_ = 1; + thread_ = thread; + quietMode_ = 0; + + // + // Track created instances. + // + + instancesMutex_.lock(); + instances_.insert(this); + instancesMutex_.unlock(); + + if (protocol) + { + protocol_ = protocol; + } + + state_ = NET_STATE_PENDING; + + clientInfo_ = "N/A"; + + DBG_LEAVE3("NetConnection"); + } + + // + // Desctructor. Shutdown connection to force flush. + // + + NetConnection::~NetConnection() + { + DBG_ENTER("NetConnection::~NetConnection"); + + // + // Check is this pointer correct. + // + + if (isPointerCorrect(this) == 0) + { + Error("ERROR: Attemp to destroy non existing NetConnection PTR#%p.\n", this); + + return; + } + + // + // Track created instances. + // + + instancesMutex_.lock(); + instances_.erase(this); + instancesMutex_.unlock(); + + DBG_MSG3("Destroying NetConnection PTR=[%p] CTX=[%p]...\n", this, ctx_); + + shutdown(); + + DBG_SET_DEL("NetConnection", this); + + DBG_LEAVE("NetConnection::~NetConnection"); + } + + // + // Low level I/O. + // + + // + // Send bytes stored in . + // + // buf - source buffer where data to write stored (IN). + // count - number of bytes to send (IN). + // timeout - timeout in miliseconds (IN). + // + // RETURNS: Number of bytes written or + // -1 if error. + // + + int NetConnection::write(const void *buf, int count, int timeout) + { + Error("ERROR: write() is NOT implemented.\n"); + } + // + // Reveive up to bytes and store them in . + // + // buf - destination buffer where to store readed data (OUT). + // count - expecting number of bytes to be readed (IN). + // timeout - timeout in miliseconds (IN). + // + // RETURNS: Number of bytes readed or + // -1 if error. + // + + int NetConnection::read(void *buf, int count, int timeout) + { + Error("ERROR: read() is NOT implemented.\n"); + } + + // + // Cancel all pending I/O associated with connection (if any). + // + + void NetConnection::cancel() + { + Error("ERROR: cancel() is NOT implemented.\n"); + } + + // + // Shutdown connection. + // + + int NetConnection::shutdown(int how) + { + } + + // + // Wait until connection finished work. + // + + int NetConnection::join() + { + while(1) + { + #ifdef WIN32 + Sleep(1000.0); + #else + sleep(1.0); + #endif + } + } + + // + // Static wrappers for read/write methods to be compatible with pure C code. + // Ctx means this pointer (NetConnection object). + // Used to pass read/write callback to IOMixer without adding dependency + // on LibNet. + // + // To pass read/write method to another C code we need to pass 2 values: + // + // - this pointer ('this') + // - pointer to NetConnection::readCallback ('callback') + // + // After that third C code can use it by calling: + // + // callback(buf, count, timeout, this) + // + + int NetConnection::readCallback(void *buf, int count, int timeout, void *ctx) + { + NetConnection *this_ = (NetConnection *) ctx; + + return this_ -> read(buf, count, timeout); + } + + int NetConnection::writeCallback(void *buf, int count, int timeout, void *ctx) + { + NetConnection *this_ = (NetConnection *) ctx; + + return this_ -> write(buf, count, timeout); + } + + void NetConnection::cancelCallback(void *ctx) + { + NetConnection *this_ = (NetConnection *) ctx; + + this_ -> cancel(); + } + + // + // High level I/O. + // + + // + // - Send single, printf like formatted request to server + // - read answer in format 'XYZ > message' + // - split answer to code and parts. + // + // Example usage: + // + // request(&serverCode, serverMsg, sizeof(serverMsg), + // "share --alias %s --path %s", alias, path); + // + // TIP: If only exit code is needed can be set to NULL. + // + // serverCode - exit code returned by server (OUT). + // serverMsg - ASCIZ message returned by server (OUT/OPT). + // serverMsgSize - size of answer buffer in bytes (IN). + // timeout - timeout in ms, defaulted to infinite if -1 (IN/OPT). + // fmt - printf like parameters to format command to send (IN). + // + // RETURNS: 0 if request sucessfuly sent and asnwer from server received. + // -1 otherwise. + // + // WARNING!: Request could still failed on server side. + // To get server's side exit code use 'answerCode' parameter. + // + + int NetConnection::request(int *serverCode, char *serverMsg, + int serverMsgSize, int timeout, + const char *fmt, ...) + { + DBG_ENTER("NetConnection::request"); + + int exitCode = -1; + + char buf[1024]; + + int cmdLen = 0; + + char *dst = NULL; + + int readed = 0; + int total = 0; + + int eofReceived = 0; + + int len = 0; + + va_list ap; + + // + // Check args. + // + + FAILEX(serverCode == NULL, "ERROR: 'serverCode' cannot be NULL in NetConnection::request."); + FAILEX(fmt == NULL, "ERROR: 'fmt' cannot be NULL in NetConnection::request."); + + // + // Format printf like message. + // + + va_start(ap, fmt); + + len = vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + + va_end(ap); + + // + // Send command to server INCLUDING zero terminator byte. + // + + FAILEX(write(buf, len + 1, timeout) < 0, + "ERROR: Cannot send request.\n"); + + // + // Read answer from server in below format: + // 'XYZ> ' + // + // Where is 3 decimal server side code e.g. "871". + // + + // + // Read 'XYZ> ' prefix first. + // where XYZ is 3 decimal exit code returned by server. + // + + FAILEX(read(buf, 5, timeout) != 5, + "ERROR: Cannot read 'XYZ> ' prefix."); + + buf[4] = 0; + + *serverCode = atoi(buf); + + // + // Read ASCIZ message part if needed. + // + + if (serverMsg && serverMsgSize > 0) + { + dst = serverMsg; + + total = 0; + + // + // FIXME: Avoid reading byte by byte. + // + + while(read(dst, 1, timeout) == 1) + { + // + // Caller buffer too short. + // + + if (total == serverMsgSize) + { + break; + } + + // + // End of message, it's ordinal end. + // + + if (dst[0] == 0) + { + eofReceived = 1; + + break; + } + + total ++; + + dst ++; + } + + serverMsg[total] = 0; + } + + // + // Flush remaining message from server if any. + // This is scenario when caller message[] buffer is shorter + // than message sent by server. + // + + while(eofReceived == 0) + { + if (read(buf, 1, timeout) <= 0 || buf[0] == 0) + { + eofReceived = 1; + } + } + + exitCode = 0; + + // + // Clean up. + // + + fail: + + if (exitCode) + { + Error("Cannot send NET request.\n" + "Error code is : %d.\n", GetLastError()); + } + + DBG_LEAVE("NetConnection::request"); + + return exitCode; + } + + // + // Get back caller context passed to constructor if any. + // + + const void *NetConnection::getContext() + { + return ctx_; + } + + // + // Get back protocol passed to constructor if any. + // + + const char *NetConnection::getProtocol() + { + return protocol_.c_str(); + } + + // + // Get back socket passed to constructor if any. + // + + int NetConnection::getSocket() + { + return socket_; + } + + // + // Get back handler function passed to constructor if any. + // + + NetHandleConnProto NetConnection::getHandler() + { + return handler_; + } + + // + // Get string with information about remote client. + // + + const char *NetConnection::getClientInfo() + { + return clientInfo_.c_str(); + } + + // + // Increase refference counter. + // + // WARNING! Every call to addRef() MUSTS be followed by one release() call. + // + // TIP #1: Object will not be destroyed until refference counter is greater + // than 0. + // + // TIP #2: Don't call destructor directly, use release() instead. If + // refference counter achieve 0, object will be destroyed + // automatically. + // + + void NetConnection::addRef() + { + refCountMutex_.lock(); + + refCount_ ++; + + DEBUG2("Increased refference counter to %d for NetConnection PTR#%p.\n", + refCount_, this); + + refCountMutex_.unlock(); + } + + // + // Decrease refference counter increased by addRef() before. + // + + void NetConnection::release() + { + int deleteNeeded = 0; + + // + // Check is this pointer correct. + // + + if (isPointerCorrect(this) == 0) + { + Error("ERROR: Attemp to destroy non existing NetConnection PTR#%p.\n", this); + + return; + } + + // + // Decrease refference counter by 1. + // + + refCountMutex_.lock(); + + refCount_ --; + + DEBUG2("Decreased refference counter to %d for NetConnection PTR#%p.\n", + refCount_, this); + + if (refCount_ == 0) + { + deleteNeeded = 1; + } + + refCountMutex_.unlock(); + + // + // Delete object if refference counter goes down to 0. + // + + if (deleteNeeded) + { + delete this; + } + } + + // + // Connection's state management. + // + + // + // Set connection state. See NET_STATE_XXX defines in LibNet.h for + // possible states. + // + // state - one of NET_STATE_XXX state defined in LibNet.h (IN). + // + // RETURNS: 0 if OK. + // + + int NetConnection::setState(int state) + { + DBG_MSG("NetConnection PTR 0x%p changed state to [%d].\n", this, state); + + state_ = state; + } + + // + // Get back current connection state set by setState() before. + // + + int NetConnection::getState() + { + return state_; + } + + // + // Wait until connection reach given state or timeout. + // + // state - target state, which should be set (IN). + // timeout - timeout limit in ms. Defaulted to infinite if -1. (IN/OPT). + // + // RETURNS: 0 if target status reached, + // -1 otherwise. + // + + int NetConnection::waitForState(int state, int timeout) + { + DBG_ENTER("NetConnection::waitForState"); + + int exitCode = -1; + + int timeLeft = timeout; + + DBG_MSG3("NetConnection::waitForState : Waiting for state" + " [%d] for PTR 0x%p...\n", state, this); + + while(state != state_) + { + #ifdef WIN32 + Sleep(100); + #else + usleep(100000); + #endif + + if (timeout > 0) + { + timeLeft -= 100; + + FAILEX(timeLeft <= 0, "ERROR: Timeout reached.\n") + } + + FAIL(state_ == NET_STATE_DEAD); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: State [%d] not reached on connection PTR 0x%x.\n", state, this); + } + + DBG_LEAVE("NetConnection::waitForState"); + + return exitCode; + } + + // + // Disable nagle algorithm on given connection if possible. + // + // value - 1 to disable algo, 0 to enable it back (IN). + // + + void NetConnection::setNoDelay(int value) + { + } + + // + // Enable SO_KEEPALIVE flag, it keeps connections active by + // enabling the periodic transmission of messages. + // + // interval - -1 to disable SO_KEEPALIVE, above 0 will set time + // in seconds between individual keepalive probes. + // + + void NetConnection::setKeepAlive(int interval) + { + } + + // + // Get back thread handle set in costructor or by setThread() later. + // + + ThreadHandle_t *NetConnection::getThread() + { + return thread_; + } + + // + // Set thread handle associated with object. + // + // thread - thread handle created by threadCreate() before (IN). + // + + void NetConnection::setThread(ThreadHandle_t *thread) + { + thread_ = thread; + } + + // + // Authroize connection if needed. + // + // RETURNS: 0 if OK. + // + + int NetConnection::authorize(const void *authData, int authDataSize) + { + return 0; + } + + // + // Get authorization data needed to be passed to another side if needed. + // + // RETURNS: 0 if OK. + // + + int NetConnection::getAuthData(void *authData, int authDataSize) + { + return 0; + } + + // + // Disable inherit to child process (exec). + // + // RETURNS: 0 if OK. + // + + int NetConnection::disableInherit() + { + return -1; + } + + // + // Check is given this pointer points to correct NetConnection *object. + // + // ptr - this pointer to check (IN). + // + // RETURNS: 1 if given pointer points to correct net connection object, + // 0 otherwise. + // + + int NetConnection::isPointerCorrect(NetConnection *ptr) + { + int found = 0; + + instancesMutex_.lock(); + found = instances_.count(ptr); + instancesMutex_.unlock(); + + return found; + } + + // + // Set quiet mode to avoid printing error message longer. + // + + void NetConnection::setQuietMode(int value) + { + quietMode_ = value; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/NetConnection.h b/Source/Net/LibNet/NetConnection.h new file mode 100644 index 0000000..b4d89f6 --- /dev/null +++ b/Source/Net/LibNet/NetConnection.h @@ -0,0 +1,172 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_NetConnection_H +#define Tegenaria_Core_NetConnection_H + +#include +#include +#include +#include + +#include +#include +#include + +#include "Net.h" + +namespace Tegenaria +{ + using std::string; + using std::set; + + class NetConnection + { + protected: + + const void *ctx_; + + string protocol_; + + string clientInfo_; + + int socket_; + + NetHandleConnProto handler_; + + int refCount_; + + int state_; + int quietMode_; + + ThreadHandle_t *thread_; + + // + // Protected desctructor. + // Use release() instead to handle refference counter. + // + + virtual ~NetConnection(); + + public: + + // + // Constructors. + // + + NetConnection(const void *ctx, const char *protocol, + int socket = -1, NetHandleConnProto handler = NULL, + ThreadHandle_t *thread = NULL); + + // + // Refference counter. + // + + void addRef(); + void release(); + + Mutex refCountMutex_; + + // + // Track created instances to check is given this pointer correct or not. + // + + static set instances_; + + static Mutex instancesMutex_; + + static int isPointerCorrect(NetConnection *ptr); + + // + // Get property. + // + + const void *getContext(); + + virtual const char *getProtocol(); + + virtual const char *getClientInfo(); + + virtual int getSocket(); + + NetHandleConnProto getHandler(); + + ThreadHandle_t *getThread(); + + // + // Set property. + // + + void setThread(ThreadHandle_t *thread); + + void setQuietMode(int value); + + // + // Authorization/hash exchange function. + // + + virtual int authorize(const void *authData, int authDataSize); + + virtual int getAuthData(void *localHash, int localHashSize); + + // + // Low level I/O. + // + + virtual int write(const void *buf, int count, int timeout = -1); + virtual int read(void *buf, int count, int timeout = -1); + virtual void cancel(); + + virtual int shutdown(int how = SD_BOTH); + + virtual int join(); + + virtual void setNoDelay(int value); + virtual void setKeepAlive(int interval); + + static int readCallback(void *buf, int count, int timeout, void *ctx); + static int writeCallback(void *buf, int count, int timeout, void *ctx); + static void cancelCallback(void *ctx); + + // + // High level I/O. + // + + int request(int *serverCode, char *serverMsg, int serverMsgSize, + int timeout, const char *fmt, ...); + + int setState(int state); + int getState(); + int waitForState(int state, int timeout = -1); + + // + // Disable inherit in child process (exec). + // + + virtual int disableInherit(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_NetConnection */ diff --git a/Source/Net/LibNet/NetEpollServer.cpp b/Source/Net/LibNet/NetEpollServer.cpp new file mode 100644 index 0000000..115c975 --- /dev/null +++ b/Source/Net/LibNet/NetEpollServer.cpp @@ -0,0 +1,1352 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: TCP server based on Linux epoll API. +// + +#pragma qcbuild_set_file_title("epoll based server (Linux only)"); +#pragma qcbuild_set_private(1) + +#include +#include "NetEpollServer.h" +#include "Utils.h" + +namespace Tegenaria +{ + // + // Allocate new epoll context and associate it with given fd. + // + // epollFd - epoll fd returned from epoll_create() before (IN). + // fd - related fd to associate (IN). + // openHandler - callback to inform about new connections (IN/OPT). + // closeHandler - callback to inform about closed connections (IN/OPT). + // dataHandler - callback to process incoming data (IN/OPT). + // + // WARNING! Returned pointer MUST be freed by NetEpollContextDestroy() + // if no needed longer. + // + // RETURNS: Pointer to new allocated epoll context or, + // NULL if error. + // + + NetEpollContext *NetEpollContextCreate(int epollFd, int fd, + NetEpollOpenProto openHandler, + NetEpollCloseProto closeHandler, + NetEpollDataProto dataHandler) + { + DBG_ENTER("NetEpollContextCreate"); + + NetEpollContext *ctx = NULL; + + // + // Allocate new epoll context. + // + + ctx = (NetEpollContext *) calloc(1, sizeof(NetEpollContext)); + + FAILEX(ctx == NULL, "ERROR: Cannot allicate epoll context.\n"); + + // + // Associate context with given epoll and fd. + // + + ctx -> custom_ = NULL; + ctx -> epollFd_ = epollFd; + ctx -> lastError_ = NET_EPOLL_SUCCESS; + ctx -> fd_ = fd; + ctx -> openHandler_ = openHandler; + ctx -> closeHandler_ = closeHandler; + ctx -> dataHandler_ = dataHandler; + + // + // Error handler. + // + + fail: + + DBG_LEAVE("NetEpollContextCreate"); + + return ctx; + } + + // + // Free epoll context created by NetEpollContextCreate() before. + // + // ctx - pointer returned by NetEpollContextCreate() before (IN). + // + + void NetEpollContextDestroy(NetEpollContext *ctx) + { + DBG_ENTER("NetEpollContextDestroy"); + + if (ctx) + { + if (ctx -> closeHandler_) + { + ctx -> closeHandler_(ctx, ctx -> fd_); + } + + if (ctx -> data_) + { + free(ctx -> data_); + } + + free(ctx); + } + + DBG_LEAVE("NetEpollContextDestroy"); + } + + // + // Slave loop to handle one worker thread. + // Used internally only. + // + // data - pointer to listenCtx struct created in NetEpollServerLoop() (IN/OUT). + // + // RETURNS: 0 if OK. + // + + int NetEpollServerSlaveLoop(void *data) + { + DBG_ENTER("NetEpollServerSlaveLoop"); + + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + Error("NetEpollServerSlaveLoop not implemented on Windows.\n"); + + return -1; + } + + // + // Linux. + // + + #else + + int eventstriggered = 0; + int newconns = 0; + int fd = -1; + + struct epoll_event *events = NULL; + + int activeconns = 0; + + NetEpollContext *listenCtx = (NetEpollContext *) data; + + NetEpollContext *ctx = NULL; + + // + // Allocate event table. + // + + events = (struct epoll_event *) malloc(NET_EPOLL_MAXEVENTS * sizeof(struct epoll_event)); + + FAILEX(events == NULL, "ERROR: out of memory.\n"); + + // + // Fall into main interrupt-triggerd polling queue loop. + // + + while(1) + { + // + // Wait for events. + // + + eventstriggered = epoll_wait(listenCtx -> epollFd_, events, NET_EPOLL_MAXEVENTS, -1); + + if (eventstriggered == -1) + { + Fatal("FATAL: epoll wait returned -1.\n"); + } + + DEBUG2("Event triggered: %d\n", eventstriggered); + + // + // Serve all events. + // + + for (int i = 0; i < eventstriggered; i++) + { + ctx = (NetEpollContext *) events[i].data.ptr; + + fd = ctx -> fd_; + + // + // Event on listening socket. + // We're expecting new incoming connetions here. + // + + if (fd == listenCtx -> fd_) + { + DEBUG3("NetEpollServerLoop : Accept event on FD #%d/%p.\n", fd, ctx); + + newconns = NetEpollAccept(ctx, fd, activeconns); + + if (newconns > 0) + { + activeconns += newconns; + + DBG_MSG("Added %d new fd to list (currently %d connections in event loop)\n", newconns, activeconns); + } + } + + // + // Event on data socket. + // + + else + { + // + // Check if the socket went in err/hangup (triggered by wait by default) + // + + if((events[i].events & EPOLLERR) || (events[i].events & EPOLLHUP)) + { + // + // Socket will automatically be removed from epoll list. + // + + close(fd); + + activeconns--; + + DBG_MSG("Closed connection (currently %d connections in event loop)\n", activeconns); + + // + // Free related epoll context. + // + + NetEpollContextDestroy(ctx); + + continue; + } + + // + // Write ready event. + // + + if(events[i].events & EPOLLOUT) + { + DEBUG3("NetEpollServerLoop : Write event on FD #%d/%p.\n", fd, ctx); + + if(NetEpollWriteEvent(ctx, fd)) + { + activeconns--; + + DBG_MSG("Closed connection (currently %d connections in event loop)\n",activeconns); + + // + // Free related epoll context. + // + + NetEpollContextDestroy(ctx); + } + } + + // + // Read ready event. + // + + else if (events[i].events & EPOLLIN) + { + DEBUG3("NetEpollServerLoop : Write event on FD #%d/%p.\n", fd, ctx); + + NetEpollReadEvent(ctx, fd); + + if (ctx -> lastError_ == NET_EPOLL_EOF || ctx -> lastError_ == NET_EPOLL_ERROR) + { + activeconns--; + + DBG_MSG("Closed connection (currently %d connections in event loop)\n",activeconns); + + // + // Free related epoll context. + // + + NetEpollContextDestroy(ctx); + } + } + } + } + + DEBUG2("Looping event loop.\n", activeconns); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create epoll server slave loop.\n"); + } + + if (events) + { + free(events); + } + + DBG_LEAVE("NetEpollServerSlaveLoop"); + + return 0; + + #endif + } + + // + // Main server loop. + // Create non-blocking epoll based TCP server. + // + // port - listening port (IN). + // openHandler - handler called when new connection arrived (IN/OPT). + // closeHandler - handler called when existing connection closed (IN/OPT). + // + // dataHandler - handler called when something to read on one of existing + // connection (IN). + // + // TIP #1: Use NetEpollWrite() to write data inside data handler. + // TIP #2: Use NetEpollRead() to read data inside data handler. + // + // RETURNS: 0 if terminated correctly by NetEpollServerKill(), + // -1 if error. + // + + int NetEpollServerLoop(int port, NetEpollOpenProto openHandler, + NetEpollCloseProto closeHandler, + NetEpollDataProto dataHandler) + { + DBG_ENTER("NetEpollServerLoop"); + + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + Error("NetEpollServerLoop not implemented on Windows.\n"); + + return -1; + } + + // + // Linux. + // + + #else + + int listensocket; + int epollfd; + + struct epoll_event ev = {0}; + + NetEpollContext listenCtx[64] = {0}; + + ThreadHandle_t *workerThread[64]; + + // + // Check and change if needed the per-user limit of open files. + // + + FAIL(NetSetFDsLimit(NET_EPOLL_MAXCONNS + 1)); + + // + // Start listening socket on given port. + // + + listensocket = NetEpollListen(port); + + FAIL(listensocket < 0); + + // + // Create worker threads. + // + + for (int i = 0; i < NetGetCpuNumber(); i++) + { + // + // Set up epoll queue for worker. + // + + epollfd = epoll_create(NET_EPOLL_MAXEVENTS); + + if (epollfd == -1) + { + Fatal("FATAL: Could not create epoll FD."); + } + + listenCtx[i].lastError_ = NET_EPOLL_SUCCESS; + listenCtx[i].epollFd_ = epollfd; + listenCtx[i].openHandler_ = openHandler; + listenCtx[i].closeHandler_ = closeHandler; + listenCtx[i].dataHandler_ = dataHandler; + listenCtx[i].fd_ = listensocket; + + // + // Add listening socket to epoll. + // + + ev.events = EPOLLIN; + ev.data.ptr = &listenCtx[i]; + + FAILEX(epoll_ctl(epollfd, EPOLL_CTL_ADD, listensocket, &ev) == -1, + "ERROR: epoll_ctl failure on listening socket #%d.\n", listensocket); + + workerThread[i] = ThreadCreate(NetEpollServerSlaveLoop, &listenCtx[i]); + + DBG_INFO("NetEpollServerLoop: Craeted worker ID#%d.\n", i); + } + + // + // Wait until workers finished. + // + + for (int i = 0; i < NetGetCpuNumber(); i++) + { + ThreadWait(workerThread[i]); + ThreadClose(workerThread[i]); + + workerThread[i] = NULL; + + DBG_INFO("NetEpollServerLoop: Worker #%d finished.\n", i); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create epoll server loop.\n"); + } + + if (listensocket != -1) + { + close(listensocket); + } + + DBG_LEAVE("NetEpollServerLoop"); + + return 0; + + #endif + } + + // + // This functions creates non-block listening socket. + // + // port - listening port (IN). + // + // RETURNS: Listening socket + // or -1 if error. + // + + int NetEpollListen(int port) + { + // + // Windows. + // + + #ifdef WIN32 + { + Error("NetEpollListen() not implemented on Windows.\n"); + + return -1; + } + + // + // Linux. + // + + #else + + DBG_ENTER("NetEpollListen"); + + int sock = -1; + + int exitCode = -1; + + int reuseAddress = 1; + + struct sockaddr_in6 addr = {0}; + + // + // Set up IP6 address to ::port. + // + + addr.sin6_port = htons(port); + addr.sin6_addr = in6addr_any; + addr.sin6_family = AF_INET6; + + // + // Create listening socket. + // + + sock = socket(AF_INET6,SOCK_STREAM | SOCK_NONBLOCK, 0); + + FAILEX(sock == -1, + "ERROR: Cannot create listening socket.\n"); + + // + // Set address reuse. + // + + FAILEX(setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, + &reuseAddress, sizeof(reuseAddress)) == -1, + "ERROR: Cannot set reuse flag on socket #%d.\n", sock); + // + // Bind socket to IP address. + // + + FAILEX(bind(sock, (struct sockaddr *) &addr, sizeof(addr)) == -1, + "ERROR: Cannot bind address to socket #%d.\n", sock); + + // + // Listen for incoming connection. + // + + FAILEX(listen(sock, NET_EPOLL_MAXCONNS) == -1, + "ERROR: Cannot listen on socket #%d.\n", sock); + + DBG_INFO("Listening on port %d...\n", port); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("Cannot create listening epoll socket.\n" + "Error code is %d.\n", errno); + + if (sock != -1) + { + close(sock); + + sock = -1; + } + } + + DBG_LEAVE("NetEpollListen"); + + return sock; + + #endif + } + + // + // This function accepts incoming connections, and adds read-ready events for + // them to the event queue. The function returns the number of newly opened + // connections. + // + // + // Handle epoll event on listening socket. + // Called internall from NetEpollServerLoop() when new connection arrived. + // + // listenCtx - epoll context asociated with listening socket created in + // NetEpollServerLoop() function (IN). + // + // listensocket - listening socket related with event (IN). + // + // activeconns - number of already active connections on listensocket (IN). + // + // RETURNS: Number of new accepted connections, + // or -1 if error. + // + + int NetEpollAccept(NetEpollContext *listenCtx, int listensocket, int activeconns) + { + // + // Windows. + // + + #ifdef WIN32 + { + Error("NetEpollAccept() not implemented on Windows.\n"); + + return -1; + } + + // + // Linux. + // + + #else + + DBG_ENTER("NetEpollAccept"); + + int addrlen = 0; + int newfd = 0; + int newconncount = 0; + + struct sockaddr_in caddr; + + struct epoll_event ev = {0}; + + NetEpollContext *ctx = NULL; + + // + // Accept connections until something to accept. + // + + newconncount = 0; + + while(1) + { + addrlen = sizeof(caddr); + + newfd = accept4(listensocket, (struct sockaddr *) &caddr, + (socklen_t *) &addrlen, SOCK_NONBLOCK); + + // + // Error or socket busy. + // + + if (newfd == -1) + { + // + // No more new connections ? + // + + if ((errno == EAGAIN) || (errno == EWOULDBLOCK)) + { + break; + } + + // + // We did not break, error occurred + // + + Error("ERROR: Cannot accept new connection.\n"); + + continue; + } + + DBG_MSG("Accepted new connection on FD#%d.\n", newfd); + + // + // Check limit of connection. + // + + if ((activeconns + 1) >= NET_EPOLL_MAXEVENTS) + { + Fatal("FATAL: Too many open connections at FD#%d.\n", newfd); + } + + // + // Allocate epoll context for new connection. + // + + ctx = NetEpollContextCreate(listenCtx -> epollFd_, newfd, + listenCtx -> openHandler_, + listenCtx -> closeHandler_, + listenCtx -> dataHandler_); + + if (ctx == NULL) + { + Error("Cannot allocate new epoll context.\n"); + + continue; + } + + // + // Available for input and non edge_triggered. + // + + ev.events = EPOLLIN; + ev.data.ptr = ctx; + + if (epoll_ctl(ctx -> epollFd_, EPOLL_CTL_ADD, newfd, &ev) == -1) + { + Fatal("FATAL: epoll_ctl failure on FD#%d", newfd); + } + + // + // Successfully accepted and added newfd to the list. + // Loop for new connections. + // + + if (ctx -> openHandler_) + { + ctx -> openHandler_(ctx, newfd); + } + + newconncount ++; + } + + fail: + + DBG_LEAVE("NetEpollAccept"); + + return newconncount; + + #endif + } + + // + // Push data to write queue for delay write, when socket will became ready + // to write. + // Used internally only if blocked write failed or only part of data + // written in NetEpollWrite(). + // + // ctx - epoll queue context created in NetEpollServerLoop function (IN). + // fd - CRT FD configured to work with epoll queue (IN). + // buf - source buffer with data to write (IN). + // len - number of bytes in buf[] (IN). + // + // written - how many bytes already sent, only remaining part will be + // processed (IN). + // + + void NetEpollDelayWrite(NetEpollContext *ctx, int fd, + char *buf, int len, int written) + { + DBG_ENTER("NetEpollDelayWrite"); + + // + // Windows. + // + + #ifdef WIN32 + { + Error("NetEpollDelayWrite() not implemented on Windows.\n"); + } + + // + // Linux. + // + + #else + + // + // Will simply not mark the socket, discard the data, + // and keep the socket in the loop. + // + + if(NET_EPOLL_TCP_SEND_BUFFER_CORRECT == 0) + { + return; + } + + struct epoll_event ev = {0}; + + DBG_MSG("WARNING: Socket became write blocked" + " (still %d/%d bytes to send).", written, len); + + // + // Remove the socket from the queue + // + + if (epoll_ctl(ctx -> epollFd_, EPOLL_CTL_DEL, fd, NULL) == -1) + { + Fatal("FATAL: epoll_ctl removal failure on fd %d", fd); + } + + // + // Check if we already have an entry (we shouldn't). + // If we have data in send buffer append data to it. + // + + if (ctx -> len_ > 0) + { + int oldLen = ctx -> len_; + + ctx -> len_ = oldLen + len - written; + ctx -> data_ = realloc(ctx -> data_, ctx -> len_); + + memcpy((char *) ctx -> data_ + oldLen, buf + written, len - written); + } + + // + // Buffer empty. + // Create new one. + // + + else + { + ctx -> len_ = len - written; + ctx -> data_ = realloc(ctx -> data_, ctx -> len_); + + memmove(ctx -> data_, buf + written, ctx -> len_); + } + + // + // Readd the socket to the queue. + // + + ev.events = EPOLLOUT; + ev.data.ptr = ctx; + + if(epoll_ctl(ctx -> epollFd_, EPOLL_CTL_ADD, fd, &ev) == -1) + { + Fatal("FATAL: epoll_ctl failure on readdition of fd %d", fd); + } + + #endif + + DBG_LEAVE("NetEpollDelayWrite"); + } + + // + // Read bytes from FD created by epoll server. + // + // ctx - epoll queue context (IN). + // fd - CRT FD configured to work with epoll queue (IN). + // buf - destination buffer (OUT). + // len - number of bytes to read (IN). + // + // RETURNS: Number of bytes readed - success (always greater than 0), + // NET_EPOLL_WOULD_BLOCK - FD not ready right now, + // NET_EPOLL_EOF - connection shutted down by remote side, + // NET_EPOLL_ERROR - connection shutted down due to unexpected error. + // + + int NetEpollRead(NetEpollContext *ctx, int fd, void *buf, int len) + { + DBG_ENTER("NetEpollRead"); + + int ret = NET_EPOLL_ERROR; + + // + // Windows. + // + + #ifdef WIN32 + { + Error("NetEpollRead() not implemented on Windows.\n"); + } + + // + // Linux. + // + + #else + + int readed = read(fd, buf, len); + + switch(readed) + { + // + // Socket not ready right now or error. + // + + case -1: + { + // + // FD busy right now, go away and try once again later. + // + + if((errno == EAGAIN) && (errno == EWOULDBLOCK)) + { + ret = NET_EPOLL_WOULD_BLOCK; + } + + // + // Unexpected error. + // + + else + { + close(fd); + + Error("Could not read from FD #%d due to unexpected reason" + " (hence closing it). Reason: %s\n", fd, strerror(errno)); + + ret = NET_EPOLL_ERROR; + } + + break; + } + + // + // EOF. + // + + case 0: + { + close(fd); + + ret = NET_EPOLL_EOF; + + break; + } + + // + // Data readed. + // + + default: + { + ret = readed; + + break; + } + } + + // + // Save last error code for given epoll queue. + // + + if (ret > 0) + { + ctx -> lastError_ = NET_EPOLL_SUCCESS; + } + else + { + ctx -> lastError_ = ret; + } + + #endif + + DBG_LEAVE("NetEpollRead"); + + return ret; + } + + // + // Write bytes to FD created by epoll server. + // + // ctx - epoll queue context (IN). + // fd - CRT FD configured to work with epoll queue (IN). + // buf - destination buffer (OUT). + // len - number of bytes to read (IN). + // + // RETURNS: Number of bytes written or + // -1 if error. + // + + int NetEpollWrite(NetEpollContext *ctx, int fd, void *buf, int len) + { + DBG_ENTER("NetEpollWrite"); + + int ret = NET_EPOLL_ERROR; + + int written = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + Error("NetEpollWrite() not implemented on Windows.\n"); + } + + // + // Linux. + // + + #else + { + // + // Check args. + // + + FAILEX(ctx -> fd_ != fd, + "ERROR: FD #%d doesn't match epoll context PTR #%p.\n", + fd, ctx); + + // + // Note that this is a bit tricky. It is possible that the write does not return the number of bytes + // that we tried to send to it. (This could be the case because TCP's send buffer is full, and the receiver's + // flow control is blocking it.) Although unlikely, we do try to not loose data here, and keep a userspace + // buffer active to send it the next time the socket becomes writable. In addition, we then have + // remove the "read" event, and schedule the write event. + // + + if (ctx -> len_ == 0) + { + written = write(fd, buf, len); + } + + // + // Write error or socket not ready. + // + + if (written == -1) + { + // + // Socket not ready. + // Delay writing to next write ready event. + // + + if((errno == EAGAIN) || (errno == EWOULDBLOCK)) + { + DBG_MSG("WARNING: Send-buffer full for connection %d\n", fd); + + NetEpollDelayWrite(ctx, fd, (char *) buf, len, 0); + + ret = len; + + ctx -> lastError_ = NET_EPOLL_WOULD_BLOCK; + } + + // + // Write error. Close socket. + // + + else + { + Error("ERROR: Cannot write to FD #%d due to unexpected reason (hence closing it)." + " Reason: %s\n", fd, strerror(errno)); + + close(fd); + + ctx -> lastError_ = NET_EPOLL_ERROR; + + ret = NET_EPOLL_ERROR; + } + } + + // + // Data partially written. + // Delay writing remaining part to next write ready event. + // + + else if (written < len) + { + NetEpollDelayWrite(ctx, fd, (char *) buf, len, written); + + ctx -> lastError_ = NET_EPOLL_SUCCESS; + + ret = len; + } + + // + // Whole data written. + // + + else + { + ret = len; + + ctx -> lastError_ = NET_EPOLL_SUCCESS; + } + } + + fail: + + #endif + + DBG_LEAVE("NetEpollWrite"); + + return ret; + } + + // + // Handle epoll read ready event on given FD. + // Called internally only from NetEpollServerLoop(). + // + // ctx - epoll queue context created in NetEpollServerLoop (IN). + // fd - fd, where to read data from (IN). + // + // RETURNS: 1 if socket closed inside function, + // 0 otherwise. + // + + int NetEpollReadEvent(NetEpollContext *ctx, int fd) + { + DBG_ENTER("NetEpollReadEvent"); + + int ret = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + Error("NetEpollReadEvent() not implemented on Windows.\n"); + } + + // + // Linux. + // + + #else + + int readed = 0; + + int socketClosed = 0; + + char buf[NET_EPOLL_READBUFF]; + + // + // Note that because we potentially have a lot of data, + // we might need to do this in a few loops. + // + + ctx -> lastError_ = NET_EPOLL_SUCCESS; + + while(ctx -> lastError_ == NET_EPOLL_SUCCESS) + { + readed = NetEpollRead(ctx, fd, buf, sizeof(buf)); + + switch(readed) + { + // + // Read error. + // + + case NET_EPOLL_ERROR: + { + Error("ERROR: Cannot read data from FD #%d.\n", fd); + + break; + } + + // + // EOF readed. + // + + case NET_EPOLL_EOF: + { + break; + } + + // + // FD not ready right now, go away and try again. + // + + case NET_EPOLL_WOULD_BLOCK: + { + break; + } + + // + // Data readed. + // Call user handler. + // + + default: + { + if (ctx -> dataHandler_) + { + ctx -> dataHandler_(ctx, fd, buf, readed); + } + + break; + } + } + } + + ret = 0; + + #endif + + DBG_LEAVE("NetEpollReadEvent"); + + return ret; + } + + // + // Handle epoll write ready event on given FD. + // Called internally only from NetEpollServerLoop(). + // + // ctx - epoll queue context created in NetEpollServerLoop (IN). + // fd - fd, where to write data to (IN). + // + // RETURNS: 1 if socket closed inside function, + // 0 otherwise. + // + + int NetEpollWriteEvent(NetEpollContext *ctx, int fd) + { + DBG_ENTER("NetEpollWriteEvent"); + + int ret = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + Error("NetEpollWriteEvent() not implemented on Windows.\n"); + } + + // + // Linux. + // + + #else + + char *storedbuffer; + + int storedsize = 0; + int closedconns = 0; + int written = 0; + + struct epoll_event ev = {0}; + + storedbuffer = (char *) ctx -> data_; + + if (storedbuffer == NULL) + { + Fatal("FATAL: socket was write blocked, but out of memory.\n"); + } + + storedsize = ctx -> len_; + + if (storedsize == -1) + { + Fatal("FATAL: socket was write blocked, but out of memory.\n"); + } + + // + // Set delay buffer as empty. + // + + ctx -> len_ = 0; + + // + // Now we can again start to attempt to write this data to the socket + // + + written = write(fd, storedbuffer, storedsize); + + // + // Write failed. + // + + if(written == -1) + { + // + // Something went wrong. Either we are blocking (buffer full), or there was a real error + // + + if((errno == EAGAIN) || (errno == EWOULDBLOCK)) + { + DBG_MSG("WARNING: write-blocked socket became ready for" + " writing, but blocked again immediately! (fd %d)\n", fd); + + // + // We again did not succeed in sending everything we wanted to send. + // Stop echoing, and queue the data until the socket becomes ready. + // + + NetEpollDelayWrite(ctx, fd, storedbuffer, storedsize, 0); + + return 0; + } + else + { + Error("Could not read from socket (fd %d) due to " + "unexpected reason (hence closing it). Reason: %s\n", + fd, strerror(errno)); + + close(fd); + + return 1; + } + } + + // + // Written only part of data. + // + + else if (written < storedsize) + { + // + // We did not sent all the bytes we wanted to send. + // Stop echoing, and queue the data until the socket becomes ready. + // + + DBG_MSG("WARNING: write-blocked socket became ready for writing, but blocked again immediately! (fd %d)\n", fd); + + NetEpollDelayWrite(ctx, fd, storedbuffer, storedsize, written); + + return 0; + } + + // + // Whole buffer written. + // + + else if (written == storedsize) + { + free(ctx -> data_); + + ctx -> data_ = NULL; + } + + // + // At this point, we have successfully written our data. We can now + // finally reenable read events. Remove the socket from the queue + // + + if (epoll_ctl(ctx -> epollFd_, EPOLL_CTL_DEL, fd, NULL) == -1) + { + Fatal("FATAL: epoll_ctl removal failure on fd %d", fd); + } + + // + // Readd the socket to the queue. + // + + // + // Available for read and non edge_triggered. + // + + ev.events = EPOLLIN; + ev.data.ptr = ctx; + + if (epoll_ctl(ctx -> epollFd_, EPOLL_CTL_ADD, fd, &ev) == -1) + { + Fatal("FATAL: epoll_ctl failure on readdition of fd %d", fd); + } + + DBG_MSG("INFO: write-blocked socket became ready" + " for writing, and userspace buffer was cleared! (fd %d)\n", fd); + + ret = 0; + + #endif + + DBG_LEAVE("NetEpollWriteEvent"); + + return ret; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/NetEpollServer.h b/Source/Net/LibNet/NetEpollServer.h new file mode 100644 index 0000000..f9ca4b4 --- /dev/null +++ b/Source/Net/LibNet/NetEpollServer.h @@ -0,0 +1,133 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_NetEpollServer_H +#define Tegenaria_Core_NetEpollServer_H + +#ifndef WIN32 +# include +# include +# include +# include +# include +# include +# include +# include +# include +# include +# include +# include +#endif + +#include +#include +#include + +namespace Tegenaria +{ + using std::map; + + // + // Defines. + // + + #define NET_EPOLL_SUCCESS 1 + #define NET_EPOLL_EOF 0 + #define NET_EPOLL_ERROR -1 + #define NET_EPOLL_WOULD_BLOCK -2 + + #define NET_EPOLL_MAXCONNS 255/*200000*/ + #define NET_EPOLL_MAXEVENTS 256/*200001*/ + #define NET_EPOLL_READBUFF 8096 + #define NET_EPOLL_MAXTHREADS 16 + + #define NET_EPOLL_TCP_SEND_BUFFER_CORRECT 1 + + // + // Forward definitions. + // + + struct NetEpollContext; + + // + // Typedef. + // + + typedef void (*NetEpollCloseProto)(NetEpollContext *ctx, int fd); + typedef void (*NetEpollOpenProto)(NetEpollContext *ctx, int fd); + typedef void (*NetEpollDataProto)(NetEpollContext *ctx, int fd, void *buf, int len); + + // + // Structs. + // + + struct NetEpollContext + { + void *custom_; + + int lastError_; + int epollFd_; + int fd_; + + // + // Delayed write if blocking write couldn't be complited + // immediatelly. + // + + int len_; + + void *data_; + + // + // User handlers. + // + + NetEpollCloseProto closeHandler_; + NetEpollOpenProto openHandler_; + NetEpollDataProto dataHandler_; + }; + + // + // Internal functions. + // + + int NetEpollListen(int port); + int NetEpollAccept(NetEpollContext *ctx, int listensocket, int activeconns); + int NetEpollReadEvent(NetEpollContext *ctx, int fd); + int NetEpollWriteEvent(NetEpollContext *ctx, int currfd); + + // + // Exported functions. + // + + int NetEpollServerLoop(int port, NetEpollOpenProto openHandler, + NetEpollCloseProto closeHandler, + NetEpollDataProto dataHandler); + + int NetEpollRead(NetEpollContext *ctx, int fd, void *buf, int len); + int NetEpollWrite(NetEpollContext *ctx, int fd, void *buf, int len); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_EpollServer_H */ diff --git a/Source/Net/LibNet/NetHpServer.cpp b/Source/Net/LibNet/NetHpServer.cpp new file mode 100644 index 0000000..b4d3a4b --- /dev/null +++ b/Source/Net/LibNet/NetHpServer.cpp @@ -0,0 +1,140 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Callback based TCP server working on Linux and Windows. +// It used internally: +// - epoll based server on linux +// - IO Completion Port based server on Windows. +// + +#pragma qcbuild_set_file_title("Callback TCP server"); + +#include "NetHpServer.h" +#include "NetEpollServer.h" +#include "NetIOCPServer.h" + +namespace Tegenaria +{ + // + // Create TCP server based on IO Completion Ports (WIndows) + // or epoll (Linux). + // + // port - listening port (IN). + // openHandler - handler called when new connection arrived (IN/OPT). + // closeHandler - handler called when existing connection closed (IN/OPT). + // + // dataHandler - handler called when something to read on one of existing + // connection (IN). + // + // TIP #1: Use NetHpWrite() to write data inside data handler. Don't + // use write() or send() directly. + // + // RETURNS: 0 if terminated correctly by NetIocpServerKill(), + // -1 if error. + // + + int NetHpServerLoop(int port, NetHpOpenProto openHandler, + NetHpCloseProto closeHandler, + NetHpDataProto dataHandler) + { + // + // Windows. + // Create IO Completion Port server. + // + + #ifdef WIN32 + { + NetIocpOpenProto iocpOpen = (NetIocpOpenProto) openHandler; + NetIocpCloseProto iocpClose = (NetIocpCloseProto) closeHandler; + NetIocpDataProto iocpData = (NetIocpDataProto) dataHandler; + + return NetIocpServerLoop(port, iocpOpen, iocpClose, iocpData); + } + + #else + + // + // Linux. + // Create epoll server. + // + + { + NetEpollOpenProto epollOpen = (NetEpollOpenProto) openHandler; + NetEpollCloseProto epollClose = (NetEpollCloseProto) closeHandler; + NetEpollDataProto epollData = (NetEpollDataProto) dataHandler; + + return NetEpollServerLoop(port, epollOpen, epollClose, epollData); + } + + #endif + } + + // + // Write bytes to FD received inside NetHpData handler called + // from NetHpServerLoop(). + // + // TIP #1: Caller should use this function to write data + // to client inside data handler specified to + // NetIocpServerLoop(). Don't use write() or send() directly. + // + // ctx - context received in data handler parameters (IN). + // fd - related FD where to write data (IN). + // buf - buffer with data to write (IN). + // len - how many bytes to write (IN). + // + // RETURNS: Number of bytes written or + // -1 if error. + // + + int NetHpWrite(NetHpContext *ctx, int fd, void *buf, int len) + { + // + // Windows. + // IO Completion Port server. + // + + #ifdef WIN32 + { + NetIocpContext *iocpCtx = (NetIocpContext *) ctx; + + return NetIocpWrite(iocpCtx, fd, buf, len); + } + + #else + + // + // Linux. + // Epoll server. + // + + { + NetEpollContext *epollCtx = (NetEpollContext *) ctx; + + return NetEpollWrite(epollCtx, fd, buf, len); + } + + #endif + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/NetHpServer.h b/Source/Net/LibNet/NetHpServer.h new file mode 100644 index 0000000..5e0f890 --- /dev/null +++ b/Source/Net/LibNet/NetHpServer.h @@ -0,0 +1,63 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_HPServer_H +#define Tegenaria_Core_HPServer_H + +namespace Tegenaria +{ + // + // Structs. + // + + // + // Wrap first, common field for NetEpollContext and NetIocpContext. + // This gives possibility to set custom per FD specified context. + + struct NetHpContext + { + void *custom_; + }; + + // + // Typedef. + // + + typedef void (*NetHpOpenProto)(NetHpContext *ctx, int fd); + typedef void (*NetHpCloseProto)(NetHpContext *ctx, int fd); + typedef void (*NetHpDataProto)(NetHpContext *ctx, int fd, void *buf, int len); + + // + // Exported functions. + // + + int NetHpServerLoop(int port, NetHpOpenProto openHandler, + NetHpCloseProto closeHandler, + NetHpDataProto dataHandler); + + int NetHpWrite(NetHpContext *ctx, int fd, void *buf, int len); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_HPServer_H */ diff --git a/Source/Net/LibNet/NetIOCPServer.cpp b/Source/Net/LibNet/NetIOCPServer.cpp new file mode 100644 index 0000000..99c9ccf --- /dev/null +++ b/Source/Net/LibNet/NetIOCPServer.cpp @@ -0,0 +1,784 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Callback based TCP server based on IO Completion ports on +// Windows. It's equivalent of epoll server on Linux. +// + +// +// Includes. +// +#pragma qcbuild_set_file_title("IOCP based server (Windows only)"); +#pragma qcbuild_set_private(1) + +#include "NetIOCPServer.h" +#include "NetInternal.h" +#include "Utils.h" +#include "Net.h" + +namespace Tegenaria +{ + // + // Main worker loop to handle IOCP events. + // We create two workers per CPU core in NetIocpServerLoop(). + // + // One worker do in loop: + // - pop next IOCP ready event + // - pass data to caller callback + // - post another IO request to go on. + // + + #ifdef WIN32 + + DWORD NetIocpWorkerLoop(LPVOID param) + { + DBG_ENTER("NetIocpWorkerLoop"); + + HANDLE iocp = HANDLE(param); + + int ret = 0; + + LPWSAOVERLAPPED ov = NULL; + + NetIocpContext *ctx = NULL; + + PER_IO_CONTEXT *ioCtx = NULL; + + WSABUF buffRecv; + WSABUF buffSend; + + DWORD readed = 0; + DWORD written = 0; + DWORD flags = 0; + DWORD ioSize = 0; + + // + // Continually loop to service IO completion packets. + // + + while(1) + { + // + // Pop next event from IOCP queue. + // + + ret = GetQueuedCompletionStatus(iocp, &ioSize, (PDWORD_PTR) &ctx, + (LPOVERLAPPED *) &ov, INFINITE); + + if (ret == 0 && GetLastError() != ERROR_NETNAME_DELETED) + { + Error("GetQueuedCompletionStatus() failed: %d\n", GetLastError()); + } + + // + // CTRL-C handler used PostQueuedCompletionStatus to post an I/O packet with + // a NULL CompletionKey (or if we get one for any reason). It is time to exit. + // + + if(ctx == NULL) + { + return 0; + } + + // + // Empty queue IO popped. + // Connection dropped. + // Treat as close event. + // + + if(ret == 0 || ioSize == 0) + { + NetIocpContextDestroy(ctx, 0); + + continue; + } + + // + // Read or write completed event. + // + + ioCtx = (PER_IO_CONTEXT *) ov; + + switch(ioCtx -> operation_) + { + // + // Read completed event. + // + + case NET_IOCP_READ: + { + // + // Call caller specified callback. + // + + if (ctx -> dataHandler_) + { + ctx -> dataHandler_(ctx, ctx -> socket_, + ioCtx -> wsabuf_.buf, ioSize); + } + + // + // Check is ctx marked as dead while processing caller handler. + // + + if (ctx -> dead_) + { + NetIocpContextDestroy(ctx, 0); + } + + // + // Post aother read request. + // + + else + { + if (ctx -> socket_ != INVALID_SOCKET) + { + flags = 0; + + ret = WSARecv(ctx -> socket_, &(ioCtx -> wsabuf_), 1, + &readed, &flags, &ioCtx -> ov_, NULL); + + if(ret == SOCKET_ERROR && (ERROR_IO_PENDING != WSAGetLastError())) + { + Error("WSARecv() failed: %d\n", WSAGetLastError()); + + NetIocpContextDestroy(ctx, 0); + } + } + } + + break; + } + + // + // Write completed event. + // + + case NET_IOCP_WRITE: + { + // + // A write operation has completed, determine if all the data + // intended to be sent actually was sent. + // + + ioCtx -> operation_ = NET_IOCP_WRITE; + ioCtx -> written_ += ioSize; + + flags = 0; + + // + // The previous write operation didn't send all the data, + // post another send to complete the operation. + // + + if(ioCtx -> written_ < ioCtx -> total_) + { + buffSend.buf = ioCtx -> buffer_ + ioCtx -> written_; + buffSend.len = ioCtx -> total_ - ioCtx -> written_; + + ret = WSASend(ctx -> socket_, &buffSend, 1, + &written, flags, &(ioCtx -> ov_), NULL); + + if(ret == SOCKET_ERROR && (ERROR_IO_PENDING != WSAGetLastError())) + { + Error("WSASend() failed: %d\n", WSAGetLastError()); + + NetIocpContextDestroy(ctx, 0); + } + } + + break; + } + } + } + + DBG_LEAVE("NetIocpWorkerLoop"); + + return 0; + } + #endif /* WIN32 */ + + // + // Create TCP server based on IO Completion Ports API. + // + // port - listening port (IN). + // openHandler - handler called when new connection arrived (IN/OPT). + // closeHandler - handler called when existing connection closed (IN/OPT). + // + // dataHandler - handler called when something to read on one of existing + // connection (IN). + // + // TIP #1: Use NetIocpWrite() to write data inside data handler. + // + // RETURNS: 0 if terminated correctly by NetIocpServerKill(), + // -1 if error. + // + + int NetIocpServerLoop(int port, NetIocpOpenProto openHandler, + NetIocpCloseProto closeHandler, + NetIocpDataProto dataHandler) + { + DBG_ENTER("NetIocpServerLoop"); + + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + HANDLE threads[NET_IOCP_MAX_THREADS] = {0}; + + HANDLE iocp = NULL; + + NetIocpContext *ctx = NULL; + + SOCKET listenSocket = INVALID_SOCKET; + SOCKET acceptSocket = INVALID_SOCKET; + + DWORD recvFlags = 0; + DWORD readed = 0; + + // + // Init Winsock if needed. + // + + FAIL(_NetInit()); + + // + // Init empty IO Completion Port context. + // + + iocp = CreateIoCompletionPort(INVALID_HANDLE_VALUE, + NULL, ULONG_PTR(iocp), 0); + + FAILEX(iocp == NULL, "ERROR: Cannot init IOCP context.\n"); + + // + // Create non-block listening socket. + // + + listenSocket = NetCreateListenSocket(port, NET_IOCP_MAXCONN); + + FAIL(listenSocket == INVALID_SOCKET); + + // + // Create 2 worker threads per every CPU core. + // + + for (int i = 0; i < NetGetCpuNumber() * 2; i++) + { + threads[i] = CreateThread(NULL, 0, + LPTHREAD_START_ROUTINE(NetIocpWorkerLoop), + iocp, 0, NULL); + + FAILEX(threads[i] == NULL, "ERROR: Cannot create worker thread.\n"); + } + + // + // Fall into main server loop. + // + + while(1) + { + // + // Accept new connection. + // + + acceptSocket = WSAAccept(listenSocket, NULL, NULL, NULL, 0); + + if (acceptSocket == INVALID_SOCKET) + { + Error("ERROR: Cannot accept connection on socket #%d.\n" + "Error code is : %d.\n", listenSocket, GetLastError()); + + continue; + } + + // + // Allocate new IOCP context for accepted connection. + // + + ctx = NetIocpContextCreate(acceptSocket); + + if(ctx == NULL) + { + Error("ERROR: Cannot allocate context for new client.\n"); + + continue; + } + + // + // Set user specified handlers. + // + + if (openHandler) + { + openHandler(ctx, acceptSocket); + } + + ctx -> openHandler_ = openHandler; + ctx -> closeHandler_ = closeHandler; + ctx -> dataHandler_ = dataHandler; + + // + // Add new socket to IO Completion Port queue. + // + + if (CreateIoCompletionPort((HANDLE) acceptSocket, iocp, + DWORD_PTR(ctx), 0) == NULL) + { + Error("ERROR: Cannot add client socket to IOCP queue.\n"); + + continue; + } + + // + // Post initial receive on this socket. + // + + if (WSARecv(acceptSocket, + &(ctx -> inpIoCtx_.wsabuf_), + 1, &readed, &recvFlags, + &(ctx -> inpIoCtx_.ov_), + NULL) == SOCKET_ERROR) + { + if (WSAGetLastError() != ERROR_IO_PENDING) + { + Error("WSARecv() Failed: %d\n", WSAGetLastError()); + + NetIocpContextDestroy(ctx, 0); + + continue; + } + } + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (iocp) + { + CloseHandle(iocp); + } + } + + // + // Linux, not implemented. + // + + #else + { + fprintf(stderr, "NetIocpServerLoop() not implemented on this OS.\n"); + } + #endif + + // + // Common error handler. + // + + if (exitCode) + { + Error("ERROR: Cannot set up IOCP blocking server loop.\n" + "Error code is : %d.\n", GetLastError()); + } + + DBG_LEAVE("NetIocpServerLoop"); + + return exitCode; + } + + // + // Allocate new IOCP context associated with given socket. + // + // sock - related socket, already connected to client (IN). + // + // WARNING! Returned struct MUST be freed by NetIocpContextFree() + // if not needed longer. + // + // RETURNS: Pointer to new allocated IOCP struct or + // NULL if error. + // + + NetIocpContext *NetIocpContextCreate(SOCKET sock) + { + DBG_ENTER("NetIocpContextCreate"); + + int exitCode = -1; + + NetIocpContext *ctx = NULL; + + // + // Windows. + // + + #ifdef WIN32 + + { + // + // Allocate new context. + // + + ctx = (NetIocpContext *) malloc(sizeof(NetIocpContext)); + + FAILEX(ctx == NULL, "ERROR: Cannot allocate new IOCP context.\n"); + + // + // Associate context with given socket. + // + + ctx -> dead_ = 0; + ctx -> socket_ = sock; + + // + // Allocate one input I/O context. + // We can have only one pending reading at one time. + // + + ctx -> inpIoCtx_.ov_.Internal = 0; + ctx -> inpIoCtx_.ov_.InternalHigh = 0; + ctx -> inpIoCtx_.ov_.Offset = 0; + ctx -> inpIoCtx_.ov_.OffsetHigh = 0; + ctx -> inpIoCtx_.ov_.hEvent = NULL; + ctx -> inpIoCtx_.operation_ = NET_IOCP_READ; + ctx -> inpIoCtx_.total_ = 0; + ctx -> inpIoCtx_.written_ = 0; + ctx -> inpIoCtx_.bufferSize_ = NET_IOCP_INIT_INPUT_BUFFER; + + // + // Allocate input buffer. + // + + ctx -> inpIoCtx_.buffer_ = (char *) malloc(NET_IOCP_INIT_INPUT_BUFFER); + + FAILEX(ctx -> inpIoCtx_.buffer_ == NULL, "ERROR: Out of memory.\n"); + + ctx -> inpIoCtx_.wsabuf_.buf = ctx -> inpIoCtx_.buffer_; + ctx -> inpIoCtx_.wsabuf_.len = ctx -> inpIoCtx_.bufferSize_; + + // + // Allocate one output I/O context. + // + + ctx -> outIoCtx_.ov_.Internal = 0; + ctx -> outIoCtx_.ov_.InternalHigh = 0; + ctx -> outIoCtx_.ov_.Offset = 0; + ctx -> outIoCtx_.ov_.OffsetHigh = 0; + ctx -> outIoCtx_.ov_.hEvent = NULL; + ctx -> outIoCtx_.operation_ = NET_IOCP_WRITE; + ctx -> outIoCtx_.total_ = 0; + ctx -> outIoCtx_.written_ = 0; + ctx -> outIoCtx_.bufferSize_ = NET_IOCP_INIT_OUTPUT_BUFFER; + + // + // Allocate output buffer. + // + + ctx -> outIoCtx_.buffer_ = (char *) malloc(NET_IOCP_INIT_OUTPUT_BUFFER); + + FAILEX(ctx -> outIoCtx_.buffer_ == NULL, "ERROR: Out of memory.\n"); + + ctx -> outIoCtx_.wsabuf_.buf = ctx -> outIoCtx_.buffer_; + ctx -> outIoCtx_.wsabuf_.len = ctx -> outIoCtx_.bufferSize_; + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create new IOCP context for socket #%d.\n", sock); + + if (ctx) + { + if (ctx -> inpIoCtx_.buffer_) + { + free(ctx -> inpIoCtx_.buffer_); + } + + if (ctx -> outIoCtx_.buffer_) + { + free(ctx -> outIoCtx_.buffer_); + } + + free(ctx); + } + } + } + + // + // Linux, MacOS. + // Not implemented. + // + + #else + { + Error("ERROR: NetIocpContextCreate() not implemented on this OS.\n"); + } + #endif + + DBG_LEAVE("NetIocpContextCreate"); + + return ctx; + } + + // + // Free IOCP context created by NetIocpContextCreate before. + // + // ctx - pointer to IOCP context returned by NetIocpContextCreate() (IN). + // graceful - 1 if we want to force graceful socket shutdown (IN). + // + // RETURN: none. + // + + void NetIocpContextDestroy(NetIocpContext *ctx, int graceful) + { + DBG_ENTER("NetIocpContextDestroy"); + + // + // Windows. + // + + #ifdef WIN32 + { + NetIocpContext *pBack = NULL; + NetIocpContext *pForward = NULL; + + PER_IO_CONTEXT * pNextIO = NULL; + PER_IO_CONTEXT * pTempIO = NULL; + + FAILEX(ctx == NULL, "ERROR: ctx cannot be NULL in NetIocpContextDestroy().\n"); + + if (ctx -> closeHandler_) + { + ctx -> closeHandler_(ctx, ctx -> socket_); + } + + // + // force the subsequent closesocket to be abortative. + // + + if(graceful == 0) + { + LINGER linger; + + linger.l_onoff = 1; + linger.l_linger = 0; + + setsockopt(ctx -> socket_, SOL_SOCKET, SO_LINGER, (char *) &linger, sizeof(linger)); + } + + // + // Close related socket. + // + + closesocket(ctx -> socket_); + + ctx -> socket_ = INVALID_SOCKET; + + // + // Wait until writing pending IO finished. + // + + while(HasOverlappedIoCompleted(LPOVERLAPPED(&(ctx -> outIoCtx_.ov_))) == FALSE) + { + Sleep(0); + } + + // + // Wait until reading pending IO finished. + // + + while(HasOverlappedIoCompleted(LPOVERLAPPED(&(ctx -> inpIoCtx_.ov_))) == FALSE) + { + Sleep(0); + } + + // + // Free asociated input and output buffers. + // + + if (ctx -> inpIoCtx_.buffer_) + { + free(ctx -> inpIoCtx_.buffer_); + } + + if (ctx -> outIoCtx_.buffer_) + { + free(ctx -> outIoCtx_.buffer_); + } + + // + // Free context. + // + + free(ctx); + + fail:; + } + + // + // Linux, MacOS. + // Not implemented. + // + + #else + { + Error("ERROR: NetIocpContextDestroy() not implemented on this OS.\n"); + } + #endif + + DBG_LEAVE("NetIocpContextDestroy"); + } + + // + // Write bytes to FD received inside IOCP data handler. + // + // TIP #1: Caller should use this function to write data + // to client inside data handler specified to NetIocpServerLoop(). + // + // ctx - IOCP context created in NetIocpServerLoop (IN). + // fd - related FD where to write data (IN). + // buf - buffer with data to write (IN). + // len - how many bytes to write (IN). + // + // RETURNS: Number of bytes written or + // -1 if error. + // + + int NetIocpWrite(NetIocpContext *ctx, int fd, void *buf, int len) + { + DBG_ENTER("NetIocpWrite"); + + int ret = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + DWORD written = 0; + + // + // Check args. + // + + FAILEX(ctx -> socket_ != fd, + "ERROR: FD#%d doesn't match IOCP context PTR#%p.\n", fd, ctx); + + FAILEX(ctx -> socket_ == INVALID_SOCKET, + "ERROR: Writing to closed IOCP FD#%d/%p.\n", fd, ctx); + + FAILEX(len > NET_IOCP_MAX_OUTPUT_BUFFER, + "ERROR: Packet %d bytes is too big for FD#%d.\n", len, fd); + + // + // Wait until pending write finished if another thread was + // written something to the same socket. + // + + while(HasOverlappedIoCompleted(LPOVERLAPPED(&(ctx -> outIoCtx_.ov_))) == FALSE) + { + Sleep(0); + } + + // + // Realloc output buffer if needed. + // + + if (len > ctx -> outIoCtx_.bufferSize_) + { + ctx -> outIoCtx_.bufferSize_ = len; + + free(ctx -> outIoCtx_.buffer_); + + ctx -> outIoCtx_.buffer_ = (char *) malloc(len); + + ctx -> outIoCtx_.wsabuf_.buf = ctx -> outIoCtx_.buffer_; + } + + // + // Put data into output buffer. + // + + ctx -> outIoCtx_.total_ = len; + ctx -> outIoCtx_.written_ = 0; + ctx -> outIoCtx_.wsabuf_.len = len; + + memcpy(ctx -> outIoCtx_.buffer_, buf, len); + + // + // Post write request. + // + + ret = WSASend(ctx -> socket_, &(ctx -> outIoCtx_.wsabuf_), 1, + &written, 0, &(ctx -> outIoCtx_.ov_), NULL); + + if (ret == SOCKET_ERROR && (ERROR_IO_PENDING != WSAGetLastError())) + { + ctx -> dead_ = 1; + + ret = -1; + } + else + { + ret = len; + } + } + + // + // Linux, MacOS. + // Not implemented. + // + + #else + { + Error("ERROR: NetIocpWrite() not implemented on this OS.\n"); + } + #endif + + // + // Error handler. + // + + fail: + + DBG_LEAVE("NetIocpWrite"); + + return ret; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/NetIOCPServer.h b/Source/Net/LibNet/NetIOCPServer.h new file mode 100644 index 0000000..481c715 --- /dev/null +++ b/Source/Net/LibNet/NetIOCPServer.h @@ -0,0 +1,151 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_IOCPServer_H +#define Tegenaria_Core_IOCPServer_H + +#ifdef WIN32 +# include +# include +# include +#endif + +#include +#include +#include + +namespace Tegenaria +{ + #define NET_IOCP_INIT_INPUT_BUFFER 1024 + #define NET_IOCP_INIT_OUTPUT_BUFFER 128 + + #define NET_IOCP_MAX_INPUT_BUFFER (1024 * 8) + #define NET_IOCP_MAX_OUTPUT_BUFFER (1024 * 32) + + #define NET_IOCP_ACCEPT 0 + #define NET_IOCP_READ 1 + #define NET_IOCP_WRITE 2 + + #define NET_IOCP_MAXCONN 200000 + #define NET_IOCP_MAX_THREADS 16 + + // + // Forward declaration. + // + + struct NetIocpContext; + + // + // Typedef. + // + + typedef void (*NetIocpOpenProto)(NetIocpContext *ctx, int fd); + typedef void (*NetIocpCloseProto)(NetIocpContext *ctx, int fd); + typedef void (*NetIocpDataProto)(NetIocpContext *ctx, int fd, void *buf, int len); + + #ifndef WIN32 + typedef int SOCKET; + #endif + + // + // Structs. + // + + #ifdef WIN32 + + typedef BOOL (PASCAL FAR * LPFN_ACCEPTEX)(SOCKET, SOCKET, PVOID, DWORD, DWORD, + DWORD, LPDWORD, LPOVERLAPPED); + + // + // Data to be associated for every I/O operation on a socket. + // + + struct PER_IO_CONTEXT + { + WSAOVERLAPPED ov_; + + char *buffer_; + + WSABUF wsabuf_; + + int total_; + int written_; + int operation_; + int bufferSize_; + + SOCKET acceptSocket_; + }; + + // + // Data to be associated with every socket added to the IOCP. + // + + struct NetIocpContext + { + void *custom_; + + SOCKET socket_; + + LPFN_ACCEPTEX fnAcceptEx; + + // + // linked list for all outstanding I/O on the socket. + // + + PER_IO_CONTEXT outIoCtx_; + PER_IO_CONTEXT inpIoCtx_; + + // + // Caller specified handlers to change general server template + // into real app doing real work. + // + + NetIocpOpenProto openHandler_; + NetIocpCloseProto closeHandler_; + NetIocpDataProto dataHandler_; + + int dead_; + }; + + #endif /* WIN32 */ + + // + // Exported functions. + // + + int NetIocpServerLoop(int port, NetIocpOpenProto openHandler, + NetIocpCloseProto closeHandler, + NetIocpDataProto dataHandler); + + void NetIocpContextDestroy(NetIocpContext * lpPerSocketContext, int bGraceful); + + NetIocpContext *NetIocpContextCreate(SOCKET sock); + + int NetCreateListenSocket(int port, int maxConnections, int nonBlock = 0); + + int NetIocpWrite(NetIocpContext *ctx, int fd, void *buf, int len); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_IOCPServer_H */ diff --git a/Source/Net/LibNet/NetInternal.h b/Source/Net/LibNet/NetInternal.h new file mode 100644 index 0000000..5d621cc --- /dev/null +++ b/Source/Net/LibNet/NetInternal.h @@ -0,0 +1,111 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Group internal structure, which should NOT +// be visible in public. This structures can be +// modified from version to version wthout risk. +// + +#ifndef Tegenaria_Core_NetInternal_H +#define Tegenaria_Core_NetInternal_H + + +#ifdef WIN32 + + // + // Windows. + // + + #include + #include + #include + + // + // Hide differences beetwen WinSock and BSD defines. + // + + #define SHUT_RDWR SD_BOTH + #define SHUT_RD SD_RECEIVE + #define SHUT_WR SD_SEND + + typedef int socklen_t; + +#else + + // + // Linux, MacOS includes. + // + + typedef int SOCKET; + + // + // Hide differences beetwen WinSock and BSD defines. + // + + #define SD_BOTH SHUT_RDWR + #define SD_RECEIVE SHUT_RD + #define SD_SEND SHUT_WR + #define closesocket(X) close(X) + + #include + #include + #include + #include + #include + +#endif + +namespace Tegenaria +{ + // + // Structs. + // + + struct NetRequestData + { + int fd_[2]; + + int *serverCode_; + + char *serverMsg_; + + int serverMsgSize_; + + void *data_; + + int dataSize_; + }; + + // + // Functions. + // + + int _NetRequestWorker(NetRequestData *req); + + int _NetInit(); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_NetInternal_H */ diff --git a/Source/Net/LibNet/NetStatistics.cpp b/Source/Net/LibNet/NetStatistics.cpp new file mode 100644 index 0000000..57f1785 --- /dev/null +++ b/Source/Net/LibNet/NetStatistics.cpp @@ -0,0 +1,612 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#pragma qcbuild_set_file_title("NetStatistics class") +#pragma qcbuild_set_private(1) + +#include +#include +#include +#include +#include "NetStatistics.h" + +namespace Tegenaria +{ + #ifdef WIN32 + #define snprintf _snprintf + #endif + + // + // Create new clear net statistics with no any fields set. + // + + NetStatistics::NetStatistics() + { + reset(); + } + + // + // Convert net statistics into human readable string. + // + + string NetStatistics::toString() + { + char buf[128]; + + int quality = this -> getNetworkQuality(); + + string ret = "Network statistics:\n"; + + snprintf(buf, sizeof(buf) - 1, " Connection time : %lf s.\n", (getTimeMs() - resetTime_) / 1000.0); + + ret += buf; + + if (fieldsSet_ & NET_STAT_FIELD_UPLOAD_SPEED) + { + snprintf(buf, sizeof(buf) - 1, " Upload speed : %lf KB/s.\n", uploadSpeedAvg_.getValue()); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_DOWNLOAD_SPEED) + { + snprintf(buf, sizeof(buf) - 1, " Download speed : %lf KB/s.\n", downloadSpeedAvg_.getValue()); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_BYTES_UPLOADED) + { + snprintf(buf, sizeof(buf) - 1, " Data uploaded : %lf MB.\n", bytesUploaded_ / 1024.0 / 1024.0); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_BYTES_DOWNLOADED) + { + snprintf(buf, sizeof(buf) - 1, " Data downloaded : %lf MB.\n", bytesDownloaded_ / 1024.0 / 1024.0); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_BYTES_SENT) + { + snprintf(buf, sizeof(buf) - 1, " Data sent : %lf MB.\n", bytesSent_ / 1024.0 / 1024.0); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_BYTES_RECV) + { + snprintf(buf, sizeof(buf) - 1, " Data received : %lf MB.\n", bytesRecv_ / 1024.0 / 1024.0); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_PACKET_SENT_COUNT) + { + snprintf(buf, sizeof(buf) - 1, " Packets sent : %d.\n", packetSentCount_); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_PACKET_RECV_COUNT) + { + snprintf(buf, sizeof(buf) - 1, " Packets received : %d.\n", packetRecvCount_); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_REQUEST_COUNT) + { + snprintf(buf, sizeof(buf) - 1, " Requests processed : %d.\n", requestCount_); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_REQUEST_SPEED) + { + snprintf(buf, sizeof(buf) - 1, " Request speed : %lf KB/s.\n", requestSpeedAvg_.getValue()); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_REQUEST_TIME_TOTAL) + { + snprintf(buf, sizeof(buf) - 1, " Total requests time : %lf s.\n", requestTimeTotal_ / 1000.0); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_REQUEST_TIME_TOTAL) + { + snprintf(buf, sizeof(buf) - 1, " Max. request time : %lf ms.\n", requestTimeMax_); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_REQUEST_TIME_AVG) + { + snprintf(buf, sizeof(buf) - 1, " Avg. request time : %lf ms.\n", requestTimeAvg_.getValue()); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_PARTIAL_READ_TRIGGERED) + { + snprintf(buf, sizeof(buf) - 1, " Partial read triggered : %d.\n", partialReadTriggered_); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_PARTIAL_WRITE_TRIGGERED) + { + snprintf(buf, sizeof(buf) - 1, " Partial write triggered : %d.\n", partialWriteTriggered_); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_PING_MAX) + { + snprintf(buf, sizeof(buf) - 1, " Max. ping : %lf ms.\n", pingMax_); + + ret += buf; + } + + if (fieldsSet_ & NET_STAT_FIELD_PING_AVG) + { + snprintf(buf, sizeof(buf) - 1, " Avg. ping : %lf ms.\n", pingAvg_.getValue()); + + ret += buf; + } + + if (quality != -1) + { + snprintf(buf, sizeof(buf) - 1, " Network quality : %d.\n", quality); + + ret += buf; + } + + return ret; + } + + // + // Add one outcoming packet containing bytes to statistics. + // + + void NetStatistics::insertOutcomingPacket(int size) + { + bytesSent_ += size; + + packetSentCount_ ++; + + fieldsSet_ |= NET_STAT_FIELD_BYTES_SENT; + fieldsSet_ |= NET_STAT_FIELD_PACKET_SENT_COUNT; + } + + // + // Add one incoming packet containing bytes to statistics. + // + + void NetStatistics::insertIncomingPacket(int size) + { + bytesRecv_ += size; + + packetRecvCount_ ++; + + fieldsSet_ |= NET_STAT_FIELD_BYTES_RECV; + fieldsSet_ |= NET_STAT_FIELD_PACKET_RECV_COUNT; + } + + // + // Insert one network request to statistics. + // + // size - total request size in bytes i.e. incoming + outcoming (IN). + // elapsed - time spent to process request in ms (IN). + // + + void NetStatistics::insertRequest(int size, double elapsed) + { + // + // Update maximum request time. + // + + if (elapsed > requestTimeMax_) + { + requestTimeMax_ = elapsed; + } + + // + // Update counter of all processed requests. + // + + requestCount_ ++; + + requestTimeTotal_ += elapsed; + + // + // Update average request speed and time. + // + + requestSpeedAvg_.insert((size / 1024.0) / (elapsed / 1000.0 + 0.1)); + + requestTimeAvg_.insert(elapsed); + + // + // Interpretate small request as ping info. + // + + if (size < 128) + { + insertPing(elapsed); + } + + // + // Set that request related fields changed. + // + + fieldsSet_ |= NET_STAT_FIELD_REQUEST_SPEED; + fieldsSet_ |= NET_STAT_FIELD_REQUEST_COUNT; + fieldsSet_ |= NET_STAT_FIELD_REQUEST_TIME_TOTAL; + fieldsSet_ |= NET_STAT_FIELD_REQUEST_TIME_MAX; + fieldsSet_ |= NET_STAT_FIELD_REQUEST_TIME_AVG; + } + + // + // Mark that partial read occured. + // + + void NetStatistics::triggerPartialRead() + { + partialReadTriggered_ = 1; + + fieldsSet_ |= NET_STAT_FIELD_PARTIAL_READ_TRIGGERED; + } + + // + // Mark that partial write occured. + // + + void NetStatistics::triggerPartialWrite() + { + partialWriteTriggered_ = 1; + + fieldsSet_ |= NET_STAT_FIELD_PARTIAL_WRITE_TRIGGERED; + } + + // + // Notify that we uploaded bytes in time. + // + // size - number of bytes uploaded (IN). + // elapsed - upload time in ms (IN). + // + + void NetStatistics::insertUploadEvent(int size, double elapsed) + { + bytesUploaded_ += size; + + uploadSpeedAvg_.insert((size / 1024.0) / (elapsed / 1000.0 + 0.1)); + + fieldsSet_ |= NET_STAT_FIELD_BYTES_UPLOADED; + fieldsSet_ |= NET_STAT_FIELD_UPLOAD_SPEED; + } + + // + // Notify that we downloaded bytes in time. + // + // size - number of bytes downloaded (IN). + // elapsed - upload time in ms (IN). + // + + void NetStatistics::insertDownloadEvent(int size, double elapsed) + { + bytesDownloaded_ += size; + + downloadSpeedAvg_.insert((size / 1024.0) / (elapsed / 1000.0 + 0.1)); + + fieldsSet_ |= NET_STAT_FIELD_BYTES_DOWNLOADED; + fieldsSet_ |= NET_STAT_FIELD_DOWNLOAD_SPEED; + } + + // + // Insert current ping value. + // + // ping - noted ping value in ms (IN). + // + + void NetStatistics::insertPing(double ping) + { + if (ping > pingMax_) + { + pingMax_ = ping; + } + + pingAvg_.insert(ping); + + fieldsSet_ |= NET_STAT_FIELD_PING_MAX; + fieldsSet_ |= NET_STAT_FIELD_PING_AVG; + } + + + // + // Clear all fields. + // + + void NetStatistics::reset() + { + resetTime_ = getTimeMs(); + + uploadSpeedAvg_.clear(); + downloadSpeedAvg_.clear(); + requestTimeAvg_.clear(); + requestSpeedAvg_.clear(); + pingAvg_.clear(); + + packetSentCount_ = 0; + packetRecvCount_ = 0; + requestCount_ = 0; + + bytesSent_ = 0.0; + bytesRecv_ = 0.0; + + bytesDownloaded_ = 0.0; + bytesUploaded_ = 0.0; + + requestTimeTotal_ = 0.0; + requestTimeMax_ = 0.0; + + partialReadTriggered_ = 0; + partialWriteTriggered_ = 0; + + pingMax_ = 0.0; + + fieldsSet_ = 0; + } + + // + // ---------------------------------------------------------------------------- + // + // Getters + // + // ---------------------------------------------------------------------------- + // + + double NetStatistics::getTimeMs() + { + struct timeval tv; + + gettimeofday(&tv, NULL); + + return tv.tv_sec * 1000.0 + tv.tv_usec / 1000.0; + } + + double NetStatistics::getUploadSpeed() + { + return uploadSpeedAvg_.getValue(); + } + + double NetStatistics::getDownloadSpeed() + { + return downloadSpeedAvg_.getValue(); + } + + double NetStatistics::getRequestTime() + { + return requestTimeAvg_.getValue(); + } + + double NetStatistics::getRequestSpeed() + { + return requestSpeedAvg_.getValue(); + } + + double NetStatistics::getPing() + { + return pingAvg_.getValue(); + } + + double NetStatistics::getPingMax() + { + return pingMax_; + } + + // + // Get connection time in seconds. + // + + double NetStatistics::getConnectionTime() + { + return (resetTime_ - getTimeMs()) / 1000.0; + } + + int NetStatistics::getPacketSentCount() + { + return packetSentCount_; + } + + int NetStatistics::getPacketRecvCount() + { + return packetSentCount_; + } + + int NetStatistics::getRequestCount() + { + return packetSentCount_; + } + + double NetStatistics::getBytesUploaded() + { + return bytesUploaded_; + } + + double NetStatistics::getBytesDownloaded() + { + return bytesUploaded_; + } + + double NetStatistics::getBytesSent() + { + return bytesSent_; + } + + double NetStatistics::getBytesReceived() + { + return bytesRecv_; + } + + // + // Get total time spent in processing requests in seconds. + // + + double NetStatistics::getRequestTimeTotal() + { + return requestTimeTotal_ / 1000.0; + } + + // + // Get maximum time spent to process one request. + // + + double NetStatistics::getRequestTimeMax() + { + return requestTimeMax_; + } + + int NetStatistics::isPartialReadTriggered() + { + return partialReadTriggered_; + } + + int NetStatistics::isPartialWriteTriggered() + { + return partialWriteTriggered_; + } + + // + // Limit input value to fit <0;1> range. + // Used internally only. + // + + double NetStatistics::limit(double x) + { + if (x < 0.0) return 0.0; + if (x > 1.0) return 1.0; + + return x; + } + + // + // Compute network quality in 1-5 scale. + // + // RETURNS: Network quality in <1;5> range, + // or -1 if too less data to estimate network quality. + // + + int NetStatistics::getNetworkQuality() + { + double wsum = 0.0; + + double sum = 0.0; + + // + // Estimate average request time quality. + // + + if (fieldsSet_ & NET_STAT_FIELD_REQUEST_TIME_AVG) + { + sum += (1.0 - limit(getRequestTime() / 500.0)) * 1.0; + + wsum += 1.0; + } + + // + // Estimate download quality. + // + + if (fieldsSet_ & NET_STAT_FIELD_DOWNLOAD_SPEED) + { + sum += (1.0 - limit(getDownloadSpeed() / 10000.0)) * 0.5; + + wsum += 0.5; + } + + // + // Estimate upload quality. + // + + if (fieldsSet_ & NET_STAT_FIELD_UPLOAD_SPEED) + { + sum += (1.0 - limit(getUploadSpeed() / 10000.0)) * 0.5; + + wsum += 0.5; + } + + // requestTimeMax + // Estimate -------------- ratio quality. + // requestTimeAvg + // + + if (fieldsSet_ & NET_STAT_FIELD_REQUEST_TIME_MAX + && fieldsSet_ & NET_STAT_FIELD_REQUEST_TIME_AVG + && getRequestTime() > 100.0) + { + sum += (1.0 - limit((getRequestTimeMax() / getRequestTime()) / 4.0)) * 0.5; + + wsum += 0.5; + } + + // + // Estimate ping quality. + // + + if (fieldsSet_ & NET_STAT_FIELD_PING_AVG) + { + sum += (1.0 - limit(getPing() / 200)) * 1.0; + + wsum += 1.0; + } + + // + // Decrease quality if partial read/write occures. + // + + if (isPartialReadTriggered() || isPartialWriteTriggered()) + { + wsum += 2.0; + } + + // + // Compute total quality from partials. + // + + if (wsum > 0.0) + { + return round((sum / wsum) * 5.0); + } + else + { + return -1; + } + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/NetStatistics.h b/Source/Net/LibNet/NetStatistics.h new file mode 100644 index 0000000..18b8658 --- /dev/null +++ b/Source/Net/LibNet/NetStatistics.h @@ -0,0 +1,168 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_NetStatistics_H +#define Tegenaria_Core_NetStatistics_H + +#include +#include + +namespace Tegenaria +{ + using std::string; + + // + // Field set in NetStatistics.fieldsSet_ meaning which struct + // fields are set. + // + + #define NET_STAT_FIELD_UPLOAD_SPEED (1 << 0) + #define NET_STAT_FIELD_DOWNLOAD_SPEED (1 << 1) + #define NET_STAT_FIELD_REQUEST_SPEED (1 << 2) + + #define NET_STAT_FIELD_BYTES_SENT (1 << 3) + #define NET_STAT_FIELD_BYTES_RECV (1 << 4) + + #define NET_STAT_FIELD_BYTES_UPLOADED (1 << 5) + #define NET_STAT_FIELD_BYTES_DOWNLOADED (1 << 6) + + #define NET_STAT_FIELD_PACKET_SENT_COUNT (1 << 7) + #define NET_STAT_FIELD_PACKET_RECV_COUNT (1 << 8) + + #define NET_STAT_FIELD_REQUEST_COUNT (1 << 9) + #define NET_STAT_FIELD_REQUEST_TIME_TOTAL (1 << 10) + #define NET_STAT_FIELD_REQUEST_TIME_MAX (1 << 11) + #define NET_STAT_FIELD_REQUEST_TIME_AVG (1 << 12) + + #define NET_STAT_FIELD_PARTIAL_READ_TRIGGERED (1 << 13) + #define NET_STAT_FIELD_PARTIAL_WRITE_TRIGGERED (1 << 14) + + #define NET_STAT_FIELD_PING_MAX (1 << 15) + #define NET_STAT_FIELD_PING_AVG (1 << 16) + + // + // Structure to store network statistics. + // + + class NetStatistics + { + private: + + // + // Fields. + // + + MathWeightAvg uploadSpeedAvg_; // Average upload speed in KB/s + MathWeightAvg downloadSpeedAvg_; // Average download speed in KB/s + MathWeightAvg requestTimeAvg_; // Average request speed in KB/s + MathWeightAvg requestSpeedAvg_; // Average request time in ms + MathWeightAvg pingAvg_; // Average ping in ms + + double resetTime_; // Last reset time to compute connection time + + int packetSentCount_; // Number of all packets sent + int packetRecvCount_; // Number of all packets received + int requestCount_; // Number of all requests processed. + + double bytesUploaded_; // Number of bytes uploaded + double bytesDownloaded_; // Number of bytes downloaded + + double bytesSent_; // Total number of bytes sent + double bytesRecv_; // Total number of bytes received + + double requestTimeTotal_; // Total ms spent in processing one request in ms + double requestTimeMax_; // Max. time spent in processing one request in ms + + int partialReadTriggered_; // Read operation was cancelled due to timeout + int partialWriteTriggered_; // Write operation was cancelled due to timeout + + double pingMax_; // Max. noted ping + + unsigned int fieldsSet_; // Combination of NET_STAT_FIELD_XXX values + // telling which struct fields are set. + // + // Functions. + // + + public: + + NetStatistics(); + + string toString(); + + void reset(); + + double limit(double x); + + // + // Put data into statistics. + // + + void insertOutcomingPacket(int size); + void insertIncomingPacket(int size); + + void insertUploadEvent(int size, double elapsed); + void insertDownloadEvent(int size, double elapsed); + + void insertRequest(int size, double elapsed); + + void insertPing(double ping); + + void triggerPartialRead(); + void triggerPartialWrite(); + + // + // Getters. + // + + double getTimeMs(); + + double getUploadSpeed(); + double getDownloadSpeed(); + double getRequestTime(); + double getRequestSpeed(); + double getPing(); + double getPingMax(); + double getConnectionTime(); + + int getPacketSentCount(); + int getPacketRecvCount(); + int getRequestCount(); + + double getBytesUploaded(); + double getBytesDownloaded(); + double getBytesSent(); + double getBytesReceived(); + double getRequestTimeTotal(); + double getRequestTimeMax(); + + int isPartialReadTriggered(); + int isPartialWriteTriggered(); + + int getNetworkQuality(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_NetStatistics_H */ diff --git a/Source/Net/LibNet/NetTcpConnection.cpp b/Source/Net/LibNet/NetTcpConnection.cpp new file mode 100644 index 0000000..3f3ab5c --- /dev/null +++ b/Source/Net/LibNet/NetTcpConnection.cpp @@ -0,0 +1,581 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#pragma qcbuild_set_file_title("NetTcpConnection class") +#pragma qcbuild_set_private(1) + +#include "NetTcpConnection.h" + +namespace Tegenaria +{ + // + // Constructor. + // + // ctx - caller specified context (IN/OPT). + // socket - asociatet socket number (IN. + // handler - callback to handle incoming connections (IN). + // addr - associated remote IP address (IN). + // thread - handle to related worker thread (IN). + // + + NetTcpConnection::NetTcpConnection(const void *ctx, int socket, + NetHandleConnProto handler, + struct sockaddr_in addr, + ThreadHandle_t *thread) + + : NetConnection(ctx, "TCP/IP4", socket, handler) + { + char tmp[64] = {0}; + + DBG_SET_ADD("NetTcpConnection", this); + + addr_ = addr; + + snprintf(tmp, sizeof(tmp), "%s:%d", + inet_ntoa(addr.sin_addr), htons(addr.sin_port)); + + clientInfo_ = tmp; + + thread_ = thread; + + #ifdef WIN32 + { + ZeroMemory(&ov_, sizeof(ov_)); + + ov_.hEvent = CreateEvent(NULL, FALSE, FALSE, NULL); + + cancelEvent_ = CreateEvent(NULL, FALSE, FALSE, NULL); + } + #else + { + cancelPipe_[0] = -1; + cancelPipe_[1] = -1; + + if (pipe(cancelPipe_) < 0) + { + Error("ERROR: Cannot create cancel pipe for" + " TCP/IP4 connection on '%s'.\n", clientInfo_.c_str()); + } + } + #endif + + DBG_MSG("Created TCP/IP4 connection on '%s'.\n", clientInfo_.c_str()); + } + + // + // Desctructor. + // - shutdownc onnetcion. + // - wait until associated thread finished work. + // + + NetTcpConnection::~NetTcpConnection() + { + DBG_ENTER("NetTcpConnection::~NetTcpConnection"); + + shutdown(SD_SEND); + + // + // Join connection thread if any. + // + + if (thread_) + { + DBG_MSG3("NetTcpConnection::shutdown : Joining thread for connection PTR 0x%x...\n", this); + + ThreadWait(thread_); + ThreadClose(thread_); + + thread_ = NULL; + } + + #ifdef WIN32 + { + CloseHandle(ov_.hEvent); + CloseHandle(cancelEvent_); + } + #else + { + if (cancelPipe_[0] != -1) + { + close(cancelPipe_[0]); + } + + if (cancelPipe_[1] != -1) + { + close(cancelPipe_[1]); + } + } + #endif + + DBG_SET_DEL("NetTcpConnection", this); + + DBG_LEAVE("NetTcpConnection::~NetTcpConnection"); + } + + // + // Get back IP address set in constructor time before. + // + + const struct sockaddr_in NetTcpConnection::getAddr() + { + return addr_; + } + + // + // Send bytes stored in . + // + // buf - source buffer where data to write stored (IN). + // count - number of bytes to send (IN). + // timeout - timeout in miliseconds (IN). + // + // RETURNS: Number of bytes written or + // -1 if error. + // + + int NetTcpConnection::write(const void *buf, int count, int timeout) + { + int written = 0; + int goOn = 1; + int totalWritten = 0; + + DEBUG3("NetTcpConnection::write : Writing [%d]" + " bytes inside PTR=[%p] CTX=[%p]...\n", count, this, ctx_); + + if (int(socket_) != -1) + { + DBG_IO_WRITE_BEGIN("socket", socket_, buf, count); + + while(goOn) + { + // + // Try write another piece. + // + + written = send(socket_, ((const char *) buf) + totalWritten, + count - totalWritten, 0); + + // + // Piece written. + // + + if (written > 0) + { + totalWritten += written; + + if (totalWritten == count) + { + goOn = 0; + } + } + + // + // Piece not written, but would block error found. + // Wait until socket available for write. + // + + #ifdef WIN32 + else if (GetLastError() == WSAEWOULDBLOCK) + #else + else if (errno == EWOULDBLOCK) + #endif + { + fd_set fdset; + + struct timeval tv; + + int ret = -1; + + tv.tv_sec = timeout / 1000; + tv.tv_usec = timeout % 1000 * 1000; + + FD_ZERO(&fdset); + + FD_SET(socket_, &fdset); + + if (timeout > 0) + { + ret = select(socket_ + 1, NULL, &fdset, NULL, &tv); + } + else + { + ret = select(socket_ + 1, NULL, &fdset, NULL, NULL); + } + + if (ret <= 0) + { + Error("ERROR: Timeout while writing to TCP connection PTR#%p.\n", this); + + totalWritten = -1; + + goOn = 0; + } + } + + // + // Unexpected error. Fail with -1. + // + + else + { + totalWritten = -1; + + goOn = 0; + } + } + + DBG_IO_WRITE_END("socket", socket_, buf, written); + } + + return totalWritten; + } + + // + // Read up bytes and save it to buf[]. + // + // buf - destination buffer, where to put readed data (OUT). + // count - number of bytes to read (IN). + // timeout - timeout in miliseconds, defaulted to infinite if skipped (IN/OPT). + // + // RETURNS: Number of bytes readed or + // -1 if error. + // + + int NetTcpConnection::read(void *buf, int count, int timeout) + { + int readed = -1; + + DBG_MSG5("NetTcpConnection::read : Reading [%d] bytes" + " inside PTR=[%p] CTX=[%p]...\n", count, this, ctx_); + + if (int(socket_) != -1) + { + DBG_IO_READ_BEGIN("socket", socket_, buf, count); + { + #ifdef WIN32 + { + DWORD to = timeout; + + HANDLE events[2] = + { + ov_.hEvent, + cancelEvent_ + }; + + ReadFile(HANDLE(socket_), buf, count, NULL, &ov_); + + if (timeout == -1) + { + to = INFINITE; + } + + switch(WaitForMultipleObjects(2, events, FALSE, to)) + { + case WAIT_OBJECT_0 + 0: + { + GetOverlappedResult(HANDLE(socket_), &ov_, (PDWORD) &readed, FALSE); + + break; + } + + case WAIT_OBJECT_0 + 1: + { + DBG_MSG("NetTcpConnection : Read canceled on SOCKET#%d.\n", socket_); + + readed = 0; + + break; + } + } + } + #else + { + struct timeval tv; + + tv.tv_sec = timeout / 1000; + tv.tv_usec = timeout * 1000; + + fd_set rfd; + + int fdmax = std::max(socket_, cancelPipe_[0]); + + FD_ZERO(&rfd); + + FD_SET(socket_, &rfd); + FD_SET(cancelPipe_[0], &rfd); + + if (timeout == -1) + { + select(fdmax + 1, &rfd, NULL, NULL, NULL); + } + else + { + select(fdmax + 1, &rfd, NULL, NULL, &tv); + } + + if (FD_ISSET(cancelPipe_[0], &rfd)) + { + DBG_INFO("NetTcpConnection : Read canceled on socket #%d.\n", socket_); + + readed = 0; + } + else if (FD_ISSET(socket_, &rfd)) + { + readed = recv(socket_, (char *) buf, count, 0); + } + } + #endif + } + DBG_IO_READ_END("socket", socket_, buf, readed); + } + + return readed; + } + + // + // Shutdown connection. + // + // how - SD_RECV to close reading, SD_SEND to close sending, SD_BOTH to close + // for reading and writing (IN). + // + // RETURNS: 0 if OK. + // + + int NetTcpConnection::shutdown(int how) + { + DBG_ENTER("NetTcpConnection::shutdown"); + + int ret = -1; + + int state = state_; + + if (state != NET_STATE_DEAD) + { + setState(NET_STATE_DEAD); + + cancel(); + + if (int(socket_) != -1) + { + DBG_MSG3("NetTcpConnection : shutting down SOCKET #%d with method [%d].\n", socket_, how); + + DBG_IO_CLOSE_BEGIN("socket", socket_); + { + ret = ::shutdown(socket_, how); + + if (how == SD_SEND) + { + fd_set rfd; + + struct timeval tv; + + FD_ZERO(&rfd); + + FD_SET(socket_, &rfd); + + tv.tv_sec = 0; + tv.tv_usec = 100000; + + if (select(socket_ + 1, &rfd, NULL, NULL, &tv) > 0 + && FD_ISSET(socket_, &rfd)) + { + char buf[64]; + + recv(socket_, buf, sizeof(buf), 0); + } + } + + closesocket(socket_); + } + DBG_IO_CLOSE_END("socket", socket_); + + DBG_SET_DEL("socket", socket_); + + socket_ = -1; + } + } + + DBG_LEAVE("NetTcpConnection::shutdown"); + + return ret; + } + + // + // Disable/enable nagle algorithm. + // + // value - 1 to disable algo, 0 to enable back (IN). + // + + void NetTcpConnection::setNoDelay(int value) + { + DEBUG1("NetTcpConnection::setNoDelay : set nodelay for" + " SOCKET #%d connection PTR [%p] to value [%d]", + socket_, this, value); + + setsockopt(socket_, IPPROTO_TCP, TCP_NODELAY, (char *) &value, sizeof(value)); + } + + // + // Enable SO_KEEPALIVE flag, it keeps connections active by + // enabling the periodic transmission of messages. + // + // interval - -1 to disable SO_KEEPALIVE, above 0 will set time + // in seconds between individual keepalive probes. + // + + void NetTcpConnection::setKeepAlive(int interval) + { + DEBUG1("NetTcpConnection::setKeepAlive : set KeepAlive for " + "SOCKET #%d connection PTR [%p] to value [%d]", + socket_, this, interval); + + int value; + + // + // Disable keepalive. + // + + if (interval == -1) + { + value = 0; + + setsockopt(socket_, SOL_SOCKET, SO_KEEPALIVE, (char *)&value, sizeof(value)); + } + + // + // Enable keepalive. + // + + else if (interval > 0) + { + // + // Windows. + // + + #ifdef WIN32 + { + struct tcp_keepalive alive; + + DWORD dwBytesRet = 0; + + alive.onoff = TRUE; + alive.keepalivetime = interval * 1000; + alive.keepaliveinterval = interval * 1000; + + WSAIoctl(socket_, SIO_KEEPALIVE_VALS, &alive, sizeof(alive), NULL, 0, &dwBytesRet, NULL, NULL); + } + + // + // Linux, MacOS. + // + + #else + { + value = 1; + setsockopt(socket_, SOL_SOCKET, SO_KEEPALIVE, (char *)&value, sizeof(value)); + + value = 2; + setsockopt (socket_, SOL_TCP, TCP_KEEPCNT, (char *)&value, sizeof(value)); + + value = interval; + setsockopt (socket_, SOL_TCP, TCP_KEEPIDLE, (char *)&value, sizeof(value)); + + value = interval; + setsockopt (socket_, SOL_TCP, TCP_KEEPINTVL, (char *)&value, sizeof(value)); + } + #endif + } + } + + // + // Cancel pending I/O operations asociated with connection if any. + // + + void NetTcpConnection::cancel() + { + DBG_IO_CANCEL("socket", socket_); + + DEBUG3("Sending cancel event for SOCKET#%d.\n", socket_); + + #ifdef WIN32 + { + SetEvent(cancelEvent_); + } + #else + { + if (::write(cancelPipe_[1], "x", 1) <= 0) + { + Error("NetTcpConnection::cancel: ERROR: Cannot cancel pending I/O.\n"); + } + } + #endif + } + + // + // Disable inherit to child process (exec). + // + // RETURNS: 0 if OK. + // + + int NetTcpConnection::disableInherit() + { + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + FAIL(SetHandleInformation(HANDLE(socket_), + HANDLE_FLAG_INHERIT, 0) == FALSE); + } + + // + // Linux. + // + + #else + { + FAIL(fcntl(socket_, F_SETFD, FD_CLOEXEC) != 0); + } + #endif + + DEBUG1("Disabled inherit for socket #%d.\n", socket_); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot disable inherit for socket #%d.\n", socket_); + } + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/NetTcpConnection.h b/Source/Net/LibNet/NetTcpConnection.h new file mode 100644 index 0000000..cd8c87a --- /dev/null +++ b/Source/Net/LibNet/NetTcpConnection.h @@ -0,0 +1,100 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_NetTcpConnection_H +#define Tegenaria_Core_NetTcpConnection_H + +#include "NetConnection.h" + +// +// Windows. +// + +#ifdef WIN32 +# include + +# ifndef SIO_KEEPALIVE_VALS +# define SIO_KEEPALIVE_VALS 0x98000004 +# endif + +struct tcp_keepalive +{ + u_long onoff; + u_long keepalivetime; + u_long keepaliveinterval; +}; + +// +// Linux. +// + +#else +# include +#endif + +namespace Tegenaria +{ + // + // Class to wrap TCP/IP socket. + // + + class NetTcpConnection : public NetConnection + { + private: + + struct sockaddr_in addr_; + + #ifdef WIN32 + HANDLE cancelEvent_; + OVERLAPPED ov_; + #else + int cancelPipe_[2]; + #endif + + virtual ~NetTcpConnection(); + + public: + + NetTcpConnection(const void *ctx, int socket, + NetHandleConnProto handler, + struct sockaddr_in addr, + ThreadHandle_t *thread = NULL); + + const struct sockaddr_in getAddr(); + + virtual int write(const void *buf, int count, int timeout = -1); + virtual int read(void *buf, int count, int timeout = -1); + virtual void cancel(); + + virtual int shutdown(int how = SD_BOTH); + + virtual void setNoDelay(int value); + virtual void setKeepAlive(int interval); + + virtual int disableInherit(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_NetTcpConnection */ diff --git a/Source/Net/LibNet/SMTP.cpp b/Source/Net/LibNet/SMTP.cpp new file mode 100644 index 0000000..435da95 --- /dev/null +++ b/Source/Net/LibNet/SMTP.cpp @@ -0,0 +1,384 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Client to send mail via SMTP server. +// + +#pragma qcbuild_set_file_title("SMTP client (email)") + +#include "Net.h" +#include "NetInternal.h" + +namespace Tegenaria +{ + #define SMTP_EHLO "EHLO Dirligo\r\n" + #define SMTP_AUTH_LOGIN "AUTH LOGIN\r\n" + #define SMTP_DATA "DATA\r\n" + #define SMTP_END "\r\n.\r\n" + #define SMTP_RSET "RSET\r\n" + #define SMTP_QUIT "QUIT\r\n" + + #define SMTP_HEAD_FMT "From: %s <%s>\r\n" \ + "To: <%s>\r\n" \ + "Subject: %s\r\n" \ + "Content-Type: text/plain\r\n" \ + "Mime-Version: 1.0\r\n" \ + "X-Mailer: Dirligo\r\n" \ + "Content-Transfer-Encoding: 7bit\r\n\r\n" + + #define SMTP_BASE64_USER "334 VXNlcm5hbWU6" + #define SMTP_BASE64_PASS "334 UGFzc3dvcmQ6" + + // + // Read SMTP server response in 'XXX message' format. + // + // smtpCode - SMTP response code (OUT). + // msg - buffer, where to put server message (OUT). + // msgSize - size of msg[] buffer in bytes (IN). + // nc - pointer NetConnection object connected to SMTP server (IN). + // + // RETURNS: 0 if OK. + // + + int NetSmtpReadServerAnswer(int *smtpCode, char *msg, + int msgSize, NetConnection *nc) + { + DBG_ENTER3("NetSmtpReadServerAnswer"); + + int exitCode = -1; + + int smtpCodeGroup = 0; + + msg[0] = 0; + + // + // Read message. + // + + int readed = nc -> read(msg, msgSize); + + FAIL(readed <= 0); + + msg[readed - 1] = 0; + + // + // Decode SMTP code. + // + + *smtpCode = atoi(msg); + + DEBUG2("Received SMTP message [%s].\n", msg); + + // + // Get first digit from 3-digits SMTP code. + // 2xx and 3xx means success. + // 4xx and 5xx means error. + // + + smtpCodeGroup = (*smtpCode) / 100; + + FAIL(smtpCodeGroup != 2 && smtpCodeGroup != 3); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot read answer from SMTP server or server fail.\n" + "SMTP message is : '%s'.\n", msg); + } + + DBG_LEAVE3("NetSmtpReadServerAnswer"); + + return exitCode; + } + + // + // Send email using existing SMTP server. + // + // smtpHost - hostname of smtp server to use e.g. "smtp.wp.pl" (IN). + // smtpPort - port, where smtp server listening. Default is 25. (IN). + // from - from field in email e.g. login@wp.pl (IN). + // subject - subject field in email (IN). + // receivers - list of destination email addresses (IN). + // message - message field in email (IN). + // login - login to authenticate on smtp server (IN). + // password - password to authenticate on smtp server (IN). + // + // RETURNS: 0 if OK, + // -1 otherwise. + // + + int NetSmtpSendMail(const char *smtpHost, int smtpPort, const char *from, + const char *fromFull, const char *subject, + vector receivers, const char *message, + const char *login, const char *password) + { + DBG_ENTER2("NetSmtpSendMail"); + + int exitCode = -1; + + NetConnection *nc = NULL; + + string body; + string hash; + + char buf[512]; + + int smtpCode = -1; + int written = -1; + int readed = -1; + int len = -1; + + // + // Check args. + // + + FAILEX(smtpHost == NULL, "ERROR: 'smtpHost' cannot be NULL in NetSmtpSendMail()"); + FAILEX(from == NULL, "ERROR: 'from' cannot be NULL in NetSmtpSendMail()"); + FAILEX(fromFull == NULL, "ERROR: 'fromFull' cannot be NULL in NetSmtpSendMail()"); + FAILEX(subject == NULL, "ERROR: 'subject' cannot be NULL in NetSmtpSendMail()"); + FAILEX(message == NULL, "ERROR: 'message' cannot be NULL in NetSmtpSendMail()"); + FAILEX(login == NULL, "ERROR: 'login' cannot be NULL in NetSmtpSendMail()"); + FAILEX(password == NULL, "ERROR: 'password' cannot be NULL in NetSmtpSendMail()"); + FAILEX(receivers.empty(), "ERROR: 'receivers' vector cannot be empty in NetSmtpSendMail()"); + + // + // Connect to SMTP server. + // + + nc = NetConnect(smtpHost, smtpPort); + + FAIL(nc == NULL); + + // + // Get server hello. + // + + FAIL(NetSmtpReadServerAnswer(&smtpCode, buf, sizeof(buf), nc)); + + // + // Send client hello message. + // + + written = nc -> write(SMTP_EHLO, sizeof(SMTP_EHLO) - 1); + + DEBUG2("NetSmtpSendMail: Sent [%s].\n", SMTP_EHLO); + + FAIL(written < 0); + + // + // Server should reply with list of known auth methods. + // + + FAIL(NetSmtpReadServerAnswer(&smtpCode, buf, sizeof(buf), nc)); + + // + // Authenticate. + // Client: AUTH LOGIN + // Server: VXNlcm5hbWU6 <- ask for base64(username) + // Client: base64(login) + // Server: UGFzc3dvcmQ6 <- ask for base64(pass) + // Client: base64(pass) + // + + written = nc -> write(SMTP_AUTH_LOGIN, sizeof(SMTP_AUTH_LOGIN) - 1); + + DEBUG2("NetSmtpSendMail: Sent AUTH LOGIN.\n"); + + for (int i = 0; i < 2; i++) + { + FAIL(NetSmtpReadServerAnswer(&smtpCode, buf, sizeof(buf), nc)); + + // + // Username request. + // + + if (strncmp(buf, SMTP_BASE64_USER, sizeof(SMTP_BASE64_USER) - 1) == 0) + { + hash = NetBase64(login, strlen(login)); + + len = snprintf(buf, sizeof(buf), "%s\r\n", hash.c_str()); + + nc -> write(buf, len); + + DEBUG2("NetSmtpSendMail: Sent username.\n"); + } + + // + // Password request. + // + + else if (strncmp(buf, SMTP_BASE64_PASS, sizeof(SMTP_BASE64_PASS) - 1) == 0) + { + hash = NetBase64(password, strlen(password)); + + len = snprintf(buf, sizeof(buf), "%s\r\n", hash.c_str()); + + nc -> write(buf, len); + + DEBUG2("NetSmtpSendMail: Sent password.\n"); + } + + // + // Unexpected message request. + // + + else + { + Error("Unexpected SMTP message in AUTH LOGIN protocol [%s]\n", buf); + + goto fail; + } + } + + FAIL(NetSmtpReadServerAnswer(&smtpCode, buf, sizeof(buf), nc)); + + // + // Send 'MAIL FROM: '. + // + + len = snprintf(buf, sizeof(buf) - 1, "MAIL FROM: <%s>\r\n", from); + + written = nc -> write(buf, len); + + FAIL(written <= 0); + + DEBUG2("NetSmtpSendMail: Sent [%s]\n", buf); + + FAIL(NetSmtpReadServerAnswer(&smtpCode, buf, sizeof(buf), nc)); + + // + // Send 'RCPT TO:
\r\n' for each receiver address. + // + + for (int i = 0; i < receivers.size(); i++) + { + len = snprintf(buf, sizeof(buf) - 1, "RCPT TO: <%s>\r\n", receivers[i].c_str()); + + written = nc -> write(buf, len); + + FAIL(written <= 0); + + DEBUG2("NetSmtpSendMail: Sent [%s]\n", buf); + + FAIL(NetSmtpReadServerAnswer(&smtpCode, buf, sizeof(buf), nc)); + } + + // + // Send 'DATA' to begin email body. + // + + written = nc -> write(SMTP_DATA, sizeof(SMTP_DATA) - 1); + + FAIL(written <= 0); + + DEBUG2("NetSmtpSendMail: Sent DATA.\n"); + + FAIL(NetSmtpReadServerAnswer(&smtpCode, buf, sizeof(buf), nc)); + + // + // Send body header. + // + + len = snprintf(buf, sizeof(buf), SMTP_HEAD_FMT, + fromFull, from, receivers[0].c_str(), subject); + + written = nc -> write(buf, len); + + FAIL(written <= 0); + + DEBUG2("NetSmtpSendMail: Sent header [%s].\n", buf); + + // + // Send message part. + // + + written = nc -> write(message, strlen(message)); + + FAIL(written <= 0); + + DEBUG2("NetSmtpSendMail: Sent message body.\n"); + + // + // Send '\r\n.\r\n' to finish DATA part. + // + + nc -> write(SMTP_END, sizeof(SMTP_END) - 1); + + DEBUG2("NetSmtpSendMail: Sent END tag.\n"); + + FAIL(NetSmtpReadServerAnswer(&smtpCode, buf, sizeof(buf), nc)); + + // + // Send RSET command. + // + + nc -> write(SMTP_RSET, sizeof(SMTP_RSET) - 1); + + DEBUG2("NetSmtpSendMail: Sent RSET.\n"); + + FAIL(NetSmtpReadServerAnswer(&smtpCode, buf, sizeof(buf), nc)); + + // + // Send QUIT command. + // + + nc -> write(SMTP_QUIT, sizeof(SMTP_QUIT) - 1); + + DEBUG2("NetSmtpSendMail: Sent QUIT.\n"); + + FAIL(NetSmtpReadServerAnswer(&smtpCode, buf, sizeof(buf), nc)); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot send email.\n" + "Error code is : %d.\nSMTP code is : %d.\n", + GetLastError(), smtpCode); + } + + if (nc) + { + nc -> release(); + } + + DBG_LEAVE2("NetSmtpSendMail"); + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/Server.cpp b/Source/Net/LibNet/Server.cpp new file mode 100644 index 0000000..38054fe --- /dev/null +++ b/Source/Net/LibNet/Server.cpp @@ -0,0 +1,738 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: TCP/IP4 server. +// +// Usage I (wait for one client only): +// ----------------------------------- +// +// NetConnection *nc = NetAccept() +// nc -> read(,..) +// nc -> write(...) +// nc -> release() +// +// Usage II (create main server loop in new thread, +// serve connection in new threads): +// ------------------------------------------------ +// +// Create main server loop: +// NetConnection *nc = NetServerCreate(..., handler, ...) +// nc -> join() +// +// Implement connection handler: +// int handler(NetConnection *nc) +// { +// nc -> write() +// nc -> read() +// ... +// nc -> release() +// } +// + +#pragma qcbuild_set_file_title("Server side API") + +#include "Net.h" +#include "NetInternal.h" +#include "NetTcpConnection.h" + +namespace Tegenaria +{ + // + // Main server loop, which does: + // + // - Wait for incoming connection on given socket + // - Accept connection + // - Create new thread to serve connection by given handle + // - wait again for next incoming connection + // - ... + // + // conn - struct describing opened connection to use (IN). + // + // RETURNS: 0 if OK. + // + + // + // Define this to avoid TIME_WAIT warning + // on Linux. + // + #ifndef WIN32 + + #define AVOID_TIMEWAIT + + #endif + + int NetServerLoop(NetConnection *nc) + { + DBG_ENTER("NetServerLoop"); + + int exitCode = -1; + + SOCKET client = -1; + + socklen_t len = 0; + + int port = -1; + + struct sockaddr_in clientAddress = {0}; + + NetTcpConnection *clientConn = NULL; + + ThreadHandle_t *thread = NULL; + + NetTcpConnection *serv = (NetTcpConnection *) nc; + + DBG_SET_ADD("NetServerLoop", nc); + + // + // Increase refference counter for listening connection. + // Until refference counter is > 0 object cannot be destroyed + // by third thread. + // + + if (nc) + { + nc -> addRef(); + } + + // + // Check args. + // + + FAILEX(serv == NULL, "ERROR: 'Conn' cannot be NULL in NetServerLoop.\n"); + FAILEX(int(serv -> getSocket()) < 0, "ERROR: Wrong server's socket in NetServerLoop.\n"); + FAILEX(serv -> getHandler() == NULL, "ERROR: Wrong connection's handler in NetServerLoop.\n"); + + // + // Change connection state to LISTENING. + // + + serv -> setState(NET_STATE_LISTENING); + + port = htons(serv -> getAddr().sin_port); + + DBG_SET_RENAME("NetTcpConnection", nc, "Listen/%d", port); + + // + // Fall into main server loop. + // + + while(serv -> getState() == NET_STATE_LISTENING) + { + // + // Wait for connection. + // + + DBG_MSG("NetServerLoop : Listening on port [%d] inside context [%p]...\n", + port, serv -> getContext()); + + FAILEX(listen(serv -> getSocket(), 5), + "ERROR: Cannot listen on socket.\n", serv -> getSocket()); + + // + // Accept connection. + // + + len = sizeof(clientAddress); + + client = accept(serv -> getSocket(), (struct sockaddr *) &clientAddress, &len); + + // + // Avoid error message if server shutted down in usual way. + // + + if (serv -> getState() == NET_STATE_DEAD) + { + DBG_INFO("NetServerLoop : Server on SOCKET #%d port #%d shutted down.\n", + serv -> getSocket(), port); + + break; + } + + FAILEX(int(client) < 0, + "ERROR: Cannot accept connection on socket [%d].\n", + serv -> getSocket()); + + DBG_MSG("NetServerLoop : Accepted connection from [%s] on socket [%d].\n", + inet_ntoa(clientAddress.sin_addr), client); + + DBG_SET_ADD("socket", client, "IN"); + + // + // Pass connection to handler. + // + + clientConn = new NetTcpConnection(serv -> getContext(), client, + serv -> getHandler(), clientAddress); + + FAILEX(clientConn == NULL, "ERROR: Out of memory.\n"); + + DBG_SET_RENAME("NetTcpConnection", clientConn, "IN"); + + // + // Start up connection handler in another thread. + // + + thread = ThreadCreate((ThreadEntryProto) serv -> getHandler(), clientConn); + + DBG_SET_RENAME("thread", thread, "NET/IN/Handler"); + + clientConn -> setThread(thread); + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + DBG_MSG("NetServerLoop : listening loop for connection [%p] finished.\n", nc); + + if (nc) + { + nc -> release(); + } + + DBG_SET_DEL("NetServerLoop", nc); + + DBG_LEAVE("NetServerLoop"); + + return exitCode; + } + + // + // Start up TCP server in background thread. + // + // handler - callback routine to handle incoming connections (IN). + // + // custom - custom, caller specified data passed to handler directly + // inside NetConnection struct as 'ctx' (IN/OPT). + // + // port - listening port (IN). + // + // RETURNS: Pointer to server side connection, + // or NULL if error. + // + + NetConnection *NetServerCreate(int port, NetHandleConnProto handler, void *custom) + { + DBG_ENTER("NetServerCreate"); + + int exitCode = -1; + + SOCKET server = -1; + + struct sockaddr_in serverAddress = {0}; + + NetTcpConnection *serverConn = NULL; + + ThreadHandle_t *serverLoopThread = NULL; + + #ifdef AVOID_TIMEWAIT + int iSetOption = 1; + struct linger so_linger; + so_linger.l_onoff = 1; + so_linger.l_linger = 0; + #endif + + // + // Initialize WinSock 2.2 on windows. + // + + FAIL(_NetInit()); + + // + // Create listening/server socket. + // + + server = socket(AF_INET, SOCK_STREAM, 0); + + #ifdef AVOID_TIMEWAIT + setsockopt(server, SOL_SOCKET, SO_LINGER, &so_linger, sizeof(so_linger)); + setsockopt(server, SOL_SOCKET, SO_REUSEADDR, (char*)&iSetOption, sizeof(iSetOption)); + #endif + + FAILEX(int(server) < 0, "ERROR: Cannot create listening socket.\n"); + + DBG_SET_ADD("socket", server, "Listen"); + + // + // bind links the socket we just created with the sockaddr_in + // structure. Basically it connects the socket with + // the local address and a specified port. + // If it returns non-zero quit, as this indicates error + // + + serverAddress.sin_family = AF_INET; //Address family + serverAddress.sin_addr.s_addr = INADDR_ANY; //Wild card IP address + serverAddress.sin_port = htons((u_short) port); //port to use + + FAILEX(bind(server, (sockaddr *) &serverAddress, sizeof(serverAddress)), + "ERROR: Cannot bind listening socket to port '%d'.\n", port); + + // + // Allocate and fill output struct. + // + + serverConn = new NetTcpConnection(custom, server, handler, serverAddress); + + FAILEX(serverConn == NULL, "ERROR: Out of memory.\n"); + + // + // Create server loop thread. + // + + serverLoopThread = ThreadCreate((ThreadEntryProto) NetServerLoop, serverConn); + + DBG_SET_RENAME("thread", serverLoopThread, "NetServerLoop"); + + FAILEX(serverLoopThread == NULL, + "ERROR: Cannot create server loop thread.\n"); + + DBG_MSG("Created server loop thread '%p' within context [%p].\n", + serverLoopThread, serverConn -> getContext()); + + serverConn -> setThread(serverLoopThread); + + // + // Wait until server ready. + // + + FAIL(serverConn -> waitForState(NET_STATE_LISTENING, 10000)); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("Cannot create TCP server on port [%d].\n", port); + + if (int(server) != -1) + { + DBG_MSG("NetServerCreate : Shutting down SOCKET #%d...\n", server); + + shutdown(server, SD_BOTH); + + closesocket(server); + + DBG_SET_DEL("socket", server); + } + + if (serverConn) + { + serverConn -> setState(NET_STATE_DEAD); + + serverConn -> release(); + + serverConn = NULL; + } + } + + DBG_LEAVE("NetServerCreate"); + + return serverConn; + } + + // + // Create listening TCP/IP4 socket and wait for one client. + // After connection negociated, listening socket is shutted down. + // + // WARNING: Caller MUST release received net connection object by + // calling nc -> release() method on it. + // + // port - listening port (IN). + // timeout - maximum listening time in miliseconds. Defaulted to infinite if -1 (IN/OPT). + // + // RETURNS: Pointer to server side connection, + // or NULL if error. + // + + NetConnection *NetAccept(int port, int timeout) + { + DBG_ENTER("NetAccept"); + + int exitCode = -1; + + socklen_t len = 0; + + SOCKET server = -1; + SOCKET client = -1; + + struct sockaddr_in serverAddress = {0}; + struct sockaddr_in clientAddress = {0}; + + int ret = -1; + + fd_set fds; + + NetTcpConnection *nc = NULL; + + // + // Initialize WinSock 2.2 on windows. + // + + FAIL(_NetInit()); + + // + // Create listening/server socket. + // + + server = socket(AF_INET, SOCK_STREAM, 0); + + FAILEX(int(server) < 0, "ERROR: Cannot create listening socket.\n"); + + DBG_SET_ADD("socket", server, "Listen/%d", port); + + // + // bind links the socket we just created with the sockaddr_in + // structure. Basically it connects the socket with + // the local address and a specified port. + // If it returns non-zero quit, as this indicates error + // + + serverAddress.sin_family = AF_INET; //Address family + serverAddress.sin_addr.s_addr = INADDR_ANY; //Wild card IP address + serverAddress.sin_port = htons((u_short) port); //port to use + + FAILEX(bind(server, (sockaddr *) &serverAddress, sizeof(serverAddress)), + "ERROR: Cannot bind listening socket to port '%d'.\n", port); + + // + // Set listening socket to non-block mode. + // + + FAIL(NetSetNonBlockMode(server)); + + // + // Wait for connection. + // + + DEBUG2("NetAccept : Listening on port [%d]...\n", port); + + FAILEX(listen(server, 5), "ERROR: Cannot listen on socket.\n", server); + + // + // Wait for connection or timeout. + // + + DEBUG2("NetAccept : Waiting for incoming connection on port [%d]...\n", port); + + FD_ZERO(&fds); + FD_SET(server, &fds); + + if (timeout > 0) + { + struct timeval tv = {0}; + + tv.tv_sec = timeout / 1000; + tv.tv_usec = timeout % 1000 * 1000; + + ret = select(server + 1, &fds, NULL, NULL, &tv); + } + else + { + ret = select(server + 1, &fds, NULL, NULL, NULL); + } + + FAILEX(ret <= 0, "ERROR: Timeout while listening on port [%d].\n", port); + + // + // Accept connection. + // + + len = sizeof(clientAddress); + + client = accept(server, (struct sockaddr *) &clientAddress, &len); + + FAILEX(int(client) < 0, "ERROR: Cannot accept connection on socket [%d].\n", client); + + DBG_MSG("NetServerLoop : Accepted connection from [%s] on socket [%d].\n", + inet_ntoa(clientAddress.sin_addr), client); + + DBG_SET_ADD("socket", client, "IN"); + + // + // Wrap socket into NetConnection class. + // + + nc = new NetTcpConnection(NULL, client, NULL, clientAddress); + + nc -> setState(NET_STATE_ESTABLISHED); + + DBG_SET_RENAME("NetTcpConnection", nc, "IN"); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create TCP server on port [%d]. Error is %d.\n", + port, GetLastError()); + } + + // + // Shutdown listening socket. + // + + if (int(server) != -1) + { + DBG_MSG("NetAccept : Shutting down SOCKET #%d...\n", server); + + shutdown(server, SD_BOTH); + + closesocket(server); + + DBG_SET_DEL("socket", server); + } + + DBG_LEAVE("NetAccept"); + + return nc; + } + + // + // Try create listening socket on given port. + // + // port - listening port (IN). + // + // RETURNS: 0 if socket can be created (port free) + // -1 otherwise. + // + + int NetTryBind(int port) + { + DBG_ENTER("NetTryBind"); + + int exitCode = -1; + + socklen_t len = 0; + + SOCKET server = -1; + SOCKET client = -1; + + struct sockaddr_in serverAddress = {0}; + struct sockaddr_in clientAddress = {0}; + + // + // Initialize WinSock 2.2 on windows. + // + + FAIL(_NetInit()); + + // + // Create listening/server socket. + // + + server = socket(AF_INET, SOCK_STREAM, 0); + + FAIL(int(server) < 0); + + DBG_SET_ADD("socket", server, "Listen/%d", port); + + // + // bind links the socket we just created with the sockaddr_in + // structure. Basically it connects the socket with + // the local address and a specified port. + // If it returns non-zero quit, as this indicates error + // + + serverAddress.sin_family = AF_INET; //Address family + serverAddress.sin_addr.s_addr = INADDR_ANY; //Wild card IP address + serverAddress.sin_port = htons((u_short) port); //port to use + + FAIL(bind(server, (sockaddr *) &serverAddress, sizeof(serverAddress))); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + // + // Shutdown listening socket. + // + + if (int(server) != -1) + { + shutdown(server, SD_BOTH); + + closesocket(server); + + DBG_SET_DEL("socket", server); + } + + DBG_LEAVE("NetTryBind"); + + return exitCode; + } + + // + // Create listening socket on given port. + // queue. + // + // port - port number, where to start litsening (IN). + // maxConnections - maximum allowed number of incoming connections (IN). + // nonBlock - create non-blocking socket if set to 1 (IN). + // + // RETURNS: Listening socket + // or -1 if error. + // + + int NetCreateListenSocket(int port, int maxConnections, int nonBlock) + { + DBG_ENTER("NetCreateListenSocket"); + + int exitCode = -1; + + int sock = -1; + int reuseAddress = 1; + + #ifdef WIN32 + struct sockaddr_in addr = {0}; + #else + struct sockaddr_in6 addr = {0}; + #endif + + // + // Create non-block listening socket. + // + + #ifdef WIN32 + { + sock = socket(AF_INET, SOCK_STREAM, 0); + } + #else + { + if (nonBlock) + { + sock = socket(AF_INET6, SOCK_STREAM | SOCK_NONBLOCK, 0); + } + else + { + sock = socket(AF_INET6, SOCK_STREAM, 0); + } + } + #endif + + FAILEX(SOCKET(sock) == -1, + "ERROR: Cannot create listening socket.\n"); + + // + // Windows doesn't support for SOCK_NONBLOCK option in socket(). + // We need to set up it manually. + // + + #ifdef WIN32 + { + if (nonBlock) + { + u_long nonblock = 1; + + FAILEX(ioctlsocket(sock, FIONBIO, &nonblock), + "ERROR: Cannot set non-block mode on SOCKET #%d.\n", sock); + } + } + #endif + + // + // Set address reuse. + // + + FAILEX(setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, + (char *) &reuseAddress, sizeof(reuseAddress)) == -1, + "ERROR: Cannot set reuse flag on socket #%d.\n", sock); + // + // Bind socket to any address and selected port. + // + + #ifdef WIN32 + { + addr.sin_family = AF_INET; + addr.sin_addr.s_addr = INADDR_ANY; + addr.sin_port = htons((u_short) port); + } + #else + { + addr.sin6_port = htons(port); + addr.sin6_addr = in6addr_any; + addr.sin6_family = AF_INET6; + } + #endif + + FAILEX(bind(sock, (struct sockaddr *) &addr, sizeof(addr)) == -1, + "ERROR: Cannot bind address to socket #%d.\n", sock); + + // + // Start listening for incoming connection. + // + + FAILEX(listen(sock, maxConnections) == -1, + "ERROR: Cannot listen on socket #%d.\n", sock); + + DBG_INFO("Listening on port %d...\n", port); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("Cannot create listening socket.\n" + "Error code is %d.\n", GetLastError()); + + if (SOCKET(sock) != -1) + { + #ifdef WIN32 + closesocket(sock); + #else + close(sock); + #endif + + sock = -1; + } + } + + DBG_LEAVE("NetCreateListenSocket"); + + return sock; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/TODO b/Source/Net/LibNet/TODO new file mode 100644 index 0000000..724e063 --- /dev/null +++ b/Source/Net/LibNet/TODO @@ -0,0 +1 @@ +- Hide NetStatistics implementation. \ No newline at end of file diff --git a/Source/Net/LibNet/Utils.cpp b/Source/Net/LibNet/Utils.cpp new file mode 100644 index 0000000..0cab2d2 --- /dev/null +++ b/Source/Net/LibNet/Utils.cpp @@ -0,0 +1,910 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#pragma qcbuild_set_file_title("General utils") + +#include "Net.h" +#include "NetInternal.h" +#include "Utils.h" + +#ifndef WIN32 +# include +# include +# include +# include +# include +#endif + +#include +#include + +namespace Tegenaria +{ + // + // Initialize WinSock2 on Windows. + // Called internally. + // + // RETURNS: 0 if OK. + // + + int _NetInit() + { + #pragma qcbuild_set_private(1) + + DBG_ENTER3("NetInit"); + + int exitCode = -1; + + static int initOk = 0; + + // + // Call WsaStartup only at first call. + // + + if (initOk == 0) + { + // + // Initialize WinSock 2.2 on Windows. + // + + #ifdef WIN32 + + WSADATA wsaData = {0}; + + WORD version = MAKEWORD(2, 2); + + FAILEX(WSAStartup(version, &wsaData), + "ERROR: Cannot initialize WinSock DLL."); + #endif + + // + // Init randomize seed. + // + + srand(time(0)); + + initOk = 1; + } + + exitCode = 0; + + fail: + + DBG_LEAVE3("NetInit"); + + return exitCode; + } + + // + // Split network address string into ip and port parts. + // + // WARNING: ip1, ip2 buffers MUST have at least 16 bytes length + // if specified. + // + // ip1 - buffer, where to store recognized ip (eg. "1.2.3.4"). + // Can be NULL. (OUT/OPT). + // + // ip2 - buffer where to store second ip if UPNP scheme detected. + // Set to empty string if UPNP not detected. Can be NULL. (OUT/OPT). + // + // port - recognized port number. Can be NULL. (OUT/OPT). + // + // address - input address to parse e.g. "127.0.0.1:80" (IN). + // + // RETURNS: 0 if OK, + // -1 if string not recognized as net address. + // + + int NetParseAddress(char *ip1, char *ip2, int *port, const char *address) + { + DBG_ENTER("NetParseAddress"); + + int exitCode = -1; + + string addressString; + + char *p = NULL; + char *delim = NULL; + char *colon = NULL; + + // + // Check args. + // + + FAILEX(address == NULL, "ERROR: 'addr' cannot be NULL in NetParseAddress.\n"); + + // + // Parse address. + // + + addressString = address; + + p = &addressString[0]; + + delim = strchr(p, ':'); + colon = strchr(p, ','); + + // + // UPNP "ip1,ip2:port" scheme. + // + + if (delim && colon) + { + *delim = 0; + *colon = 0; + + DBG_MSG("NetParseAddress : Recognized [%s] as UPNP pair " + "[%s][%s] port [%s].\n", address, p, colon + 1, delim + 1); + + if (ip1) + { + strcpy(ip1, p); + } + + if (ip2) + { + strcpy(ip2, colon + 1); + } + + if (port) + { + *port = atoi(delim + 1); + } + } + + // + // "ip:port" scheme. + // + + else if (delim) + { + *delim = 0; + + DBG_MSG("NetParseAddress : Recognized [%s]" + " as [%s] port [%s].", address, p, delim + 1); + + if (ip1) + { + strcpy(ip1, p); + } + + if (ip2) + { + ip2[0] = 0; + } + + if (port) + { + *port = atoi(delim + 1); + } + } + else + { + goto fail; + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot parse network address [%s].\n", address); + } + + DBG_LEAVE("NetParseAddress"); + + return exitCode; + } + + // + // Run underlying netstat command and return state string of + // given network port. + // + // port - port number check e.g. 80 (IN). + // protocol - protocol string, defaulted to TCP (IN/OPT). + // + // RETURNS: Status string e.g. TIME_WAIT or + // "-" if port not opened or error. + // + + const string NetGetPortState(int port, const char *protocol) + { + DBG_ENTER("NetGetPortState"); + + char line[1024]; + char pattern[64]; + char command[128]; + + char state[128] = "-"; + + FILE *f = NULL; + + _NetInit(); + + // + // Run: + // + // netstat -abn -p on Widows + // netstat -apn -p on Linux + // + + #ifdef WIN32 + snprintf(command, sizeof(command) - 1, "netstat -an -p %s", protocol); + #else + snprintf(command, sizeof(command) - 1, "netstat -an -p %s 2>/dev/null", protocol); + #endif + + f = popen(command, "r"); + + FAILEX(f == NULL, "ERROR: Can't execute netstat command.\n"); + FAILEX(port == 0, "ERROR: Port can't be 0 in NetGetPortState.\n"); + + // + // Read netstat result line by line and search for given port. + // + + snprintf(pattern, sizeof(pattern) - 1, ":%d ", port); + + while(fgets(line, sizeof(line), f)) + { + // + // Port found, get status string. + // + + if (strstr(line, pattern)) + { + #ifdef WIN32 + sscanf(line, "%s%s%s%s", state, state, state, state); + #else + sscanf(line, "%s%s%s%s%s%s", state, state, state, state, state, state); + #endif + } + } + + fail: + + DBG_LEAVE("NetGetPortState"); + + return state; + } + + // + // Check is given port opened in any state. + // + // port - port number to check e.g. 80 (IN). + // protocol - protocol string, defaulted to TCP (IN/OPT). + // + // RETURNS: 1 if port opened, + // 0 if port NOT opened or error. + // + + int NetIsPortOpen(int port, const char *protocol) + { + _NetInit(); + + string state = NetGetPortState(port, protocol); + + if (state != "-") + { + return 1; + } + else + { + return 0; + } + } + + // + // Find random unused port. + // + // protocol - protocol string, defaulted to "TCP" if skipped (IN/OPT). + // + // RETURNS: First found unused port or + // -1 if error. + // + + int NetGetFreePort(const char *protocol) + { + _NetInit(); + + for (int i = 0; i < 128; i++) + { + int port = 1024 + rand() % (65536 - 1024); + + if (NetTryBind(port) == 0) + { + DEBUG2("NetGetFreePort: Free %s port found at [%d].\n", protocol, port); + + return port; + } + } + + Error("ERROR: Cannot found free %s port.\n", protocol); + + return -1; + } + + // + // Check is given port closed in any state. + // + // port - port number to check e.g. 80 (IN). + // protocol - protocol string, defaulted to TCP (IN/OPT). + // + // RETURNS: 1 if port opened, + // 0 if port NOT opened or error. + // + + int NetIsPortClosed(int port, const char *protocol) + { + string state = NetGetPortState(port, protocol); + + if (state == "-" || + strstr(state.c_str(), "TIME_WAIT") || + strstr(state.c_str(), "CZAS_OCZEK")) + { + return 1; + } + else + { + return 0; + } + } + + // + // Set limit of maximum opened FD for current user. + // + // limit - new limit to set (IN). + // + // RETURNS: 0 if OK. + // + + int NetSetFDsLimit(int limit) + { + DBG_ENTER("NetSetFDsLimit"); + + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + Error("NetSetFDsLimit not implemented.\n"); + } + + // + // Linux. + // + + #else + + // + // Check and change if needed the per-user limit of open files + // + + struct rlimit limitstruct; + + if(getrlimit(RLIMIT_NOFILE,&limitstruct) == -1) + { + fprintf(stderr, "Could not establish user limits of open files."); + + goto fail; + } + + DBG_MSG("Polled user limits for maximum number of open files:" + " soft: %d; hard: %d\n", (int) limitstruct.rlim_cur, (int) limitstruct.rlim_max); + + if(limitstruct.rlim_max < limit) + { + // The maximum value of the maximum number of open files is currently to low. + // We can try to increase this, but this probably will only work as root. + // A better durable solution is to use the /etc/security/limits.conf + // + // Attempt to increase the limits + + limitstruct.rlim_cur = limit; + limitstruct.rlim_max = limit; + + if(setrlimit(RLIMIT_NOFILE,&limitstruct) == -1) + { + fprintf(stderr, "Could not increase hard user limit of open files to %d.\n" + "You can either try to run this program as root, or more recommended,\n" + "change the user limits on the system (e.g. /etc/security.limits.conf)\n", limit); + + goto fail; + } + + DBG_MSG("Changed hard & soft limit to %d.\n", limit); + } + else if (limitstruct.rlim_cur < limit) + { + // + // The maximum limit is high enough, but the current limit might not be. + // We should be able to increase this. + // + + limitstruct.rlim_cur = limit; + + if(setrlimit(RLIMIT_NOFILE,&limitstruct) == -1) + { + fprintf(stderr, "Could not increase soft user limit of open files to %d.\n" + "You can either try to run this program as root, or more recommended,\n" + "change the user limits on the system (e.g. /etc/security.limits.conf)\n",limit); + + goto fail; + } + + DBG_MSG("Changed soft limit to %d\n", limit); + } + else + { + DBG_MSG("Limit was high enough\n"); + } + + exitCode = 0; + + #endif + + // + // Error handler. + // + + fail: + + if (exitCode) + { + fprintf(stderr, "ERROR: Cannot set up open FDs limit to %d.\n", limit); + } + + DBG_LEAVE("NetSetFDsLimit"); + + return exitCode; + } + + // + // Return number of CPU cores installed on system. + // + + int NetGetCpuNumber() + { + DBG_ENTER("NetGetCpuNumber"); + + static int cpuCount = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + if (cpuCount == -1) + { + SYSTEM_INFO si = {0}; + + GetSystemInfo(&si); + + cpuCount = si.dwNumberOfProcessors; + } + } + + // + // Linux, MacOS. + // + + #else + { + cpuCount = 1;//sysconf(_SC_NPROCESSORS_ONLN); + } + #endif + + DBG_LEAVE("NetGetCpuNumber"); + + return cpuCount; + } + + // + // Retrieve IP of current running machine e.g. 10.0.0.14. + // + // ip - buffer, where to store retrieved ip of local machine (OUT). + // ipSize - size of ip[] buffer in bytes (IN). + // + // RETURNS: 0 if OK. + // + + int NetGetLocalIp(char *ip, int ipSize) + { + DBG_ENTER("NetGetLocalIp"); + + int exitCode = -1; + + int sd = -1; + + _NetInit(); + + // + // Check args. + // + + FAILEX(ip == NULL, "ERROR: ip parameter cannot be NULL in NetGetLocalIp().\n"); + FAILEX(ipSize <= 0, "ERROR: ipSize parameter cannot be <= 0 in NetGetLocalIp().\n"); + + ip[0] = 0; + + // + // Init LibNet if needed. + // + + _NetInit(); + + // + // Windows. + // + + #ifdef WIN32 + { + char hostName[1024] = {0}; + + struct hostent *host = NULL; + + // + // Get name of current running machine. + // + + FAILEX(gethostname(hostName, sizeof(hostName)) != 0, + "ERROR: Cannot get name of current running machine.\n"); + + // + // Convert host name to host struct. + // + + host = gethostbyname(hostName); + + FAILEX(host == NULL, "ERROR: Cannot import host '%s'.\n", hostName); + + // + // Put retrieved ip into caller buffer. + // + + strncpy(ip, inet_ntoa(*(struct in_addr *) *host -> h_addr_list), ipSize - 1); + } + + // + // Linux, MacOS. + // + + #else + { + struct ifreq ifreqs[32]; + + struct ifconf ifconf = {0}; + + ifconf.ifc_req = ifreqs; + ifconf.ifc_len = sizeof(ifreqs); + + // + // Create PF_INET socket. + // + + sd = socket(PF_INET, SOCK_STREAM, 0); + + FAILEX(sd < 0, "ERROR: Cannot create PF_INET socket.\n"); + + // + // Get ifconfig from sd socket. + // + + FAILEX(ioctl(sd, SIOCGIFCONF, (char *) &ifconf) != 0, + "ERROR: Cannot send SIOCGIFCONF ioctl to %d socket.\n", sd); + + // + // Iterate over interfaces. + // + + for(int i = 0; i < ifconf.ifc_len / sizeof(struct ifreq); i++) + { + struct ifreq ifreq; + + strcpy(ifreq.ifr_name, ifreqs[i].ifr_name); + + // + // Get interface flags. + // + + FAILEX(ioctl(sd, SIOCGIFFLAGS, (char *) &ifreq) != 0, + "ERROR: Cannot send SIOCGIFFLAGS to %d socket.\n", sd); + + // + // Skip loopback devices like 127.0.0.1. + // + + if ((ifreq.ifr_flags & IFF_LOOPBACK) == 0) + { + // + // Put interface IP to caller buffer. + // + + strncpy(ip, inet_ntoa(((struct sockaddr_in *) &ifreqs[i].ifr_addr) -> sin_addr), ipSize - 1); + + break; + } + } + } + #endif + + DEBUG3("NetGetLocalIp : Local IP is [%s].\n", ip); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot retrieve IP of current running machine." + " Error is %d.\n", GetLastError()); + } + + if (sd > 0) + { + close(sd); + } + + return exitCode; + } + + // + // Switch socket to non-block mode. + // + // RETURNS: 0 if OK. + + int NetSetNonBlockMode(int sock) + { + DBG_ENTER("NetSetNonBlockMode"); + + int exitCode = -1; + + #ifdef WIN32 + { + u_long nonblock = 1; + + FAILEX(ioctlsocket(sock, FIONBIO, &nonblock), + "ERROR: Cannot set non-block mode on SOCKET #%d.\n", sock); + } + #else + { + long arg = 0; + + arg = fcntl(sock, F_GETFL, NULL) | O_NONBLOCK; + + FAILEX(fcntl(sock, F_SETFL, arg), + "ERROR: Cannot set non-block mode on SOCKET #%d.\n", sock); + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE("NetSetNonBlockMode"); + + return exitCode; + } + + // + // Switch socket to block mode. + // + // RETURNS: 0 if OK. + + int NetSetBlockMode(int sock) + { + DBG_ENTER("NetSetBlockMode"); + + int exitCode = -1; + + #ifdef WIN32 + { + u_long nonblock = 0; + + FAILEX(ioctlsocket(sock, FIONBIO, &nonblock), + "ERROR: Cannot set block mode on SOCKET #%d.\n", sock); + } + #else + { + long arg = 0; + + arg = fcntl(sock, F_GETFL, NULL) & ~O_NONBLOCK; + + FAILEX(fcntl(sock, F_SETFL, arg), + "ERROR: Cannot set block mode on SOCKET #%d.\n", sock); + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE("NetSetBlockMode"); + + return exitCode; + } + + // + // Resolve ip adresses for given host name. + // + // ips - list of found IP addresses (OUT). + // host - host name to resolve e.g. "google.pl" (IN). + // + // RETURNS: 0 if OK, + // -1 otherwise. + // + + int NetResolveIp(vector &ips, const char *host) + { + int exitCode = -1; + + hostent *remoteHost = NULL; + + in_addr addr; + + // + // Check args. + // + + ips.clear(); + + FAILEX(host == NULL, "ERROR: 'host' cannot be NULL in NetResolveIp().\n"); + + // + // Initialize WinSock 2.2 on windows. + // + + FAIL(_NetInit()); + + // + // Get host info. + // + + remoteHost = gethostbyname(host); + + FAIL(remoteHost == NULL); + + // + // Retrieve IP addresses. + // + + FAIL(remoteHost -> h_addrtype != AF_INET); + + for (int i = 0; remoteHost -> h_addr_list[i]; i++) + { + addr.s_addr = *(u_long *) remoteHost -> h_addr_list[i]; + + ips.push_back(inet_ntoa(addr)); + } + + FAIL(ips.empty()); + + DEBUG1("Host '%s' resolved to '%s'.\n", host, ips[0].c_str()); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot resolve host '%s'.\n" + "Error code is: %d.\n", host, GetLastError()); + } + + return exitCode; + }; + + // + // Encode data to base64 string. + // + // data - binary data to encode (IN). + // size - size of data[] buffer in bytes (IN). + // + // RETURNS: base64 string. + // + + string NetBase64(const char *data, int size) + { + static const char b64_charset[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; + + string ret; + + unsigned char block_3[3]; + unsigned char block_4[4]; + unsigned char *str = (unsigned char *) data; + + int i = 0; + int j = 0; + + while(size--) + { + block_3[i++] = *(str++); + + if( i == 3 ) + { + block_4[0] = (block_3[0] & 0xfc) >> 2; + block_4[1] = ((block_3[0] & 0x03) << 4) + ((block_3[1] & 0xf0) >> 4); + block_4[2] = ((block_3[1] & 0x0f) << 2) + ((block_3[2] & 0xc0) >> 6); + block_4[3] = block_3[2] & 0x3f; + + for(i = 0; (i <4) ; i++) + { + ret += b64_charset[block_4[i]]; + } + + i = 0; + } + } + + if(i) + { + for(j = i; j < 3; j++) + { + block_3[j] = '\0'; + } + + block_4[0] = (block_3[0] & 0xfc) >> 2; + block_4[1] = ((block_3[0] & 0x03) << 4) + ((block_3[1] & 0xf0) >> 4); + block_4[2] = ((block_3[1] & 0x0f) << 2) + ((block_3[2] & 0xc0) >> 6); + block_4[3] = block_3[2] & 0x3f; + + for(j = 0; (j < i + 1); j++) + { + ret += b64_charset[block_4[j]]; + } + + while((i++ < 3)) + { + ret += '='; + } + } + + return ret; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNet/Utils.h b/Source/Net/LibNet/Utils.h new file mode 100644 index 0000000..586caa8 --- /dev/null +++ b/Source/Net/LibNet/Utils.h @@ -0,0 +1,41 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Net_Utils_H +#define Tegenaria_Core_Net_Utils_H + +#ifndef WIN32 +# include +# include +#endif + +namespace Tegenaria +{ + int NetInit(); + int NetSetFDsLimit(int limit); + int NetGetCpuNumber(); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Net_Utils_H */ diff --git a/Source/Net/LibNet/qcbuild.src b/Source/Net/LibNet/qcbuild.src new file mode 100644 index 0000000..6dfae4d --- /dev/null +++ b/Source/Net/LibNet/qcbuild.src @@ -0,0 +1,46 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibNet + +CXXSRC = Server.cpp Client.cpp Utils.cpp NetConnection.cpp +CXXSRC += NetTcpConnection.cpp NetEpollServer.cpp NetIOCPServer.cpp +CXXSRC += NetHpServer.cpp SMTP.cpp NetStatistics.cpp Firewall.cpp + +INC_DIR = Tegenaria + +ISRC = Net.h NetConnection.h NetHpServer.h NetStatistics.h + +LIBS = -lthread -llock -ldebug -lmath-static + +PURPOSE = General mid-level and high-level network functions. + +AUTHOR = Sylwester Wysocki + +DEPENDS = LibDebug LibThread LibMath + +.section MinGW + LIBS += -lws2_32 -loleaut32 +.endsection diff --git a/Source/Net/LibNetEx/Example01-hp-server/Main.cpp b/Source/Net/LibNetEx/Example01-hp-server/Main.cpp new file mode 100644 index 0000000..186fd27 --- /dev/null +++ b/Source/Net/LibNetEx/Example01-hp-server/Main.cpp @@ -0,0 +1,96 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Show how to set up minimal callback echo server. +// + +#include +#include + +using namespace Tegenaria; + +// +// Open handler called when new connection created. +// + +void OpenHandler(NetExHpContext *ctx) +{ + printf("Worker #%d : New connection PTR#%p from [%s].\n", + ctx -> workerNo_, ctx, ctx -> clientIp_); + + // + // TIP: Init custom_ field with user specified data. + // This field will be available back in close and data handlers. + // + + // ctx -> custom_ = ... +} + +// +// Close handler called when one of existing connection closed. +// + +void CloseHandler(NetExHpContext *ctx) +{ + printf("Worker #%d : Closed connection PTR#%p.\n", ctx -> workerNo_, ctx); +} + +// +// Data handler called when new data arrived inside one of existing +// connections. +// + +void DataHandler(NetExHpContext *ctx, void *buf, int len) +{ + printf("Worker #%d : Received [%d] bytes inside connection PTR#%p.\n", + ctx -> workerNo_, len, ctx); + + // + // Echo server here. + // Write back the same data to client. + // + + NetExHpWrite(ctx, buf, len); +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_HEAD("LibNetEx HP server"); + + int port = -1; + + if (argc < 2) + { + Fatal("Usage is: %s \n", argv[0]); + } + + port = atoi(argv[1]); + + return NetExHpServerLoop(port, OpenHandler, CloseHandler, DataHandler); +} diff --git a/Source/Net/LibNetEx/Example01-hp-server/qcbuild.src b/Source/Net/LibNetEx/Example01-hp-server/qcbuild.src new file mode 100644 index 0000000..84d0f3b --- /dev/null +++ b/Source/Net/LibNetEx/Example01-hp-server/qcbuild.src @@ -0,0 +1,40 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibNetEx-example01-hp-server + +# +# Component's info. +# + +PURPOSE = Show how to set up high performance event based TCP server. +AUTHOR = Sylwester Wysocki +CXXSRC = Main.cpp +LIBS = -lnetex -levent -lthread -llock -ldebug -lsecure -lssl -lcrypto +DEPENDS = LibNetEx + +.section Linux + LIBS += -levent_pthreads +.endsection diff --git a/Source/Net/LibNetEx/Example02-tls-server/Main.cpp b/Source/Net/LibNetEx/Example02-tls-server/Main.cpp new file mode 100644 index 0000000..495d2b9 --- /dev/null +++ b/Source/Net/LibNetEx/Example02-tls-server/Main.cpp @@ -0,0 +1,127 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Show how to set up minimal SSL echo server. +// + +#include +#include + +using namespace Tegenaria; + +// +// Open handler called when new connection created. +// + +void OpenHandler(NetExHpContext *ctx) +{ + printf("Worker #%d : New connection PTR#%p from [%s].\n", + ctx -> workerNo_, ctx, ctx -> clientIp_); + + // + // TIP: Init custom_ field with user specified data. + // This field will be available back in close and data handlers. + // + + // ctx -> custom_ = ... +} + +// +// Close handler called when one of existing connection closed. +// + +void CloseHandler(NetExHpContext *ctx) +{ + printf("Worker #%d : Closed connection PTR#%p.\n", ctx -> workerNo_, ctx); +} + +// +// Data handler called when new data arrived inside one of existing +// connections. +// + +void DataHandler(NetExHpContext *ctx, void *buf, int len) +{ + printf("Worker #%d : Received [%d] bytes inside connection PTR#%p.\n", + ctx -> workerNo_, len, ctx); + + // + // Echo server here. + // Write back the same data to client. + // + + NetExHpWrite(ctx, buf, len); +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_INIT_EX(NULL, "info", -1); + + DBG_HEAD("LibNetEx HP TLS encrypted server"); + + int port = -1; + + const char *cert = NULL; + const char *privKey = NULL; + + char privKeyPass[64] = {0}; + + // + // Check args. + // + + if (argc < 4) + { + Fatal("Usage is: %s \n", argv[0]); + } + + port = atoi(argv[1]); + + cert = argv[2]; + privKey = argv[3]; + + // + // Read private key passphrase and cache it in memory to avoid + // asking for pass on every connection. + // + + SecureReadPassword(privKeyPass, + sizeof(privKeyPass), + "Enter private key passhrase: "); + + // + // Start up TLS server. + // + + printf("Using certificate : [%s].\n", cert); + printf("Using private key : [%s].\n", privKey); + + return NetExHpSecureServerLoop(port, OpenHandler, CloseHandler, DataHandler, + cert, privKey, privKeyPass); +} diff --git a/Source/Net/LibNetEx/Example02-tls-server/qcbuild.src b/Source/Net/LibNetEx/Example02-tls-server/qcbuild.src new file mode 100644 index 0000000..5a3c0cb --- /dev/null +++ b/Source/Net/LibNetEx/Example02-tls-server/qcbuild.src @@ -0,0 +1,42 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibNetEx-example02-tls-server + +# +# Component's info. +# + +PURPOSE = Show how to set up high performance event based TCP server +PURPOSE += with encrypted TLS connection. + +AUTHOR = Sylwester Wysocki +CXXSRC = Main.cpp +LIBS = -lnetex -levent -lthread -llock -ldebug -lsecure -lssl -lcrypto +DEPENDS = LibNetEx + +.section Linux + LIBS += -levent_pthreads +.endsection diff --git a/Source/Net/LibNetEx/NetEx.h b/Source/Net/LibNetEx/NetEx.h new file mode 100644 index 0000000..ea6b396 --- /dev/null +++ b/Source/Net/LibNetEx/NetEx.h @@ -0,0 +1,119 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_LibNetEx_H +#define Tegenaria_Core_LibNetEx_H + +#include + +using std::string; + +// +// Defines. +// + +// +// Define to enable NetExSecureServerLoop() to support TLS based server. +// + +#define NET_EX_USE_LIBSECURE + +// +// Define to enable extra debug code to track create/destroy of server +// contexts. Debug purpose only. +// + +#undef NET_EX_CHECK_CTX + +// +// Include LibSecure to handle secure TLS connection. +// + +#ifdef NET_EX_USE_LIBSECURE +# include +#endif + +namespace Tegenaria +{ + // + // Forward declaration. + // + + struct NetExHpContext; + + // + // Typedef. + // + + typedef void (*NetExHpOpenProto)(NetExHpContext *ctx); + typedef void (*NetExHpCloseProto)(NetExHpContext *ctx); + typedef void (*NetExHpDataProto)(NetExHpContext *ctx, void *buf, int len); + + // + // Structs. + // + + struct NetExHpContext + { + void *custom_; + void *eventBase_; + void *eventBuffer_; + + int workerNo_; + + NetExHpOpenProto openHandler_; + NetExHpCloseProto closeHandler_; + NetExHpDataProto dataHandler_; + + #ifdef NET_EX_USE_LIBSECURE + SecureConnection *sc_; + + char *secureCert_; + char *securePrivKey_; + char *securePrivKeyPass_; + #endif + + char clientIp_[16]; + }; + + // + // Exported functions. + // + + int NetExHpServerLoop(int port, NetExHpOpenProto openHandler, + NetExHpCloseProto closeHandler, + NetExHpDataProto dataHandler); + + int NetExHpSecureServerLoop(int port, NetExHpOpenProto openHandler, + NetExHpCloseProto closeHandler, + NetExHpDataProto dataHandler, + const char *cert, + const char *privKey, + const char *privKeyPass); + + int NetExHpWrite(NetExHpContext *ctx, void *buf, int len); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_LibNetEx_H */ diff --git a/Source/Net/LibNetEx/NetExHpServer.cpp b/Source/Net/LibNetEx/NetExHpServer.cpp new file mode 100644 index 0000000..c8350fc --- /dev/null +++ b/Source/Net/LibNetEx/NetExHpServer.cpp @@ -0,0 +1,1011 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Callback based server based on libevent toolkit. +// + +#include +#include +#include +#include +#include +#include + +using std::max; + +#ifdef WIN32 +# include +# include +#else +# include +# include +# ifdef _XOPEN_SOURCE_EXTENDED +# include +# endif +# include +#endif + +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include "NetEx.h" +#include "Utils.h" + +namespace Tegenaria +{ + using std::set; + + const int NET_EX_MAX_THREADS = 64; + + // + // Internal use only callbacks passed to libevent. + // + + static void NetExHpOpenCallback(evutil_socket_t, short, void *); + + static void NetExHpExitCallback(evutil_socket_t, short, void *); + + static void NetExHpEventCallback(struct bufferevent *, short, void *); + + static void NetExHpReadCallback(struct bufferevent *, void *); + + // + // Global variables. + // + + static struct event_base *EventBase[NET_EX_MAX_THREADS] = {0}; + + static int CpuCount = NetExGetCpuNumber(); + + static int ServerRunning = 0; + + // + // Map to check is given context correct. + // Debug purpose only. + // + + #ifdef NET_EX_CHECK_CTX + + static set CtxSet; + + static Mutex CtxSetMutex("NetExHpServer::CtxSetMutex"); + + #endif + + // + // Internal use only. Thread function falling into main libevent loop. + // We create one libevent loop for every CPU core inside NetExHpServerLoop(). + // + // ctx - HP context created inside NetExHpServerLoop() (IN). + // + + int NetExHpServerWorkerLoop(NetExHpContext *ctx) + { + int workerNo = ctx -> workerNo_; + + struct event_base *eventBase = (struct event_base *) ctx -> eventBase_; + + DBG_INFO("Created HP worker #%d.\n", workerNo); + + event_base_dispatch(eventBase); + + DBG_INFO("HP worker #%d finished.\n", workerNo); + } + + // + // Create TCP server based on libevent library. Traffic is encrypted + // basing on TLS protocol. + // + // port - listening port (IN). + // openHandler - handler called when new connection arrived (IN/OPT). + // closeHandler - handler called when existing connection closed (IN/OPT). + // + // dataHandler - handler called when something to read on one of existing + // connection (IN). + // + // secureCert - filename, where server certificate is stored (IN). + // + // securePrivKey - filename, where server private key is stored (server side + // only) (IN/OPT). + // + // securePrivKeyPass - passphrase to decode private key. Readed from keyboard + // if skipped (IN/OPT). + // + // + // TIP #1: Use NetExHpWrite() to write data inside data handler. Don't + // use write() or send() directly. + // + // RETURNS: never reached in correct work, + // -1 if error. + // + + int NetExHpSecureServerLoop(int port, NetExHpOpenProto openHandler, + NetExHpCloseProto closeHandler, + NetExHpDataProto dataHandler, + const char *secureCert, + const char *securePrivKey, + const char *securePrivKeyPass) + { + DBG_ENTER("NetExHpServerLoop"); + + int exitCode = -1; + + struct event *exitEvent = NULL; + + struct event *acceptEvent[NET_EX_MAX_THREADS] = {0}; + + ThreadHandle_t *workerThread[NET_EX_MAX_THREADS] = {0}; + + struct sockaddr_in sin = {0}; + + int listenfd = -1; + + int eventFlags = 0; + + int reuseaddr_on = 1; + + struct linger so_linger; + + NetExHpContext *ctx[NET_EX_MAX_THREADS] = {0}; + + // + // Set up pthread locking for multithreading on Linux + // + + #ifdef __linux__ + { + struct sigaction act = {0}; + + // + // Enable multithread support in livevent. + // + + evthread_use_pthreads(); + + // + // Ignore SIGPIPE on Linux. + // + + act.sa_handler = SIG_IGN; + act.sa_flags = SA_RESTART; + + sigaction(SIGPIPE, &act, NULL); + } + #endif + + // + // Fail if TLS requested without NET_EX_USE_LIBSECURE. + // + + #ifndef NET_EX_USE_LIBSECURE + { + if (secureCert || securePrivKey) + { + Error("ERROR: NetExHp server is compiled without LibSecure.\n" + "TLS server is not available.\n"); + + goto fail; + } + } + #endif + + // + // HP Server is not thread safe. It means one process can have only one + // (multithreaded) HP server running. + // + + FAILEX(ServerRunning, "ERROR: Only one HP server per process allowed.\n"); + + ServerRunning = 1; + + // + // Init WINSOCK2 on windows. + // + + #ifdef WIN32 + WSADATA wsadata; + WSAStartup(0x0201, &wsadata); + #endif + + // + // Create listening socket. + // + + listenfd = socket(AF_INET, SOCK_STREAM, 0); + + FAILEX(listenfd < 0, "ERROR: Cannot create listening socket.\n"); + + // + // Set SO_LINGER flag. + // + + so_linger.l_onoff = 1; + so_linger.l_linger = 0; + + setsockopt(listenfd, SOL_SOCKET, SO_LINGER, + (const char *) &so_linger, sizeof(so_linger)); + + // + // Set address reuse on listening socket. + // + + reuseaddr_on = 1; + + setsockopt(listenfd, SOL_SOCKET, SO_REUSEADDR, + (const char *) &reuseaddr_on, sizeof(reuseaddr_on)); + + // + // Bind socket to given port. + // + + sin.sin_family = AF_INET; + sin.sin_port = htons(port); + + FAILEX(bind(listenfd, (struct sockaddr *) &sin, sizeof(sin)), + "ERROR: Cannot bind lsitening socket to port %d.\n", port); + + // + // Start listening. + // + + FAILEX(listen(listenfd, SOMAXCONN) < 0, "ERROR: Listen() failed.\n"); + + DBG_INFO("NetExHpLoop : Listening on TCP port %d...\n", port); + + // + // Set nonblock mode on listening socket. + // + + FAILEX(evutil_make_socket_nonblocking(listenfd) < 0, + "ERROR: Cannot set non-blocking mode on listening socket.\n"); + + // + // Initialize event worker per every CPU core. + // + + for (int i = 0; i < CpuCount; i++) + { + // + // Create new event base object for worker. + // + + EventBase[i] = event_base_new(); + + FAILEX(EventBase[i] == NULL, "ERROR: Cannot initialize libevent.\n"); + + // + // Allocate new NetExHp context. + // + + ctx[i] = (NetExHpContext *) calloc(1, sizeof(NetExHpContext)); + + FAILEX(ctx[i] == NULL, "ERROR: Out of memory.\n"); + + ctx[i] -> eventBase_ = EventBase[i]; + ctx[i] -> openHandler_ = openHandler; + ctx[i] -> closeHandler_ = closeHandler; + ctx[i] -> dataHandler_ = dataHandler; + ctx[i] -> workerNo_ = i; + + // + // Save data to establish secure session on incoming connection. + // + + #ifdef NET_EX_USE_LIBSECURE + { + if (secureCert) + { + ctx[i] -> secureCert_ = strdup(secureCert); + } + + if (securePrivKey) + { + ctx[i] -> securePrivKey_ = strdup(securePrivKey); + } + + if (securePrivKeyPass) + { + ctx[i] -> securePrivKeyPass_ = strdup(securePrivKeyPass); + } + } + #endif + + // + // Create accept event for given event base. + // + + acceptEvent[i] = event_new(EventBase[i], listenfd, EV_READ | EV_PERSIST, + NetExHpOpenCallback, (void *) ctx[i]); + + FAILEX(acceptEvent[i] == NULL, "ERROR: Cannot initialize accept event.\n"); + + FAILEX(event_add(acceptEvent[i], NULL) < 0, + "ERROR: Cannot register accept event.\n"); + } + + // + // Initialize exit event to catch SIGINT (linux) or CTRL_BREAK (windows). + // + + /* + FIXME: Only one thread finished. + + exitEvent = evsignal_new(EventBase[0], SIGINT, + NetExHpExitCallback, NULL); + + FAILEX(exitEvent == NULL, "ERROR: Cannot initialize exit event.\n"); + + // + // Register exit event. + // + + FAILEX(event_add(exitEvent, NULL) < 0, + "ERROR: Cannot register exit event.\n"); + + */ + + // + // Create libevent loop in another thread for every CPU core. + // + + for (int i = 0; i < CpuCount; i++) + { + workerThread[i] = ThreadCreate(NetExHpServerWorkerLoop, ctx[i]); + } + + // + // Wait until every workers finished. + // + + for (int i = 0; i < CpuCount; i++) + { + ThreadWait(workerThread[i]); + ThreadClose(workerThread[i]); + workerThread[i] = NULL; + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot initialize HP server loop on port %d.\n" + "Error code is : %d.\n", port, GetLastError()); + } + + if (exitEvent) + { + event_free(exitEvent); + } + + for (int i = 0; i < CpuCount; i++) + { + if (acceptEvent[i]) + { + event_free(acceptEvent[i]); + } + + if (EventBase[i]) + { + event_base_free(EventBase[i]); + } + + if (ctx[i]) + { + #ifdef NET_EX_USE_LIBSECURE + { + if (ctx[i] -> secureCert_) + { + free(ctx[i] -> secureCert_); + } + + if (ctx[i] -> securePrivKey_) + { + free(ctx[i] -> securePrivKey_); + } + + if (ctx[i] -> securePrivKeyPass_) + { + free(ctx[i] -> securePrivKeyPass_); + } + } + #endif + + free(ctx[i]); + } + } + + ServerRunning = 0; + + DBG_LEAVE("NetExHpServerLoop"); + + return exitCode; + } + + // + // Create TCP server based on libevent library. + // + // port - listening port (IN). + // openHandler - handler called when new connection arrived (IN/OPT). + // closeHandler - handler called when existing connection closed (IN/OPT). + // + // dataHandler - handler called when something to read on one of existing + // connection (IN). + // + // TIP #1: Use NetExHpWrite() to write data inside data handler. Don't + // use write() or send() directly. + // + // TIP #2: Use NetExHpSecureServerLoop() to create TLS encrypted server. + // + // RETURNS: never reached in correct work, + // -1 if error. + // + + int NetExHpServerLoop(int port, NetExHpOpenProto openHandler, + NetExHpCloseProto closeHandler, + NetExHpDataProto dataHandler) + { + return NetExHpSecureServerLoop(port, openHandler, closeHandler, + dataHandler, NULL, NULL, NULL); + } + + // + // Write bytes remote client related with given NetExHpContext. + // + // TIP #1: Caller should use this function to write data + // to remote client inside data handler specified to + // NetExServerLoop(). Don't use write() or send() directly. + // + // ctx - context received in data handler parameters (IN). + // buf - buffer with data to write (IN). + // len - how many bytes to write (IN). + // + // RETURNS: Number of bytes written or + // -1 if error. + // + + int NetExHpWrite(NetExHpContext *ctx, void *buf, int len) + { + DBG_ENTER3("NetExHpWrite"); + + int ret = -1; + + // + // Debug purpose only. + // Track created contexts. + // + + #ifdef NET_EX_CHECK_CTX + { + CtxSetMutex.lock(); + + if (CtxSet.count(ctx) == 0) + { + Fatal("FATAL: Context PTR#%p does not exist in NetExHpContext().\n", ctx); + } + + CtxSetMutex.unlock(); + } + #endif + + // + // Use LibSecure. + // + + #ifdef NET_EX_USE_LIBSECURE + { + if (ctx) + { + bufferevent *bev = (bufferevent *) ctx -> eventBuffer_; + + // + // TLS encrypted session. + // + + if (ctx -> sc_) + { + int encryptBufferSize = max(8096, len * 2); + + char *encryptBuffer = (char *) malloc(encryptBufferSize); + + FAILEX(encryptBuffer == NULL, "ERROR: Out of memory.\n"); + + // + // Encrypt outcoming data before send. + // + + encryptBufferSize = ctx -> sc_ -> encrypt(encryptBuffer, + encryptBufferSize, buf, len); + + // + // Send encrypted data to client. + // + + if (bufferevent_write(bev, encryptBuffer, encryptBufferSize) == 0) + { + ret = len; + } + + free(encryptBuffer); + } + + // + // Non-TLS unecrypted session. + // + + else + { + if (bufferevent_write(bev, buf, len) == 0) + { + ret = len; + } + } + } + } + + // + // LibSecure disabled. + // + + #else + { + // + // Write data into libevent buffer. + // + + if (ctx) + { + bufferevent *bev = (bufferevent *) ctx -> eventBuffer_; + + if (bufferevent_write(bev, buf, len) == 0) + { + ret = len; + } + } + } + #endif + + fail: + + DBG_ENTER3("NetExHpWrite"); + + return ret; + } + + // + // Callback called when new connection arrived. + // + + static void NetExHpOpenCallback(evutil_socket_t fd, short ev, void *data) + { + DBG_ENTER3("NetExHpOpenCallback"); + + int exitCode = -1; + + struct event_base *eventBase = NULL; + + struct bufferevent *eventBuffer = NULL; + + NetExHpContext *serverCtx = NULL; + + NetExHpContext *ctx = NULL; + + int clientfd = -1; + + struct sockaddr_in client_addr = {0}; + + socklen_t client_len = sizeof(client_addr); + + // + // Get back main HP server loop context from data pointer. + // + + serverCtx = (NetExHpContext *) data; + + // + // Allocate HP context for new connection. + // + + ctx = (NetExHpContext *) calloc(1, sizeof(NetExHpContext)); + + FAILEX(ctx == NULL, "ERROR: Out of memory.\n"); + + // + // Accept conncetion. + // + + clientfd = accept(fd, (struct sockaddr *) &client_addr, &client_len); + + FAIL(clientfd < 0); + + // + // Save client IP in connection context. + // + + strncpy(ctx -> clientIp_, + inet_ntoa(client_addr.sin_addr), + sizeof(ctx -> clientIp_) - 1); + + // + // Initialize new event buffer for new connection. + // + + eventBase = (event_base *) serverCtx -> eventBase_; + + eventBuffer = bufferevent_socket_new(eventBase, clientfd, BEV_OPT_CLOSE_ON_FREE); + + FAILEX(eventBuffer == NULL, "ERROR: Cannot create event buffer.\n"); + + // + // Debug purpose only. + // Track created contexts. + // + + #ifdef NET_EX_CHECK_CTX + { + CtxSetMutex.lock(); + CtxSet.insert(ctx); + CtxSetMutex.unlock(); + } + #endif + + // + // Init secure context for secure connection. + // + + #ifdef NET_EX_USE_LIBSECURE + { + // + // TLS encrypted session. Init secure context. + // + + if (serverCtx -> secureCert_ && serverCtx -> securePrivKey_) + { + ctx -> sc_ = SecureConnectionCreate(SECURE_INTENT_SERVER, + serverCtx -> secureCert_, + serverCtx -> securePrivKey_, + serverCtx -> securePrivKeyPass_); + FAILEX(ctx -> sc_ == NULL, + "ERROR: Cannot init secure context for new connection.\n"); + } + } + #endif + + // + // Call underlying open handler if specified. + // + + ctx -> openHandler_ = serverCtx -> openHandler_; + ctx -> closeHandler_ = serverCtx -> closeHandler_; + ctx -> dataHandler_ = serverCtx -> dataHandler_; + ctx -> workerNo_ = serverCtx -> workerNo_; + ctx -> eventBuffer_ = eventBuffer; + + if (ctx -> openHandler_) + { + ctx -> openHandler_(ctx); + } + + // + // Set event and read callbacks. + // + + bufferevent_setcb(eventBuffer, NetExHpReadCallback, + NULL, NetExHpEventCallback, ctx); + + bufferevent_enable(eventBuffer, EV_READ); + + // + // Error handler. + // Accept failed or already accepted from another libevent loop. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + // + // Clean up on error. + // + + if (clientfd > 0) + { + #ifdef WIN32 + closesocket(clientfd); + #else + close(clientfd); + #endif + } + + if (ctx) + { + #ifdef NET_EX_USE_LIBSECURE + { + if (ctx -> sc_) + { + ctx -> sc_ -> release(); + + ctx -> sc_ = NULL; + } + } + #endif + + free(ctx); + } + } + + DBG_LEAVE3("NetExHpOpenCallback"); + } + + // + // Callback called when new data arrived. + // + + static void NetExHpReadCallback(struct bufferevent *bev, void *data) + { + DBG_ENTER3("NetExHpReadCallback"); + + NetExHpContext *ctx = (NetExHpContext *) data; + + // + // Get event input buffer. + // + + struct evbuffer *input = bufferevent_get_input(bev); + + size_t len = evbuffer_get_length(input); + + unsigned char *buf = evbuffer_pullup(input, len); + + // + // Use TLS secure connection. + // + + #ifdef NET_EX_USE_LIBSECURE + { + // + // TLS encrypted session enabled. + // + + if (ctx && ctx -> sc_) + { + switch(ctx -> sc_ -> getState()) + { + case SECURE_STATE_ESTABLISHED: + { + char *decryptBuffer = (char *) malloc(len); + + int decryptBufferSize = len; + + FAILEX(decryptBuffer == NULL, "ERROR: Out of memory.\n"); + + // + // Decrypt incoming data into buffer[]. + // + + decryptBufferSize = ctx -> sc_ -> decrypt(decryptBuffer, + decryptBufferSize, + buf, len); + + // + // Call underlying data handler with decrypted buffer. + // + + if (ctx -> dataHandler_) + { + ctx -> dataHandler_(ctx, decryptBuffer, decryptBufferSize); + } + + free(decryptBuffer); + + break; + } + + // + // SSL Handshake is pending. + // We must handle it by own. + + case SECURE_STATE_HANDSHAKE_READ: + case SECURE_STATE_HANDSHAKE_WRITE: + { + char toWrite[1024]; + + int toWriteSize = 1024; + + if (ctx -> sc_ -> handshakeStep(toWrite, &toWriteSize, buf, len) == 0) + { + // + // Write handshake data to client. + // + + if (toWriteSize > 0) + { + bufferevent *bev = (bufferevent *) ctx -> eventBuffer_; + + bufferevent_write(bev, toWrite, toWriteSize); + } + } + + // + // Handshake error. Close connection. + // + + else + { + NetExHpEventCallback(bev, 0, ctx); + + bev = NULL; + } + + break; + } + } + } + + // + // Non-TLS pure unencrypted session. + // + + else + { + // + // Call underlying data handler if exist. + // + + if (ctx && ctx -> dataHandler_) + { + ctx -> dataHandler_(ctx, buf, len); + } + } + } + + // + // Don't use LibSecure. Only pure TCP server. + // + + #else + { + // + // Call underlying data handler if exist. + // + + if (ctx && ctx -> dataHandler_) + { + ctx -> dataHandler_(ctx, buf, len); + } + } + #endif + + // + // Clean up. + // + + fail: + + // + // Pop processed data from event buffer. + // + + if (bev) + { + evbuffer_drain(input, len); + } + + DBG_LEAVE3("NetExHpReadCallback"); + } + + // + // Callback called when connection closed. + // + + static void NetExHpEventCallback(struct bufferevent *bev, + short events, void *data) + { + DBG_ENTER3("NetExHpEventCallback"); + + NetExHpContext *ctx = (NetExHpContext *) data; + + if (ctx) + { + if (ctx -> closeHandler_) + { + ctx -> closeHandler_(ctx); + } + + // + // Debug purpose only. + // Track created contexts. + // + + #ifdef NET_EX_CHECK_CTX + { + CtxSetMutex.lock(); + + if (CtxSet.count(ctx) == 0) + { + Fatal("FATAL: Context PTR #%p does not exists in NetExHpEventCallback().\n", ctx); + } + + CtxSet.erase(ctx); + + CtxSetMutex.unlock(); + } + #endif + + // + // Free secure context if needed. + // + + #ifdef NET_EX_USE_LIBSECURE + { + if (ctx -> sc_) + { + ctx -> sc_ -> release(); + + ctx -> sc_ = NULL; + } + } + #endif + + // + // Free context. + // + + free(ctx); + } + + bufferevent_free(bev); + + DBG_LEAVE3("NetExHpEventCallback"); + } + + // + // Callback called when SIGINT handled. + // + + static void NetExHpExitCallback(evutil_socket_t sig, short events, void *data) + { + DBG_INFO("NetExHpExitCallback : CTRL_BREAK received. Going to shutdown...\n"); + + for (int i = CpuCount - 1; i >= 0; i--) + { + event_base_loopbreak(EventBase[i]); + } + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNetEx/Utils.cpp b/Source/Net/LibNetEx/Utils.cpp new file mode 100644 index 0000000..352cfe7 --- /dev/null +++ b/Source/Net/LibNetEx/Utils.cpp @@ -0,0 +1,80 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 + +#ifndef WIN32 +# include +# include +# include +# include +# include +#endif + +#include +#include + +namespace Tegenaria +{ + // + // Return number of CPU cores installed on system. + // + + int NetExGetCpuNumber() + { + DBG_ENTER("GetCpuNumber"); + + static int cpuCount = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + if (cpuCount == -1) + { + SYSTEM_INFO si = {0}; + + GetSystemInfo(&si); + + cpuCount = si.dwNumberOfProcessors; + } + } + + // + // Linux, MacOS. + // + + #else + { + cpuCount = sysconf(_SC_NPROCESSORS_ONLN); + } + #endif + + DBG_LEAVE("GetCpuNumber"); + + return cpuCount; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibNetEx/Utils.h b/Source/Net/LibNetEx/Utils.h new file mode 100644 index 0000000..e636414 --- /dev/null +++ b/Source/Net/LibNetEx/Utils.h @@ -0,0 +1,40 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_NetEx_Utils_H +#define Tegenaria_Core_NetEx_Utils_H + +#ifdef WIN32 +# include +#else +# include +#endif + +namespace Tegenaria +{ + int NetExGetCpuNumber(); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_NetEx_Utils_H */ diff --git a/Source/Net/LibNetEx/qcbuild.src b/Source/Net/LibNetEx/qcbuild.src new file mode 100644 index 0000000..9c09c8a --- /dev/null +++ b/Source/Net/LibNetEx/qcbuild.src @@ -0,0 +1,45 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibNetEx + +# +# Component's info. +# + +PURPOSE = High-level network functions depending on third part libraries. +AUTHOR = Sylwester Wysocki + +INC_DIR = Tegenaria +ISRC = NetEx.h +CXXSRC = NetExHpServer.cpp Utils.cpp + +LIBS = -levent-static -ldebug -llock -lthread -lsecure -lcrypto -lssl + +.section Linux +LIBS += -levent_pthreads-static +.endsection + +DEPENDS = libevent LibDebug LibLock LibThread LibSecure diff --git a/Source/Net/LibSecure/Acl.cpp b/Source/Net/LibSecure/Acl.cpp new file mode 100644 index 0000000..4c3a345 --- /dev/null +++ b/Source/Net/LibSecure/Acl.cpp @@ -0,0 +1,562 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Generic implementation of access lists. +// + +#include "Secure.h" + +namespace Tegenaria +{ + // + // Create empty, NULL access list. + // + + SecureAcl::SecureAcl() + { + this -> clear(); + } + + // + // Init access list from raw string. + // + // String format is: "user1:rights1;user2:rights2...*:otherRights" + // + // Example lists are: + // + // "jan:R;jozek:F;*:D" - jan can read, jozek can read and write, others have no access + // "jan:F;*:R" - jan can read and write, others can read only + // "*:F" - all can read and write + // "*:D" - nobody have access + // "" - invalid data, * terminator missing. + // + // R = read only + // F = full access + // D = access denied + // + // * = others users not included in list explicite. SHOULD be the + // last entry on the access list. + // + // Parameters: + // + // acl - string containing correct access list in format describet above (IN). + // + // RETURNS: 0 if OK, + // -1 otherwise. + // + + int SecureAcl::initFromString(const char *acl) + { + DBG_ENTER3("SecureAcl::initFromString"); + + int exitCode = -1; + + char *tmp = NULL; + char *token = NULL; + char *user = NULL; + char *rights = NULL; + char *delim = NULL; + + // + // Clear current list on startup. + // + + this -> clear(); + + // + // Check args. + // + + FAILEX(acl == NULL, "ERROR: 'acl' cannot be NULL in SeucureAcl::initFromString().\n"); + + // + // Duplicate input string. + // We will tokenize it with destructive way. + // + + tmp = strdup(acl); + + // + // Tokenize input string. + // We except list in format: "user1:rights1;user2:rights2;..." + // + + token = strtok(tmp, ";"); + + while(token) + { + // + // One element is user:rights. + // Split into user and message part. + // + + delim = strchr(token, ':'); + + FAILEX(delim == NULL, "ERROR: Missing ':' delimer in ACL string.\n"); + + *delim = 0; + + user = token; + rights = delim + 1; + + // + // Put to rights into user |-> rights map. + // + + DEBUG3("SecureAcl::initFromString : Granting rights [%s] to [%s].\n", rights, user); + + rights_[user] = encodeRights(rights); + + // + // Go to next entry on list. + // + + token = strtok(NULL, ";"); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot init access list object from '%s' string.\n", acl); + + this -> clear(); + } + + if (tmp) + { + free(tmp); + } + + DBG_LEAVE3("SecureAcl::initFromString"); + + return exitCode; + } + + // + // Set user rights to given value. + // + // WARNING#1: If user has already some rights granted function will OVERWRITE + // them with new one. + // + // TIP#1: To read back rights granted to user use getRights() method. + // + // user - username, which we want grant rights to (IN). + // + // rights - rights, which we want to grant in binary representation i.e. + // combination of SECURE_ACL_XXX flags defined in Secure.h (IN). + // + // RETURNS: 0 if OK. + // + + int SecureAcl::setRights(const char *user, int rights) + { + DBG_ENTER3("SecureAcl::setRights"); + + int exitCode = -1; + + // + // Check args. + // + + FAILEX(user == NULL, "ERROR: 'user' cannot be NULL in SecureAcl::setRights().\n"); + + // + // Grant rights to user. + // + + rights_[user] = rights; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("SecureAcl::setRights"); + + return exitCode; + } + + // + // Set user rights to given value. + // + // WARNING#1: If user has already some rights granted function will OVERWRITE + // them with new one. + // + // TIP#1: To read back rights granted to user use getRights() method. + // + // user - username, which we want grant rights to (IN). + // + // rights - rights, which we want to grant as human readable string i.e. + // combination of SECURE_ACL_SYMBOL_XXX chars defined in Secure.h. + // Example string is "D" (deny) or "F" (Full access) (IN). + // + // RETURNS: 0 if OK. + // + + int SecureAcl::setRights(const char *user, const char *rights) + { + return this -> setRights(user, encodeRights(rights)); + } + + // + // Set rights granted to others users to given value. Others means all users + // not mentioned in ACL explicite. + // + // WARNING#1: If others has already some rights granted function will OVERWRITE + // them with new one. + // + // rights - rights, which we want to grant in binary representation i.e. + // combination of SECURE_ACL_XXX flags defined in Secure.h (IN). + // + // RETURNS: 0 if OK. + // + + int SecureAcl::setOthersRights(int rights) + { + return this -> setRights("*", rights); + } + + // + // Set rights granted to others users to given value. Others means all users + // not mentioned in ACL explicite. + // + // WARNING#1: If others has already some rights granted function will OVERWRITE + // them with new one. + // + // rights - rights, which we want to grant as human readable string i.e. + // combination of SECURE_ACL_SYMBOL_XXX chars defined in Secure.h. + // Example string is "D" (deny) or "F" (Full access) (IN). + // + // RETURNS: 0 if OK. + // + + int SecureAcl::setOthersRights(const char *rights) + { + return this -> setRights("*", encodeRights(rights)); + } + + // + // Remove user from accesslist. After that user has no any rights granted. + // + // user - user, which we want revoke rights for (IN). + // + // RETURNS: 0 if OK. + // + + int SecureAcl::revokeAll(const char *user) + { + DBG_ENTER3("SecureAcl::revokeAll"); + + int exitCode = -1; + + // + // Check args. + // + + FAILEX(user == NULL, "ERROR: 'user' cannot be NULL in SecureAcl::revokeAll().\n"); + + // + // Remove user from righrs map. + // + + rights_.erase(user); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("SecureAcl::removeAll"); + + return exitCode; + } + + // + // Gather rights for given users. + // + // user - name of user, which we want rights for (IN). + // + // RETURNS: Rights granted to given user. + // + + int SecureAcl::getRights(const char *user) + { + DBG_ENTER3("SecureAcl::getRights"); + + int ret = SECURE_ACL_DENY; + + map::iterator it; + + // + // Check args. + // + + FAILEX(user == NULL, "ERROR: 'User' cannot be NULL in SecureAcl::getRights().\n"); + + // + // Try find user in rights map. + // + + it = rights_.find(user); + + // + // User exists in map, get rights from map. + // + + if (it != rights_.end()) + { + ret = it -> second; + } + + // + // User does not exist in map, get rights for others user (*). + // + + else + { + ret = rights_["*"]; + } + + // + // Error handler. + // + + fail: + + DBG_LEAVE3("SecureAcl::getRights"); + + return ret; + } + + // + // Gather rights for given users. + // + // user - name of user, which we want rights for (IN). + // + // RETURNS: Rights granted to given user as human readable string. + // + + string SecureAcl::getRightsString(const char *user) + { + return decodeRights(this -> getRights(user)); + } + + // + // Convert access list stored inside object into ACL string. + // + + string SecureAcl::toString() + { + DBG_ENTER3("SecureAcl::toString"); + + string ret; + + int othersRights; + + map::iterator it; + + // + // Iterate over whole [user] |-> [rights] map. + // + + for (it = rights_.begin(); it != rights_.end(); it++) + { + // + // Others rights. Save for future. + // We want put it as last entry in string. + // + + if (it -> first == "*") + { + othersRights = it -> second; + } + + // + // Ordinary user, put to string. + // + + else + { + ret += it -> first; + ret += ':'; + ret += decodeRights(it -> second); + ret += ';'; + } + } + + // + // Add others rights as * keyword. + // + + ret += "*:"; + ret += decodeRights(othersRights); + ret += ';'; + + DBG_LEAVE3("SecureAcl::toString"); + + return ret; + } + + // + // Revoke all grant from all users stored accesslist. + // + + void SecureAcl::clear() + { + DBG_ENTER3("SecureAcl::clear"); + + rights_.clear(); + + rights_["*"] = SECURE_ACL_DENY; + + DBG_LEAVE3("SecureAcl::clear"); + } + + // + // Encode rights string into its binary representation. + // Rights in binary representation is combination of SECURE_ACL_XXX flags + // defined in Secure.h file. + // + // WARNING#1: If input rights string is incorrect function assign SECURE_ACL_DENY + // rights value. + // + // rights - human readable string representing rights to encode, for list of + // allowed chars see SECURE_ACL_SYMBOL_XXX defines in Secure.h (IN). + // + // RETURNS: Binary representation of rights. + // + + int SecureAcl::encodeRights(const char *str) + { + DBG_ENTER3("SecureAcl::encodeRights"); + + int rights = 0; + + // + // Translate rights from string into rights codes. + // + + if (str) + { + for (int i = 0; str[i]; i++) + { + switch(str[i]) + { + case SECURE_ACL_SYMBOL_DENY : rights |= SECURE_ACL_DENY; break; + case SECURE_ACL_SYMBOL_FULL : rights |= SECURE_ACL_FULL; break; + case SECURE_ACL_SYMBOL_READ : rights |= SECURE_ACL_READ; break; + case SECURE_ACL_SYMBOL_WRITE : rights |= SECURE_ACL_WRITE; break; + case SECURE_ACL_SYMBOL_ERASE : rights |= SECURE_ACL_ERASE; break; + } + } + } + + // + // Normalize rights. + // + + if ((rights == 0) || (rights & SECURE_ACL_DENY)) + { + rights = SECURE_ACL_DENY; + } + else if (rights & SECURE_ACL_FULL) + { + rights = SECURE_ACL_FULL; + } + + DBG_LEAVE3("SecureAcl::encodeRights"); + + return rights; + } + + // + // Decode rights value into string. + // String contains chars representing single rights eg. "RW" means READ+WRITE. + // Full list of allowed rights chars is defined at SECURE_ACL_SYMBOL_XXX defines + // in Secure.h file + // + // WARNING#1: If input rights value is incorrect function assign "D" (access denied) + // rights. + // + // rights - binary encoded rights i.e. combination of SECURE_ACL_XXX flags + // defined in Secure.h (IN). + // + // RETURNS: Human readable string representing rights. + // + + string SecureAcl::decodeRights(int rights) + { + DBG_ENTER3("SecureAcl::decodeRights"); + + string ret; + + // + // Deny. + // + + if ((rights == 0) || (rights & SECURE_ACL_DENY)) + { + ret = SECURE_ACL_SYMBOL_DENY; + } + + // + // Full. + // + + else if (rights & SECURE_ACL_FULL) + { + ret = SECURE_ACL_SYMBOL_FULL; + } + + // + // Complex list. + // Create composition from single rights. + // + + else + { + if (rights & SECURE_ACL_READ) ret += SECURE_ACL_SYMBOL_READ; + if (rights & SECURE_ACL_WRITE) ret += SECURE_ACL_SYMBOL_WRITE; + if (rights & SECURE_ACL_ERASE) ret += SECURE_ACL_SYMBOL_ERASE; + } + + DBG_LEAVE3("SecureAcl::decodeRights"); + + return ret; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibSecure/Cipher.cpp b/Source/Net/LibSecure/Cipher.cpp new file mode 100644 index 0000000..a7276a3 --- /dev/null +++ b/Source/Net/LibSecure/Cipher.cpp @@ -0,0 +1,261 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: General encryption/decryption routines working on raw buffers. +// + +#include "Secure.h" +#include "Internal.h" + +#ifdef WIN64 + static int Win64NotImportedError() + { + fprintf(stderr, "OpenSSL is not imported on Win64"); + exit(-1); + } + + #define BF_cfb64_encrypt(a, b, c, d, e, f, g) Win64NotImportedError() + #define BF_set_key(a, b, c) Win64NotImportedError() +#endif + +namespace Tegenaria +{ + // + // Encrypt data. + // + // ctx - secure context containing cipher state created by + // SecureCipherCreate before (IN/OUT). + // + // buffer - buffer to encrypt (IN/OUT). + // + // size - size of buffer[] in bytes (IN). + // + + void SecureEncrypt(SecureCipher *ctx, void *buffer, int size) + { + DBG_ENTER3("SecureEncrypt"); + + unsigned char iv[16]; + + int num = 0; + + int *piv = (int *) iv; + + memcpy(iv, ctx -> iv_, 16); + + // + // Apply counter number for CTR mode. + // + + if (ctx -> cipherMode_ == SECURE_CIPHER_MODE_CTR) + { + (*piv) ^= ctx -> counterEncrypt_; + + ctx -> counterEncrypt_ ++; + } + + // + // Encrypt data. + // + + BF_cfb64_encrypt((unsigned char *) buffer, (unsigned char *) buffer, + size, &(ctx -> key_), (unsigned char *) iv, &num, BF_ENCRYPT); + + DBG_LEAVE3("SecureEncrypt"); + } + + // + // Decrypt data. + // + // ctx - secure context containing cipher state created by + // SecureCipherCreate before (IN/OUT). + // + // buffer - buffer to decrypt (IN/OUT). + // + // size - size of buffer[] in bytes (IN). + // + + void SecureDecrypt(SecureCipher *ctx, void *buffer, int size) + { + DBG_ENTER("SecureDecrypt"); + + unsigned char iv[16]; + + int num = 0; + + int *piv = (int *) iv; + + memcpy(iv, ctx -> iv_, 16); + + // + // Apply counter number for CTR mode. + // + + if (ctx -> cipherMode_ == SECURE_CIPHER_MODE_CTR) + { + (*piv) ^= ctx -> counterDecrypt_; + + ctx -> counterDecrypt_ ++; + } + + // + // Decrypt data. + // + + BF_cfb64_encrypt((unsigned char *) buffer, (unsigned char *) buffer, + size, &(ctx -> key_), (unsigned char *) iv, &num, BF_DECRYPT); + + DBG_LEAVE3("SecureDecrypt"); + } + + // + // Create secure context object to track state of encrypt/decrypt process. + // + // TIP#1: Use SecureEncrypt to encrypt data using created context. + // TIP#2: Use SecureDecrypt to decrypt data using created context. + // + // cipher - cipher to use, see SECURE_CIPHER_XXX defines in Secure.h (IN). + // + // cipherMode - the way how encrpted blocks are joined into stream, + // see SECURE_CIPHER_MODE_XXX defines in Secure.h (IN). + // + // key - symmetric key to use (IN). + // keySize - size of key[] buffer in bytes (IN). + // iv - init vector, can be treated as second part of key (IN). + // ivSize - size of iv[] buffer in bytes (IN). + // + + SecureCipher *SecureCipherCreate(int cipher, int cipherMode, + const char *key, int keySize, + const char *iv, int ivSize) + { + DBG_ENTER("SecureCipherCreate"); + + int exitCode = -1; + + // + // Allocate context buffer. + // + + SecureCipher *ctx = (SecureCipher *) calloc(sizeof(SecureCipher), 1); + + ctx -> cipher_ = cipher; + ctx -> cipherMode_ = cipherMode; + + // + // Init selected cipher. + // + + switch(cipher) + { + // + // Blowfish. + // + // Save iv vector and set key. + // + + case SECURE_CIPHER_BLOWFISH: + { + // + // Check iv[] length. + // + + FAILEX(ivSize != SECURE_BLOWFISH_KEY_SIZE, + "ERROR: iv[] musts have %d bytes long for blowfish cipher.\n", + SECURE_BLOWFISH_KEY_SIZE); + + // + // Check key[] length. + // + + FAILEX(keySize != SECURE_BLOWFISH_KEY_SIZE, + "ERROR: key[] musts have %d bytes long for blowfish cipher.\n", + SECURE_BLOWFISH_KEY_SIZE); + + // + // Save iv[] vector. + // + + memcpy(ctx -> iv_, iv, ivSize); + + // + // Set blowfish key. + // + + BF_set_key(&(ctx -> key_), keySize, (unsigned char *) key); + + break; + } + + // + // Unknown cipher. + // + + default: + { + Error("ERROR: Unsupported cipher '%d'.\n", cipher); + + goto fail; + } + } + + // + // Error handler. + // + + exitCode = 0; + + if (exitCode) + { + Error("Cannot init cipher context '%d' mode '%d'.\n", cipher, cipherMode); + + SecureCipherDestroy(ctx); + + ctx = NULL; + } + + fail: + + DBG_LEAVE("SecureCipherCreate"); + + return ctx; + } + + // + // Free secure context created by SecureCipherCreate() before. + // + + void SecureCipherDestroy(SecureCipher *ctx) + { + DBG_ENTER("SecureCipherDestroy"); + + if (ctx) + { + free(ctx); + } + + DBG_LEAVE("SecureCipherDestroy"); + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibSecure/Connection.cpp b/Source/Net/LibSecure/Connection.cpp new file mode 100644 index 0000000..e04f4da --- /dev/null +++ b/Source/Net/LibSecure/Connection.cpp @@ -0,0 +1,1449 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// WARNING! +// To create fully secure connection we need two steps: +// +// 1. Create secure TLS session - after that transfered data are encrypted +// and *NOT READABLE* by third parties, +// +// 2. validate *WHO is ON THE OTHER SIDE* basing on data from certificate, +// e.g. by check domain name. +// +// Below code performs (1) but does *NOT* perform (2). +// Caller *SHOULD* deliver own mechanism to check does data delivered +// within certificate are match to what he's expecting. +// + +// +// Purpose: Wrap existing unsecure connection into secure one. +// +// Source unsecure connection can be defined in follow ways: +// +// - {read, write} callbacks +// - {FDin, FDout} pair +// - socket +// +// - custom, caller must use SecureEncrypt before every write operation and +// SecureDecrypt afrer every read operation manually +// + +#include "Secure.h" + +#ifdef WIN64 + static int Win64NotImportedError() + { + fprintf(stderr, "OpenSSL is not imported on Win64"); + exit(-1); + } + + #define SSL_write(x, y, z) Win64NotImportedError() + #define SSL_read(x, y, z) Win64NotImportedError() + #define SSL_free(x) Win64NotImportedError() + #define SSL_CTX_free(x) Win64NotImportedError() + #define SSL_is_init_finished(x) Win64NotImportedError() + #define SSL_do_handshake(x) Win64NotImportedError() + #define BIO_read(x, y, z) Win64NotImportedError() + #define BIO_write(x, y, z) Win64NotImportedError() + #define SSL_library_init() Win64NotImportedError() + #define SSL_CTX_new(x) (SSL_CTX *) Win64NotImportedError() + #define SSL_CTX_use_certificate_chain_file(x, y) Win64NotImportedError() + #define SSL_CTX_set_default_passwd_cb(x, y) Win64NotImportedError() + #define SSL_CTX_set_default_passwd_cb_userdata(x, y) Win64NotImportedError() + #define SSL_CTX_use_PrivateKey_file(x, y, z) Win64NotImportedError() + #define SSL_CTX_use_certificate_file(x, y, z) Win64NotImportedError() + #define SSL_CTX_set_options(x, y) Win64NotImportedError() + #define SSL_CTX_set_session_id_context(x, y, z) Win64NotImportedError() + #define SSL_new(x) (SSL *) Win64NotImportedError() + #define SSL_set_accept_state(x) Win64NotImportedError() + #define SSL_set_verify(x, y, z) Win64NotImportedError() + #define SSL_set_session_id_context(x, y, z) Win64NotImportedError() + #define BIO_s_mem() Win64NotImportedError() + #define SSL_set_connect_state(x) Win64NotImportedError() + #define BIO_new(x) (BIO *) Win64NotImportedError() + #define BIO_set_nbio(x, y) Win64NotImportedError() + #define SSL_set_bio(x, y, z) Win64NotImportedError() +#endif + +namespace Tegenaria +{ + // + // Write bytes directly to underlying IO skipping SSL object beetwen. + // + // Used internally only. + // + // buf - source buffer with data, which we want to write (IN). + // len - number of bytes to write (IN). + // timeout - timeout in ms, set to -1 for infinite (IN). + // + // RETURNS: Number of bytes written or + // -1 if error. + // + + int SecureConnection::writeRaw(const void *buf, int len, int timeout) + { + DBG_ENTER3("SecureConnection::writeRaw"); + + int written = -1; + + // + // Write data to underlying IO. + // + + switch(ioMode_) + { + // + // Underlying IO is defined by {read, write, cancel} callbacks. + // + + case SECURE_IOMODE_CALLBACKS: + { + written = writeCallback_(buf, len, -1, ioCtx_); + + break; + } + + // + // Underlying IO is defined as FD pair. + // + + case SECURE_IOMODE_FDS: + { + if (timeout > 0) + { + Error("ERROR: Timeout not implemented for FDs yet in SecureConnection::writeRaw().\n"); + } + + written = ::write(fdOut_, buf, len); + + break; + } + + // + // Underlying IO is a socket. + // + + case SECURE_IOMODE_SOCKET: + { + if (timeout > 0) + { + Error("ERROR: Timeout not implemented for SOCKET yet in SecureConnection::writeRaw().\n"); + } + + written = send(sock_, (char *) buf, len, 0); + + break; + } + } + + DBG_LEAVE3("SecureConnection::writeRaw"); + + return written; + } + + // + // Read data directly from underlying IO (without parsing it via SSL + // object). + // + // Used internally only. + // + // buf - destination buffer, where to write readed data (OUT). + // len - number of bytes to read (IN). + // timeout - timeout in ms, set -1 to infinity (IN). + // + // RETURNS: Number of bytes readed or + // -1 if error. + // + + int SecureConnection::readRaw(void *buf, int len, int timeout) + { + DBG_ENTER3("SecureConnection::readRaw"); + + int written = -1; + int readed = -1; + + // + // Read data from underlying IO. + // + + switch(ioMode_) + { + // + // Underlying IO is defined as {read, write, cancel} callbacks. + // + + case SECURE_IOMODE_CALLBACKS: + { + readed = readCallback_(buf, len, timeout, ioCtx_); + + break; + } + + // + // Underlying IO is defined as FD pair. + // + + case SECURE_IOMODE_FDS: + { + if (timeout > 0) + { + Error("WARNING: Timeout is not available for FDs yet in SecureConnection::readRaw().\n"); + } + + readed = ::read(fdIn_, buf, len); + + break; + } + + // + // Underlying IO is a socket. + // + + case SECURE_IOMODE_SOCKET: + { + if (timeout > 0) + { + Error("WARNING: Timeout is not available for SOCKETs yet in SecureConnection::readRaw().\n"); + } + + readed = recv(sock_, (char *) buf, len, 0); + + break; + } + } + + DBG_ENTER3("SecureConnection::readRaw"); + + return readed; + } + + // + // Encrypt message. + // + // encrypted - buffer, where to store encrypted message (OUT). + // encryptedSize - size of encrypted[] buffer in bytes (IN). + // buffer - source buffer with data to encrypt (IN). + // bufferSize - number of bytes to be encrypted (IN). + // + // RETURNS: Length of encrypted data written to encrypted[] in bytes or + // -1 if error. + // + + int SecureConnection::encrypt(void *encrypted, int encryptedSize, + const void *buffer, int bufferSize) + { + DBG_ENTER3("SecureConnection::encrypt"); + + int readed = 0; + + // + // Pass unecrypted message to SSL BIO. + // + + SSL_write(ssl_, buffer, bufferSize); + + // + // Read back encrypted message from SSL. + // + + readed = BIO_read(writeBio_, encrypted, encryptedSize); + + DBG_LEAVE3("SecureConnection::encrypt"); + + return readed; + } + + // + // Decrypt message. + // + // decrypted - buffer, where to store decrypted message (OUT). + // decryptedSize - size of decrypted[] buffer in bytes (IN). + // buffer - source buffer with data to be decrypt (IN). + // bufferSize - number of bytes to be decrypted (IN). + // + // RETURNS: Length of decrypted data written to decrypted[] in bytes or + // -1 if error. + // + + int SecureConnection::decrypt(void *decrypted, int decryptedSize, + const void *buffer, int bufferSize) + { + DBG_ENTER3("SecureConnection::decrypt"); + + int readed = 0; + + // + // Pass readed enrypted data to SSL BIO. + // + + BIO_write(readBio_, buffer, bufferSize); + + // + // Read back decrypted data from SSL. + // + + readed = SSL_read(ssl_, decrypted, decryptedSize); + + DBG_LEAVE3("SecureConnection::ecrypt"); + + return readed; + } + + // + // Write bytes throught secure connection. + // + // buf - source buffer with data, which we want to write (IN). + // len - number of bytes to write (IN). + // timeout - timeout in ms, set to -1 for infinite (IN). + // + // RETURNS: Number of bytes written or + // -1 if error. + // + + int SecureConnection::write(const void *buf, int len, int timeout) + { + DBG_ENTER3("SecureConnection::write"); + + int written = -1; + int readed = -1; + + char encrypted[1024]; + + int encryptedSize = 0; + + // + // Encrypt message. + // + + encryptedSize = this -> encrypt(encrypted, sizeof(encrypted), buf, len); + + // + // Write encrypted data to underlying IO. + // + + if (encryptedSize > 0) + { + written = this -> writeRaw(encrypted, encryptedSize, timeout); + } + + DBG_LEAVE3("SecureConnection::write"); + + return written; + } + + // + // Read data from secure connection. + // + // buf - destination buffer, where to write readed data (OUT). + // len - number of bytes to read (IN). + // timeout - timeout in ms, set -1 to infinite (IN) + // + // RETURNS: Number of bytes readed or + // -1 if error. + // + + int SecureConnection::read(void *buf, int len, int timeout) + { + DBG_ENTER3("SecureConnection::read"); + + int written = -1; + int readed = -1; + + char encrypted[1024]; + + int encryptedSize = 0; + + // + // Read encrypted data from underlying IO. + // + + encryptedSize = this -> readRaw(encrypted, sizeof(encrypted), timeout); + + // + // Decrypt message into caller buffer. + // + + if (encryptedSize > 0) + { + readed = this -> decrypt(buf, len, encrypted, encryptedSize); + } + + DBG_LEAVE3("SecureConnection::read"); + + return readed; + } + + // + // - Send single, printf like formatted request to server + // - read answer in format 'XYZ > message' + // - split answer to code and parts. + // + // Example usage: + // + // request(&serverCode, serverMsg, sizeof(serverMsg), + // "share --alias %s --path %s", alias, path); + // + // TIP: If only exit code is needed can be set to NULL. + // + // sc - pointer to SecureConnection object connected to server (IN). + // serverCode - exit code returned by server (OUT). + // serverMsg - ASCIZ message returned by server (OUT/OPT). + // serverMsgSize - size of answer buffer in bytes (IN). + // timeout - timeout in ms, defaulted to infinite if -1 (IN/OPT). + // fmt - printf like parameters to format command to send (IN). + // + // RETURNS: 0 if request sucessfuly sent and asnwer from server received. + // -1 otherwise. + // + // WARNING!: Request could still failed on server side. + // To get server's side exit code use 'answerCode' parameter. + // + + int SecureConnection::request(int *serverCode, char *serverMsg, + int serverMsgSize, int timeout, + const char *fmt, ...) + { + DBG_ENTER("SecureConnection::request"); + + int exitCode = -1; + + char buf[1024]; + + int cmdLen = 0; + + char *dst = NULL; + + int readed = 0; + int total = 0; + + int eofReceived = 0; + + int len = 0; + + va_list ap; + + // + // Check args. + // + + FAILEX(serverCode == NULL, "ERROR: 'serverCode' cannot be NULL in SecureRequest."); + FAILEX(fmt == NULL, "ERROR: 'fmt' cannot be NULL in SecureRequest."); + + // + // Format printf like message. + // + + va_start(ap, fmt); + + len = vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + + va_end(ap); + + // + // Send command to server INCLUDING zero terminator byte. + // + + FAILEX(this -> write(buf, len + 1, timeout) < 0, + "ERROR: Cannot send request.\n"); + + // + // Read answer from server in below format: + // 'XYZ> ' + // + // Where is 3 decimal server side code e.g. "871". + // + + // + // Read 'XYZ> ' prefix first. + // where XYZ is 3 decimal exit code returned by server. + // + + FAILEX(this -> read(buf, 5, timeout) != 5, + "ERROR: Cannot read 'XYZ> ' prefix."); + + buf[4] = 0; + + *serverCode = atoi(buf); + + // + // Read ASCIZ message part if needed. + // + + if (serverMsg && serverMsgSize > 0) + { + dst = serverMsg; + + total = 0; + + // + // FIXME: Avoid reading byte by byte. + // + + while(this -> read(dst, 1, timeout) == 1) + { + // + // Caller buffer too short. + // + + if (total == serverMsgSize) + { + break; + } + + // + // End of message, it's ordinal end. + // + + if (dst[0] == 0) + { + eofReceived = 1; + + break; + } + + total ++; + + dst ++; + } + + serverMsg[total] = 0; + } + + // + // Flush remaining message from server if any. + // This is scenario when caller message[] buffer is shorter + // than message sent by server. + // + + while(eofReceived == 0) + { + if (this -> read(buf, 1, timeout) <= 0 || buf[0] == 0) + { + eofReceived = 1; + } + } + + exitCode = 0; + + // + // Clean up. + // + + fail: + + if (exitCode) + { + Error("Cannot execute secure request.\n" + "Error code is : %d.\n", GetLastError()); + } + + DBG_LEAVE("SecureConnection::request"); + + return exitCode; + } + + // + // Desctroy secure connection created by SecureConnectionCreate() before. + // + + SecureConnection::~SecureConnection() + { + DBG_ENTER("SecureConnection::~SecureConnection"); + + if (ssl_) + { + SSL_free(ssl_); + } + + if (sslCtx_) + { + SSL_CTX_free(sslCtx_); + } + + DBG_LEAVE("SecureConnection::~SecureConnection"); + } + + // + // Perform underlying SSL handshake to init encrypted secure connection. + // + // Internal use only. + // + // TIP#1: For custom connection use 5-parameter SecureHandshakeStep. + // + // TIP#2: For non-custom connections (underlying IO is set to callbacks, + // socket or FDs pair} handshake is performed automatically in + // SecureConnectionCreate. No manually work needed. + // + // + // WARNING! Handshake must be performed before any data would be send + // via SecureWrite() or read via SecureRead() functions. + // + // Parameters: + // + // customBuffer - on input data treated as readed from underlying IO if IOMODE + // set to NONE. On output data needed to be written to + // underlying IO. (IN/OUT/OPT). + // + // customSize - on input size of customBuffer[] in bytes if IOMODE set to + // NONE. On output number of bytes returned in customBuffer[] + // and needed to be written back to underlying IO (IN/OUT/OPT). + // + // RETURNS: 0 if OK. + // + + int SecureConnection::handshakeStep(void *customBuffer, int *customSize) + { + DBG_ENTER("SecureConnection::handshakeStep"); + + int exitCode = -1; + + char buffer[1024]; + + int readed = 0; + int written = 0; + + // + // Handshake finished. + // + + if (SSL_is_init_finished(ssl_)) + { + state_ = SECURE_STATE_ESTABLISHED; + + // + // Server should sent "OK" message at the end of handshake. + // + + if (intent_ == SECURE_INTENT_CLIENT) + { + readed = SSL_read(ssl_, buffer, 2); + + FAIL(readed != 2); + FAIL(buffer[0] != 'O'); + FAIL(buffer[1] != 'K'); + } + } + + // + // Handshake still pending. + // + + else + { + switch(state_) + { + // + // Write turn. + // Client begins here. + // + // -> SSL -> IO -> ... + // + + case SECURE_STATE_HANDSHAKE_WRITE: + { + // + // Read handshake data from SSL BIO. + // + + SSL_do_handshake(ssl_); + + readed = BIO_read(writeBio_, buffer, 1024); + + DEBUG3("Readed [%d] bytes from SSL BIO.\n", readed); + + FAIL(readed <= 0); + + // + // Underlying IO is set to NONE. + // Pass data needed to be written back to caller. + // + + if (ioMode_ == SECURE_IOMODE_NONE) + { + FAILEX(*customSize < readed, + "ERROR: 'customSize' too small in SecureHandshakeStep.\n"); + + memcpy(customBuffer, buffer, readed); + + *customSize = readed; + + written = readed; + } + + // Underlying IO is set. + // Write back handshake data to underlying IO. + // + + else + { + written = this -> writeRaw(buffer, readed, SECURE_TLS_HANDSHAKE_TIMEOUT); + } + + DEBUG3("Written [%d] bytes to underlying IO.\n", written); + + FAIL(written <= 0); + + // + // Handshake finished. + // + + if (SSL_is_init_finished(ssl_)) + { + state_ = SECURE_STATE_ESTABLISHED; + } + + // + // Handshake pending. + // Swap turn into read. + // + + else + { + state_ = SECURE_STATE_HANDSHAKE_READ; + } + + break; + } + + // + // Read turn. + // Server begins here. + // + // ... -> IO -> SSL + // + + case SECURE_STATE_HANDSHAKE_READ: + { + // + // Underlying IO is not set. Use input customBuffer as data + // readed from underlying IO. + // + + if (ioMode_ == SECURE_IOMODE_NONE) + { + memcpy(buffer, customBuffer, *customSize); + + readed = *customSize; + } + + // + // Underlying IO is set. + // Read handshake data from underlying IO. + // + + else + { + readed = this -> readRaw(buffer, 1024, SECURE_TLS_HANDSHAKE_TIMEOUT); + } + + DEBUG3("Readed [%d] bytes from underlying IO.\n", readed); + + FAIL(readed <= 0); + + // + // Redirect readed data to SSL BIO. + // + + written = BIO_write(readBio_, buffer, readed); + + DEBUG3("Written [%d] bytes to SSL BIO.\n", written); + + FAIL(written <= 0); + + // + // Handshake finished. + // + + if (SSL_is_init_finished(ssl_)) + { + state_ = SECURE_STATE_ESTABLISHED; + + if (intent_ == SECURE_INTENT_CLIENT) + { + readed = SSL_read(ssl_, buffer, 2); + + FAIL(readed != 2); + FAIL(buffer[0] != 'O'); + FAIL(buffer[1] != 'K'); + } + } + + // + // Handshake pending. + // Swap turn into write. + // + + else + { + SSL_do_handshake(ssl_); + + state_ = SECURE_STATE_HANDSHAKE_WRITE; + } + + break; + } + } + } + + // + // Server send ecrypted "OK" message if handshake finished. + // + + if (state_ == SECURE_STATE_ESTABLISHED && intent_ == SECURE_INTENT_SERVER) + { + if (ioMode_ == SECURE_IOMODE_NONE) + { + *customSize = this -> encrypt(customBuffer, *customSize, "OK", 2); + + DEBUG1("SSL Handshake finished.\n"); + } + else + { + this -> write("OK", 2, SECURE_TLS_HANDSHAKE_TIMEOUT); + } + } + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("SSL handshake failed.\n"); + } + + DBG_LEAVE("SecureConnection::handshakeStep"); + + return exitCode; + } + + // + // Handshake step for custom connection (iomode set to none). + // + // TIP#1: This function should be used to perform manually handshake when + // underlying IO is set to NONE (i.e. custom secure connection). + // + // TIP#2: Before call, caller should read data from underlying IO manually + // and pass it in {inputBuffer, inputSize} parameters. + // + // TIP#3: After call, caller should write data returned in + // {outputBuffer, outputSize} to underlying IO manually. + // + // Caller algorithm to do handshake manually: + // + // while(sc -> state != SECURE_STATE_ESTABLISHED) + // { + // Read data from underlying IO to inputBuffer[]. + // Call SecureHandshakeStep(inputBuffer, ..., outputBuffer, ...) + // Write data from outputBuffer[] to underlying IO. + // } + // + // + // sc - secure connection object returned from SecureConnectionCreate() (IN). + // outputBuffer - data needed to be written to underlying IO by caller (OUT). + // + // outputSize - on input size of outputBuffer[] in bytes, on output number + // of bytes written to outputBuffer[] (IN/OUT). + // + // inputBuffer - data readed from underlying IO (IN). + // inputSize - size of inputBuffer[] in bytes (IN). + // + // RETURNS: 0 if OK. + // + + int SecureConnection::handshakeStep(void *outputBuffer, int *outputSize, + void *inputBuffer, int inputSize) + { + DBG_ENTER("SecureConnection::handshakeStep"); + + int exitCode = -1; + + FAIL(this -> handshakeStep(inputBuffer, &inputSize)); + + if (this -> state_ != SECURE_STATE_ESTABLISHED) + { + FAIL(this -> handshakeStep(outputBuffer, outputSize)); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE("SecureConnection::handshakeStep"); + + return exitCode; + } + + // + // Create empty secure connection object. + // Used internally only. + // + // TIP#1: Don't create SecureConnection object directly. + // Use one of SecureConnectionCreate() function instead. + // + + SecureConnection::SecureConnection() + { + readBio_ = NULL; + writeBio_ = NULL; + ssl_ = NULL; + sslCtx_ = NULL; + + int intent_ = -1; + int state_ = -1; + int ioMode_ = -1; + + readCallback_ = NULL; + writeCallback_ = NULL; + + ioCtx_ = NULL; + + int fdIn_ = -1; + int fdOut_ = -1; + int sock_ = -1; + + refCount_ = 1; + + refCountMutex_.setName("SecureConnection::refCountMutex_"); + } + + // + // Initialize SSL DTLS connection inside secure connection object. + // + // Internal use only by SecureConnectionCreate(). + // + // RETURNS: 0 if OK. + // + + int SecureConnection::initSSL(int intent, const char *cert, + const char *privKey, const char *privKeyPass) + { + DBG_ENTER("SecureConnection::initSSL"); + + int exitCode = -1; + + unsigned char sid[SSL_MAX_SSL_SESSION_ID_LENGTH] ; + + // + // Init SSL library. + // + + SSL_library_init(); + + // + // Create SSL context. + // + + DEBUG3("Creating SSL context...\n"); + + sslCtx_ = SSL_CTX_new(DTLSv1_method()); + + FAILEX(sslCtx_ == NULL, "ERROR: Cannot create SSL context.\n"); + + // + // Server. + // + + if (intent == SECURE_INTENT_SERVER) + { + // + // Assign certificate and private key to context. + // + + DEBUG3("Assigning certificate to SSL context...\n"); + + SSL_CTX_use_certificate_chain_file(sslCtx_, cert); + + // + // Set pass to decode private key if needed. + // + + if (privKeyPass) + { + FAILEX(true, "ERROR: 'privKeyPass' param is obsolete.") + } + + // + // Set input files with prviate key and server certificate. + // + + SSL_CTX_use_PrivateKey_file(sslCtx_, privKey, SSL_FILETYPE_PEM); + SSL_CTX_use_certificate_file(sslCtx_, cert, SSL_FILETYPE_PEM); + + // + // Set SINGLE_DH_USE option. + // + + DEBUG3("Setting SINGLE_DH_USE...\n"); + + SSL_CTX_set_options(sslCtx_, SSL_OP_SINGLE_DH_USE); + + // + // Assign session ID. + // + + DEBUG3("Setting session id...\n"); + + FAIL(SecureRandom(sid, sizeof(sid))); + + SSL_CTX_set_session_id_context(sslCtx_, sid, 4); + } + + // + // Allocate SSL object. + // + + DEBUG3("Allocating SSL object...\n"); + + ssl_ = SSL_new(sslCtx_); + + // + // Server. + // + + if (intent == SECURE_INTENT_SERVER) + { + SSL_set_accept_state(ssl_); + SSL_set_verify(ssl_, SSL_VERIFY_NONE, NULL); + SSL_set_session_id_context(ssl_, sid, 4); + + state_ = SECURE_STATE_HANDSHAKE_READ; + } + + // + // Client. + // + + else + { + SSL_set_connect_state(ssl_); + + SSL_set_verify(ssl_, SSL_VERIFY_NONE, NULL); + + state_ = SECURE_STATE_HANDSHAKE_WRITE; + } + + readBio_ = BIO_new(BIO_s_mem()); + + BIO_set_nbio(readBio_, 1); + + writeBio_ = BIO_new(BIO_s_mem()); + + BIO_set_nbio(writeBio_, 1); + + SSL_set_bio(ssl_, readBio_, writeBio_); + + // + // Do SSL handshake, if underlying IO available. + // Otherwise must be handled manually. + // + + if (ioMode_ != SECURE_IOMODE_NONE) + { + while(state_ != SECURE_STATE_ESTABLISHED) + { + FAIL(handshakeStep()); + } + + DBG_INFO("SSL Handshake finished.\n"); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot init SSL connection.\n"); + } + + DBG_LEAVE("SecureConnection::initSSL"); + + return exitCode; + } + + // + // Increase refference counter. + // + // WARNING! Every call to addRef() MUSTS be followed by one release() call. + // + // TIP #1: Object will not be destroyed until refference counter is greater + // than 0. + // + // TIP #2: Don't call destructor directly, use release() instead. If + // refference counter achieve 0, object will be destroyed + // automatically. + // + + void SecureConnection::addRef() + { + refCountMutex_.lock(); + + refCount_ ++; + + DEBUG2("Increased refference counter to %d for SecureConnection PTR#%p.\n", + refCount_, this); + + refCountMutex_.unlock(); + } + + // + // Decrease refference counter increased by addRef() before and + // desroy object when it's refference counter reach 0. + // + + void SecureConnection::release() + { + int deleteNeeded = 0; + + // + // Decrease refference counter by 1. + // + + refCountMutex_.lock(); + + refCount_ --; + + DEBUG2("Decreased refference counter to %d for SecureConnection PTR#%p.\n", + refCount_, this); + + if (refCount_ == 0) + { + deleteNeeded = 1; + } + + refCountMutex_.unlock(); + + // + // Delete object if refference counter goes down to 0. + // + + if (deleteNeeded) + { + delete this; + } + } + + int SecureConnection::getState() + { + return state_; + } + + // + // Wrap abstract read/write callbacks into secure connection. + // + // intent - set to SECURE_INTENT_CLIENT or SECURE_INTENT_SERVER (IN). + // readCallback - callback used to read from underlying unsecure IO (IN). + // writeCallback - callback used to write to underlying unsecure IO (IN). + // cancelCallback - callback used to cancel pending read on underlying IO (IN). + // ioCtx - caller specified context passed to IO callbacks directly (IN). + // cert - filename, where server certificate is stored (IN/OPT). + // privKey - filename, where server private key is stored (server side + // only) (IN/OPT). + // privKeyPass - passphrase to decode private key. Readed from keyboard + // if skipped (IN/OPT). + // + // WARNING! Returned pointer MUSTS be freed by SecureConnectionDestroy() if not + // needed longer. + // + // TIP#1: Use SecureHandshake() to init encrypted SSL connection before + // attemp to read or write via created connection. + // + // TIP#2: Use SecureWrite to send data via secure connection. + // + // TIP#3: Use SecureRead to read data from secure connection. + // + // + // RETURNS: Pointer to new allocated SecureConnectionCreate object + // or NULL if error. + // + + SecureConnection *SecureConnectionCreate(int intent, + SecureReadProto readCallback, + SecureWriteProto writeCallback, + void *ioCtx, + const char *cert, + const char *privKey, + const char *privKeyPass) + { + DBG_ENTER("SecureConnectionCreate"); + + int exitCode = -1; + + SecureConnection *sc = new SecureConnection; + + sc -> readCallback_ = readCallback; + sc -> writeCallback_ = writeCallback; + sc -> ioCtx_ = ioCtx; + sc -> intent_ = intent; + sc -> ioMode_ = SECURE_IOMODE_CALLBACKS; + + // + // Init SSL. + // + + FAIL(sc -> initSSL(intent, cert, privKey, privKeyPass)); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create secure connection.\n"); + + sc -> release(); + + sc = NULL; + } + + DBG_LEAVE("SecureConnectionCreate"); + + return sc; + } + + // + // Wrap FD pair into secure connection. + // + // intent - set to SECURE_INTENT_CLIENT or SECURE_INTENT_SERVER (IN). + // fdin - FD used to read data from underlying unsecure IO (IN). + // fdout - FD used to write data into underlying unsecure IO (IN). + // cert - filename, where server certificate is stored (IN/OPT). + // + // privKey - filename, where server private key is stored (server side + // only) (IN/OPT). + // + // privKeyPass - passphrase to decode private key, readed from keyboard if + // skipped (IN/OPT). + // + // WARNING! Returned pointer MUSTS be released release() method when not + // needed longer. + // + // TIP#1: Use SecureHandshake() to init encrypted SSL connection before + // attemp to read or write via created connection. + // + // TIP#2: Use SecureWrite to send data via secure connection. + // + // TIP#3: Use SecureRead to read data from secure connection. + // + // + // RETURNS: Pointer to new allocated SecureConnectionCreate object + // or NULL if error. + // + + SecureConnection *SecureConnectionCreate(int intent, int fdin, int fdout, + const char *cert, const char *privKey, + const char *privKeyPass) + { + DBG_ENTER("SecureConnectionCreate"); + + int exitCode = -1; + + SecureConnection *sc = new SecureConnection; + + sc -> fdIn_ = fdin; + sc -> fdOut_ = fdout; + sc -> intent_ = intent; + sc -> ioMode_ = SECURE_IOMODE_FDS; + + // + // Init SSL. + // + + FAIL(sc -> initSSL(intent, cert, privKey, privKeyPass)); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create secure connection over FDs #%d/%d.\n", fdin, fdout); + + sc -> release(); + + sc = NULL; + } + + DBG_LEAVE("SecureConnectionCreate"); + + return sc; + } + + // + // Wrap socket into secure connection. + // + // intent - set to SECURE_INTENT_CLIENT or SECURE_INTENT_SERVER (IN). + // sock - socket connected to remote machine (IN) + // cert - filename, where server certificate is stored (IN/OPT). + // + // privKey - filename, where server private key is stored (server + // side only) (IN/OPT). + // + // privKeyPass - passphrase to decode private key, readed from keyboard if + // skipped (IN/OPT). + // + // WARNING! Returned pointer MUSTS be released release() method when not + // needed longer. + // + // TIP#1: Use SecureHandshake() to init encrypted SSL connection before + // attemp to read or write via created connection. + // + // TIP#2: Use SecureWrite to send data via secure connection. + // + // TIP#3: Use SecureRead to read data from secure connection. + // + // + // RETURNS: Pointer to new allocated SecureConnectionCreate object + // or NULL if error. + // + + SecureConnection *SecureConnectionCreate(int intent, int sock, + const char *cert, const char *privKey, + const char *privKeyPass) + { + DBG_ENTER("SecureConnectionCreate"); + + int exitCode = -1; + + SecureConnection *sc = new SecureConnection; + + sc -> sock_ = sock; + sc -> intent_ = intent; + sc -> ioMode_ = SECURE_IOMODE_SOCKET; + + // + // Init SSL. + // + + FAIL(sc -> initSSL(intent, cert, privKey, privKeyPass)); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create secure connection over SOCKET #%d.\n", sock); + + sc -> release(); + + sc = NULL; + } + + DBG_LEAVE("SecureConnectionCreate"); + + return sc; + } + + // + // Custom secure connection. + // + // intent - set to SECURE_INTENT_CLIENT or SECURE_INTENT_SERVER (IN). + // + // cert - filename, where server certificate is stored (IN/OPT). + // + // privKey - filename, where server private key is stored (server + // side only) (IN/OPT). + // + // privKeyPass - passphrase to decode private key, readed from keyboard if + // skipped (IN/OPT). + // + // WARNING! Returned pointer MUSTS be released release() method when not + // needed longer. + // + // TIP#1: Use SecureHandshake() to init encrypted SSL connection before + // attemp to read or write via created connection. + // + // TIP#2: Use SecureWrite to send data via secure connection. + // + // TIP#3: Use SecureRead to read data from secure connection. + // + // + // RETURNS: Pointer to new allocated SecureConnectionCreate object + // or NULL if error. + // + + SecureConnection *SecureConnectionCreate(int intent, const char *cert, + const char *privKey, + const char *privKeyPass) + { + DBG_ENTER("SecureConnectionCreate"); + + int exitCode = -1; + + SecureConnection *sc = new SecureConnection; + + sc -> intent_ = intent; + sc -> ioMode_ = SECURE_IOMODE_NONE; + + // + // Init SSL. + // + + FAIL(sc -> initSSL(intent, cert, privKey, privKeyPass)); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create custom secure connection.\n"); + + sc -> release(); + + sc = NULL; + } + + DBG_LEAVE("SecureConnectionCreate"); + + return sc; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibSecure/Example01-callbacks/Main.cpp b/Source/Net/LibSecure/Example01-callbacks/Main.cpp new file mode 100644 index 0000000..04c2851 --- /dev/null +++ b/Source/Net/LibSecure/Example01-callbacks/Main.cpp @@ -0,0 +1,147 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to wrap NetConnection object into secure +// DTLS connection. +// + +#include +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + SecureConnection *sc = NULL; + + char msg[1024] = "Hello world!."; + + int readed = 0; + int written = 0; + + // + // Server. + // + + if (argc == 1) + { + DBG_INFO("Server mode.\n"); + + // + // Wait for incoming connection on TCP 6666 port. + // + + NetConnection *nc = NetAccept(6666); + + FAIL(nc == NULL); + + // + // Wrap {read, write} callbacks from NetworkConnection class + // into SecureConnection object. + // + + sc = SecureConnectionCreate(SECURE_INTENT_SERVER, + SecureReadProto(nc -> readCallback), + SecureWriteProto(nc -> writeCallback), + nc, "server.crt", "server.key", NULL); + + FAIL(sc == NULL); + } + + // + // Client. + // + + else + { + DBG_INFO("Client mode.\n"); + + // + // Connect with 127.0.0.1:6666. + // + + NetConnection *nc = NetConnect("127.0.0.1", 6666); + + FAIL(nc == NULL); + + // + // Wrap {read, write} callbacks from NetConnection into + // SecureConnection object. + // + + sc = SecureConnectionCreate(SECURE_INTENT_CLIENT, + SecureReadProto(nc -> readCallback), + SecureWriteProto(nc -> writeCallback), + nc, NULL, NULL, NULL); + + FAIL(sc == NULL); + } + + // + // Secure connection established. + // + + // + // Write "hello world" message to another side via + // encrypted connection. + // + + written = sc -> write(msg, strlen(msg), -1); + + FAIL(write <= 0); + + // + // Read message from another side via encrypted connection. + // + + readed = sc -> read(msg, sizeof(msg), -1); + + FAIL(readed <= 0); + + // + // Print out what is readed. + // + + msg[readed] = 0; + + DBG_INFO("Readed message [%s].\n", msg); + + // + // Clean up. + // + + fail: + + if (sc) + { + sc -> release(); + } + + return 0; +} diff --git a/Source/Net/LibSecure/Example01-callbacks/qcbuild.src b/Source/Net/LibSecure/Example01-callbacks/qcbuild.src new file mode 100644 index 0000000..5a175b8 --- /dev/null +++ b/Source/Net/LibSecure/Example01-callbacks/qcbuild.src @@ -0,0 +1,35 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSecure-example01-callbacks +CXXSRC = Main.cpp + +DEPENDS = OpenSSL LibNet LibSecure LibDebug + +LIBS = -lssl -lcrypto -lsecure -lnet -lthread -llock -ldebug + +.section MinGW +LIBS += -lws2_32 -lgdi32 +.endsection diff --git a/Source/Net/LibSecure/Example02-socket/Main.cpp b/Source/Net/LibSecure/Example02-socket/Main.cpp new file mode 100644 index 0000000..f84ca42 --- /dev/null +++ b/Source/Net/LibSecure/Example02-socket/Main.cpp @@ -0,0 +1,143 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to wrap socket conected to remote machine into secure +// DTLS connection. +// + +#include +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_SET_LEVEL("debug3"); + + SecureConnection *sc = NULL; + + char msg[1024] = "Hello world!."; + + int readed = 0; + int written = 0; + + // + // Server. + // + + if (argc == 1) + { + DBG_INFO("Server mode.\n"); + + // + // Wait for incoming connection on TCP 6666 port. + // + + NetConnection *nc = NetAccept(6666); + + FAIL(nc == NULL); + + // + // Wrap socket from NetworkConnection class into SecureConnection object. + // + + sc = SecureConnectionCreate(SECURE_INTENT_SERVER, nc -> getSocket(), + "server.crt", "server.key", NULL); + + FAIL(sc == NULL); + } + + // + // Client. + // + + else + { + DBG_INFO("Client mode.\n"); + + // + // Connect with 127.0.0.1:6666. + // + + NetConnection *nc = NetConnect("127.0.0.1", 6666); + + FAIL(nc == NULL); + + // + // Wrap socket from from NetConnection into SecureConnection object. + // + + sc = SecureConnectionCreate(SECURE_INTENT_CLIENT, + nc -> getSocket(), NULL, NULL, NULL); + + FAIL(sc == NULL); + } + + // + // Secure connection established. + // + + // + // Write "hello world" message to another side via + // encrypted connection. + // + + written = sc -> write(msg, strlen(msg), -1); + + FAIL(write <= 0); + + // + // Read message from another side via encrypted connection. + // + + readed = sc -> read(msg, sizeof(msg), -1); + + FAIL(readed <= 0); + + // + // Print out what is readed. + // + + msg[readed] = 0; + + DBG_INFO("Readed message [%s].\n", msg); + + // + // Clean up. + // + + fail: + + if (sc) + { + sc -> release(); + } + + return 0; +} diff --git a/Source/Net/LibSecure/Example02-socket/qcbuild.src b/Source/Net/LibSecure/Example02-socket/qcbuild.src new file mode 100644 index 0000000..80cc27c --- /dev/null +++ b/Source/Net/LibSecure/Example02-socket/qcbuild.src @@ -0,0 +1,35 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSecure-example02-socket +CXXSRC = Main.cpp + +DEPENDS = OpenSSL LibNet LibSecure LibDebug + +LIBS = -lssl -lcrypto -lsecure -lnet -lthread -llock -ldebug + +.section MinGW +LIBS += -lws2_32 -lgdi32 +.endsection diff --git a/Source/Net/LibSecure/Example03-Random/Main.cpp b/Source/Net/LibSecure/Example03-Random/Main.cpp new file mode 100644 index 0000000..0245945 --- /dev/null +++ b/Source/Net/LibSecure/Example03-Random/Main.cpp @@ -0,0 +1,53 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to generate random numbers and buffers via LibSecure. +// + +#include +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + char text[32] = {0}; + char hexText[32] = {0}; + + SecureRandomText(text, sizeof(text)); + SecureRandomHexText(hexText, sizeof(hexText)); + + printf("Random text : [%s].\n", text); + printf("Random hex : [%s].\n", hexText); + printf("Random int64 : [%"PRIu64"].\n", SecureRandomInt64()); + printf("Random int32 : [%u].\n", SecureRandomInt32()); + printf("Random byte : [%u].\n", SecureRandomByte()); + + return 0; +} diff --git a/Source/Net/LibSecure/Example03-Random/qcbuild.src b/Source/Net/LibSecure/Example03-Random/qcbuild.src new file mode 100644 index 0000000..f08873e --- /dev/null +++ b/Source/Net/LibSecure/Example03-Random/qcbuild.src @@ -0,0 +1,35 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSecure-example03-random +CXXSRC = Main.cpp + +DEPENDS = OpenSSL LibSecure LibDebug + +LIBS = -lssl -lcrypto -lsecure -llock -ldebug + +.section MinGW +LIBS += -lws2_32 -lgdi32 +.endsection diff --git a/Source/Net/LibSecure/Example04-hp-server/Main.cpp b/Source/Net/LibSecure/Example04-hp-server/Main.cpp new file mode 100644 index 0000000..857b839 --- /dev/null +++ b/Source/Net/LibSecure/Example04-hp-server/Main.cpp @@ -0,0 +1,214 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// WARNING! +// To create fully secure connection we need two steps: +// +// 1. Create secure TLS session - after that transfered data are encrypted +// i.e. not readable by third parties, +// +// 2. validate *WHO* is on the other side basing on data from certificate, +// e.g. by check domain name. +// +// Below code performs (1) but does *NOT* perform (2). +// Caller *SHOULD* deliver own mechanism to check does data delivered +// within certificate are match to what he's expecting. +// + +// +// Example shows how to integrate callback based server with SSL. +// + +#include +#include + +#include +#include +#include + +using namespace std; +using namespace Tegenaria; + +// +// Custom, optional object related with incoming connections. +// + +struct UserContext +{ + string name_; + + SecureConnection *sc_; +}; + +// +// Handler called when new connection arrived. +// + +void OpenHandler(NetHpContext *ctx, int fd) +{ + printf("Opened connection on FD #%d.\n", fd); + + // + // Initialize custom SecureConnection object without underlying + // IO defined. + // + + SecureConnection *sc = SecureConnectionCreate(SECURE_INTENT_SERVER, + "server.crt", "server.key", + NULL); + + // + // Initialize some connection related object e.g. user context + // and associate SecureConnection object with our context. + // + + UserContext *user = new UserContext; + + user -> name_ = "Marian"; + user -> sc_ = sc; + + // + // Associate user context with opened connection. + // We will get it back in further close and data handlers. + // + + ctx -> custom_ = (void *) user; +} + +// +// Handler called when existing connection closed. +// + +void CloseHandler(NetHpContext *ctx, int fd) +{ + UserContext *user = (UserContext *) ctx -> custom_; + + printf("Closed connection on FD #%d for user %s.\n", fd, user -> name_.c_str()); + + // + // Free related connection object. + // + + delete user; +} + +// +// Handler called when something to read on given fd. +// + +void DataHandler(NetHpContext *ctx, int fd, void *buf, int len) +{ + UserContext *user = (UserContext *) ctx -> custom_; + + // + // SSL connection already established. + // Normal session flow. + // + + switch(user -> sc_ -> getState()) + { + case SECURE_STATE_ESTABLISHED: + { + char buffer[1024]; + + int bufferSize = 1024; + + char msg[] = "Hello world."; + + // + // Decrypt incoming data into buffer[]. + // + + len = user -> sc_ -> decrypt(buffer, bufferSize, buf, len); + + printf("%s: Readed %d bytes from FD #%d.\n", user -> name_.c_str(), len, fd); + + // + // ... + // do some real work here + // ... + // + + // + // Encrypt outcoming data before send. + // + // + + len = user -> sc_ -> encrypt(buffer, bufferSize, msg, sizeof(msg)); + + // + // Write encrypted message to client. + // + + int written = NetHpWrite(ctx, fd, buffer, len); + + printf("%s: Written %d bytes to FD #%d.\n", user -> name_.c_str(), written, fd); + + break; + } + + // + // SSL Handshake is pending. + // We must handle it by own. + + case SECURE_STATE_HANDSHAKE_READ: + case SECURE_STATE_HANDSHAKE_WRITE: + { + char toWrite[1024]; + + int toWriteSize = 1024; + + FAIL(user -> sc_ -> handshakeStep(toWrite, &toWriteSize, buf, len)); + + if (toWriteSize > 0) + { + NetHpWrite(ctx, fd, toWrite, toWriteSize); + } + + break; + } + } + + fail: + + return; +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_HEAD("DIRLIGO-HP-SERVER\nBuild [%s, %s]\n", __DATE__, __TIME__); + + // + // Start HP server waiting on TCP port 6666. + // + + NetHpServerLoop(6666, OpenHandler, CloseHandler, DataHandler); + + return 0; +} diff --git a/Source/Net/LibSecure/Example04-hp-server/qcbuild.src b/Source/Net/LibSecure/Example04-hp-server/qcbuild.src new file mode 100644 index 0000000..304c210 --- /dev/null +++ b/Source/Net/LibSecure/Example04-hp-server/qcbuild.src @@ -0,0 +1,35 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSecure-example04-hp-server +CXXSRC = Main.cpp + +DEPENDS = OpenSSL LibNet LibSecure LibDebug + +LIBS = -lssl -lcrypto -lsecure -lnet -lthread -llock -ldebug + +.section MinGW +LIBS += -lws2_32 -lgdi32 +.endsection diff --git a/Source/Net/LibSecure/Example05-encrypt/Main.cpp b/Source/Net/LibSecure/Example05-encrypt/Main.cpp new file mode 100644 index 0000000..3273683 --- /dev/null +++ b/Source/Net/LibSecure/Example05-encrypt/Main.cpp @@ -0,0 +1,103 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to encrypt/decrypt raw buffers. +// + +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + char buf[1024]; + + char key[SECURE_BLOWFISH_KEY_SIZE] = "password"; + char iv[SECURE_BLOWFISH_KEY_SIZE] = {0}; + + int readed = 0; + + // + // Initialie Blowfish cipher with given IV vector and key[]. + // + + SecureCipher *sc = SecureCipherCreate(SECURE_CIPHER_BLOWFISH, + SECURE_CIPHER_MODE_CTR, + key, sizeof(key), iv, sizeof(iv)); + + // + // Switch stdin/stdout to binary mode on windows. + // + + #ifdef WIN32 + _setmode(0, _O_BINARY); + _setmode(1, _O_BINARY); + #endif + + // + // Read data from stdin by 1024 blocks. + // + + while((readed = fread(buf, 1, sizeof(buf), stdin)) > 0) + { + // + // -d option specified. + // Decrypt mode. + // + + if (argc > 1) + { + SecureDecrypt(sc, buf, readed); + } + + // + // No option specified. + // Encrypt mode. + // + + else + { + SecureEncrypt(sc, buf, readed); + } + + // + // Write processed block to stdout. + // + + fwrite(buf, readed, 1, stdout); + } + + // + // CLean up cipher. + // + + SecureCipherDestroy(sc); + + return 0; +} diff --git a/Source/Net/LibSecure/Example05-encrypt/qcbuild.src b/Source/Net/LibSecure/Example05-encrypt/qcbuild.src new file mode 100644 index 0000000..526f3fb --- /dev/null +++ b/Source/Net/LibSecure/Example05-encrypt/qcbuild.src @@ -0,0 +1,35 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSecure-example05-encrypt +CXXSRC = Main.cpp + +DEPENDS = OpenSSL LibSecure LibDebug + +LIBS = -lssl -lcrypto -lsecure -llock -ldebug + +.section MinGW +LIBS += -lws2_32 -lgdi32 +.endsection diff --git a/Source/Net/LibSecure/Example06-hash/Main.cpp b/Source/Net/LibSecure/Example06-hash/Main.cpp new file mode 100644 index 0000000..1cc6f90 --- /dev/null +++ b/Source/Net/LibSecure/Example06-hash/Main.cpp @@ -0,0 +1,59 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to compute SHA256 hash. +// + +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + char data[1024] = {0}; + char hash[65] = {0}; + + // + // Read some string from stdin. + // + + printf("Put some example string: "); + + fgets(data, sizeof(data) - 1, stdin); + + // + // Compute SHA256 from readed string. + // + + SecureHashSha256(hash, sizeof(hash), data, strlen(data), NULL, 0); + + printf("SHA256 hash is : [%s].\n", hash); + + return 0; +} diff --git a/Source/Net/LibSecure/Example06-hash/qcbuild.src b/Source/Net/LibSecure/Example06-hash/qcbuild.src new file mode 100644 index 0000000..addd07d --- /dev/null +++ b/Source/Net/LibSecure/Example06-hash/qcbuild.src @@ -0,0 +1,35 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSecure-example06-hash +CXXSRC = Main.cpp + +DEPENDS = OpenSSL LibSecure LibDebug + +LIBS = -lssl -lcrypto -lsecure -llock -ldebug + +.section MinGW +LIBS += -lws2_32 -lgdi32 +.endsection diff --git a/Source/Net/LibSecure/Example07-read-pass/Main.cpp b/Source/Net/LibSecure/Example07-read-pass/Main.cpp new file mode 100644 index 0000000..6f920d8 --- /dev/null +++ b/Source/Net/LibSecure/Example07-read-pass/Main.cpp @@ -0,0 +1,46 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to read password from stdin with disabled echo. +// + +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + char pass[64] = {0}; + + SecureReadPassword(pass, sizeof(pass), "Enter password: "); + + printf("Entered password is : [%s].\n", pass); + + return 0; +} diff --git a/Source/Net/LibSecure/Example07-read-pass/qcbuild.src b/Source/Net/LibSecure/Example07-read-pass/qcbuild.src new file mode 100644 index 0000000..bc9070b --- /dev/null +++ b/Source/Net/LibSecure/Example07-read-pass/qcbuild.src @@ -0,0 +1,35 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSecure-example07-read-pass +CXXSRC = Main.cpp + +DEPENDS = OpenSSL LibSecure LibDebug + +LIBS = -lssl -lcrypto -lsecure -llock -ldebug + +.section MinGW +LIBS += -lws2_32 -lgdi32 +.endsection diff --git a/Source/Net/LibSecure/Example08-acl/Main.cpp b/Source/Net/LibSecure/Example08-acl/Main.cpp new file mode 100644 index 0000000..bd8b899 --- /dev/null +++ b/Source/Net/LibSecure/Example08-acl/Main.cpp @@ -0,0 +1,83 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to use access list object. +// + +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + SecureAcl acl; + + // + // Test #1. + // + // Grant rights: + // - R (read) for user jozek + // - F (full) for user janek + // + // Others (not included in list explicite) has default access denied. + // + + printf("Test #1\n"); + printf("-------\n"); + + acl.setRights("jozek", "R"); + acl.setRights("janek", SECURE_ACL_FULL); + + printf("Jozek has rights : [%s].\n", acl.getRightsString("jozek").c_str()); + printf("Janek has rights : [%s].\n", acl.getRightsString("janek").c_str()); + printf("Stefan has rights : [%s].\n", acl.getRightsString("stefan").c_str()); + printf("ACL string is : [%s].\n", acl.toString().c_str()); + + // + // Test #2. + // + // Init access list object from raw accesslist. + // We grant below rights is acl string: + // - R (read) to jozek + // - F (full) to janek + // - R (read) to others + // + + printf("\nTest #2\n"); + printf("-------\n"); + + acl.initFromString("jozek:R;janek:F;*:R;"); + + printf("Jozek has rights : [%s].\n", acl.getRightsString("jozek").c_str()); + printf("Janek has rights : [%s].\n", acl.getRightsString("janek").c_str()); + printf("Stefan has rights : [%s].\n", acl.getRightsString("stefan").c_str()); + printf("ACL string is : [%s].\n", acl.toString().c_str()); + + return 0; +} diff --git a/Source/Net/LibSecure/Example08-acl/qcbuild.src b/Source/Net/LibSecure/Example08-acl/qcbuild.src new file mode 100644 index 0000000..9e7ffd7 --- /dev/null +++ b/Source/Net/LibSecure/Example08-acl/qcbuild.src @@ -0,0 +1,35 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSecure-example08-acl +CXXSRC = Main.cpp + +DEPENDS = OpenSSL LibSecure LibDebug + +LIBS = -lssl -lcrypto -lsecure -llock -ldebug + +.section MinGW +LIBS += -lws2_32 -lgdi32 +.endsection diff --git a/Source/Net/LibSecure/Example09-readkey/Main.cpp b/Source/Net/LibSecure/Example09-readkey/Main.cpp new file mode 100644 index 0000000..7c1f9b1 --- /dev/null +++ b/Source/Net/LibSecure/Example09-readkey/Main.cpp @@ -0,0 +1,69 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Example shows how to use access list object. +// + +#include + +#include +#include +#include +#include +#include + +using namespace Tegenaria; + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + RSA *rsa = NULL; + + FILE *f = fopen("server.key", "rb"); + + RSA *ret = NULL; + + if (f) + { + ret = PEM_read_RSAPrivateKey(f, &rsa, NULL, NULL); + + fclose(f); + } + + printf("[%p].\n", ret); + printf("[%p].\n", rsa); + + ERR_print_errors_fp(stderr); + + if (rsa) + { + RSA_free(rsa); + } + + return 0; +} diff --git a/Source/Net/LibSecure/Hash.cpp b/Source/Net/LibSecure/Hash.cpp new file mode 100644 index 0000000..6934c4f --- /dev/null +++ b/Source/Net/LibSecure/Hash.cpp @@ -0,0 +1,142 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: One-direction hash functions. +// + +#include "Secure.h" + +#ifdef WIN64 + static int Win64NotImportedError() + { + fprintf(stderr, "OpenSSL is not imported on Win64"); + exit(-1); + } + + #define SHA256_Init(x) Win64NotImportedError() + #define SHA256_Update(x, y, z) Win64NotImportedError() + #define SHA256_Final(x, y) Win64NotImportedError() +#endif + +namespace Tegenaria +{ + // + // Compute sha256 hash. Function compute hash = SHA256(data + salt). + // Salt is optional, set to NULL if not needed. + // + // WARNING! Hash[] buffer MUST have at least 65 bytes length. + // + // + // hash - buffer, where to store computed hash (OUT). + // hashSize - size of hash[] buffer in bytes (IN). + // data - data to hash (IN). + // dataSize - size of data[] buffer in bytes (IN). + // salt - optional salt data to add. Can be NULL (IN/OPT). + // saltSize - size of salt[] buffer in bytes. Can be 0. (IN/OPT). + // + // RETURNS: 0 if OK. + // + + int SecureHashSha256(char *hash, int hashSize, + const char *data, int dataSize, + const char *salt, int saltSize) + { + DBG_ENTER3("SecureHashSha256"); + + int exitCode = -1; + + SHA256_CTX ctx; + + unsigned char hashRaw[SHA256_DIGEST_LENGTH]; + + char *dst = NULL; + + char hex[] = "0123456789abcdef"; + + // + // Check args. + // + + FAILEX(hash == NULL , "ERROR: 'hash' cannot be NULL in SecureHashSha256().\n"); + FAILEX(hashSize < 65, "ERROR: 'hashSize' MUST be at least 65 in SecureHashSha256().\n"); + FAILEX(data == NULL, "ERROR: 'data' cannot be NULL in SecureHashSha256().\n"); + FAILEX(dataSize < 1, "ERROR: 'dataSize' cannot be < 1 in SecureHashSha256().\n"); + + // + // Init SHA256 context. + // + + FAILEX(SHA256_Init(&ctx) == 0, + "ERROR: Cannot init SHA256 context.\n"); + + // + // Comptue SHA256(data + salt). + // + + FAILEX(SHA256_Update(&ctx, (unsigned char *) data, dataSize) == 0, + "ERROR: Cannot compute SHA256 hash.\n"); + + if (salt && saltSize > 0) + { + FAILEX(SHA256_Update(&ctx, (unsigned char *) salt, saltSize) == 0, + "ERROR: Cannot compute SHA256 hash.\n"); + } + + // + // Pop raw binary hash from SHA256 context. + // + + FAILEX(SHA256_Final(hashRaw, &ctx) == 0, + "ERROR: Cannot pop hash from SHA256 context.\n"); + + // + // Convert raw, binary hash into asciz string. + // + + dst = hash; + + for (int i = 0; i < 32; i++) + { + dst[0] = hex[(hashRaw[i] & 0x0f)]; + dst[1] = hex[(hashRaw[i] & 0xf0) >> 4]; + + dst += 2; + } + + hash[64] = 0; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("SecureHashSha256"); + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibSecure/Internal.h b/Source/Net/LibSecure/Internal.h new file mode 100644 index 0000000..55ee90f --- /dev/null +++ b/Source/Net/LibSecure/Internal.h @@ -0,0 +1,53 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Group internal structure, which should NOT +// be visible in public. This structures can be +// modified from version to version wthout risk. +// + +#ifndef Tenegaria_Core_Secure_Internal_H + +#include +#include +#include + +namespace Tegenaria +{ + struct SecureCipher + { + int counterEncrypt_; + int counterDecrypt_; + + int cipher_; + int cipherMode_; + + BF_KEY key_; + + unsigned char iv_[16]; + }; +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Secure_Internal_H */ diff --git a/Source/Net/LibSecure/Password.cpp b/Source/Net/LibSecure/Password.cpp new file mode 100644 index 0000000..04bbad3 --- /dev/null +++ b/Source/Net/LibSecure/Password.cpp @@ -0,0 +1,311 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Functions to disable echo and read password from console. +// + +#include "Secure.h" + +namespace Tegenaria +{ + // + // Disable echo on stdin. + // + // RETURNS: 0 if OK. + // + + int SecureDisableEcho() + { + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + DWORD mode; + + FAIL(GetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), &mode) == FALSE); + + mode = mode & (~ENABLE_ECHO_INPUT); + + FAIL(SetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), mode) == FALSE); + } + + // + // Linux, MacOS. + // + + #else + { + struct termios mode; + + FAIL(tcgetattr(1, &mode)); + + mode.c_lflag &= ~ECHO; + + FAIL(tcsetattr(1, TCSAFLUSH, &mode)); + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot disable echo on stdin.\n" + "Error code is : %d.\n", GetLastError()); + } + + return exitCode; + } + + // + // Enable echo on stdin. + // + // RETURNS: 0 if OK. + // + + int SecureEnableEcho() + { + int exitCode = -1; + + // + // Windows. + // + + #ifdef WIN32 + { + DWORD mode; + + FAIL(GetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), &mode) == FALSE); + + mode = mode | ENABLE_ECHO_INPUT; + + FAIL(SetConsoleMode(GetStdHandle(STD_INPUT_HANDLE), mode) == FALSE); + } + + // + // Linux, MacOS. + // + + #else + { + struct termios mode; + + FAIL(tcgetattr(1, &mode)); + + mode.c_lflag |= ECHO; + + FAIL(tcsetattr(1, TCSAFLUSH, &mode)); + } + #endif + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot enable echo on stdin.\n" + "Error code is : %d.\n", GetLastError()); + } + + return exitCode; + } + + // + // Disable echo and read password from stdin. + // + // pass - buffer, where to store readed password (OUT). + // passSize - size of pass[] buffer in bytes (IN). + // prompt - optional prompt to show before ask for pass (IN/OPT). + // + // RETURNS: 0 if OK. + // + + int SecureReadPassword(char *pass, int passSize, const char *prompt) + { + DBG_ENTER("SecureReadPassword"); + + int exitCode = -1; + + char *ret = NULL; + + // + // Check args. + // + + FAILEX(pass == NULL, "ERROR: 'pass' cannot be NULL in SecureReadPassword().\n"); + FAILEX(passSize < 1, "ERROR: 'passSize' cannot be < 1 in SecureReadPassword().\n"); + + // + // Show prompt if specified. + // + + if (prompt) + { + printf("%s", prompt); + } + + fflush(stdout); + + // + // Disable echo. + // + + FAIL(SecureDisableEcho()); + + // + // Read password from stdin. + // + + ret = fgets(pass, passSize, stdin); + + FAIL(ret == NULL); + + // + // Enable back echo. + // + + printf("\n"); + + fflush(stdout); + + // + // Remove end of line chars from readed pass. + // + + for (int i = 0; pass[i]; i++) + { + if (pass[i] == 10 || pass[i] == 13) + { + pass[i] = 0; + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot read password from stdin.\n"); + } + + SecureEnableEcho(); + + DBG_LEAVE("SecureReadPassword"); + + return exitCode; + } + + // + // Verify password stored as SHA256(pass + salt). + // Function compute SHA256(pass + salt) by own and compare result with + // expectedHash parameter. + // + // expectedHash - expected SHA256(pass + salt) hash computed in register time (IN). + // password - plain text password (IN). + // salt - salt generated in register time (IN). + // + // RETURNS: 0 if SHA256(pass + salt) matches expectedHash (authorization ok), + // 1 if hashes does not matches (authorization failed) + // -1 if unexpected error occures. + // + + int SecurePassAuthorize(const char *expectedHash, + const char *password, const char *salt) + { + DBG_ENTER3("SecurePassAuthorize"); + + int exitCode = -1; + + char hash[64 + 1]; + + // + // Check args. + // + + FAILEX(expectedHash == NULL, "ERROR: 'expectedHash' cannot be NULL in SecurePassAuthorize().\n"); + FAILEX(password == NULL, "ERROR: 'password' cannot be NULL in SecurePassAuthorize().\n"); + FAILEX(salt == NULL, "ERROR: 'salt' cannot be NULL in SecurePassAuthorize().\n"); + + // + // Compute SHA256(password + salt). + // + + FAIL(SecureHashSha256(hash, sizeof(hash), password, + strlen(password), salt, strlen(salt))); + + DEBUG3("SecurePassAuthorize: Computed hash is [%s].\n", hash); + + // + // Compare computed hash with expected one. + // + + if (strcmp(hash, expectedHash) == 0) + { + exitCode = 0; + + DEBUG2("Authorization OK.\n"); + } + else + { + exitCode = 1; + + DEBUG2("Authorization failed.\n"); + } + + // + // Error handler. + // + + fail: + + if (exitCode == -1) + { + Error("ERROR: Cannot perform password authorization.\n"); + } + + DBG_LEAVE3("SecurePassAuthorize"); + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibSecure/README b/Source/Net/LibSecure/README new file mode 100644 index 0000000..e538aa7 --- /dev/null +++ b/Source/Net/LibSecure/README @@ -0,0 +1,49 @@ +------------------------------------------------------------------------------- + + Secure connection + +------------------------------------------------------------------------------- + +1. Init +------- + +1. To wrap existing non-encrypted connection into encrypted one (TLS) use + one of SecureConnectionCreate() functions family. + + Input non-encrypted connection can be defined as: + - FD pair + - socket + - {read, write} callbacks + + +2. To start TLS session: +------------------------ + + Server needs: + - certificate file (cert parameter) + - private key file (privKey paramter) + + Client needs: + - nothing (cert and privKey parameters should be NULL) + + +3. Server skeleton code: +------------------------ + + sc = SecureConnectionCreate(SECURE_INTENT_SERVER, ..., cert, privateKey); + + sc -> read(...); + sc -> write(...); + + sc -> release(); + + +4. Client skeleton code: +------------------------ + + sc = SecureConnectionCreate(SECURE_INTENT_CLIENT, ..., NULL, NULL); + + sc -> write(...); + sc -> read(...); + + sc -> release(); diff --git a/Source/Net/LibSecure/Random.cpp b/Source/Net/LibSecure/Random.cpp new file mode 100644 index 0000000..6c7d42c --- /dev/null +++ b/Source/Net/LibSecure/Random.cpp @@ -0,0 +1,189 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Generate cryptogically strong random numbers or buffers. +// + +#include "Secure.h" + +#ifdef WIN64 + static int Win64NotImportedError() + { + fprintf(stderr, "OpenSSL is not imported on Win64"); + exit(-1); + } + + #define RAND_bytes(x, y) Win64NotImportedError() +#endif + +namespace Tegenaria +{ + // + // Generate random buffer. + // + // buf - buffer, where to store generated data (OUT). + // len - number of butes to generate (IN). + // + // RETURNS: 0 if OK. + // + + int SecureRandom(void *buf, int len) + { + if (RAND_bytes((unsigned char *) buf, len) == 1) + { + return 0; + } + else + { + Error("Cannot generate random buffer.\n"); + + return -1; + } + } + + // + // Generate random 32-bit integer. + // + + uint32_t SecureRandomInt32() + { + uint32_t ret = -1; + + SecureRandom(&ret, sizeof(ret)); + + return ret; + } + + // + // Generate random 64-bit integer. + // + + uint64_t SecureRandomInt64() + { + uint64_t ret = -1; + + SecureRandom(&ret, sizeof(ret)); + + return ret; + } + + // + // Generate random byte. + // + + uint8_t SecureRandomByte() + { + uint8_t ret = -1; + + SecureRandom(&ret, sizeof(ret)); + + return ret; + } + + // + // Generate random text. + // Example: K1aCK1bC0=38]8GM9ggk5=K836@yee5M + // + // buf - buffer, where to store generated text (OUT). + // len - size of buf[] buffer in bytes (IN). + // + // RETURNS: 0 if OK. + // + + int SecureRandomText(char *buf, int len) + { + int exitCode = -1; + + FAIL(SecureRandom(buf, len)); + + for (int i = 0; i < len; i++) + { + buf[i] = '0' + ((unsigned int) buf[i]) % ('z' - '0'); + } + + buf[len - 1] = 0; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return exitCode; + } + + // + // Generate random hex asciz text. + // Example: 23c02a8b7c7 + // + // buf - buffer, where to store generated hex text (OUT). + // len - size of buf[] buffer in bytes (IN). + // + // RETURNS: 0 if OK. + // + + int SecureRandomHexText(char *buf, int len) + { + int exitCode = -1; + + char *dst = buf; + + char hex[] = "0123456789abcdef"; + + // + // Generate raw random buffer. + // + + FAIL(SecureRandom(buf + len / 2, len / 2)); + + // + // Convert raw buffer to hex. + // + + dst = buf; + + for (int i = len / 2; i < len; i++) + { + dst[0] = hex[(buf[i] & 0x0f)]; + dst[1] = hex[(buf[i] & 0xf0) >> 4]; + + dst += 2; + } + + buf[len - 1] = 0; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return exitCode; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibSecure/Secure.h b/Source/Net/LibSecure/Secure.h new file mode 100644 index 0000000..fe9a290 --- /dev/null +++ b/Source/Net/LibSecure/Secure.h @@ -0,0 +1,439 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Secure_H +#define Tegenaria_Core_Secure_H + +// +// Includes. +// + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#ifdef WIN32 +# include +#else +# include +# include +#endif + +#include +#include +#include + +#include +#include + +namespace Tegenaria +{ + using std::string; + using std::list; + using std::map; + + // + // Defines. + // + + #define SECURE_INTENT_SERVER 0 + #define SECURE_INTENT_CLIENT 1 + + #define SECURE_STATE_HANDSHAKE_WRITE 0 + #define SECURE_STATE_HANDSHAKE_READ 1 + #define SECURE_STATE_ESTABLISHED 2 + + #define SECURE_IOMODE_NONE 0 + #define SECURE_IOMODE_CALLBACKS 1 + #define SECURE_IOMODE_FDS 2 + #define SECURE_IOMODE_SOCKET 3 + + #define SECURE_TLS_HANDSHAKE_TIMEOUT 30000 // Timeout while performing SSL handshake + + #define SECURE_BLOWFISH_KEY_SIZE 16 + + #define SECURE_CIPHER_BLOWFISH 0 + + #define SECURE_CIPHER_MODE_ECB 0 + #define SECURE_CIPHER_MODE_CTR 1 + + #define SECURE_MAX_KEYPASS_LEN 64 + + // + // Rights for ACL. + // + + #define SECURE_ACL_DENY (1 << 0) + #define SECURE_ACL_FULL (1 << 1) + #define SECURE_ACL_READ (1 << 2) + #define SECURE_ACL_WRITE (1 << 3) + #define SECURE_ACL_ERASE (1 << 4) + + #define SECURE_ACL_SYMBOL_DENY 'D' + #define SECURE_ACL_SYMBOL_FULL 'F' + #define SECURE_ACL_SYMBOL_READ 'R' + #define SECURE_ACL_SYMBOL_WRITE 'W' + #define SECURE_ACL_SYMBOL_ERASE 'E' + + // + // Typedef. + // + + typedef int (*SecureReadProto)(void *buf, int count, int timeout, void *ctx); + typedef int (*SecureWriteProto)(const void *buf, int count, int timeout, void *ctx); + + // + // Class to wrap FD/SOCKET/Callbacks into secure one. + // + + class SecureConnection + { + // + // Friends. + // + + friend SecureConnection + *SecureConnectionCreate(int, SecureReadProto, SecureWriteProto, + void *, const char *, const char *, + const char *); + friend SecureConnection + *SecureConnectionCreate(int, int, int, const char *, + const char *, const char *); + friend SecureConnection + *SecureConnectionCreate(int, int, const char *, + const char *, const char *); + + friend SecureConnection + *SecureConnectionCreate(int, const char *, + const char *, const char *); + + // + // Private fields. + // + + private: + + // + // Underlying SSL data. + // + + BIO *readBio_; + BIO *writeBio_; + + SSL *ssl_; + + SSL_CTX *sslCtx_; + + // + // SECURE_INTENT_CLIENT or SECURE_INTENT_SERVER. + // + + int intent_; + + // + // Current connection state. + // See SECURE_STATE_XXX defines. + // + + int state_; + + // + // Specify type of underlying unecrypted IO. + // See SECURE_IOMODE_XXX defines. + // + + int ioMode_; + + // + // Used when underlying IO is defined by {read, write} callbacks. + // + + SecureReadProto readCallback_; + SecureWriteProto writeCallback_; + + void *ioCtx_; + + // + // Used when underlying IO is defined by FD pair. + // + + int fdIn_; + int fdOut_; + + // + // Used when underlying IO is a socket. + // + + int sock_; + + // + // Reffrence counter to track number of third objects + // using current secure connection object. + // + + int refCount_; + + Mutex refCountMutex_; + + // + // Private init functions. + // + + SecureConnection(); + + ~SecureConnection(); + + int initSSL(int intent, const char *cert, + const char *privKey, const char *privKeyPass); + + // + // Callbacks called by OpenSSL. + // + + static int readPassCallback(char *buf, int size, + int rwflag, void *userdata); + + // + // Public interface. + // + + public: + + // + // Refference counter. + // + + void addRef(); + void release(); + + // + // Functions for read/write/request over secure connection. + // + + int write(const void *buf, int len, int timeout); + + int read(void *buf, int len, int timeout); + + int request(int *serverCode, char *serverMsg, + int serverMsgSize, int timeout, const char *fmt, ...); + + // + // Direct encrypt/decrypt using underlying SSL object. + // + + int encrypt(void *encrypted, int encryptedSize, + const void *buffer, int bufferSize); + + int decrypt(void *decrypted,int decryptedSize, + const void *buffer, int bufferSize); + + // + // Functions for read/write bypassing encryption system. + // These function passes data to underlying IO directly. + // + + int writeRaw(const void *buf, int len, int timeout); + + int readRaw(void *buf, int len, int timeout); + + // + // Handshake. + // + + int handshakeStep(void *customBuffer = NULL, int *customSize = NULL); + + int handshakeStep(void *outputBuffer, int *outputSize, + void *inputBuffer, int inputSize); + + // + // Getters. + // + + int getState(); + }; + + // + // Structure to store cipher context while encrypting/decrypting + // streams. + // + + struct SecureCipher; + + // + // Class to implement generic access list. + // + + class SecureAcl + { + private: + + map rights_; + + public: + + // + // Init methods. + // + + SecureAcl(); + + int initFromString(const char *acl); + + // + // Get rights from ACL. + // + + int getRights(const char *user); + + string getRightsString(const char *user); + + // + // Grant/revoke rights to ACL. + // + + int setRights(const char *user, int rights); + + int setRights(const char *user, const char *rights); + + int setOthersRights(int rights); + + int setOthersRights(const char *rights); + + int revokeAll(const char *user); + + void clear(); + + // + // Conversion methods. + // + + int encodeRights(const char *str); + + string decodeRights(int rights); + + string toString(); + }; + + // + // Exported functions. + // + + // + // Random numbers. + // + + int SecureRandom(void *buf, int len); + + int SecureRandomText(char *buf, int len); + + int SecureRandomHexText(char *buf, int len); + + uint32_t SecureRandomInt32(); + uint64_t SecureRandomInt64(); + + unsigned char SecureRandomByte(); + + // + // Generic encrypt/decrypt for raw buffers. + // + + void SecureEncrypt(SecureCipher *sc, void *buffer, int size); + void SecureDecrypt(SecureCipher *sc, void *buffer, int size); + + SecureCipher *SecureCipherCreate(int cipher, int cipherMode, + const char *key, int keySize, + const char *iv, int ivSize); + + void SecureCipherDestroy(SecureCipher *ctx); + + // + // Wrap {read, write} callback into secure connection. + // + + SecureConnection *SecureConnectionCreate(int intent, + SecureReadProto readCallback, + SecureWriteProto writeCallback, + void *ioCtx, + const char *cert, + const char *privKey, + const char *privKeyPass); + + // + // Wrap fdin/fdout pair into secure connection. + // + + SecureConnection *SecureConnectionCreate(int intent, int fdin, int fdout, + const char *cert, + const char *privKey, + const char *privKeyPass); + + // + // Wrap socket into secure connection. + // + + SecureConnection *SecureConnectionCreate(int intent, int sock, + const char *cert, + const char *privKey, + const char *privKeyPass); + + // + // Custom secure connection. + // + + SecureConnection *SecureConnectionCreate(int intent, + const char *cert, + const char *privKey, + const char *privKeyPass); + + // + // One-direction hash functions. + // + + int SecureHashSha256(char *hash, int hashSize, + const char *data, int dataSize, + const char *salt, int saltSize); + + // + // Password related functions. + // + + int SecureDisableEcho(); + + int SecureEnableEcho(); + + int SecureReadPassword(char *pass, int passSize, const char *prompt); + + int SecurePassAuthorize(const char *expectedHash, + const char *password, const char *salt); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Secure_H */ diff --git a/Source/Net/LibSecure/init.bat b/Source/Net/LibSecure/init.bat new file mode 100644 index 0000000..9ee5852 --- /dev/null +++ b/Source/Net/LibSecure/init.bat @@ -0,0 +1,23 @@ +rem +rem Private key. +rem + +openssl genrsa -des3 -out server.key 2048 + +rem +rem Public key from private. +rem + +rem openssl rsa -in server.key -out client.key -outform PEM + +rem +rem Generate a certificate signing request (CSR) +rem + +openssl req -new -key server.key -out server.csr + +rem +rem Generate self signed certificate +rem + +openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt \ No newline at end of file diff --git a/Source/Net/LibSecure/qcbuild.src b/Source/Net/LibSecure/qcbuild.src new file mode 100644 index 0000000..daa7780 --- /dev/null +++ b/Source/Net/LibSecure/qcbuild.src @@ -0,0 +1,46 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibSecure + +CXXSRC = Connection.cpp Random.cpp Cipher.cpp Hash.cpp Password.cpp Acl.cpp + +INC_DIR = Tegenaria +ISRC = Secure.h + +AUTHOR = Sylwester Wysocki + +PURPOSE = Wrap unsecure connection into secure one, +PURPOSE += generate cryptografically strong random numbers, +PURPOSE += encrypt/decrypt raw buffers. + +DEPENDS = OpenSSL LibDebug LibLock + +LIBS = -llock -ldebug +#LIBS = -lssl -lcrypto -llock -ldebug + +.section MinGW +LIBS += -lws2_32 -lgdi32 +.endsection diff --git a/Source/Net/LibSftp/Example01-sftp-client/Main.cpp b/Source/Net/LibSftp/Example01-sftp-client/Main.cpp new file mode 100644 index 0000000..e6d8811 --- /dev/null +++ b/Source/Net/LibSftp/Example01-sftp-client/Main.cpp @@ -0,0 +1,612 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +using namespace Tegenaria; + +// +// Callback function called when upload/download/list job: +// - changed state +// - new transfer statistics arrived (upload/download jobs) +// - new portion of files list arrived (list job). +// + +void JobNotifyCallback(int type, SftpJob *job) +{ + DBG_ENTER3("JobNotifyCallback"); + + switch(type) + { + // + // State changed. + // + + case SFTP_JOB_NOTIFY_STATE_CHANGED: + { + switch(job -> getState()) + { + case SFTP_JOB_STATE_ERROR: printf("\nSFTP job failed.\n"); break; + case SFTP_JOB_STATE_INITIALIZING: printf("\nSFTP job initializing.\n"); break; + case SFTP_JOB_STATE_PENDING: printf("\nSFTP job started.\n"); break; + case SFTP_JOB_STATE_FINISHED: printf("\nSFTP job finished.\n"); break; + case SFTP_JOB_STATE_STOPPED: printf("\nSFTP job stopped.\n"); break; + } + + break; + } + + // + // Transfer statistics. + // + + case SFTP_JOB_NOTIFY_TRANSFER_STATISTICS: + { + double rateMBs = job -> getAvgRate() / 1024.0 / 1024.0; + double processed = double(job -> getProcessedBytes()); + double total = double(job -> getTotalBytes()); + + printf("\rProcessed %.0lf / %.0lf, rate is %8.3lf MB/s.", processed, total, rateMBs); + + break; + } + + // + // Next part of files list arrived while performing SFTP_JOB_TYPE_LIST + // job. + // + + case SFTP_JOB_NOTIFY_FILES_LIST_ARRIVED: + { + vector &files = job -> getFiles(); + + for (int i = 0; i < files.size(); i++) + { + // + // Directory. + // + + if (SFTP_ISDIR(files[i].attr_.perm_)) + { + printf("[%s]\n", files[i].name_.c_str()); + } + + // + // File. + // + + else + { + printf("%s %"PRId64"\n", files[i].name_.c_str(), files[i].attr_.size_); + } + } + + break; + } + } + + DBG_LEAVE3("JobNotifyCallback"); +} + +// +// Get filename part from full path. +// +// Example: +// path = c:/tmp/file.dat +// returns = file.dat +// +// path - full, absolute path to split (IN). +// +// RETURNS: File part of given input path. +// + +const char *GetFileName(const char *path) +{ + int lastSlashPos = -1; + + const char *fname = NULL; + + if (path) + { + for (int i = 0; path[i]; i++) + { + if (path[i] == '/' || path[i] == '\\') + { + lastSlashPos = i; + } + } + + if (lastSlashPos == -1) + { + fname = path; + } + else + { + fname = path + lastSlashPos + 1; + } + } + + return fname; +} + +// +// On success pwd is changed to 'pwd/subDir'. +// +// sftp - pointer to connected sftp client object (IN). +// pwd - buffer, where current remote directory is stored (IN/OUT). +// pwdSize - size of pwd[] buffer in bytes (IN). +// subDir - subdirectory, where to enter (IN). +// +// RETURNS: 0 if OK. +// + +int EnterDirectory(SftpClient *sftp, char *pwd, int pwdSize, const char *subDir) +{ + DBG_ENTER("EnterDirectory"); + + int exitCode = -1; + + char newPwd[512]; + + SftpFileAttr attr; + + // + // Create newPwd = pwd/subDir. + // + + strncpy(newPwd, pwd, sizeof(newPwd) - 1); + + if (pwd[0] && pwd[1]) + { + strncat(newPwd, "/", sizeof(newPwd) - 1); + } + + strncat(newPwd, subDir, sizeof(newPwd) - 1); + + // + // Check is newPwd exists on server. + // + + if (sftp -> stat(newPwd, &attr) != 0) + { + Error("ERROR: Directory '%s' does not exist on server.\n", newPwd); + + goto fail; + } + + // + // Save new pwd. + // + + strncpy(pwd, newPwd, pwdSize); + + DEBUG1("Entered to '%s'.\n", pwd); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot enter '%s' subdirectory.\n", subDir); + } + + DBG_LEAVE("EnterDirectory"); + + return exitCode; +} + +// +// Leave current directory (i.e. go one directory up). +// On success part after last slash (/) removed from pwd[] buffer. +// +// Example: +// input pwd[] = /home/john +// output pwd[] = /home +// +// sftp - pointer to connected sftp client object (IN). +// pwd - buffer, where current remote directory is stored (IN/OUT). +// +// RETURNS: 0 if OK. +// + +int LeaveDirectory(SftpClient *sftp, char *pwd) +{ + DBG_ENTER("LeaveDirectory"); + + int exitCode = -1; + + // + // Root directory. No leave possible. + // + + if (pwd[0] == '/' && pwd[1] == 0) + { + Error("ERROR: Cannot leave root directory.\n"); + + goto fail; + } + + // + // Non-root directory. Remove part after last slash. + // + + else + { + int lastSlashPos = 0; + + for (int i = 0; pwd[i]; i++) + { + if (pwd[i] == '/' || pwd[i] == '\\') + { + lastSlashPos = i; + } + } + + if (lastSlashPos == 0) + { + lastSlashPos = 1; + } + + pwd[lastSlashPos] = 0; + + DEBUG1("Leaved to '%s'.\n", pwd); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE("LeaveDirectory"); + + return exitCode; +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + NetConnection *nc = NULL; + + SftpClient *sftp = NULL; + + const char *ip = NULL; + + int port = -1; + + int sock = -1; + int fd = -1; + + const char *localPath = NULL; + const char *remotePath = NULL; + + char cmd[128] = {0}; + char pwd[512] = "/"; + + char *ret = NULL; + + vector tokens; + + DBG_INIT_EX("libsftp-example-client.log", "debug1", DBG_STATE_ENABLE); + + DBG_HEAD("LibSFTP console client example"); + + // + // Parse command line parameters. + // + + if (argc < 3) + { + fprintf(stderr, "Usage is: %s \n", argv[0]); + + exit(-1); + } + + ip = argv[1]; + + port = atoi(argv[2]); + + // + // Connect to server. + // + + nc = NetConnect(ip, port); + + // + // Get raw socket from net connection. + // + + sock = nc -> getSocket(); + + // + // Init SFTP client over raw socket with 30s timeout. + // + + sftp = new SftpClient(sock, sock, 30, SFTP_CLIENT_SOCKET); + + sftp -> connect(); + + // + // Fall into client loop. + // + + while(1) + { + // + // Read command from stdin. + // + + printf("%s> ", pwd); + + ret = fgets(cmd, sizeof(cmd), stdin); + + // + // Remove end of line character. + // + + StrRemoveChar(cmd, 10); + StrRemoveChar(cmd, 13); + + // + // Tokenize command. + // + + StrTokenize(tokens, cmd, " \t", "\""); + + // + // Dispatch command. + // + + if (tokens.size() > 0) + { + // + // ls + // + + if (strcmp(tokens[0], "ls") == 0) + { + SftpJob *job = NULL; + + // + // Start listing content of remote directory in background + // thread. + // + + job = sftp -> listFiles(pwd, JobNotifyCallback); + + // + // Wait until list job finished. + // TIP#1: Use job -> stop() method to stop listing before finished. + // + + job -> wait(); + + job -> release(); + } + + // + // cd + // + + else if (strcmp(tokens[0], "cd") == 0) + { + // + // argument missing. + // + + if (tokens.size() < 2) + { + Error("ERROR: argument missing.\n"); + } + + // + // Change current directory. + // + + else + { + remotePath = tokens[1]; + + // + // Go one directory up. + // + + if (strcmp(remotePath, "..") == 0) + { + LeaveDirectory(sftp, pwd); + } + + // + // Go to deeper subdirectory. + // + + else + { + EnterDirectory(sftp, pwd, sizeof(pwd), remotePath); + } + } + } + + // + // download + // + + else if (strcmp(tokens[0], "download") == 0) + { + // + // argument missing. + // + + if (tokens.size() < 2) + { + Error("ERROR: argument missing.\n"); + } + + // + // Download file. + // + + else + { + string remote; + string local; + + SftpJob *job = NULL; + + // + // Remote source path = pwd/file. + // Download file from current working directory on server. + // + + remote = string(pwd); + + if (remote[remote.size() - 1] != '/') + { + remote += '/'; + } + + remote += tokens[1]; + + // + // Local destination path = file. + // Download to current directory. + // + + local = tokens[1]; + + // + // Download from to . + // + + job = sftp -> downloadFile(local.c_str(), remote.c_str(), JobNotifyCallback); + + // + // Wait until download job finished. + // TIP#1: Use job -> stop() method to stop downlading before finished. + // + + job -> wait(); + + job -> release(); + } + } + + // + // upload + // + + else if (strcmp(tokens[0], "upload") == 0) + { + // + // argument missing. + // + + if (tokens.size() < 2) + { + Error("ERROR: argument missing.\n"); + } + + // + // Download file. + // + + else + { + string remote; + string local; + + SftpJob *job = NULL; + + // + // Remote source path = pwd/file. + // Download file from current working directory on server. + // + + remote = string(pwd); + + if (remote[remote.size() - 1] != '/') + { + remote += '/'; + } + + remote += GetFileName(tokens[1]); + + // + // Local destination path = file. + // Download to current directory. + // + + local = tokens[1]; + + // + // Download from to . + // + + job = sftp -> uploadFile(remote.c_str(), local.c_str(), JobNotifyCallback); + + // + // Wait until download job finished. + // TIP#1: Use job -> stop() method to stop downlading before finished. + // + + job -> wait(); + + job -> release(); + } + } + + // + // Unknown command. + // + + else + { + Error("ERROR: Unknown command '%s'.\n", tokens[0]); + } + } + } + + return 0; +} diff --git a/Source/Net/LibSftp/Example01-sftp-client/qcbuild.src b/Source/Net/LibSftp/Example01-sftp-client/qcbuild.src new file mode 100644 index 0000000..d72aaef --- /dev/null +++ b/Source/Net/LibSftp/Example01-sftp-client/qcbuild.src @@ -0,0 +1,32 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = PROGRAM +TITLE = LibSftp-example01-sftp-client + +AUTHOR = Sylwester Wysocki + +CXXSRC = Main.cpp +DEPENDS = LibSftp LibNet LibStr +LIBS = -lsftp -lnet -lstr -ldebug -llock -lthread diff --git a/Source/Net/LibSftp/README b/Source/Net/LibSftp/README new file mode 100644 index 0000000..734a466 --- /dev/null +++ b/Source/Net/LibSftp/README @@ -0,0 +1,52 @@ +1. Init +------- + + To wrap existing FDs pair or socket connected to SFTP server + create new SftpClient object. + + SftpClient *sftp = new SftpClient(fdin, fdout); + + sftp -> connect(); + + ... some work here ... + + delete sftp; + + +2. Synchronous requests (low-level API) +--------------------------------------- + + Below methods maps to related basic SFTP requests: + + SSH2_FXP_OPEN |-> sftp -> open() + SSH2_FXP_CLOSE |-> sftp -> close() + SSH2_FXP_READ |-> sftp -> read() + SSH2_FXP_WRITE |-> sftp -> write() + SSH2_FXP_OPENDIR |-> sftp -> opendir() + SSH2_FXP_READDIR |-> sftp -> readiir() + SSH2_FXP_REMOVE |-> sftp -> remove() + SSH2_FXP_MKDIR |-> sftp -> mkdir() + SSH2_FXP_RMDIR |-> sftp -> rmdir() + SSH2_FXP_STAT |-> sftp -> stat() + SSH2_FXP_RENAME |-> sftp -> rename() + +3. Asynchronous requests (high-level API) +----------------------------------------- + + There high-level API on top of basic SFTP requests from [2] to run SFTP job + asynchronous in background threads. + + A. Download job: sftp -> downloadFile(..., callback) + B. Upload job: sftp -> uploadFile(..., callback) + C. List job: sftp -> listFiles(..., callback) + + Callback function is called when: + + - job changed its states (e.g. job finished or error occured) + - new transfer statistics arrived (upload/download jobs) + - new portion of file list arrived (list job) + + To cancel pending job use job -> cancel() method. + + WARNING: All SftpJob objects MUSTS be freed by job -> release() when no + needed longer. diff --git a/Source/Net/LibSftp/Sftp.h b/Source/Net/LibSftp/Sftp.h new file mode 100644 index 0000000..2fe5ebc --- /dev/null +++ b/Source/Net/LibSftp/Sftp.h @@ -0,0 +1,196 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Sftp_H +#define Tegenaria_Core_Sftp_H + +#ifdef WIN32 +# include +#endif + +#include +#include + +#include + +namespace Tegenaria +{ + using std::string; + + struct Statvfs_t + { + uint64_t bsize_; + uint64_t frsize_; + uint64_t blocks_; + uint64_t bfree_; + uint64_t bavail_; + uint64_t files_; + uint64_t ffree_; + uint64_t favail_; + uint64_t fsid_; + uint64_t flags_; + uint64_t namemax_; + }; + + struct SftpFileAttr + { + int64_t size_; + + uint32_t flags_; + uint32_t uid_; + uint32_t guid_; + uint32_t perm_; + uint32_t atime_; + uint32_t mtime_; + }; + + struct SftpFileInfo + { + string name_; + + SftpFileAttr attr_; + }; + + // + // Our Sftp version. + // + + #define SSH2_FILEXFER_VERSION 3 + + // + // Default sector size. + // + + #define SFTP_DEFAULT_SECTOR_SIZE (1024*32) + + // + // Timeouts to trigger partial read/write in seconds. + // + + #define SFTP_PARTIAL_READ_TIMEOUT 10 + #define SFTP_PARTIAL_WRITE_TIMEOUT 10 + + // + // Check network statistics every N packets. + // + + #define SFTP_NETSTAT_DEFAULT_TICK 128 + + // + // Client to server messages. + // + + #define SSH2_FXP_INIT 1 + #define SSH2_FXP_OPEN 3 + #define SSH2_FXP_CLOSE 4 + #define SSH2_FXP_READ 5 + #define SSH2_FXP_WRITE 6 + #define SSH2_FXP_LSTAT 7 + #define SSH2_FXP_STAT_VERSION_0 7 + #define SSH2_FXP_FSTAT 8 + #define SSH2_FXP_SETSTAT 9 + #define SSH2_FXP_FSETSTAT 10 + #define SSH2_FXP_OPENDIR 11 + #define SSH2_FXP_READDIR 12 + #define SSH2_FXP_REMOVE 13 + #define SSH2_FXP_MKDIR 14 + #define SSH2_FXP_RMDIR 15 + #define SSH2_FXP_REALPATH 16 + #define SSH2_FXP_STAT 17 + #define SSH2_FXP_RENAME 18 + #define SSH2_FXP_READLINK 19 + #define SSH2_FXP_SYMLINK 20 + #define SSH2_FXP_EXTENDED 200 + + // + // Server to client messages. + // + + #define SSH2_FXP_VERSION 2 + #define SSH2_FXP_STATUS 101 + #define SSH2_FXP_HANDLE 102 + #define SSH2_FXP_DATA 103 + #define SSH2_FXP_NAME 104 + #define SSH2_FXP_ATTRS 105 + + #define SSH2_FXP_EXTENDED_REPLY 201 + + // + // Dirligo packets. + // + + #define SSH2_FXP_DIRLIGO_CREATEFILE 220 + #define SSH2_FXP_DIRLIGO_MULTICLOSE 221 + #define SSH2_FXP_DIRLIGO_RESETDIR 222 + #define SSH2_FXP_DIRLIGO_APPEND 223 + #define SSH2_FXP_DIRLIGO_READDIR_SHORT 224 + + #define SSH2_FXP_DIRLIGO_DIR_FLAG (1 << 30) + + // + // Attributes. + // + + #define SSH2_FILEXFER_ATTR_SIZE 0x00000001 + #define SSH2_FILEXFER_ATTR_UIDGID 0x00000002 + #define SSH2_FILEXFER_ATTR_PERMISSIONS 0x00000004 + #define SSH2_FILEXFER_ATTR_ACMODTIME 0x00000008 + #define SSH2_FILEXFER_ATTR_EXTENDED 0x80000000 + + // + // Portable open modes. + // + + #define SSH2_FXF_READ 0x00000001 + #define SSH2_FXF_WRITE 0x00000002 + #define SSH2_FXF_APPEND 0x00000004 + #define SSH2_FXF_CREAT 0x00000008 + #define SSH2_FXF_TRUNC 0x00000010 + #define SSH2_FXF_EXCL 0x00000020 + + // + // statvfs@openssh.com f_flag flags. + // + + #define SSH2_FXE_STATVFS_ST_RDONLY 0x00000001 + #define SSH2_FXE_STATVFS_ST_NOSUID 0x00000002 + + // + // Status codes. + // + + #define SSH2_FX_OK 0 + #define SSH2_FX_EOF 1 + #define SSH2_FX_NO_SUCH_FILE 2 + #define SSH2_FX_PERMISSION_DENIED 3 + #define SSH2_FX_FAILURE 4 + #define SSH2_FX_BAD_MESSAGE 5 + #define SSH2_FX_NO_CONNECTION 6 + #define SSH2_FX_CONNECTION_LOST 7 + #define SSH2_FX_OP_UNSUPPORTED 8 + #define SSH2_FX_MAX 8 + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Sftp_H */ diff --git a/Source/Net/LibSftp/SftpClient.cpp b/Source/Net/LibSftp/SftpClient.cpp new file mode 100644 index 0000000..6236bd3 --- /dev/null +++ b/Source/Net/LibSftp/SftpClient.cpp @@ -0,0 +1,4753 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include +#include +#include + +#include +#include + +#ifdef WIN32 +# include +# include +#else +# include +#endif + +#include +#include + +#include "SftpClient.h" +#include "SftpJob.h" +#include "Sftp.h" +#include "Utils.h" + +namespace Tegenaria +{ + using std::string; + using std::min; + + #ifndef MAX_PATH + #define MAX_PATH 260 + #endif + + // + // ---------------------------------------------------------------------------- + // + // Constructors and destructors. + // + // ---------------------------------------------------------------------------- + // + + // + // Create SFTP client over given CRT FD pair. + // + // TIP: To initiate session with server on other side + // use connect() method. + // + // fdin - FD for input data (IN). + // fdout - FD for output data (IN). + // timeout - I/O timeout in ms, -1 means infinite (IN). + // + // fdType - set SFTP_CLIENT_FD if fdin/fdout are CRT FDs and + // SFTP_CLIENT_SOCKET if fdin/fdout are sockets. + // Defaulted to SFTP_CLIENT_FD if skipped (IN/OPT). + // + + SftpClient::SftpClient(int fdin, int fdout, int timeout, int fdType) + { + DBG_ENTER3("SftpClient"); + + DBG_SET_ADD("SftpClient", this, "%d/%d", fdin, fdout); + + fdin_ = fdin; + fdout_ = fdout; + timeout_ = timeout; + fdType_ = fdType; + sectorSize_ = SFTP_DEFAULT_SECTOR_SIZE; + dead_ = 0; + + connectionDroppedCallback_ = NULL; + connectionDroppedCallbackCtx_ = NULL; + + mutex_.setName("SftpClient"); + + // + // Init request pool. + // + + rpool_ = new RequestPool(8, "SftpClient"); + + // + // Init network statistics. + // + + netStatTick_ = SFTP_NETSTAT_DEFAULT_TICK; + + netStatCallback_ = NULL; + netStatCallbackCtx_ = NULL; + + partialReadThreshold_ = SFTP_PARTIAL_READ_TIMEOUT * 1000; + partialWriteThreshold_ = SFTP_PARTIAL_WRITE_TIMEOUT * 1000; + + netstat_.reset(); + + DBG_LEAVE3("SftpClient"); + } + + // + // Shutdown connection if any. + // + + SftpClient::~SftpClient() + { + DBG_ENTER3("SftpClient::~SftpClient"); + + disconnect(); + + delete rpool_; + + DBG_SET_DEL("SftpClient", this); + + DBG_LEAVE3("SftpClient::~SftpClient"); + } + + // + // ---------------------------------------------------------------------------- + // + // SFTP session negotiation + // + // ---------------------------------------------------------------------------- + // + + // + // Establish connection with sftp-server. + // + // Sends : SSH2_FXP_INIT packet. + // Expects : SSH2_VERSION packet. + // + // RETURNS: 0 if OK. + // + + int SftpClient::connect() + { + DBG_ENTER3("Connect::connect"); + + int exitCode = -1; + + string packet; + + // + // Process SSH2_FXP_INIT packet. + // + + StrPushDword(packet, 5, STR_BIG_ENDIAN); + StrPushByte(packet, SSH2_FXP_INIT); + StrPushDword(packet, SSH2_FILEXFER_VERSION, STR_BIG_ENDIAN); + + FAIL(processPacketSimple(packet, packet)); + + DBG_INFO("Established connection with server.\n"); + + netstat_.reset(); + + // + // Start thread loop. + // + + readThread_ = ThreadCreate(readLoop, this); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot connect to server.\n"); + } + + DBG_LEAVE3("Connect::connect"); + + return exitCode; + } + + // + // Disconnect existing connection with sftp server. + // + + void SftpClient::disconnect() + { + DEBUG1("WARNING: SftpClient::disconnect not implemented."); + } + + // + // Close existing connection with server and reinit it once again + // from begin. + // + + int SftpClient::reconnect() + { + Error("ERROR: SftpClient::reconnect is not implemented.\n"); + + return -1; + } + + // + // ---------------------------------------------------------------------------- + // + // Wrapper for standard SSH2_FXP_XXX commands. + // + // ---------------------------------------------------------------------------- + // + + // + // Open remote file or directory. + // + // Sends : SSH2_FXP_OPEN or SSH2_FXP_OPENDIR packet. + // Expect : SSH2_FXP_HANDLE or SSSH2_FXP_STATUS packet. + // + // path - path to remote file or directory (IN). + // mode - sftp access mode (IN). + // isDir - set to 1 for directory, 0 otherwise (IN). + // + // RETURNS: handle assigned by sftp-server + // or -1 if error. + // + + int64_t SftpClient::open(const char *path, int mode, int isDir) + { + DBG_ENTER3("SftpClient::open"); + + int exitCode = -1; + + string packet; + + int64_t handle = -1; + uint32_t handleSize = -1; + + int pathLen = strlen(path); + + uint32_t id = GenerateUniqueId(); + uint32_t idRet = 0; + uint32_t serverStatus = SSH2_FX_FAILURE; + uint32_t size = 0; + + uint8_t type = 0; + + DEBUG1("SFTP #%d: opening %s [%s] mode [0x%x].", + id, isDir ? "directory" : "file", path, mode); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Prepare SSH2_FXP_OPEN packet: + // + // size 4 + // SSH2_FXP_OPEN 1 + // id 4 + // pathLen 4 + // path pathLen + // mode 4 (for file only) + // attribs 4 (for file only) + // ---------------------------------- + // total: 17 + 4 + + // + + if (isDir) + { + DEBUG2("SFTP #%d: Preparing SSH2_FXP_OPENDIR packet...", id); + + type = SSH2_FXP_OPENDIR; + size = 9 + pathLen; + } + else + { + DEBUG2("SFTP #%d: Preparing SSH2_FXP_OPEN packet...", id); + + type = SSH2_FXP_OPEN; + size = 17 + pathLen; + } + + StrPushDword(packet, size, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, type); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, pathLen, STR_BIG_ENDIAN); // pathLen 4 + StrPushRaw(packet, path, pathLen); // path pathLen + + if (isDir == 0) + { + StrPushDword(packet, mode, STR_BIG_ENDIAN); // mode 4 + StrPushDword(packet, 0, STR_BIG_ENDIAN); // attr 4 + } + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + // + // Parse answer. + // + // size 4 + // type 1 + // id 4 + // ... + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + shutdown(); + + goto fail; + } + + // + // Check packet type. + // + + switch(type) + { + // + // SSH2_FXP_HANDLE with opened server side handle. + // It means success. + // + // handleSize 4 + // handle handleSize + // + + case SSH2_FXP_HANDLE: + { + uint32_t tmp; + + DEBUG2("SFTP #%d: Received [SSH2_FXP_HANDLE].", id); + + // + // FIXME: Handle 64-bit handle. + // + + FAIL(StrPopDword(&handleSize, packet, STR_BIG_ENDIAN)); + + FAILEX(handleSize != 4, "ERROR: Unsupported handle size [%d].\n", handleSize); + + FAIL(StrPopDword(&tmp, packet, STR_BIG_ENDIAN)); + + handle = tmp; + + DEBUG1("SFTP #%d: Opened [%s] as remote handle [%"PRId64"].\n", id, path, handle); + + break; + } + + // + // SSH2_FXP_STATUS feans errors on server side. + // Probably access denied. + // + + case SSH2_FXP_STATUS: + { + DEBUG2("SFTP #%d: Received [SSH2_FXP_STATUS].", id); + + FAIL(StrPopDword(&serverStatus, packet, STR_BIG_ENDIAN)); + + DEBUG1("SFTP #%d: Open [%s] failed with server code [%d][%s].\n", + id, path, serverStatus, TranslateSftpStatus(serverStatus)); + + break; + } + + // + // Fatal error. Unexpected packet type. + // + + default: + { + Error("ERROR: Unexpected packet type [%d].\n", type); + + shutdown(); + + goto fail; + } + } + + if (handle >= 0) + { + DBG_SET_ADD("sftp handle", handle, "[%s]", path); + } + + // + // Cleanup. + // + + exitCode = 0; + + fail: + + if (exitCode < 0) + { + DBG_MSG("Cannot open remote resource.\n" + "Error code is: %u.\nServer status is : [%d][%s].", + GetLastError(), serverStatus, + TranslateSftpStatus(serverStatus)); + + handle = -1; + } + + DBG_LEAVE3("SftpClient::open"); + + return handle; + } + + // + // Open remote directory. + // Works as open with isDir set to 1. + // See SftpClient::open(). + // + + int64_t SftpClient::opendir(const char *path) + { + return open(path, 0, 1); + } + + // + // Close remote handle on server. + // + // Sends : SSH2_FXP_CLOSE packet. + // Expect : SSH2_FXP_STATUS packet. + // + // handle - handle value retrieved from open() before (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::close(int64_t handle) + { + DBG_ENTER3("SftpClient::close"); + + uint32_t serverStatus = SSH2_FX_FAILURE; + + uint32_t id = GenerateUniqueId(); + uint32_t size = 0; + uint32_t idRet = 0; + + uint8_t type = 0; + + string packet; + + DEBUG1("SFTP #%d: close handle [%"PRId64"].", id, handle); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Prepare SSH2_FXP_CLOSE packet: + // + // size 4 + // SSH2_FXP_CLOSE 1 + // id 4 + // handleLen 4 + // handle 4 + // ---------------------------------- + // total: 13 + 4 + // + + DEBUG2("SFTP #%d: Preparing SSH2_FXP_CLOSE packet...", id); + + StrPushDword(packet, 13, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_CLOSE); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, 4, STR_BIG_ENDIAN); // handleLen 4 + StrPushDword(packet, uint32_t(handle), STR_BIG_ENDIAN); // handle 4 + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + // + // Receive status packet. + // + + serverStatus = popStatusPacket(packet, id); + + FAIL(serverStatus != SSH2_FX_OK); + + DBG_SET_DEL("sftp handle", handle); + + // + // Error handler. + // + + fail: + + DEBUG1("SFTP #%d: Close handle [%"PRId64"] finished with code [%d].\n", + id, handle, serverStatus); + + DBG_LEAVE3("SftpClient::close"); + + return serverStatus; + } + + // + // Close many remote handles in one request. + // + // Sends : SSH2_FXP_DIRLIGO_MULTICLOSE packet. + // Expect : SSH2_FXP_STATUS packet. + // + // handle - list of handles value retrieved from open() before (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::multiclose(vector &handles) + { + DBG_ENTER3("SftpClient::multiclose"); + + uint32_t serverStatus = SSH2_FX_FAILURE; + + uint32_t id = GenerateUniqueId(); + uint32_t size = 0; + uint32_t idRet = 0; + + uint32_t packetSize; + + uint8_t type = 0; + + string packet; + + #ifdef DEBUG + { + string handlesListStr; + + for (int i = 0; i < handles.size(); i++) + { + char buf[32]; + + snprintf(buf, sizeof(buf) - 1, "%I64d, ", handles[i]); + + handlesListStr += buf; + } + + DEBUG1("SFTP #%d: multi-close {%s}.", id, handlesListStr.c_str()); + } + #endif + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Don't run request if handles lilst is empty. + // + + if (handles.size() > 0) + { + // + // Prepare SSH2_FXP_DIRLIGO_MULTICLOSE packet: + // + // size 4 + // SSH2_FXP_MULTICLOSE 1 + // id 4 + // count 4 + // handle 4 x n times + // ---------------------------------- + // total: 13 + 4 * nHandles + // + + DEBUG2("SFTP #%d: Preparing SSH2_FXP_MULTICLOSE packet...", id); + + packetSize = 9 + 4 * handles.size(); + + StrPushDword(packet, packetSize, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_DIRLIGO_MULTICLOSE); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, handles.size(), STR_BIG_ENDIAN); // count 4 + + for (int i = 0; i < handles.size(); i++) + { + StrPushDword(packet, uint32_t(handles[i]), STR_BIG_ENDIAN); // handle 4 + } + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + // + // Receive status packet. + // + + serverStatus = popStatusPacket(packet, id); + + FAIL(serverStatus != SSH2_FX_OK); + + for (int i = 0; i < handles.size(); i++) + { + DBG_SET_DEL("sftp handle", handles[i]); + } + } + + // + // Error handler. + // + + fail: + + DEBUG1("SFTP #%d: multi-close finished with code [%d].\n", id, serverStatus); + + DBG_LEAVE3("SftpClient::multiclose"); + + return serverStatus; + } + + // + // Reset directory handle. If readdir() finished with EOF on given handle + // resetdir() request will reopen directory on server to make the same handle + // possible to reuse in another readdir() request. + // + // Sends : SSH2_FXP_DIRLIGO_RESETDIR packet. + // Expect : SSH2_FXP_STATUS packet. + // + // handle - handle value retrieved from opendir() before (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::resetdir(int64_t handle) + { + DBG_ENTER3("SftpClient::resetdir"); + + uint32_t serverStatus = SSH2_FX_FAILURE; + + uint32_t id = GenerateUniqueId(); + uint32_t size = 0; + uint32_t idRet = 0; + + uint32_t packetSize; + + uint8_t type = 0; + + string packet; + + DEBUG1("SFTP #%d: resetdir [%I64d].", id, handle); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Prepare SSH2_FXP_DIRLIGO_RESETDIR packet: + // + // size 4 + // SSH2_FXP_RESETDIR 1 + // id 4 + // handle 4 + // ---------------------------------- + // total: 13 + // + + DEBUG2("SFTP #%d: Preparing SSH2_FXP_RESETDIR packet...", id); + + StrPushDword(packet, 9, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_DIRLIGO_RESETDIR); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, int32_t(handle), STR_BIG_ENDIAN); // handle 4 + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + // + // Receive status packet. + // + + serverStatus = popStatusPacket(packet, id); + + FAIL(serverStatus != SSH2_FX_OK); + + // + // Error handler. + // + + fail: + + DEBUG1("SFTP #%d: resetdir finished with code [%d].\n", id, serverStatus); + + DBG_LEAVE3("SftpClient::resetdir"); + + return serverStatus; + } + + // + // Read data from remote file. + // + // Sends : many SSH2_FXP_READ. + // Expect : many SSH2_FXP_DATA and one SSH2_FXP_STATUS for EOF signal. + // + // handle - handle retrieved from open() before (IN). + // buffer - buffer, where to store readed data (OUT). + // offset - file position of first byte to read (IN). + // bytesToRead - number of bytes to read (IN). + // + // RETURNS: Number of bytes readed, + // or -1 if error. + // + + int SftpClient::read(int64_t handle, char *buffer, uint64_t offset, int bytesToRead) + { + DBG_ENTER3("SftpClient::read"); + + int exitCode = -1; + + int goOn = 1; + int readed = 0; + + double startTime = 0.0; + double endTime = 0.0; + double elapsed = 0.0; + double elapsedTotal = 0.0; + + int pieceSize = 0; + + uint32_t serverStatus = 0; + + string packet; + + DEBUG1("SFTP: read(%"PRId64", %p, %"PRId64", %d).", handle, buffer, offset, bytesToRead); + + FAILEX(dead_, "SFTP: read() rejected because session dead.\n"); + + // + // Read packets unitil: + // + // - EOF. + // - error. + // - read time can exceed system I/O timeout + // (for big caller buffer or slow network). + // + + while(goOn) + { + packet.clear(); + + uint32_t id = GenerateUniqueId(); + uint32_t idRet = 0; + uint32_t size = 0; + + uint8_t type = 0; + + // + // Compute size of current piece. + // + + pieceSize = min(bytesToRead - readed, sectorSize_); + + // + // Prepare next SSH2_FXP_READ message. + // + // size 4 + // type 1 + // id 4 + // handleLen 4 + // handle 4 (32-bit) + // offset 8 (64-bit) + // bytesToRead 4 + // ----------------------- + // total: 25 + 4 + // + + DEBUG3("SFTP #%d: Preparing SSH2_FXP_READ packet...\n", id); + + StrPushDword(packet, 25, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_READ); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, 4, STR_BIG_ENDIAN); // handleLen 4 + StrPushDword(packet, uint32_t(handle), STR_BIG_ENDIAN); // handle 4 + StrPushQword(packet, offset, STR_BIG_ENDIAN); // offset 8 + StrPushDword(packet, pieceSize, STR_BIG_ENDIAN); // toRead 4 + + // + // Send SSH2_FXP_READ packet. + // Expect SSH2_FXP_DATA or SSH2_FXP_STATUS. + // + + startTime = GetTimeMs(); + + FAIL(processPacket(packet, packet)); + + endTime = GetTimeMs(); + + elapsed = endTime - startTime; + + DEBUG2("SFTP #%d: Sent [SSH2_FXP_READ] packet.\n", id); + + // + // Pop header: + // + // size 4 + // type 1 + // id 4 + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + shutdown(); + + goto fail; + } + + // + // Parse reveived packet. + // + + switch(type) + { + // + // Next portion of readed data. + // + + case SSH2_FXP_DATA: + { + DEBUG2("SFTP #%d: received [SSH2_FXP_DATA].", id); + + uint32_t len = 0; + + // + // Put reveived data to output buffer. + // + + FAIL(StrPopDword(&len, packet, STR_BIG_ENDIAN)); + + DEBUG3("SFTP #%d: Excepting [%d] data bytes...", id, len); + + if (packet.size() < len) + { + Error("ERROR: Received [%d] data, but [%d] expected.", packet.size(), len); + + shutdown(); + + goto fail; + } + + memcpy(buffer, &packet[0], len); + + readed += len; + buffer += len; + offset += len; + + // + // If we readed all expected data stop listening. + // + + if (readed == bytesToRead) + { + DEBUG3("SFTP #%d: Reading completed.", id); + + goOn = 0; + } + + // + // Update statistics. + // + + netstat_.insertDownloadEvent(len, elapsed); + + break; + } + + // + // Status message means EOF or error. + // + + case SSH2_FXP_STATUS: + { + DEBUG2("SFTP #%d: received [SSH2_FXP_STATUS].\n", id); + + FAIL(StrPopDword(&serverStatus, packet, STR_BIG_ENDIAN)); + + FAILEX(serverStatus != SSH2_FX_EOF, + "Read failed with server code [%d][%s].\n", + serverStatus, TranslateSftpStatus(serverStatus)); + + goOn = 0; + + break; + } + + // + // Unexpected packet's type. + // + + default: + { + Error("SFTP #%d: ERROR: Unexpected packet type received [%d].", id, type); + + shutdown(); + + goto fail; + } + } + + // + // Check for timeout. + // + + elapsedTotal += elapsed; + + if (elapsedTotal > partialReadThreshold_) + { + Error("WARNING: Partial read triggered after %lf seconds.\n", elapsedTotal / 1000.0); + + netstat_.triggerPartialRead(); + + if (netStatCallback_) + { + netStatCallback_(&netstat_, netStatCallbackCtx_); + } + + goOn = 0; + } + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot read from remote file. Error code is: %u.\n" + "Server status: is [%d][%s].", GetLastError(), + serverStatus, TranslateSftpStatus(serverStatus)); + } + + DBG_LEAVE3("SftpClient::read"); + + return exitCode ? -1 : readed; + } + + // + // Write data to remote file. + // + // Sends : many SSH2_FXP_WRITE packets. + // Expect : many SSH2_FXP_STATUS packets. + // + // handle - handle retrieved from open() before (IN). + // buffer - buffer with data, which we want to write (IN). + // offset - file position, where to start writing (IN). + // bytesToWrite - number of bytes to write (IN). + // + // RETURNS: Number of bytes written, + // or -1 if error. + // + + int SftpClient::write(int64_t handle, char *buffer, uint64_t offset, int bytesToWrite) + { + DBG_ENTER3("SftpClient::write"); + + int exitCode = -1; + + int written = 0; + int pieceSize = 0; + + int goOn = 1; + + double startTime = 0.0; + double endTime = 0.0; + double elapsed = 0.0; + double elapsedTotal = 0.0; + + uint32_t serverStatus = 0; + + string packet; + + DEBUG1("SFTP: write(%"PRId64", %p, %"PRId64", %d).", handle, buffer, offset, bytesToWrite); + + FAILEX(dead_, "SFTP: write() rejected because session dead.\n"); + + // + // Write packets until all data sent or error. + // + + while(goOn) + { + uint32_t id = GenerateUniqueId(); + uint32_t idRet = 0; + uint32_t size = 0; + + uint8_t type = 0; + + // + // Compute size of current piece. + // + + pieceSize = min(bytesToWrite - written, sectorSize_); + + // + // Prepare next SSH2_FXP_WRITE message. + // + // size 4 + // type 1 + // id 4 + // handleLen 4 + // handle 4 (32-bit) + // offset 8 (64-bit) + // pieceSize 4 + // data pieceSize + // ----------------------- + // total: 25 + 4 + pieceSize + // + + DEBUG3("SFTP #%d: Preparing SSH2_FXP_WRITE packet...\n", id); + + packet.clear(); + + StrPushDword(packet, 25 + pieceSize, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_WRITE); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, 4, STR_BIG_ENDIAN); // handleLen 4 + StrPushDword(packet, uint32_t(handle), STR_BIG_ENDIAN); // handle 4 + StrPushQword(packet, offset, STR_BIG_ENDIAN); // offset 8 + StrPushDword(packet, pieceSize, STR_BIG_ENDIAN); // pieceSize 4 + + packet.resize(packet.size() + pieceSize); + + memcpy(&packet[29], buffer, pieceSize); + + // + // Send SSH2_FXP_WRITE packet. + // Expect SSH2_FXP_STATUS. + // + + startTime = GetTimeMs(); + + FAIL(processPacket(packet, packet)); + + endTime = GetTimeMs(); + + DEBUG2("SFTP #%d: Sent [SSH2_FXP_WRITE] packet.\n", id); + + // + // Pop header: + // + // size 4 + // type 1 + // id 4 + // status 4 + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + FAIL(StrPopDword(&serverStatus, packet, STR_BIG_ENDIAN)); // status 4 + + // + // Check packet ID. + // + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + shutdown(); + + goto fail; + } + + // + // Check packet type. + // + + if (type != SSH2_FXP_STATUS) + { + Error("ERROR: Unexpected packet type [%d]" + " when [%d] expected.\n", type, SSH2_FXP_STATUS); + + shutdown(); + + goto fail; + } + + FAIL(serverStatus != SSH2_FX_OK); + + // + // Move to next piece to send. + // + + written += pieceSize; + buffer += pieceSize; + offset += pieceSize; + + // + // Update statistics. + // + + elapsed = endTime - startTime; + + netstat_.insertUploadEvent(pieceSize, elapsed); + + // + // Check for timeout. + // + + elapsedTotal += elapsed; + + if (elapsedTotal > partialWriteThreshold_) + { + Error("WARNING: Partial write triggered after %lf seconds.\n", elapsedTotal / 1000.0); + + netstat_.triggerPartialWrite(); + + if (netStatCallback_) + { + netStatCallback_(&netstat_, netStatCallbackCtx_); + } + + goOn = 0; + } + + // + // Check do we still have some to write. + // + + if (written >= bytesToWrite) + { + goOn = 0; + } + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot write to remote file. Error code is: %u.\n" + "Server status is: [%d][%s].", GetLastError(), + serverStatus, TranslateSftpStatus(serverStatus)); + } + + DBG_LEAVE3("SftpClient::write"); + + return exitCode ? -1 : written; + } + + // + // Append data to remote file. + // + // Sends : many SSH2_FXP_DIRLIGO_APPEND packets. + // Expect : many SSH2_FXP_STATUS packets. + // + // handle - handle retrieved from open() before (IN). + // buffer - buffer with data, which we want to write (IN). + // bytesToWrite - number of bytes to write (IN). + // + // RETURNS: Number of bytes written, + // or -1 if error. + // + + int SftpClient::append(int64_t handle, char *buffer, int bytesToWrite) + { + DBG_ENTER3("SftpClient::append"); + + int exitCode = -1; + + Error("SftpClient::append() not implemented.\n"); + + DBG_LEAVE3("SftpClient::append"); + + return exitCode; + } + + #ifdef WIN32 + + // + // Windows implementation of stat() command. + // Check is file exists and optionally retrieve file attributes. + // + // Sends : SSH2_FXP_STAT_VERSION_0 packet. + // Expects : SSH2_FXP_ATTR or SSH2_FXP_STATUS. + // + // path - full remote path on server (IN). + // info - info about remote file. (OUT). + // + // RETURNS: 0 if OK. + // + + int SftpClient::stat(const char *path, BY_HANDLE_FILE_INFORMATION *info) + { + DBG_ENTER3("SftpClient::stat"); + + int exitCode = -1; + + uint32_t serverStatus = 0; + uint32_t id = GenerateUniqueId(); + uint32_t idRet = 0; + uint32_t pathLen = 0; + uint32_t size = 0; + + uint8_t type = 0; + + string packet; + + DEBUG1("SFTP #%d: stat(%s).", id, path); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Check args. + // + + FAILEX(path == NULL, "ERROR: Null 'path' passed to SftpClient::stat().\n"); + FAILEX(info == NULL, "ERROR: Null 'info' passed to SftpClient::stat().\n"); + + // + // Prepare SSH2_FXP_STAT_VERSION_0 packet. + // + // size 4 + // type 1 + // id 4 + // pathLen 4 + // path pathLen + // ----------------------- + // total: 9 + pathLen + 4 + // + + DEBUG3("SFTP #%d: preparing SSH2_FXP_STAT_VERSION_0 packet...", id); + + pathLen = strlen(path); + + StrPushDword(packet, 9 + pathLen, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_STAT_VERSION_0); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, pathLen, STR_BIG_ENDIAN); // pathLen 4 + StrPushRaw(packet, path, pathLen); // path pathLen + + // + // Send packet, wait for answer. + + FAIL(processPacket(packet, packet)); + + DEBUG2("SFTP #%d: [SSH2_FXP_STAT_VERSION_0][%s] packet.\n", id, path); + + // + // Pop header: + // + // size 4 + // type 1 + // id 4 + // status 4 + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + shutdown(); + + goto fail; + } + + // + // Process received answer. + // + + switch(type) + { + // + // SSH2_FXP_ATTR message. We should get resource's + // attributes here. + // + + case SSH2_FXP_ATTRS: + { + DEBUG2("SFTP #%d: received [SSH2_FXP_ATTRS].", id); + + // + // If extended request decode reveived attributes. + // + + if (info) + { + FAIL(popAttribs(info, packet)); + } + + DEBUG1("SFTP #%d: Stat [%s] finished with success.", id, path); + + break; + } + + // + // SSH2_FXP_STATUS message. This means error or resource + // not exists. + // + + case SSH2_FXP_STATUS: + { + DBG_MSG("SFTP #%d: received [SSH2_FXP_STATUS].", id); + + FAIL(StrPopDword(&serverStatus, packet, STR_BIG_ENDIAN)); + + FAIL(serverStatus != SSH2_FX_OK); + + break; + } + + // + // Unexpected message type. + // + + default: + { + Error("SFTP #%d: ERROR: Unexpected message type [0x%x].", id, type); + + shutdown(); + + goto fail; + } + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("Cannot stat remote file.\n" + "Error code is: %u.\nServer status is: [%d][%s].", + GetLastError(), serverStatus, + TranslateSftpStatus(serverStatus)); + } + + DBG_LEAVE3("SftpClient::stat"); + + return exitCode; + } + + // + // Windows implementation of readdir(). + // List content of remote directory. + // + // Sends : many SSH2_FXP_DIRLIGO_READDIR_SHORT packets. + // Expects : many SSH2_FXP_NAME and one SSH2_FXP_STATUS for EOF. + // + // data - list of files/dirs living inside selected directory (OUT). + // handle - value retrieved from open() function before (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::readdir(vector &data, int64_t handle) + { + DBG_ENTER3("SftpClient::readdir"); + + int exitCode = -1; + int goOn = 1; + int capacity = 0; + int iter = 0; + + uint32_t serverStatus = 0; + + string packet; + + data.clear(); + + DEBUG1("SFTP: readdir(%"PRId64").", handle); + + FAILEX(dead_, "SFTP: readdir() rejected because session dead.\n"); + + // + // Send requests for data until EOF or error. + // + + while(goOn) + { + uint32_t id = GenerateUniqueId(); + uint32_t idRet = 0; + uint32_t size = 0; + uint32_t count = 0; + + uint8_t type = 0; + + iter ++; + + // + // Prepare SSH2_FXP_DIRLIGO_READDIR_SHORT message. + // + // + // size 4 + // type 1 + // id 4 + // handleLen 4 + // handle 4 + // ---------------------------------- + // total: 13 + 4 + // + + packet.clear(); + + StrPushDword(packet, 13, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_DIRLIGO_READDIR_SHORT); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, 4, STR_BIG_ENDIAN); // handleLen 4 + StrPushDword(packet, uint32_t(handle), STR_BIG_ENDIAN); // handle 4 + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + DEBUG2("SFTP #%d: Sent [SSH2_FXP_DIRLIGO_READDIR_SHORT][%"PRId64"].\n", id, handle); + + // + // Pop header: + // + // size 4 + // type 1 + // id 4 + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + shutdown(); + + goto fail; + } + + // + // Interprete received message. + // + + switch(type) + { + // + // Status message. This means EOF or error. + // + + case SSH2_FXP_STATUS: + { + DEBUG2("SFTP #%d: received [SSH2_FXP_STATUS].", id); + + goOn = 0; + + FAIL(StrPopDword(&serverStatus, packet, STR_BIG_ENDIAN)); + + FAIL(serverStatus != SSH2_FX_EOF); + + DEBUG1("SFTP #%d: Readdir handle [%"PRId64"] finished with code [%d][%s].\n", + id, handle, serverStatus, TranslateSftpStatus(serverStatus)); + + break; + } + + // + // SSH2_FXP_NAME. Next portion of data. + // + + case SSH2_FXP_NAME: + { + DEBUG2("SFTP #%d: received [SSH2_FXP_NAME].", id); + + // + // Pop number of elements. + // + + FAIL(StrPopDword(&count, packet, STR_BIG_ENDIAN)); + + DEBUG2("SFTP #%d: Popped elements count [%d].\n", id, count); + + // + // Pop elements from packet. + // + + for (int i = 0; i < count; i++) + { + WIN32_FIND_DATAW buf = {0}; + + BY_HANDLE_FILE_INFORMATION info = {0}; + + char name[MAX_PATH] = {0}; + char longName[MAX_PATH] = {0}; + + uint32_t nameLen = 0; + uint32_t longNameLen = 0; + + // + // Pop element's name. + // + + FAIL(StrPopDword(&nameLen, packet, STR_BIG_ENDIAN)); + FAIL(StrPopRaw(name, nameLen, packet)); + + FAIL(StrPopDword(&longNameLen, packet, STR_BIG_ENDIAN)); + FAIL(StrPopRaw(longName, longNameLen, packet)); + + DEBUG2("SFTP #%d: Popped element [%s] / [%s].\n", id, name, longName); + + // + // We expecting UTF8 from network. + // Convert UTF8 to UTF16. + // + + MultiByteToWideChar(CP_UTF8, 0, name, -1, + buf.cFileName, sizeof(buf.cFileName)); + + // + // Pop attributes. + // + + FAIL(popAttribs(&info, packet)); + + buf.dwFileAttributes = info.dwFileAttributes; + buf.ftCreationTime = info.ftCreationTime; + buf.ftLastAccessTime = info.ftLastAccessTime; + buf.ftLastWriteTime = info.ftLastWriteTime; + buf.nFileSizeHigh = info.nFileSizeHigh; + buf.nFileSizeLow = info.nFileSizeLow; + + // + // Last entry marker. Don't go on. + // + + if (strcmp(name, "...") == 0) + { + goOn = 0; + } + + // + // Put another element to list. + // + + else + { + data.push_back(buf); + } + } + + break; + } + + // + // Unexpected packet type. Break. + // + + default: + { + Error("SFTP #%d: ERROR: Unexpected packet type [%d].", id, type); + + shutdown(); + + goto fail; + } + } + } + + DEBUG2("SFTP: %d elements listed.", data.size()); + + // + // Cleanup. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot read remote directory.\n" + " Server status is: [%d][%s].", serverStatus, + TranslateSftpStatus(serverStatus)); + + } + + DBG_LEAVE3("SftpClient::readdir"); + + return exitCode; + } + + #endif /* WIN32 */ + + // Generic implementation of stat() command. + // Check is file exists and optionally retrieve file attributes. + // + // Sends : SSH2_FXP_STAT_VERSION_0 packet. + // Expects : SSH2_FXP_ATTR or SSH2_FXP_STATUS. + // + // path - full remote path on server (IN). + // attr - info about remote file. (OUT). + // + // RETURNS: 0 if OK. + // + + int SftpClient::stat(const char *path, SftpFileAttr *attr) + { + DBG_ENTER3("SftpClient::stat"); + + int exitCode = -1; + + uint32_t serverStatus = 0; + uint32_t id = GenerateUniqueId(); + uint32_t idRet = 0; + uint32_t pathLen = 0; + uint32_t size = 0; + + uint8_t type = 0; + + string packet; + + DEBUG1("SFTP #%d: stat(%s).", id, path); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Check args. + // + + FAILEX(path == NULL, "ERROR: Null 'path' passed to SftpClient::stat().\n"); + FAILEX(attr == NULL, "ERROR: Null 'attr' passed to SftpClient::stat().\n"); + + // + // Prepare SSH2_FXP_STAT_VERSION_0 packet. + // + // size 4 + // type 1 + // id 4 + // pathLen 4 + // path pathLen + // ----------------------- + // total: 9 + pathLen + 4 + // + + DEBUG3("SFTP #%d: preparing SSH2_FXP_STAT_VERSION_0 packet...", id); + + pathLen = strlen(path); + + StrPushDword(packet, 9 + pathLen, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_STAT_VERSION_0); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, pathLen, STR_BIG_ENDIAN); // pathLen 4 + StrPushRaw(packet, path, pathLen); // path pathLen + + // + // Send packet, wait for answer. + + FAIL(processPacket(packet, packet)); + + DEBUG2("SFTP #%d: [SSH2_FXP_STAT_VERSION_0][%s] packet.\n", id, path); + + // + // Pop header: + // + // size 4 + // type 1 + // id 4 + // status 4 + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + shutdown(); + + goto fail; + } + + // + // Process received answer. + // + + switch(type) + { + // + // SSH2_FXP_ATTR message. We should get resource's + // attributes here. + // + + case SSH2_FXP_ATTRS: + { + DEBUG2("SFTP #%d: received [SSH2_FXP_ATTRS].", id); + + // + // If extended request decode reveived attributes. + // + + if (attr) + { + FAIL(popAttribs(attr, packet)); + } + + DEBUG1("SFTP #%d: Stat [%s] finished with success.", id, path); + + break; + } + + // + // SSH2_FXP_STATUS message. This means error or resource + // not exists. + // + + case SSH2_FXP_STATUS: + { + DBG_MSG("SFTP #%d: received [SSH2_FXP_STATUS].", id); + + FAIL(StrPopDword(&serverStatus, packet, STR_BIG_ENDIAN)); + + FAIL(serverStatus != SSH2_FX_OK); + + break; + } + + // + // Unexpected message type. + // + + default: + { + Error("SFTP #%d: ERROR: Unexpected message type [0x%x].", id, type); + + shutdown(); + + goto fail; + } + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("Cannot stat remote file.\n" + "Error code is: %u.\nServer status is: [%d][%s].", + GetLastError(), serverStatus, + TranslateSftpStatus(serverStatus)); + } + + DBG_LEAVE3("SftpClient::stat"); + + return exitCode; + } + + // + // Generic implementation of readdir(). + // List content of remote directory. + // + // Sends : many SSH2_FXP_DIRLIGO_READDIR_SHORT packets. + // Expects : many SSH2_FXP_NAME and one SSH2_FXP_STATUS for EOF. + // + // files - list of files/dirs living inside selected directory (OUT). + // handle - value retrieved from open() function before (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::readdir(vector &files, int64_t handle) + { + DBG_ENTER3("SftpClient::readdir"); + + int exitCode = -1; + int goOn = 1; + int capacity = 0; + int iter = 0; + + uint32_t serverStatus = 0; + + string packet; + + files.clear(); + + DEBUG1("SFTP: readdir(%"PRId64").", handle); + + FAILEX(dead_, "SFTP: readdir() rejected because session dead.\n"); + + // + // Send requests for data until EOF or error. + // + + while(goOn) + { + uint32_t id = GenerateUniqueId(); + uint32_t idRet = 0; + uint32_t size = 0; + uint32_t count = 0; + + uint8_t type = 0; + + iter ++; + + // + // Prepare SSH2_FXP_DIRLIGO_READDIR_SHORT message. + // + // + // size 4 + // type 1 + // id 4 + // handleLen 4 + // handle 4 + // ---------------------------------- + // total: 13 + 4 + // + + packet.clear(); + + StrPushDword(packet, 13, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_DIRLIGO_READDIR_SHORT); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, 4, STR_BIG_ENDIAN); // handleLen 4 + StrPushDword(packet, uint32_t(handle), STR_BIG_ENDIAN); // handle 4 + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + DEBUG2("SFTP #%d: Sent [SSH2_FXP_DIRLIGO_READDIR_SHORT][%"PRId64"].\n", id, handle); + + // + // Pop header: + // + // size 4 + // type 1 + // id 4 + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + shutdown(); + + goto fail; + } + + // + // Interprete received message. + // + + switch(type) + { + // + // Status message. This means EOF or error. + // + + case SSH2_FXP_STATUS: + { + DEBUG2("SFTP #%d: received [SSH2_FXP_STATUS].", id); + + goOn = 0; + + FAIL(StrPopDword(&serverStatus, packet, STR_BIG_ENDIAN)); + + FAIL(serverStatus != SSH2_FX_EOF); + + DEBUG1("SFTP #%d: Readdir handle [%"PRId64"] finished with code [%d][%s].\n", + id, handle, serverStatus, TranslateSftpStatus(serverStatus)); + + break; + } + + // + // SSH2_FXP_NAME. Next portion of data. + // + + case SSH2_FXP_NAME: + { + DEBUG2("SFTP #%d: received [SSH2_FXP_NAME].", id); + + // + // Pop number of elements. + // + + FAIL(StrPopDword(&count, packet, STR_BIG_ENDIAN)); + + DEBUG2("SFTP #%d: Popped elements count [%d].\n", id, count); + + // + // Pop elements from packet. + // + + for (int i = 0; i < count; i++) + { + SftpFileInfo info; + + memset(&info.attr_, 0, sizeof(info.attr_)); + + char name[MAX_PATH] = {0}; + char longName[MAX_PATH] = {0}; + + uint32_t nameLen = 0; + uint32_t longNameLen = 0; + + // + // Pop element's name. + // + + FAIL(StrPopDword(&nameLen, packet, STR_BIG_ENDIAN)); + FAIL(StrPopRaw(name, nameLen, packet)); + + FAIL(StrPopDword(&longNameLen, packet, STR_BIG_ENDIAN)); + FAIL(StrPopRaw(longName, longNameLen, packet)); + + DEBUG2("SFTP #%d: Popped element [%s] / [%s].\n", id, name, longName); + + info.name_ = name; + + // + // Pop attributes. + // + + FAIL(popAttribs(&info.attr_, packet)); + + // + // Last element marker. Don't go on longer. + // + + if (strcmp(name, "...") == 0) + { + goOn = 0; + } + + // + // Put another element to list. + // + + else + { + files.push_back(info); + } + } + + break; + } + + // + // Unexpected packet type. Break. + // + + default: + { + Error("SFTP #%d: ERROR: Unexpected packet type [%d].", id, type); + + shutdown(); + + goto fail; + } + } + } + + DEBUG2("SFTP: %d elements listed.", files.size()); + + // + // Cleanup. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot read remote directory.\n" + " Server status is: [%d][%s].", serverStatus, + TranslateSftpStatus(serverStatus)); + + } + + DBG_LEAVE3("SftpClient::readdir"); + + return exitCode; + } + + // + // Retrieve info about remote disk. + // + // WARNING: Server MUST support "statvfs@openssh.com" extension. + // + // stvfs - buffer to store info about disk (see Sftp.h) (OUT) + // path - remote path to check (IN) + // + // RETURNS: 0 if OK. + // + + int SftpClient::statvfs(Statvfs_t *stvfs, const char *path) + { + DBG_ENTER3("SftpClient::statvfs"); + + int exitCode = -1; + + uint32_t id = GenerateUniqueId(); + uint32_t pathLen = 0; + uint32_t extNameLen = 0; + uint32_t idRet = 0; + uint32_t serverStatus = 0; + uint32_t size = 0; + + uint8_t type; + + const char *extName = NULL; + + string packet; + + DEBUG1("SFTP #%d: statvfs path [%s]", id, path); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Prepare SSH2_FXP_EXTENDED packet for + // 'statvfs@openssh.com' command. + // + // size 4 + // type 1 + // id 4 + // extNameLen 4 + // extName strlen(statvfs@openssh.com) + // pathLen 4 + // path strlen(path) + // -------------------------------------- + // total: 13 + extLen + pathLen + 4 + // + + DEBUG3("SFTP #%d: preparing SSH2_FXP_EXTENDED...", id); + + extName = "statvfs@openssh.com"; + pathLen = strlen(path); + extNameLen = strlen(extName); + size = 13 + extNameLen + pathLen; + + StrPushDword(packet, size, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_EXTENDED); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, extNameLen, STR_BIG_ENDIAN); // extNameLen 4 + StrPushRaw(packet, extName, extNameLen); // extName extNameLen + StrPushDword(packet, pathLen, STR_BIG_ENDIAN); // pathLen 4 + StrPushRaw(packet, path, pathLen); // path pathLen + + // + // Send packet, wait for answer. + // + + FAIL(processPacket(packet, packet)); + + DEBUG2("SFTP #%d: sent [SSH2_FXP_ENTENDED].\n", id, path); + + // + // Parse answer. + // + // 4 + // 1 + // 4 + // ... + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + + // + // Check packet ID. + // + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + shutdown(); + + goto fail; + } + + // + // Check packet type. + // + + if (type != SSH2_FXP_EXTENDED_REPLY) + { + Error("ERROR: Unexpected packet type [%d].\n", type); + + shutdown(); + + goto fail; + } + + DEBUG2("SFTP #%d: received [SSH2_FXP_EXTENDED_REPLY].", id); + + FAIL(StrPopQword(&stvfs -> bsize_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopQword(&stvfs -> frsize_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopQword(&stvfs -> blocks_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopQword(&stvfs -> bfree_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopQword(&stvfs -> bavail_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopQword(&stvfs -> files_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopQword(&stvfs -> ffree_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopQword(&stvfs -> favail_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopQword(&stvfs -> fsid_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopQword(&stvfs -> flags_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopQword(&stvfs -> namemax_, packet, STR_BIG_ENDIAN)); + + DEBUG2("bsize : [%"PRIu64"]", stvfs -> bsize_); + DEBUG2("frsize : [%"PRIu64"]", stvfs -> frsize_); + DEBUG3("blocks : [%"PRIu64"]", stvfs -> blocks_); + DEBUG2("bfree : [%"PRIu64"]", stvfs -> bfree_); + DEBUG2("bavail : [%"PRIu64"]", stvfs -> bavail_); + DEBUG2("files : [%"PRIu64"]", stvfs -> files_); + DEBUG2("ffree : [%"PRIu64"]", stvfs -> ffree_); + DEBUG3("favail : [%"PRIu64"]", stvfs -> favail_); + DEBUG2("fsid : [%"PRIu64"]", stvfs -> fsid_); + DEBUG2("flags : [%"PRIu64"]", stvfs -> flags_); + DEBUG2("namemax : [%"PRIu64"]", stvfs -> namemax_); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE3("SftpClient::statvfs"); + + return exitCode; + }; + + // + // Create new directory on server. + // + // Sends : SSH2_FXP_MKDIR packet. + // Expects : SSH2_FXP_STATUS packet. + // + // path - path to craete (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::mkdir(const char *path) + { + DBG_ENTER3("SftpClient::mkdir"); + + uint32_t serverStatus = SSH2_FX_FAILURE; + + uint32_t id = GenerateUniqueId(); + uint32_t size = 0; + uint32_t idRet = 0; + uint32_t pathLen = 0; + + uint8_t type = 0; + + string packet; + + DEBUG1("SFTP #%d BEGIN: mkdir path [%s].", id, path); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Prepare SSH2_FXP_MKDIR packet: + // + // size 4 + // SSH2_FXP_MKDIR 1 + // id 4 + // pathLen 4 + // path pathLen + // attrib 4 + // ---------------------------------- + // total: 13 + pathLen + 4 + // + + DEBUG2("SFTP #%d: Preparing SSH2_FXP_MKDIR packet...", id); + + pathLen = strlen(path); + + StrPushDword(packet, 13 + pathLen, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_MKDIR); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, pathLen, STR_BIG_ENDIAN); // pathLen 4 + StrPushRaw(packet, path, pathLen); // path pathLen + StrPushDword(packet, 0, STR_BIG_ENDIAN); // attr 4 + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + // + // Receive status packet. + // + + serverStatus = popStatusPacket(packet, id); + + // + // Error handler. + // + + fail: + + DEBUG1("SFTP #%d END : mkdir path [%s] finished with code [%d].", id, path, serverStatus); + + DBG_LEAVE3("SftpClient::mkdir"); + + return serverStatus; + } + + // + // Remove file on server. + // + // Sends : SSH2_FXP_REMOVE packet. + // Expects : SSH2_FXP_STATUS packet. + // + // path - path to craete (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::remove(const char *path) + { + DBG_ENTER3("SftpClient::remove"); + + uint32_t serverStatus = SSH2_FX_FAILURE; + + uint32_t id = GenerateUniqueId(); + uint32_t size = 0; + uint32_t idRet = 0; + uint32_t pathLen = 0; + + uint8_t type = 0; + + string packet; + + DEBUG1("SFTP #%d BEGIN: remove path [%s].", id, path); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Prepare SSH2_FXP_RMDIR packet: + // + // size 4 + // SSH2_FXP_RMDIR 1 + // id 4 + // pathLen 4 + // path pathLen + // ---------------------------------- + // total: 9 + pathLen + 4 + // + + DEBUG2("SFTP #%d: Preparing SSH2_FXP_REMOVE packet...", id); + + pathLen = strlen(path); + + StrPushDword(packet, 9 + pathLen, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_REMOVE); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, pathLen, STR_BIG_ENDIAN); // pathLen 4 + StrPushRaw(packet, path, pathLen); // path pathLen + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + // + // Receive status packet. + // + + serverStatus = popStatusPacket(packet, id); + + // + // Error handler. + // + + fail: + + DEBUG1("SFTP #%d END : remove path [%s] finished with code [%d].", id, path, serverStatus); + + return serverStatus; + } + + // + // Remove empty directory on server. + // + // Sends : SSH2_FXP_RMDIR packet. + // Expects : SSH2_FXP_STATUS packet. + // + // path - path to craete (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::rmdir(const char *path) + { + DBG_ENTER3("SftpClient::rmdir"); + + uint32_t serverStatus = SSH2_FX_FAILURE; + + uint32_t id = GenerateUniqueId(); + uint32_t size = 0; + uint32_t idRet = 0; + uint32_t pathLen = 0; + + uint8_t type = 0; + + string packet; + + DEBUG1("SFTP #%d BEGIN: rmdir path [%s].", id, path); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Prepare SSH2_FXP_RMDIR packet: + // + // size 4 + // SSH2_FXP_RMDIR 1 + // id 4 + // pathLen 4 + // path pathLen + // ---------------------------------- + // total: 9 + pathLen + 4 + // + + DEBUG2("SFTP #%d: Preparing SSH2_FXP_RMDIR packet...", id); + + pathLen = strlen(path); + + StrPushDword(packet, 9 + pathLen, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_RMDIR); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, pathLen, STR_BIG_ENDIAN); // pathLen 4 + StrPushRaw(packet, path, pathLen); // path pathLen + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + // + // Receive status packet. + // + + serverStatus = popStatusPacket(packet, id); + + // + // Error handler. + // + + fail: + + DEBUG1("SFTP #%d END : rmdir path [%s] finished with code [%d].", id, path, serverStatus); + + return serverStatus; + } + + // + // Rename remote file or directory. + // + // Sends : SSH2_FXP_RENAME packet. + // Expects: SSH2_FXP_STATUS packet. + // + // path1 - existing, old path to rename (IN). + // path2 - new name to set (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::rename(const char *path1, const char *path2) + { + DBG_ENTER3("SftpClient::rmdir"); + + uint32_t serverStatus = SSH2_FX_FAILURE; + + uint32_t id = GenerateUniqueId(); + uint32_t size = 0; + uint32_t idRet = 0; + uint32_t path1Len = 0; + uint32_t path2Len = 0; + + uint8_t type = 0; + + string packet; + + DEBUG1("SFTP #%d BEGIN: rename path [%s] to path [%s].", id, path1, path2); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Prepare SSH2_FXP_RENAME packet: + // + // size 4 + // SSH2_FXP_RENAME 1 + // id 4 + // path1Len 4 + // path1 path1Len + // path2Len 4 + // path2 path2Len + // ---------------------------------- + // total: 13 + path1Len + path2Len + 4 + // + + DEBUG2("SFTP #%d: Preparing SSH2_FXP_RENAME packet...", id); + + path1Len = strlen(path1); + path2Len = strlen(path2); + + size = 13 + path1Len + path2Len; + + StrPushDword(packet, size, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_RENAME); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, path1Len, STR_BIG_ENDIAN); // path1Len 4 + StrPushRaw(packet, path1, path1Len); // path1 path1Len + StrPushDword(packet, path2Len, STR_BIG_ENDIAN); // path2Len 4 + StrPushRaw(packet, path2, path2Len); // path2 path2Len + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + // + // Receive status packet. + // + + serverStatus = popStatusPacket(packet, id); + + // + // Error handler. + // + + fail: + + DEBUG1("SFTP #%d END : rename path [%s] to path [%s]" + " finished with code [%d].", id, path1, path2, serverStatus); + + return serverStatus; + } + + // + // ---------------------------------------------------------------------------- + // + // SSH2_FXP_DIRLIGO_XXX commands to fit SFTP protocol to WINAPI better. + // + // ---------------------------------------------------------------------------- + // + + // + // Open remote file using {access, shared, create, flags} masks + // used with CreateFile() on Windows. + // + // Sends : SSH2_FXP_DIRLIGO_CREATEFILE packet. + // Expects : SSH2_FXP_HANDLE packet. + // + // path - path to remote file (IN). + // accesMode - the same as dwSharedAccess in CreateFile (IN). + // sharedMode - the same as dwShareShared in CreateFile (IN). + // create - the same as dwCreateDisposition in CreateFile (IN). + // flags - the same as dwFlags in CreateFile (IN). + // isDIr - on output set to 1 if opened file is a directory (OUT/OPT). + // + // RETURNS: remote file handle, + // or -winapi error if error (e.g. -ERROR_FILE_NOT_FOUND). + // + + int64_t SftpClient::createfile(const char *path, uint32_t access, + uint32_t shared, uint32_t create, + uint32_t flags, int *isDir) + { + DBG_ENTER3("SftpClient::createfile"); + + int exitCode = -1; + + string packet; + + uint32_t pathLen = 0; + uint32_t id = GenerateUniqueId(); + uint32_t idRet = 0; + uint32_t size = 0; + uint32_t tmp = 0; + + int64_t handle = 0; + + uint8_t type = 0; + + DEBUG1("SFTP #%d: createfile '%s' access=%x shared=%x create=%x flags=%x", + id, path, access, shared, create, flags); + + FAILEX(dead_, "SFTP #%d: rejected because session dead.\n", id); + + // + // Prepare SSH2_FXP_DIRLIGO_CREATEFILE packet. + // + // size 4 + // type 1 + // id 4 + // pathLen 4 + // path pathLen + // access 4 + // shared 4 + // create 4 + // flags 4 + // ---------------------------------- + // total: 25 + pathLen + 4 + // + + DEBUG2("SftpClient::createfile : Preparing SSH2_FXP_DIRLIGO_CREATEFILE packet..."); + + pathLen = strlen(path); + + StrPushDword(packet, 25 + pathLen, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_DIRLIGO_CREATEFILE); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, pathLen, STR_BIG_ENDIAN); // pathLen 4 + StrPushRaw(packet, path, pathLen); // path pathLen + StrPushDword(packet, access, STR_BIG_ENDIAN); // access 4 + StrPushDword(packet, shared, STR_BIG_ENDIAN); // shared 4 + StrPushDword(packet, create, STR_BIG_ENDIAN); // create 4 + StrPushDword(packet, flags, STR_BIG_ENDIAN); // flags 4 + + // + // Send packet and wait for answer. + // + + FAIL(processPacket(packet, packet)); + + // + // Parse answer. + // + // size 4 + // type 1 + // id 4 + // handle 4 + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + + // + // Check packet ID. + // + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + shutdown(); + + goto fail; + } + + // + // Check packet type. + // + + if (type != SSH2_FXP_HANDLE) + { + Error("ERROR: Unexpected packet type [%d].\n", type); + + shutdown(); + + goto fail; + } + + DEBUG2("SFTP #%d: Received [SSH2_FXP_HANDLE].", id); + + FAIL(StrPopDword(&tmp, packet, STR_BIG_ENDIAN)); + FAIL(StrPopDword(&tmp, packet, STR_BIG_ENDIAN)); + + handle = int64_t(int32_t(tmp)); + + if (handle >= 0) + { + if (handle & SSH2_FXP_DIRLIGO_DIR_FLAG) + { + if (isDir) + { + *isDir = 1; + } + else + { + *isDir = 0; + } + } + + handle &= ~SSH2_FXP_DIRLIGO_DIR_FLAG; + + DEBUG1("SFTP #%d: createfile finished with handle [%"PRId64"].\n", id, handle); + + DBG_SET_ADD("sftp handle", handle, "[%s]", path); + } + else + { + DEBUG1("SFTP #%d: createfile finished with error [%"PRId64"].\n", id, -handle); + } + + // + // Error handler. + // + + fail: + + DBG_LEAVE3("SftpClient::createfile"); + + return handle; + } + + // + // ---------------------------------------------------------------------------- + // + // Widechar functions for DOKAN. + // Only wrappers for existing UTF8 functions above. + // + // ---------------------------------------------------------------------------- + // + + #ifdef WIN32 + + // + // Widechar wrapper for open(). + // See utf8 version of SftpClient::open(). + // + + int64_t SftpClient::open(const wchar_t *path16, int mode, int isDir) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return open(path, mode, isDir); + } + + // + // Widechar wrapper for opendir(). + // See utf8 version of SftpClient::opendir(). + // + + int64_t SftpClient::opendir(const wchar_t *path16) + { + return open(path16, 0, 1); + } + + // + // Widechar wrapper for stat(). + // See utf8 version of SftpClient::stat(). + // + + int SftpClient::stat(const wchar_t *path16, BY_HANDLE_FILE_INFORMATION *info) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return stat(path, info); + } + + // + // Widechar wrapper for mkdir(). + // See utf8 version of SftpClient::mkdir(). + // + + int SftpClient::mkdir(const wchar_t *path16) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return mkdir(path); + } + + // + // Widechar wrapper for remove(). + // See utf8 version of SftpClient::remove(). + // + + int SftpClient::remove(const wchar_t *path16) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return remove(path); + } + + // + // Widechar wrapper for rmdir(). + // See utf8 version of SftpClient::rmdir(). + // + + int SftpClient::rmdir(const wchar_t *path16) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return rmdir(path); + } + + // + // Widechar wrapper for rename(). + // See utf8 version of SftpClient::rename(). + // + + int SftpClient::rename(const wchar_t *path1_16, const wchar_t *path2_16) + { + char path1[MAX_PATH] = {0}; + char path2[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path1_16, -1, path1, sizeof(path1), NULL, NULL); + WideCharToMultiByte(CP_UTF8, 0, path2_16, -1, path2, sizeof(path2), NULL, NULL); + + return rename(path1, path2); + } + + // + // Widechar wrapper for createfile(). + // See utf8 version of SftpClient::createfile(). + // + + int64_t SftpClient::createfile(const wchar_t *path16, uint32_t access, + uint32_t shared, uint32_t create, + uint32_t flags, int *isDir) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return createfile(path, access, shared, create, flags, isDir); + } + + // + // Widechar wrapper for statvfs(). + // See utf8 version of SftpClient::statvfs(). + // + + int SftpClient::statvfs(Statvfs_t *stvfs, const wchar_t *path16) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return statvfs(stvfs, path); + } + + #endif /* WIN32 */ + + // + // ---------------------------------------------------------------------------- + // + // Helper functions. + // + // ---------------------------------------------------------------------------- + // + + #ifdef WIN32 + + int SftpClient::popAttribs(BY_HANDLE_FILE_INFORMATION *info, string &packet) + { + int exitCode = -1; + + uint32_t flags = 0; + uint32_t uid = 0; + uint32_t gid = 0; + uint32_t perm = 0; + uint32_t atime32 = 0; + uint32_t mtime32 = 0; + + uint64_t atime = 0; + uint64_t mtime = 0; + + // + // Check args. + // + + FAILEX(info == NULL, "ERROR: Null 'info' passed to SftpClient::popAttribs.\n"); + + // + // + // + + DEBUG3("SftpClient::popAttribs : Decoding attributes..."); + + // + // Clear output struct. + // + + memset(info, 0, sizeof(BY_HANDLE_FILE_INFORMATION)); + + info -> nNumberOfLinks = 1; + info -> nFileIndexHigh = 0; + info -> nFileIndexLow = 0; + + // + // Size. + // + + FAIL(StrPopDword(&flags, packet, STR_BIG_ENDIAN)); + + if (flags & SSH2_FILEXFER_ATTR_SIZE) + { + FAIL(StrPopDword((uint32_t *) &info -> nFileSizeHigh, packet, STR_BIG_ENDIAN)); + FAIL(StrPopDword((uint32_t *) &info -> nFileSizeLow, packet, STR_BIG_ENDIAN)); + } + + // + // Guid/Uid flags. We ignore it on Windows. + // + + if (flags & SSH2_FILEXFER_ATTR_UIDGID) + { + FAIL(StrPopDword(&uid, packet, STR_BIG_ENDIAN)); + FAIL(StrPopDword(&gid, packet, STR_BIG_ENDIAN)); + } + + // + // Permissions. + // + + if (flags & SSH2_FILEXFER_ATTR_PERMISSIONS) + { + FAIL(StrPopDword(&perm, packet, STR_BIG_ENDIAN)); + + if (SFTP_ISDIR(perm)) + { + info -> dwFileAttributes |= FILE_ATTRIBUTE_DIRECTORY; + } + } + + // + // Last acces and last modify times. + // We need translate time to Winapi comatible. + // + + if (flags & SSH2_FILEXFER_ATTR_ACMODTIME) + { + // + // Pop acces time and modify times. + // + + FAIL(StrPopDword(&atime32, packet, STR_BIG_ENDIAN)); + FAIL(StrPopDword(&mtime32, packet, STR_BIG_ENDIAN)); + + atime = atime32; + mtime = mtime32; + + // + // Convert time from UNIX UTC (from 1970) + // to FILETIME UTC (from 1601). + // + + LONGLONG atimell = Int32x32To64(atime, 10000000) + 116444736000000000LL; + LONGLONG mtimell = Int32x32To64(mtime, 10000000) + 116444736000000000LL; + + info -> ftLastAccessTime.dwLowDateTime = (DWORD) atimell; + info -> ftLastAccessTime.dwHighDateTime = atimell >> 32; + + info -> ftLastWriteTime.dwLowDateTime = (DWORD) mtimell; + info -> ftLastWriteTime.dwHighDateTime = mtimell >> 32; + + // + // We don't get creation time from server. + // We assume creation = last write here. + // + + info -> ftCreationTime.dwLowDateTime = (DWORD) mtimell; + info -> ftCreationTime.dwHighDateTime = mtimell >> 32; + } + + info -> dwFileAttributes |= FILE_ATTRIBUTE_NOT_CONTENT_INDEXED; + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot pop attributes data.\n"); + + shutdown(); + } + + return exitCode; + } + + #endif /* WIN32 */ + + // + // Decode attributes sent by SFTP server. + // + // info - struct, where to write decoded atributes (OUT). + // packet - raw packet received from SFTP server (IN). + // + + int SftpClient::popAttribs(SftpFileAttr *info, string &packet) + { + int exitCode = -1; + + uint32_t sizeHigh32; + uint32_t sizeLow32; + + // + // Check args. + // + + FAILEX(info == NULL, "ERROR: Null 'info' passed to SftpClient::popAttribs.\n"); + + // + // + // + + DEBUG3("SftpClient::popAttribs : Decoding attributes..."); + + // + // Clear output struct. + // + + memset(info, 0, sizeof(*info)); + + // + // Size. + // + + FAIL(StrPopDword(&info -> flags_, packet, STR_BIG_ENDIAN)); + + if (info -> flags_ & SSH2_FILEXFER_ATTR_SIZE) + { + FAIL(StrPopDword(&sizeHigh32, packet, STR_BIG_ENDIAN)); + FAIL(StrPopDword(&sizeLow32, packet, STR_BIG_ENDIAN)); + + info -> size_ = (uint64_t(sizeHigh32) << 32) | uint64_t(sizeLow32); + } + + // + // Guid/Uid flags. We ignore it on Windows. + // + + if (info -> flags_ & SSH2_FILEXFER_ATTR_UIDGID) + { + FAIL(StrPopDword(&info -> uid_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopDword(&info -> guid_, packet, STR_BIG_ENDIAN)); + } + + // + // Permissions. + // + + if (info -> flags_ & SSH2_FILEXFER_ATTR_PERMISSIONS) + { + FAIL(StrPopDword(&info -> perm_, packet, STR_BIG_ENDIAN)); + } + + // + // Last acces and last modify times. + // We need translate time to Winapi comatible. + // + + if (info -> flags_ & SSH2_FILEXFER_ATTR_ACMODTIME) + { + // + // Pop acces time and modify times. + // + + FAIL(StrPopDword(&info -> atime_, packet, STR_BIG_ENDIAN)); + FAIL(StrPopDword(&info -> mtime_, packet, STR_BIG_ENDIAN)); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot pop attributes data.\n"); + + shutdown(); + } + + return exitCode; + } + + // + // ---------------------------------------------------------------------------- + // + // Packet processing + // + // ---------------------------------------------------------------------------- + // + + // + // Send to server and receive packet. + // + // TIP: You can use the same buffers for answer and packet to send. + // + // answer - buffer, where to store received answer paceket (OUT). + // packet - buffer with packet to send (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::processPacketSimple(string &answer, string &packet) + { + DBG_ENTER3("SftpClient::processPacket"); + + int exitCode = -1; + + int readed = -1; + int written = -1; + int totalReaded = 0; + int totalWritten = 0; + + int bytesProcessed = 0; + + double startTime = 0.0; + double endTime = 0.0; + double elapsed = 0.0; + + mutex_.lock(); + + // + // Send packet. + // + + DEBUG3("SFTP: Sending [%d] bytes...\n", packet.size()); + + DBG_DUMP(&packet[0], packet.size()); + + startTime = GetTimeMs(); + + switch(fdType_) + { + // + // CRT FD. + // + + case SFTP_CLIENT_FD: + { + while(totalWritten < packet.size()) + { + written = ::write(fdout_, &packet[totalWritten], + packet.size() - totalWritten); + + if (written > 0) + { + DEBUG3("SFTP: Sent [%d] bytes.\n", written); + + totalWritten += written; + } + else + { + Error("ERROR: Write failed.\n"); + + shutdown(); + + goto fail; + } + } + + break; + } + + // + // Socket. + // + + case SFTP_CLIENT_SOCKET: + { + while(totalWritten < packet.size()) + { + written = ::send(fdout_, &packet[totalWritten], + packet.size() - totalWritten, 0); + + if (written > 0) + { + DEBUG3("SFTP: Sent [%d] bytes.\n", written); + + totalWritten += written; + } + else + { + Error("ERROR: Write failed.\n"); + + shutdown(); + + goto fail; + } + } + + break; + } + } + + FAILEX(totalWritten != packet.size(), "ERROR: Cannot send packet.\n"); + + // + // Receive answer. + // + + answer.resize(1024 * 64); + + while(packetComplete(answer, totalReaded) == 0) + { + // + // Check free space in answer[] buffer. + // + + int freeSpace = answer.size() - totalReaded; + + if (freeSpace <= 0) + { + Error("ERROR: Received packet > 64KB.\n"); + + shutdown(); + + goto fail; + } + + // + // Read next piece. + // + + DEBUG3("SFTP: Reading...\n"); + + switch(fdType_) + { + // + // CRT FD. + // + + case SFTP_CLIENT_FD: + { + readed = ::read(fdin_, &answer[totalReaded], freeSpace); + + break; + } + + // + // Socket. + // + + case SFTP_CLIENT_SOCKET: + { + readed = ::recv(fdin_, &answer[totalReaded], freeSpace, 0); + + break; + } + } + + DEBUG2("SFTP: Received [%d] bytes.\n", readed); + + FAILEX(readed <= 0, "ERROR: Cannot read data. System code is : %d.\n", GetLastError()); + + // + // Next piece. + // + + totalReaded += readed; + } + + answer.resize(totalReaded); + + endTime = GetTimeMs(); + + DBG_DUMP(&answer[0], answer.size()); + + // + // Update statistics. + // + + bytesProcessed = written + totalReaded; + + elapsed = endTime - startTime; + + netstat_.insertRequest(bytesProcessed, elapsed); + netstat_.insertOutcomingPacket(written); + netstat_.insertIncomingPacket(totalReaded); + + // + // Send statistics to caller if needed. + // + + if (netstat_.getRequestCount() % netStatTick_ == 0) + { + if (netStatCallback_) + { + netStatCallback_(&netstat_, netStatCallbackCtx_); + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot process packet.\n" + "Error code is : %d.\n", GetLastError()) + + shutdown(); + } + + mutex_.unlock(); + + DBG_LEAVE3("SftpClient::processPacket"); + + return exitCode; + } + + // + // Send to server and receive packet. + // + // TIP: You can use the same buffers for answer and packet to send. + // + // answer - buffer, where to store received answer paceket (OUT). + // packet - buffer with packet to send (IN). + // + // RETURNS: 0 if OK. + // + + int SftpClient::processPacket(string &answer, string &packet) + { + DBG_ENTER3("SftpClient::processPacket"); + + int exitCode = -1; + + int readed = -1; + int written = -1; + int totalReaded = 0; + int totalWritten = 0; + int packetSize = 0; + + int bytesProcessed = 0; + + double startTime = 0.0; + double endTime = 0.0; + double elapsed = 0.0; + + uint32_t size; + uint32_t id; + uint8_t type; + + // + // Push pening request. + // + + packetSize = packet.size(); + + decodePacketHead(&size, &id, &type, packet, packetSize); + + rpool_ -> push(id, NULL, &answer); + + // + // Send packet. + // + + DEBUG3("SFTP: Sending [%d] bytes...\n", packetSize); + + DBG_DUMP(&packet[0], packetSize); + + startTime = GetTimeMs(); + + switch(fdType_) + { + // + // CRT FD. + // + + case SFTP_CLIENT_FD: + { + mutex_.lock(); + + while(totalWritten < packetSize) + { + written = ::write(fdout_, &packet[totalWritten], + packetSize - totalWritten); + + DEBUG2("SFTP: Sent [%d] bytes, ptr [%p], packet size [%d], total written [%d].\n", + written, &packet[totalWritten], packetSize, totalWritten); + + if (written > 0) + { + totalWritten += written; + } + else + { + Error("ERROR: Write failed. System code is : %d.\n", GetLastError()); + + shutdown(); + + goto fail; + } + } + + mutex_.unlock(); + + break; + } + + // + // Socket. + // + + case SFTP_CLIENT_SOCKET: + { + mutex_.lock(); + + while(totalWritten < packetSize) + { + written = ::send(fdout_, &packet[totalWritten], + packetSize - totalWritten, 0); + + DEBUG2("SFTP: Sent [%d] bytes, ptr [%p], packet size [%d], total written [%d].\n", + written, &packet[totalWritten], packetSize, totalWritten); + + if (written > 0) + { + totalWritten += written; + } + else + { + Error("ERROR: Write failed. System code is : %d.\n", GetLastError()); + + shutdown(); + + goto fail; + } + } + + mutex_.unlock(); + + break; + } + } + + FAILEX(totalWritten != packetSize, + "ERROR: Cannot send packet (sent %d, but %d needed).\n", + totalWritten, packetSize); + + // + // Wait until request finished. + // Request will be finished when + // + + rpool_ -> wait(id); + + // + // Update statistics. + // + + endTime = GetTimeMs(); + + DBG_DUMP(&packet[0], answer.size()); + + // + // Update statistics. + // + + bytesProcessed = written + packet.size(); + + elapsed = endTime - startTime; + + netstat_.insertRequest(bytesProcessed, elapsed); + netstat_.insertOutcomingPacket(written); + netstat_.insertIncomingPacket(totalReaded); + + // + // Send statistics to caller if needed. + // + + if (netstat_.getRequestCount() % netStatTick_ == 0) + { + if (netStatCallback_) + { + netStatCallback_(&netstat_, netStatCallbackCtx_); + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot process packet.\n" + "Error code is : %d.\n", GetLastError()) + + shutdown(); + } + + mutex_.unlock(); + + DBG_LEAVE3("SftpClient::processPacket"); + + return exitCode; + } + + // + // Thread reading incoming packets. + // + // data - pointer to related SftpClient object (this pointer) (IN) + // + + int SftpClient::readLoop(void *data) + { + DBG_ENTER3("SftpClient::readLoop"); + + string buffer; + + SftpClient *this_ = (SftpClient *) data; + + int readed = 0; + int totalReaded = 0; + + Request *r = NULL; + + uint32_t size; + uint32_t id; + uint8_t type; + + int packetSize = 0; + + // + // Maximum allowed packet. + // + + buffer.resize(1024 * 64); + + // + // Receive packets. + // + + while(1) + { + while(this_ -> packetComplete(buffer, totalReaded) == 0) + { + // + // Check free space in answer[] buffer. + // + + int freeSpace = buffer.size() - totalReaded; + + if (freeSpace <= 0) + { + Error("ERROR: Received packet > 64KB.\n"); + + this_ -> shutdown(); + + goto fail; + } + + // + // Read next piece. + // + + DEBUG3("SFTP: Reading...\n"); + + switch(this_ -> fdType_) + { + // + // CRT FD. + // + + case SFTP_CLIENT_FD: + { + readed = ::read(this_ -> fdin_, &buffer[totalReaded], freeSpace); + + break; + } + + // + // Socket. + // + + case SFTP_CLIENT_SOCKET: + { + readed = ::recv(this_ -> fdin_, &buffer[totalReaded], freeSpace, 0); + + break; + } + } + + DEBUG2("SFTP: Received [%d] bytes.\n", readed); + + FAILEX(readed <= 0, "ERROR: Cannot read data. System code is : %d.\n", GetLastError()); + + // + // Next piece. + // + + totalReaded += readed; + } + + // + // Complete packet readed. + // Decode its header. + // + + this_ -> decodePacketHead(&size, &id, &type, buffer, totalReaded); + + DEBUG3("SftpClient::readLoop : Received packet" + " size=[%d], id=[%d], type=[%d], totalReaded=[%d].\n", + size, id, type, totalReaded); + // + // Serve request. + // + + packetSize = min(int(size + 4), totalReaded); + + DBG_DUMP(&buffer[0], packetSize); + + r = this_ -> rpool_ -> find(id); + + if (r) + { + string *output = NULL; + + r -> lockData(); + + output = (string *) r -> outputData_; + + if (output) + { + output -> resize(packetSize); + + memcpy(&(*output)[0], &buffer[0], packetSize); + } + + r -> unlockData(); + + r -> serve(); + } + else + { + Error("WARNING: SFTP request ID#%d does not exist in pool.\n"); + } + + // + // Pop packet from read buffer. + // + // FIXME: Avoid memcpy. + // + + if (totalReaded > packetSize) + { + memcpy(&buffer[0], &buffer[packetSize], totalReaded - packetSize); + } + + totalReaded -= packetSize; + } + + // + // Error handler. + // + + fail: + + this_ -> shutdown(); + + Error("ERROR: Read loop failed.\n"); + + DBG_LEAVE3("SftpClient::readLoop"); + } + + // + // Pop and decode SSH2_FXP_STATUS packet from buffer. + // + // packet - buffer, where status packet is stored (IN/OUT). + // + // id - expected packet's id. Status packet is a server's response + // for one of packet sent by client. Id for send and received + // packet must be the same (IN). + // + // RETURNS: Decoded serverStatus code. + // + + uint32_t SftpClient::popStatusPacket(string &packet, uint32_t id) + { + DBG_ENTER3("SftpClient::popStatusPacket"); + + uint32_t serverStatus = SSH2_FX_FAILURE; + + uint32_t size = 0; + uint32_t idRet = 0; + + uint8_t type = 0; + + // + // Parse answer. + // + // size 4 + // type 1 + // id 4 + // status 4 + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + FAIL(StrPopDword(&serverStatus, packet, STR_BIG_ENDIAN)); // status 4 + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + shutdown(); + + goto fail; + } + + if (type != SSH2_FXP_STATUS) + { + Error("ERROR: Packet type [%d] received," + " but [%d] expected.\n", type, SSH2_FXP_STATUS); + + shutdown(); + + goto fail; + } + + // + // Error handler. + // + + fail: + + DBG_LEAVE3("SftpClient::popStatusPacket"); + + return serverStatus; + } + + // + // Change used sector size. + // + // size - sector size in bytes (IN). + // + + void SftpClient::setSectorSize(int size) + { + + if (size <= 256) + { + Error("Sector size %d is too small.\n", size); + } + else + { + sectorSize_ = size; + } + + DEBUG1("Using %d byte sectors.\n", sectorSize_); + } + + // + // Check is given SFTP packet completem. + // Needed to handle partial read. + // + // packet - SFTP packet data to check (IN). + // realSize - real packet size i.e. number of useful bytes in packet[] buffer (IN). + // + // RETURNS: 1 if given packet is a full, complete SFTP packet, + // 0 otherwise (partial packet). + // + + int SftpClient::packetComplete(string &packet, int realSize) + { + DBG_ENTER3("SftpClient::packetComplete"); + + int complete = 0; + + DEBUG5("SftpClient::packetComplete :" + " packetSize=[%d], realSize=[%d].\n", packet.size(), realSize); + + DBG_DUMP(&packet[0], realSize); + + if (packet.size() > 4 && realSize > 4) + { + int expectedSize = 0; + + char *src = (char *) &packet[0]; + char *dst = (char *) &expectedSize; + + dst[0] = src[3]; + dst[1] = src[2]; + dst[2] = src[1]; + dst[3] = src[0]; + + DEBUG5("SftpClient::packetComplete : Expected size [%d]\n", expectedSize); + + if (realSize >= (expectedSize + 4)) + { + complete = 1; + } + } + + DEBUG5("SftpClient::packetComplete : Result [%d]\n", complete); + + DBG_LEAVE3("SftpClient::packetComplete"); + + return complete; + } + + // + // Decode packet {size, type, ID} head from packet buffer without + // destroying it. + // + // size - decoded packet size (OUT). + // id - decoded packet ID (OUT). + // type - decoded packet type (OUT). + // packet - SFTP packet data to check (IN). + // realSize - real packet size i.e. number of useful bytes in packet[] buffer (IN). + // + // RETURNS: 0 if OK. + + + int SftpClient::decodePacketHead(uint32_t *size, uint32_t *id, uint8_t *type, + string &packet, int realSize) + { + DBG_ENTER3("SftpClient::decodePacketHead"); + + int exitCode = -1; + + if (realSize >= 9) + { + string tmp; + + tmp.resize(9); + + memcpy(&tmp[0], &packet[0], 9); + + StrPopDword(size, tmp, STR_BIG_ENDIAN); + StrPopByte(type, tmp); + StrPopDword(id, tmp, STR_BIG_ENDIAN); + + exitCode = 0; + } + + if (exitCode) + { + Error("ERROR: Cannot decode packet header.\n"); + } + + DBG_LEAVE3("SftpClient::decodePacketHead"); + + return exitCode; + } + + // + // --------------------------------------------------------------------------- + // + // High level API + // + // --------------------------------------------------------------------------- + // + + // + // Download file from sftp server in background thread. + // Internal use only. See downloadFile() method. + // + // data - pointer to related SftpJob object (this pointer) (IN/OUT). + // + + int SftpClient::DownloadFileWorker(void *data) + { + DBG_ENTER2("SftpClient::DownloadFileWorker"); + + int exitCode = -1; + + SftpFileAttr attr; + + int64_t sftpHandle = -1; + + int pieceSize = 0; + + int64_t bytesToCopy = 0; + int64_t totalWritten = 0; + int64_t written = 0; + int64_t readed = 0; + + FILE *f = NULL; + + char buf[1024 * 32]; + + double rate = 0.0; + + SftpJob *job = (SftpJob *) data; + + SftpClient *sftp = job -> getSftpClient(); + + const char *remotePath = job -> getRemoteName(); + const char *localPath = job -> getLocalName(); + + // + // Add refference couner to related SFTP job to avoid + // delete it while this thread works. + // + + job -> addRef(); + + // + // Wait until job state is initializing. + // + + while(job -> getState() == SFTP_JOB_STATE_INITIALIZING) + { + ThreadSleepMs(10); + } + + // + // Stat file on server. + // We get total size of file here. + // + + if (sftp -> stat(remotePath, &attr) != 0) + { + Error("ERROR: Cannot stat file '%s' on server side.\n", remotePath); + + goto fail; + } + + // + // Open remote file on sftp server. + // + + sftpHandle = sftp -> open(remotePath); + + if (sftpHandle == -1) + { + Error("ERROR: Cannot open '%s' file on server.\n", remotePath); + + goto fail; + } + + // + // Open file on local. + // + + f = fopen(localPath, "wb+"); + + FAILEX(f == NULL, "ERROR: Cannot create '%s' file.\n", localPath); + + // + // Download file from server to local by 32kB blocks. + // + + bytesToCopy = attr.size_; + + while(bytesToCopy > 0) + { + // + // Check for stopped state. + // + + if (job -> getState() == SFTP_JOB_STATE_STOPPED) + { + DEBUG1("SftpJob PTR#%p: Downlading [%s] stopped.\n", job, localPath); + + exitCode = 0; + + goto fail; + } + + // + // Compute next piece size. + // + + + pieceSize = min(int64_t(sizeof(buf)), bytesToCopy); + + // + // Read piece from sftp server. + // + + readed = sftp -> read(sftpHandle, buf, totalWritten, pieceSize); + + FAILEX(readed != pieceSize, + "ERROR: Cannot read from remote file.\n"); + + // + // Write readed part to local file. + // + + fwrite(buf, pieceSize, 1, f); + + // + // Go to next part. + // + + bytesToCopy -= pieceSize; + totalWritten += pieceSize; + + // + // Compute time statistics. + // + + job -> updateStatistics(totalWritten, attr.size_); + } + + // + // Set job state as finished. + // + + job -> setState(SFTP_JOB_STATE_FINISHED); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot download file from '%s' to '%s'.\n", remotePath, localPath); + + job -> setState(SFTP_JOB_STATE_ERROR); + } + + if (f) + { + fclose(f); + } + + if (sftp && sftpHandle != -1) + { + sftp -> close(sftpHandle); + } + + job -> release(); + + DBG_LEAVE2("SftpClient::DownloadFile"); + + return exitCode; + } + + // + // Download file from sftp server. + // + // WARNING: Returned SftpJob object MUST be free by calling job -> release() + // method. + // + // TIP#1 : Use job -> wait() method to wait until job finished. + // TIP#2 : Use job -> stop() method to stop job before finished. + // + // localPath - local path, where to write downloaded file (IN). + // remotePath - full remote path on server side pointing to file to download (IN). + + // notifyCallback - function to be called when new transfer statistics arrives + // or job's state changed. Optional, can be NULL (IN/OPT). + // + // + // RETURNS: Pointer to new allocated SftpJob object, + // or NULL if error. + // + + SftpJob *SftpClient::downloadFile(const char *localPath, + const char *remotePath, + SftpJobNotifyCallbackProto notifyCallback) + { + DBG_ENTER2("SftpClient::downloadFile"); + + SftpJob *job = NULL; + + ThreadHandle_t *thread = NULL; + + // + // Check args. + // + + FAILEX(localPath == NULL, "ERROR: 'localPath' cannot be NULL in DownloadFile().\n"); + FAILEX(remotePath == NULL, "ERROR: 'remotePath' cannot be NULL in DownloadFile().\n"); + FAILEX(dead_, "ERROR: download job rejected because session dead.\n"); + + // + // Create new SFTP job. + // + + job = new SftpJob(SFTP_JOB_TYPE_DOWNLOAD, this, + localPath, remotePath, notifyCallback); + + // + // Create worker thread. + // + + thread = ThreadCreate(DownloadFileWorker, job); + + job -> setThread(thread); + + // + // Set state to pending. + // It's signal for worker thread to start work. + // + + job -> setState(SFTP_JOB_STATE_PENDING); + + // + // Error handler. + // + + fail: + + DBG_LEAVE2("SftpClient::downloadFile"); + + return job; + } + + // + // Upload file to sftp server in background thread. + // Internal use only. See uploadFile() method. + // + // data - pointer to related SftpJob object (this pointer) (IN/OUT). + // + + int SftpClient::UploadFileWorker(void *data) + { + DBG_ENTER2("SftpClient::UploadFileWorker"); + + int exitCode = -1; + + struct stat info = {0}; + + int64_t sftpHandle = -1; + + int pieceSize = 0; + + int64_t bytesToCopy = 0; + int64_t totalWritten = 0; + int64_t written = 0; + int64_t readed = 0; + + FILE *f = NULL; + + char buf[1024 * 32]; + + SftpJob *job = (SftpJob *) data; + + SftpClient *sftp = job -> getSftpClient(); + + const char *remotePath = job -> getRemoteName(); + const char *localPath = job -> getLocalName(); + + // + // Add refference couner to related SFTP job to avoid + // delete it while this thread works. + // + + job -> addRef(); + + // + // Wait until job state is initializing. + // + + while(job -> getState() == SFTP_JOB_STATE_INITIALIZING) + { + ThreadSleepMs(10); + } + + // + // Stat local file. + // We get total size of file here. + // + + if (::stat(localPath, &info) != 0) + { + Error("ERROR: Cannot stat local file '%s'.\n", localPath); + + goto fail; + } + + // + // Open local file for reading. + // + + f = fopen(localPath, "rb"); + + FAILEX(f == NULL, "ERROR: Cannot open local '%s' file.\n", localPath); + + // + // Open remote file on sftp server for writing. + // + + sftpHandle = sftp -> open(remotePath, SSH2_FXF_WRITE | SSH2_FXF_CREAT | SSH2_FXF_TRUNC); + + if (sftpHandle == -1) + { + Error("ERROR: Cannot open '%s' file on server.\n", remotePath); + + goto fail; + } + + // + // Upload file from local to server 32kB blocks. + // + + bytesToCopy = info.st_size; + + while(bytesToCopy > 0) + { + // + // Check for stopped state. + // + + if (job -> getState() == SFTP_JOB_STATE_STOPPED) + { + DEBUG1("SftpJob PTR#%p: Uploading [%s] stopped.\n", job, localPath); + + exitCode = 0; + + goto fail; + } + + pieceSize = min(int64_t(sizeof(buf)), bytesToCopy); + + // + // Read piece from local. + // + + readed = fread(buf, 1, pieceSize, f); + + FAILEX(readed != pieceSize, + "ERROR: Cannot read from local file.\n"); + + // + // Write piece to remote file on sftp server. + // + + written = sftp -> write(sftpHandle, buf, totalWritten, pieceSize); + + FAILEX(written != pieceSize, + "ERROR: Cannot write to remote file.\n"); + + // + // Go to next part. + // + + bytesToCopy -= pieceSize; + totalWritten += pieceSize; + + // + // Compute time statistics. + // + + job -> updateStatistics(totalWritten, info.st_size); + } + + // + // Set job state as finished. + // + + job -> setState(SFTP_JOB_STATE_FINISHED); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot upload file from '%s' to '%s'.\n", remotePath, localPath); + + job -> setState(SFTP_JOB_STATE_ERROR); + } + + if (f) + { + fclose(f); + } + + if (sftp && sftpHandle != -1) + { + sftp -> close(sftpHandle); + } + + job -> release(); + + DBG_LEAVE2("SftpClient::UploadFileWorker"); + + return exitCode; + } + + // + // Upload file to sftp server. + // + // WARNING: Returned SftpJob object MUST be free by calling job -> release() + // method. + // + // TIP#1 : Use job -> wait() method to wait until job finished. + // TIP#2 : Use job -> stop() method to stop job before finished. + // + // remotePath - full remote path on server side, where to put file + // (containing file name too) (IN). + // + // localPath - local path, with file to upload (IN). + // + // notifyCallback - function to be called when new transfer statistics arrives + // or job's state changed. Optional, can be NULL (IN/OPT). + // + // + // RETURNS: 0 if OK. + // + + SftpJob *SftpClient::uploadFile(const char *remotePath, + const char *localPath, + SftpJobNotifyCallbackProto notifyCallback) + { + DBG_ENTER2("SftpClient::uploadFile"); + + SftpJob *job = NULL; + + ThreadHandle_t *thread = NULL; + + // + // Check args. + // + + FAILEX(localPath == NULL, "ERROR: 'localPath' cannot be NULL in UploadFile().\n"); + FAILEX(remotePath == NULL, "ERROR: 'remotePath' cannot be NULL in UploadFile().\n"); + FAILEX(dead_, "ERROR: upload job rejected because session dead.\n"); + + // + // Create new SFTP job. + // + + job = new SftpJob(SFTP_JOB_TYPE_UPLOAD, this, + localPath, remotePath, notifyCallback); + + // + // Create worker thread. + // + + thread = ThreadCreate(UploadFileWorker, job); + + job -> setThread(thread); + + // + // Set state to pending. + // It's signal for worker thread to start work. + // + + job -> setState(SFTP_JOB_STATE_PENDING); + + // + // Error handler. + // + + fail: + + DBG_LEAVE2("SftpClient::uploadFile"); + + return job; + } + + // + // List content of remote directory in background thread. + // Internal use only. See listFiles() method. + // + // data - pointer to related SftpJob object (this pointer) (IN/OUT). + // + + int SftpClient::ListFilesWorker(void *data) + { + DBG_ENTER2("SftpClient::ListFilesWorker"); + + int exitCode = -1; + + int64_t handle = -1; + + int goOn = 1; + int iter = 0; + + string packet; + + uint32_t serverStatus = 0; + + SftpJob *job = (SftpJob *) data; + + SftpClient *sftp = job -> getSftpClient(); + + const char *remotePath = job -> getRemoteName(); + + // + // Add refference couner to related SFTP job to avoid + // delete it while this thread works. + // + + job -> addRef(); + + // + // Wait until job state is initializing. + // + + while(job -> getState() == SFTP_JOB_STATE_INITIALIZING) + { + ThreadSleepMs(10); + } + + // + // Open remote directory on sftp server. + // + + handle = sftp -> opendir(remotePath); + + if (handle < 0) + { + Error("Cannot open remote directory [%s].\n", remotePath); + + goto fail; + } + + // + // Send requests for data until EOF or error. + // + + while(goOn) + { + uint32_t id = GenerateUniqueId(); + uint32_t idRet = 0; + uint32_t size = 0; + uint32_t count = 0; + + uint8_t type = 0; + + iter ++; + + // + // Check for stopped state. + // + + if (job -> getState() == SFTP_JOB_STATE_STOPPED) + { + DEBUG1("SftpJob PTR#%p: Listing [%s] stopped.\n", job, remotePath); + + exitCode = 0; + + goto fail; + } + + // + // Prepare SSH2_FXP_DIRLIGO_READDIR_SHORT message. + // + // + // size 4 + // type 1 + // id 4 + // handleLen 4 + // handle 4 + // ---------------------------------- + // total: 13 + 4 + // + + packet.clear(); + + StrPushDword(packet, 13, STR_BIG_ENDIAN); // size 4 + StrPushByte(packet, SSH2_FXP_DIRLIGO_READDIR_SHORT); // type 1 + StrPushDword(packet, id, STR_BIG_ENDIAN); // id 4 + StrPushDword(packet, 4, STR_BIG_ENDIAN); // handleLen 4 + StrPushDword(packet, uint32_t(handle), STR_BIG_ENDIAN); // handle 4 + + // + // Send packet and wait for answer. + // + + FAIL(sftp -> processPacket(packet, packet)); + + DEBUG2("SFTP #%d: Sent [SSH2_FXP_DIRLIGO_READDIR_SHORT][%"PRId64"].\n", id, handle); + + // + // Pop header: + // + // size 4 + // type 1 + // id 4 + // + + FAIL(StrPopDword(&size, packet, STR_BIG_ENDIAN)); // size 4 + FAIL(StrPopByte(&type, packet)); // type 1 + FAIL(StrPopDword(&idRet, packet, STR_BIG_ENDIAN)); // id 4 + + if (idRet != id) + { + Error("ERROR: Packet ID mismatch.\n"); + + sftp -> shutdown(); + + goto fail; + } + + // + // Interprete received message. + // + + switch(type) + { + // + // Status message. This means EOF or error. + // + + case SSH2_FXP_STATUS: + { + DEBUG2("SFTP #%d: received [SSH2_FXP_STATUS].", id); + + goOn = 0; + + FAIL(StrPopDword(&serverStatus, packet, STR_BIG_ENDIAN)); + + FAIL(serverStatus != SSH2_FX_EOF); + + DEBUG1("SFTP #%d: Readdir handle [%"PRId64"] finished with code [%d][%s].\n", + id, handle, serverStatus, TranslateSftpStatus(serverStatus)); + + break; + } + + // + // SSH2_FXP_NAME. Next portion of data. + // + + case SSH2_FXP_NAME: + { + DEBUG2("SFTP #%d: received [SSH2_FXP_NAME].", id); + + // + // Pop number of elements. + // + + FAIL(StrPopDword(&count, packet, STR_BIG_ENDIAN)); + + DEBUG2("SFTP #%d: Popped elements count [%d].\n", id, count); + + // + // Pop elements from packet. + // + + for (int i = 0; i < count; i++) + { + SftpFileInfo info; + + memset(&info.attr_, 0, sizeof(info.attr_)); + + char name[MAX_PATH] = {0}; + char longName[MAX_PATH] = {0}; + + uint32_t nameLen = 0; + uint32_t longNameLen = 0; + + // + // Pop element's name. + // + + FAIL(StrPopDword(&nameLen, packet, STR_BIG_ENDIAN)); + FAIL(StrPopRaw(name, nameLen, packet)); + + FAIL(StrPopDword(&longNameLen, packet, STR_BIG_ENDIAN)); + FAIL(StrPopRaw(longName, longNameLen, packet)); + + DEBUG2("SFTP #%d: Popped element [%s] / [%s].\n", id, name, longName); + + info.name_ = name; + + // + // Pop attributes. + // + + FAIL(sftp -> popAttribs(&info.attr_, packet)); + + // + // Last entry marker. Don't go on longer. + // + + if (strcmp(name, "...") == 0) + { + goOn = 0; + } + + // + // Put another element to list. + // + + else + { + job -> addFile(info); + } + } + + DEBUG3("SFTP #%d: Listed next [%d] elements from [%s].\n", id, count, remotePath); + + job -> triggerNotifyCallback(SFTP_JOB_NOTIFY_FILES_LIST_ARRIVED); + + break; + } + + // + // Unexpected packet type. Break. + // + + default: + { + Error("SFTP #%d: ERROR: Unexpected packet type [%d].", id, type); + + sftp -> shutdown(); + + goto fail; + } + } + } + + // + // Set job state as finished. + // + + job -> setState(SFTP_JOB_STATE_FINISHED); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot list files from '%s'.\n", remotePath); + + job -> setState(SFTP_JOB_STATE_ERROR); + } + + if (sftp && handle != -1) + { + sftp -> close(handle); + } + + job -> release(); + + DBG_LEAVE2("SftpClient::ListFiles"); + + return exitCode; + } + + // + // Asynchronous list content of remote directory. + // + // WARNING: Returned SftpJob object MUST be free by calling job -> release() + // method. + // + // TIP#1 : Use job -> wait() method to wait until job finished. + // TIP#2 : Use job -> stop() method to stop job before finished. + // + // TIP#3 : Use job -> getFiles() method inside notifyCallback to receive next + // part of files, wchich was listed. + // + // Parameters: + // + // remotePath - full remote directory to list e.g. "/home" (IN). + // + // notifyCallback - function to be called when new part of file list arrived + // from network (IN). + // + // RETURNS: 0 if OK. + // + + SftpJob *SftpClient::listFiles(const char *remotePath, + SftpJobNotifyCallbackProto notifyCallback) + { + DBG_ENTER2("SftpClient::listFiles"); + + SftpJob *job = NULL; + + ThreadHandle_t *thread = NULL; + + // + // Check args. + // + + FAILEX(remotePath == NULL, "ERROR: 'remotePath' cannot be NULL in ListFiles().\n"); + FAILEX(dead_, "ERROR: list job rejected because session dead.\n"); + + // + // Create new SFTP job. + // + + job = new SftpJob(SFTP_JOB_TYPE_LIST, this, + NULL, remotePath, notifyCallback); + + // + // Create worker thread. + // + + thread = ThreadCreate(ListFilesWorker, job); + + job -> setThread(thread); + + // + // Set state to pending. + // It's signal for worker thread to start work. + // + + job -> setState(SFTP_JOB_STATE_PENDING); + + // + // Error handler. + // + + fail: + + DBG_LEAVE2("SftpClient::listFiles"); + + return job; + } + + // + // Change interval telling how often network statistics are computed. + // + // tick - statistics tick in number of processed packets (IN). + // + + void SftpClient::setNetStatTick(int tick) + { + netStatTick_ = tick; + } + + // + // Register callback function called when number of packets touch + // net statistics tick set by setNetStatTick() function. + // + // callback - function to be called when new statistics arrived (IN). + // ctx - caller context passed to callback function directly (IN/OPT). + // + + void SftpClient::registerNetStatCallback(SftpNetStatCallbackProto callback, void *ctx) + { + netStatCallback_ = callback; + netStatCallbackCtx_ = ctx; + } + + // + // Set timeout in seconds after, which read/write operation is stopped + // and only partial result is returned (e.g. readed 1024 bytes, when + // caller wanted 2048). + // + // readThreshold - read threshold in seconds (IN). + // writeThreshold - write threshold in seconds (IN). + // + + void SftpClient::setPartialThreshold(int readThreshold, int writeThreshold) + { + partialReadThreshold_ = readThreshold * 1000; + partialWriteThreshold_ = writeThreshold * 1000; + } + + // + // Set callback function called when underlying connection dead. + // + + void SftpClient::registerConnectionDroppedCallback(SftpConnectionDroppedProto callback, + void *ctx) + { + connectionDroppedCallback_ = callback; + connectionDroppedCallbackCtx_ = ctx; + + DEBUG1("Registered connection dropped callback" + " ptr [%p], ctx [%p].\n", callback, ctx); + } + + void SftpClient::shutdown() + { + DBG_INFO("SFTP: Shutted down.\n"); + + dead_ = 1; + + if (connectionDroppedCallback_) + { + connectionDroppedCallback_(this, connectionDroppedCallbackCtx_); + } + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibSftp/SftpClient.h b/Source/Net/LibSftp/SftpClient.h new file mode 100644 index 0000000..92d642e --- /dev/null +++ b/Source/Net/LibSftp/SftpClient.h @@ -0,0 +1,318 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_SftpClient_H +#define Tegenaria_Core_SftpClient_H + +// +// Includes. +// + +#ifdef WIN32 +# include +#endif + +#include +#include +#include +#include +#include +#include + +#include "Sftp.h" +#include "SftpJob.h" + +namespace Tegenaria +{ + using std::string; + using std::vector; + + // + // Defines. + // + + #ifdef WIN32 + # define SFTP_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR)) + #else + # define SFTP_ISDIR(mode) (((mode) & (S_IFMT)) == (S_IFDIR)) + #endif + + #define SFTP_CLIENT_FD 0 + #define SFTP_CLIENT_SOCKET 1 + + #define SFTP_CLIENT_AVG_ALFA 0.9 + + // + // Forward declarations. + // + + class SftpClient; + + // + // Typedef. + // + + typedef void (*SftpNetStatCallbackProto)(NetStatistics *netstat, void *ctx); + typedef void (*SftpConnectionDroppedProto)(SftpClient *SftpClient, void *ctx); + + // + // Sftp client class. + // + + class SftpClient + { + protected: + + int fdin_; + int fdout_; + + int timeout_; + int counter_; + + int sectorSize_; + + int fdType_; + + int dead_; + + Mutex mutex_; + + RequestPool *rpool_; + + // + // Network statistics. + // + + NetStatistics netstat_; + + // + // Thread reading incoming packets. + // + + ThreadHandle_t *readThread_; + + // + // Callback to inform owner when underlying network conenction dead. + // + + SftpConnectionDroppedProto connectionDroppedCallback_; + + void *connectionDroppedCallbackCtx_; + + // + // Shutdown object. + // After that object reach dead stead and become unusable. + // + + void shutdown(); + + // + // Partial operation detection. + // + + int partialReadThreshold_; + int partialWriteThreshold_; + + // + // Callback to pass network statistics to caller. + // + + SftpNetStatCallbackProto netStatCallback_; + + void *netStatCallbackCtx_; + + int netStatTick_; + + // + // Exported functions. + // + + public: + + SftpClient(int fdin, int fdout, + int timeout = 30, + int fdType = SFTP_CLIENT_FD); + + ~SftpClient(); + + // + // Net statisticts + // + + void setNetStatTick(int tick); + + void registerNetStatCallback(SftpNetStatCallbackProto callback, void *ctx); + + void setPartialThreshold(int readThreshold, int writeThreshold); + + // + // Callback to inform owner when underlying network conenction dead. + // + + void registerConnectionDroppedCallback(SftpConnectionDroppedProto callback, void *ctx); + + // + // Negotiate connection with server. + // + + int connect(); + int reconnect(); + + void disconnect(); + + // + // Manage sector size. + // + + void setSectorSize(int size); + + // + // Wrappers for standard sftp commands. + // + + int64_t open(const char *path, int mode = SSH2_FXP_OPEN, int isDir = 0); + + int64_t opendir(const char *path); + + int close(int64_t handle); + + // + // Windows optimized functions. + // + + #ifdef WIN32 + int stat(const char *path, BY_HANDLE_FILE_INFORMATION *extendInfo = NULL); + int readdir(vector &data, int64_t handle); + #endif + + // + // Generic functions. + // + + int stat(const char *path, SftpFileAttr *attr = NULL); + + int readdir(vector &files, int64_t handle); + + int read(int64_t handle, char *buffer, uint64_t offset, int size); + int write(int64_t handle, char *buffer, uint64_t offset, int size); + + int mkdir(const char *path); + int remove(const char *path); + int rmdir(const char *path); + int rename(const char *path1, const char *path2); + + int statvfs(Statvfs_t *stvfs, const char *path); + + // + // Custom SFTP commands to fit protocol with WINAPI better. + // + + int64_t createfile(const char *path, uint32_t access, + uint32_t shared, uint32_t create, uint32_t flags, + int *isDir); + + int multiclose(vector &handle); + + int resetdir(int64_t handle); + + int append(int64_t handle, char *buffer, int size); + + // + // Widechar version of above, because DOKAN uses WCHAR. + // Windows only. + // + + #ifdef WIN32 + int64_t open(const wchar_t *path, int mode = SSH2_FXP_OPEN, int isDir = 0); + int64_t opendir(const wchar_t *path); + + int stat(const wchar_t *path, BY_HANDLE_FILE_INFORMATION *extendInfo = NULL); + int mkdir(const wchar_t *path); + int remove(const wchar_t *path); + int rmdir(const wchar_t *path); + int rename(const wchar_t *path1, const wchar_t *path2); + #endif + + int64_t createfile(const wchar_t *path, uint32_t access, + uint32_t shared, uint32_t create, uint32_t flags, + int *isDir); + + int statvfs(Statvfs_t *stvfs, const wchar_t *path); + + // + // High level API. + // + + SftpJob *downloadFile(const char *localPath, + const char *remotePath, + SftpJobNotifyCallbackProto notifyCallback); + + SftpJob *uploadFile(const char *remotePath, + const char *localPath, + SftpJobNotifyCallbackProto notifyCallback); + + SftpJob *listFiles(const char *remotePath, + SftpJobNotifyCallbackProto notifyCallback); + + static int DownloadFileWorker(void *data); + static int UploadFileWorker(void *data); + static int ListFilesWorker(void *data); + + // + // Packet trasmission. + // + + int processPacketSimple(string &answer, string &packet); + + int processPacket(string &answer, string &packet); + + // + // Read thread handler. + // + + static int readLoop(void *data); + + // + // Helpers. + // + + int parseStatusPacket(uint32_t *status, string &packet); + + int packetComplete(string &packet, int realSize); + + int decodePacketHead(uint32_t *size, uint32_t *id, uint8_t *type, + string &packet, int realSize); + + #ifdef WIN32 + int popAttribs(BY_HANDLE_FILE_INFORMATION *info, string &packet); + #endif + + int popAttribs(SftpFileAttr *info, string &packet); + + uint32_t popStatusPacket(string &packet, uint32_t expectedId); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_SftpClient_H */ diff --git a/Source/Net/LibSftp/SftpClientCached.cpp b/Source/Net/LibSftp/SftpClientCached.cpp new file mode 100644 index 0000000..070fc00 --- /dev/null +++ b/Source/Net/LibSftp/SftpClientCached.cpp @@ -0,0 +1,799 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#pragma qcbuild_set_private(1) + +#include +#include "SftpClientCached.h" + +namespace Tegenaria +{ + #ifdef WIN32 + + using std::map; + + // + // Cleaner loop monitoring all cached handles and performs delayed + // close. + // + + int CachedSftpClient::cleanerLoop(void *data) + { + CachedSftpClient *this_ = (CachedSftpClient *) data; + + // + // Fall into main cleaner loop. + // + + while(this_ -> cleanerLoopEnabled_) + { + vector handlesToClose; + + list::iterator it; + + int currentTime = time(0); + + // + // Activate cleaner aevery 5s or when cleanerLoopReset_ + // semaphore signaled. + // + + this_ -> cleanerLoopReset_.wait(5000); + + // + // Prepare list of handles needed to be close on server. + // + + this_ -> lock(); + + for (it = this_ -> cache_.begin(); it != this_ -> cache_.end();) + { + if (it -> refCount_ == 0 + && (currentTime - it -> closeTime_) > 5) + { + handlesToClose.push_back(it -> handle_); + + it = this_ -> cache_.erase(it); + } + else + { + it++; + } + } + + this_ -> unlock(); + + // + // Close handles on SFTP server. + // + + if (handlesToClose.size() > 0) + { + this_ -> multiclose(handlesToClose); + } + } + } + + // + // Constructor. + // + + CachedSftpClient::CachedSftpClient(int fdin, int fdout, int timeout, int fdType) + : SftpClient(fdin, fdout, timeout, fdType) + { + DBG_ENTER3("CachedSftpClient::CachedSftpClient"); + + cleanerLoopEnabled_ = 1; + + cleanerThread_ = ThreadCreate(cleanerLoop, this); + + DBG_LEAVE3("CachedSftpClient::CachedSftpClient"); + } + + // + // Destructor. + // + + CachedSftpClient::~CachedSftpClient() + { + DBG_ENTER3("CachedSftpClient::~CachedSftpClient"); + + cleanerLoopEnabled_ = 0; + + cleanerLoopReset_.signal(); + + ThreadWait(cleanerThread_); + ThreadClose(cleanerThread_); + + cleanerThread_ = NULL; + + DBG_LEAVE3("CachedSftpClient::~CachedSftpClient"); + } + + // + // Find given SFTP handle in cache. + // + // handle - SFTP handle retrive from open() or opendir() function before (IN). + // + // RETURNS: Iterator to CacheElement struct, + // or CacheElement::end() if element not found. + // + + list::iterator CachedSftpClient::findElement(int64_t handle) + { + list::iterator it; + + lock(); + + for (it = cache_.begin(); it != cache_.end(); it++) + { + if (it -> handle_ == handle) + { + break; + } + } + + unlock(); + + return it; + } + + // + // Find given SFTP handle in cache and lock Cache. + // + // WARNING: Caller MUSTS unlock() cache by calling unlock() method + // when found element not needed longer. + // + // TIP: If element not found in cache object is not locked. + // + // Parameters: + // + // handle - SFTP handle retrive from open() or opendir() function before (IN). + // + // RETURNS: Iterator to CacheElement struct, + // or CacheElement::end() if element not found. + // + + list::iterator CachedSftpClient::findElementForUpdate(int64_t handle) + { + list::iterator it; + + lock(); + + for (it = cache_.begin(); it != cache_.end(); it++) + { + if (it -> handle_ == handle) + { + break; + } + } + + if (it == cache_.end()) + { + unlock(); + } + + return it; + } + + // + // Find given remote path in cache. + // + // handle - full, remote path on server side (IN). + // + // RETURNS: Iterator to CacheElement struct, + // or CacheElement::end() if element not found. + // + + list::iterator CachedSftpClient::findElement(const char *path) + { + list::iterator it; + + lock(); + + for (it = cache_.begin(); it != cache_.end(); it++) + { + if (it -> path_ == path) + { + break; + } + } + + unlock(); + + return it; + } + + // + // Find given remote path in cache and lock cache. + // + // TIP: If element not found in cache object is not locked. + // + // Parameters: + // + // handle - full, remote path on server side (IN). + // + // RETURNS: Iterator to CacheElement struct, + // or CacheElement::end() if element not found. + // + + list::iterator CachedSftpClient::findElementForUpdate(const char *path) + { + list::iterator it; + + lock(); + + for (it = cache_.begin(); it != cache_.end(); it++) + { + if (it -> path_ == path) + { + break; + } + } + + if (it == cache_.end()) + { + unlock(); + } + + return it; + } + + // + // Remove and close cached handle, but ONLY if it's unused. + // + + void CachedSftpClient::removeUnusedHandle(const char *path) + { + list::iterator it = findElementForUpdate(path); + + if (it != cache_.end()) + { + int64_t handleToClose = -1; + + if (it -> refCount_ == 0) + { + handleToClose = it -> handle_; + + cache_.erase(it); + } + + unlock(); + + if (handleToClose != -1) + { + realclose(handleToClose); + } + } + } + + // + // Remove and close cached handle, but ONLY if it's unused. + // + + void CachedSftpClient::removeUnusedHandle(int64_t handle) + { + list::iterator it = findElementForUpdate(handle); + + if (it != cache_.end()) + { + int64_t handleToClose = -1; + + if (it -> refCount_ == 0) + { + handleToClose = it -> handle_; + + cache_.erase(it); + } + + unlock(); + + if (handleToClose != -1) + { + realclose(handleToClose); + } + } + } + + // + // Lock whole object. + // + // WARNING: Every calls to lock() MUSTS be folowed by one unlock() method. + // + + void CachedSftpClient::lock() + { + mutex_.lock(); + } + + // + // Unlock object, locked by lock() function before. + // + + void CachedSftpClient::unlock() + { + mutex_.unlock(); + } + + // + // ---------------------------------------------------------------------------- + // + // Wrappers for unchached SftpClient methods + // + // ---------------------------------------------------------------------------- + // + + // + // Wrapper for SftpClient::readdir(). + // + + int CachedSftpClient::readdir(vector &data, int64_t handle) + { + int ret = -1; + + list::iterator it = findElementForUpdate(handle); + + if (it != cache_.end()) + { + if (it -> readdirCalled_ == 1) + { + if (time(0) - it -> findTime_ < 1) + { + data = it -> findData_; + + ret = 0; + + DEBUG1("SFTP-CACHE: Reused dir content [%I64d].\n", handle); + } + else + { + resetdir(handle); + + DEBUG1("SFTP-CACHE: Reset dir [%I64d].\n", handle); + } + } + + it -> readdirCalled_ = 1; + + DEBUG1("SFTP-CACHE: Called readdir on [%I64d].\n", handle); + + unlock(); + } + + if (ret == -1) + { + ret = SftpClient::readdir(data, handle); + + if (ret == 0) + { + it = findElementForUpdate(handle); + + if (it != cache_.end()) + { + it -> findData_ = data; + it -> findTime_ = time(0); + + DEBUG1("SFTP-CACHE: Cached dir content [%I64d].\n", handle); + } + + unlock(); + } + } + + return ret; + } + + // + // Wrapper for SftpClient::opendir(). + // + + int64_t CachedSftpClient::opendir(const char *path) + { + DBG_ENTER3("CachedSftpClient::opendir"); + + list::iterator it; + + int64_t handle = -1; + + // + // Find element in cache. + // + + it = findElementForUpdate(path); + + // + // Element already cached. + // Try use it. + // + + if (it != cache_.end()) + { + if (it -> isDir_) + { + handle = it -> handle_; + + it -> refCount_ ++; + + DEBUG1("SFTP-CACHE: Reused dir [%I64d][%s]" + ", new ref count is [%d]", handle, path, it -> refCount_); + } + + unlock(); + } + + // + // Element not cached. + // Open dir on server and cache retrieved handle. + // + + if (handle == -1) + { + handle = SftpClient::opendir(path); + + if (handle != -1) + { + CacheElement e; + + e.path_ = path; + e.handle_ = handle; + e.refCount_ = 1; + e.isDir_ = 1; + e.readdirCalled_ = 0; + + mutex_.lock(); + cache_.push_back(e); + mutex_.unlock(); + + DEBUG1("SFTP-CACHE: Added dir [%s][%I64d].\n", path, handle); + } + } + + DBG_LEAVE3("CachedSftpClient::opendir"); + + return handle; + } + + // + // Wrapper for SftpClient::close(). + // + + int CachedSftpClient::close(int64_t handle) + { + list::iterator it; + + int realCloseNeeded = 1; + + // + // Try find element in cache. + // + + it = findElementForUpdate(handle); + + if (it != cache_.end()) + { + // + // If cached element is dir decrease its refference count. + // + + if (it -> isDir_) + { + it -> refCount_ --; + + it -> closeTime_ = time(0); + + DEBUG1("SFTP-CACHE: Released [%I64d]" + ", new ref count is [%d].\n", handle, it -> refCount_); + + realCloseNeeded = 0; + } + + unlock(); + } + + // + // If element not found in cache pass to underlying SFTP directly. + // + + if (realCloseNeeded) + { + DEBUG1("SFTP-CACHE: Real close [%I64d]\n", handle); + + realclose(handle); + } + + mutex_.unlock(); + } + + // + // Wrapper for SftpClient::mkdir(). + // + + int CachedSftpClient::mkdir(const char *path) + { + removeUnusedHandle(path); + + return SftpClient::mkdir(path); + } + + // + // Wrapper for SftpClient::rmdir(). + // + + int CachedSftpClient::rmdir(const char *path) + { + removeUnusedHandle(path); + + return SftpClient::rmdir(path); + } + + // + // Wrapper for SftpClient::rename(). + // + + int CachedSftpClient::rename(const char *path1, const char *path2) + { + removeUnusedHandle(path1); + removeUnusedHandle(path2); + + return SftpClient::rename(path1, path2); + } + + // + // Wrapper for SftpClient::statvfs(). + // + + int CachedSftpClient::statvfs(Statvfs_t *stvfs, const char *path) + { + map::iterator it; + + int found = 0; + + int ret = -1; + + // + // Try use cache first. + // + + lock(); + + it = cacheStatvfs_.find(path); + + if (it != cacheStatvfs_.end() + && (time(0) - it -> second.timestamp_) < 5) + { + memcpy(stvfs, &it -> second.statvfs_, sizeof(*stvfs)); + + DEBUG1("SFTP-CACHE: Reusing statvfs for [%s].\n", path); + + found = 1; + + ret = 0; + } + + unlock(); + + // + // Path not found in cache or too old. + // Get info from server and put retrieved data into cache. + // + + if (found == 0) + { + ret = SftpClient::statvfs(stvfs, path); + + if (ret == 0) + { + lock(); + cacheStatvfs_[path].statvfs_ = *stvfs; + cacheStatvfs_[path].timestamp_ = time(0); + unlock(); + + DEBUG1("SFTP-CACHE: Cached statvfs for [%s].\n", path); + } + } + + return ret; + } + + // + // Wrapper on SftpClient::craetefile(). + // + + int64_t CachedSftpClient::createfile(const char *path, uint32_t access, + uint32_t shared, uint32_t create, + uint32_t flags, int *isDir) + { + DBG_ENTER3("CachedSftpClient::createfile"); + + list::iterator it; + + int64_t handle = -1; + + // + // Find element in cache. + // + + it = findElementForUpdate(path); + + // + // Element already cached. + // Try use it. + // + + if (it != cache_.end()) + { + if (it -> isDir_) + { + handle = it -> handle_; + + it -> refCount_ ++; + + DEBUG1("SFTP-CACHE: Reused craetefile dir [%I64d][%s]" + ", new ref count is [%d].\n", handle, path, it -> refCount_); + } + + unlock(); + } + + // + // Element not cached. + // Open dir on server and cache retrieved handle. + // + + if (handle == -1) + { + int isDirLocal = 0; + + handle = SftpClient::createfile(path, access, shared, + create, flags, &isDirLocal); + + if (isDir) + { + *isDir = isDirLocal; + } + + // + // If retrieved handle redirects to directory cache it. + // + + if (handle != -1 && isDirLocal) + { + CacheElement e; + + e.path_ = path; + e.handle_ = handle; + e.isDir_ = 1; + e.readdirCalled_ = 0; + e.refCount_ = 1; + + mutex_.lock(); + cache_.push_back(e); + mutex_.unlock(); + + DEBUG1("SFTP-CACHE: Added createfile dir [%s][%I64d].\n", path, handle); + } + } + + DBG_LEAVE3("CachedSftpClient::createfile"); + + return handle; + } + + // + // ---------------------------------------------------------------------------- + // + // Widechar variants for DOKAN + // + // ---------------------------------------------------------------------------- + // + + // + // Widechar wrapper for open(). + // See utf8 version of SftpClient::open(). + // + + int64_t CachedSftpClient::opendir(const wchar_t *path16) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return opendir(path); + } + + // + // ---------------------------------------------------------------------------- + // + // Helper functions + // + // ---------------------------------------------------------------------------- + // + + int CachedSftpClient::realclose(int64_t handle) + { + return SftpClient::close(handle); + } + + // + // Widechar wrapper for mkdir(). + // See utf8 version of SftpClient::mkdir(). + // + + int CachedSftpClient::mkdir(const wchar_t *path16) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return mkdir(path); + } + + // + // Widechar wrapper for rmdir(). + // See utf8 version of SftpClient::rmdir(). + // + + int CachedSftpClient::rmdir(const wchar_t *path16) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return rmdir(path); + } + + // + // Widechar wrapper for rename(). + // See utf8 version of SftpClient::rename(). + // + + int CachedSftpClient::rename(const wchar_t *path1_16, const wchar_t *path2_16) + { + char path1[MAX_PATH] = {0}; + char path2[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path1_16, -1, path1, sizeof(path1), NULL, NULL); + WideCharToMultiByte(CP_UTF8, 0, path2_16, -1, path2, sizeof(path2), NULL, NULL); + + return rename(path1, path2); + } + + // + // Widechar wrapper for createfile(). + // See utf8 version of SftpClient::createfile(). + // + + int64_t CachedSftpClient::createfile(const wchar_t *path16, uint32_t access, + uint32_t shared, uint32_t create, + uint32_t flags, int *isDir) + { + char path[MAX_PATH] = {0}; + + WideCharToMultiByte(CP_UTF8, 0, path16, -1, path, sizeof(path), NULL, NULL); + + return createfile(path, access, shared, create, flags, isDir); + } + #endif /* WIN32 */ + +} /* namespace Tegenaria */ diff --git a/Source/Net/LibSftp/SftpClientCached.h b/Source/Net/LibSftp/SftpClientCached.h new file mode 100644 index 0000000..68b0c48 --- /dev/null +++ b/Source/Net/LibSftp/SftpClientCached.h @@ -0,0 +1,165 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_CachedSftpClient_H +#define Tegenaria_Core_CachedSftpClient_H + +#ifdef WIN32 + +#include +#include +#include +#include "SftpClient.h" + +namespace Tegenaria +{ + using std::list; + using std::map; + + // + // Struct to store single cache element. + // + + struct CacheElement + { + string path_; + + int64_t handle_; + + int refCount_; + int closeTime_; + int isDir_; + int readdirCalled_; + + vector findData_; + + int findTime_; + }; + + struct CacheStatvfsElement + { + Statvfs_t statvfs_; + + int timestamp_; + }; + + // + // Wrapper class to wrap unached SftpClient into cached one. + // + + class CachedSftpClient : public SftpClient + { + private: + + list cache_; + + static int cleanerLoop(void *data); + + ThreadHandle_t *cleanerThread_; + + int cleanerLoopEnabled_; + + Semaphore cleanerLoopReset_; + + map cacheStatvfs_; + + Mutex mutex_; + + // + // Private functions. + // + + list::iterator findElement(int64_t handle); + list::iterator findElementForUpdate(int64_t handle); + + list::iterator findElement(const char *path); + list::iterator findElementForUpdate(const char *path); + + int realclose(int64_t handle); + + void removeUnusedHandle(const char *path); + void removeUnusedHandle(int64_t handle); + + // + // Exported functions. + // + + public: + + // + // Init. + // + + CachedSftpClient(int fdin, int fdout, + int timeout = 30, + int fdType = SFTP_CLIENT_FD); + + ~CachedSftpClient(); + + // + // Thread sychronization. + // + + void lock(); + void unlock(); + + // + // Wrappers for raw SftpClienet functions. + // + + int64_t opendir(const char *name); + + int close(int64_t handle); + + int readdir(vector &data, int64_t handle); + + int mkdir(const char *path); + int rmdir(const char *path); + int rename(const char *path1, const char *path2); + + int statvfs(Statvfs_t *stvfs, const char *path); + + int64_t createfile(const char *path, uint32_t access, + uint32_t shared, uint32_t create, uint32_t flags, + int *isDir); + + // + // Widechar wrappers for DOKAN. + // + + int64_t opendir(const wchar_t *path); + + int mkdir(const wchar_t *path); + int rmdir(const wchar_t *path); + int rename(const wchar_t *path1, const wchar_t *path2); + + int64_t createfile(const wchar_t *path, uint32_t access, + uint32_t shared, uint32_t create, uint32_t flags, + int *isDir); + }; + +} /* namespace Tegenaria */ + +#endif /* WIN32 */ +#endif /* Tegenaria_Core_CachedSftpClient_H */ diff --git a/Source/Net/LibSftp/SftpJob.cpp b/Source/Net/LibSftp/SftpJob.cpp new file mode 100644 index 0000000..b797dde --- /dev/null +++ b/Source/Net/LibSftp/SftpJob.cpp @@ -0,0 +1,495 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "SftpJob.h" + +namespace Tegenaria +{ + // + // SftpJob constructor. + // + // type - job's type, see SFTP_JOB_TYPE_XXX defines in SftpJob.h (IN). + // sftp - related SFTP Client object (IN). + // localName - related local path, e.g. source local file in upload job (IN). + // remoteName - related remote path e.g. destination remote path in upload job (IN). + // + // notifyCallback - function to be called when new transfer statistics arrives + // or job's state changed. Optional, can be NULL (IN/OPT). + // + + SftpJob::SftpJob(int type, SftpClient *sftp, + const char *localName, const char *remoteName, + SftpJobNotifyCallbackProto notifyCallback) + { + DBG_ENTER3("SftpJob::SftpJob"); + + DBG_SET_ADD("SftpJob", this); + + if (localName == NULL) + { + localName = ""; + } + + if (remoteName == NULL) + { + remoteName = ""; + } + + refCount_ = 1; + type_ = type; + sftp_ = sftp; + localName_ = localName; + remoteName_ = remoteName; + totalBytes_ = 0; + processedBytes_ = 0; + avgRate_ = 0.0; + startTime_ = this -> getTimeMs(); + thread_ = NULL; + state_ = SFTP_JOB_STATE_INITIALIZING; + notifyCallback_ = notifyCallback; + + switch(type) + { + case SFTP_JOB_TYPE_DOWNLOAD: + { + DBG_INFO("Created SFTP download job. PTR is '%p', remote path is '%s', local path is '%s'", + this, remoteName, localName); + + break; + } + + case SFTP_JOB_TYPE_UPLOAD: + { + DBG_INFO("Created SFTP upload job. PTR is '%p', remote path is '%s', local path is '%s'", + this, remoteName, localName); + + break; + } + + case SFTP_JOB_TYPE_LIST: + { + DBG_INFO("Created SFTP list job. PTR is '%p', remote path is '%s'", this, remoteName); + + break; + } + } + + DBG_LEAVE3("SftpJob::SftpJob"); + } + + // + // SftpJob destructor. + // + + SftpJob::~SftpJob() + { + DBG_SET_DEL("SftpJob", this); + } + + // + // Get current time in ms. + // + + double SftpJob::getTimeMs() + { + struct timeval tv; + + gettimeofday(&tv, NULL); + + return tv.tv_sec * 1000.0 + tv.tv_usec / 1000.0; + } + + // + // Increase refference counter. + // + // WARNING! Every call to addRef() MUSTS be followed by one release() call. + // + // TIP #1: Object will not be destroyed until refference counter is greater + // than 0. + // + // TIP #2: Don't call destructor directly, use release() instead. If + // refference counter achieve 0, object will be destroyed + // automatically. + // + + void SftpJob::addRef() + { + refCountMutex_.lock(); + + refCount_ ++; + + DEBUG2("Increased refference counter to %d for SftpJob PTR#%p.\n", refCount_, this); + + refCountMutex_.unlock(); + } + + // + // Decrease refference counter increased by addRef() before. + // + + void SftpJob::release() + { + int deleteNeeded = 0; + + // + // Decrease refference counter by 1. + // + + refCountMutex_.lock(); + + refCount_ --; + + DEBUG2("Decreased refference counter to %d for SftpJob PTR#%p.\n", refCount_, this); + + if (refCount_ == 0) + { + deleteNeeded = 1; + } + + refCountMutex_.unlock(); + + // + // Delete object if refference counter goes down to 0. + // + + if (deleteNeeded) + { + delete this; + } + } + + // + // Change current state. See SFTP_STATE_XXX defines in SftpJob.h. + // + // state - new state to set (IN). + // + + void SftpJob::setState(int state) + { + state_ = state; + + DEBUG2("SftpJob PTR#%p changed state to [%s].\n", this, this -> getStateString()); + + switch(state) + { + case SFTP_JOB_STATE_ERROR: DBG_INFO("SFTP job PTR#%p finished with error.\n", this); break; + case SFTP_JOB_STATE_INITIALIZING: DEBUG2("SFTP job PTR#%p initializing.\n", this); break; + case SFTP_JOB_STATE_PENDING: DEBUG2("SFTP job PTR#%p pending.\n", this); break; + case SFTP_JOB_STATE_FINISHED: DBG_INFO("SFTP job PTR#%p finished with success.\n", this); break; + case SFTP_JOB_STATE_STOPPED: DBG_INFO("SFTP job PTR#%p stopped.\n", this); break; + } + + // + // Call notify callback if set. + // + + if (notifyCallback_) + { + notifyCallback_(SFTP_JOB_NOTIFY_STATE_CHANGED, this); + } + } + + // + // Set thread handle related with job. + // + // thread - thread handle to set (IN). + // + + void SftpJob::setThread(ThreadHandle_t *thread) + { + thread_ = thread; + } + + // + // Get current state code. See SFTP_JOB_STATE_XXX defines in SftpJob.h. + // + // RETURNS: Current state code. + // + + int SftpJob::getState() + { + return state_; + } + + // + // Get current state as human readable string. + // + // RETURNS: Name of current job's state. + // + + const char *SftpJob::getStateString() + { + switch(state_) + { + case SFTP_JOB_STATE_ERROR: return "Error"; + case SFTP_JOB_STATE_INITIALIZING: return "Initializing"; + case SFTP_JOB_STATE_PENDING: return "Pending"; + case SFTP_JOB_STATE_FINISHED: return "Finished"; + case SFTP_JOB_STATE_STOPPED: return "Stopped"; + }; + + return "Unknown"; + } + + // + // Wait until job finished or stopped with error. + // + // timeout - maximum time to wait in ms. Set to -1 for infinite (IN). + // + // RETURNS: 0 if OK (job finished/stopped on exit), + // -1 otherwise (job still active on exit). + + int SftpJob::wait(int timeout) + { + DBG_ENTER2("SftpJob::waitForFinish"); + + int exitCode = -1; + + int timeLeft = timeout; + + while(state_ == SFTP_JOB_STATE_INITIALIZING || state_ == SFTP_JOB_STATE_PENDING) + { + ThreadSleepMs(50); + + if (timeout > 0) + { + timeLeft -= 50; + + if (timeLeft <= 0) + { + Error("ERROR: Timeout while waiting for SftpJob PTR#%p.\n", this); + + goto fail; + } + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE2("SftpJob::waitForFinish"); + + return exitCode; + } + + // + // Send stop signal for pending SFTP job. + // After that related thread should stop working and state + // should change to SFTP_JOB_STATE_STOPPED. + // + // WARNING#1: SFTP job object MUSTS be still released with release() method. + // + // TIP#1: To stop and release resources related with SFTP job use below code: + // + // job -> cancel(); + // job -> release(); + // + + void SftpJob::cancel() + { + this -> setState(SFTP_JOB_STATE_STOPPED); + } + + // + // Retrieve SftpClient object related with job. + // + + SftpClient *SftpJob::getSftpClient() + { + return sftp_; + } + + // + // Retrieve remote name related with job. + // + + const char *SftpJob::getRemoteName() + { + return remoteName_.c_str(); + } + + // + // Retrieve local name related with job. + // + + const char *SftpJob::getLocalName() + { + return localName_.c_str(); + } + + // + // Update transfer statistics for job. + // Internal use only. + // + // processedBytes - number of bytes already processed (IN). + // totalBytes - number of total bytes to process (IN). + // + + void SftpJob::updateStatistics(double processedBytes, double totalBytes) + { + DBG_ENTER3("SftpJob::updateTransferStatistics"); + + double currentTime = 0.0; + double dt = 0.0; + + // + // Save total and processed fields. + // + + processedBytes_ = processedBytes; + totalBytes_ = totalBytes; + + // + // Compute new averange rate. + // + + currentTime = getTimeMs(); + dt = (currentTime - startTime_) / 1000.0; + avgRate_ = double(processedBytes) / dt; + + // + // Call notify callback if set. + // + + if (notifyCallback_) + { + notifyCallback_(SFTP_JOB_NOTIFY_TRANSFER_STATISTICS, this); + } + + DBG_LEAVE3("SftpJob::updateTransferStatistics"); + } + + // + // Retrieve job type. See SFTP_JOB_TYPE_XXX defines in SftpJob.h. + // + + int SftpJob::getType() + { + return type_; + } + + // + // Get averange job's rate in bytes per seconds. + // + + double SftpJob::getAvgRate() + { + return avgRate_; + } + + // + // Get total bytes needed to be processed to finish job e.g. total size + // of file to download in bytes. + // + + int64_t SftpJob::getTotalBytes() + { + return totalBytes_; + } + + // + // Get number of bytes already processed by job. + // + + int64_t SftpJob::getProcessedBytes() + { + return processedBytes_; + } + + // + // Get completion status in percentes (0-100%). + // + + double SftpJob::getPercentCompleted() + { + double perc = 0.0; + + if (totalBytes_ > 0) + { + perc = double(processedBytes_) / double(totalBytes_) * 100.0; + } + + return perc; + } + + // + // Manage files list storing inside SftpJob object while performing + // list job. + // + + // + // Clear list of files stored inside job object. + // Used internally only. + // + + void SftpJob::clearFiles() + { + files_.clear(); + } + + // + // Add file to files list stored inside job object. + // Used internally only. + // + + void SftpJob::addFile(SftpFileInfo &file) + { + files_.push_back(file); + } + + // + // Retrieve list of files stored inside job object. + // + // TIP#1: Use this function to retrieve next part of files while performing + // SFTP_JOB_TYPE_LIST job. This function should be called inside + // notify callback passed to SftpClient::listFiles() function. + // + // RETURNS: Refference to files list currently stored inside job object. + // + + vector &SftpJob::getFiles() + { + return files_; + } + + // + // Tell sftp job object to call underlying notify callback set in constructor. + // Used internally only. + // + // code - one of SFTP_JOB_NOTIFY_XXX code passed to callback notify (IN). + // + + void SftpJob::triggerNotifyCallback(int code) + { + if (notifyCallback_) + { + notifyCallback_(code, this); + } + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibSftp/SftpJob.h b/Source/Net/LibSftp/SftpJob.h new file mode 100644 index 0000000..e4ccf3a --- /dev/null +++ b/Source/Net/LibSftp/SftpJob.h @@ -0,0 +1,179 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_SftpJob_H +#define Tegenaria_Core_SftpJob_H + +#include + +#include "Sftp.h" +#include +#include +#include + +namespace Tegenaria +{ + using std::vector; + + // + // Defines. + // + + #define SFTP_JOB_TYPE_DOWNLOAD 1 + #define SFTP_JOB_TYPE_UPLOAD 2 + #define SFTP_JOB_TYPE_LIST 3 + + #define SFTP_JOB_STATE_ERROR 1 + #define SFTP_JOB_STATE_INITIALIZING 2 + #define SFTP_JOB_STATE_PENDING 4 + #define SFTP_JOB_STATE_FINISHED 8 + #define SFTP_JOB_STATE_STOPPED 16 + + #define SFTP_JOB_NOTIFY_STATE_CHANGED 1 + #define SFTP_JOB_NOTIFY_TRANSFER_STATISTICS 2 + #define SFTP_JOB_NOTIFY_FILES_LIST_ARRIVED 3 + + // + // Forward declaration. + // + + class SftpJob; + class SftpClient; + + // + // Typedef. + // + + typedef void (*SftpJobNotifyCallbackProto)(int type, SftpJob *job); + + // + // Classes. + // + + class SftpJob + { + private: + + int type_; + + string localName_; + string remoteName_; + + int64_t totalBytes_; + int64_t processedBytes_; + + double avgRate_; + double startTime_; + + SftpClient *sftp_; + + int state_; + + Mutex refCountMutex_; + + int refCount_; + + ThreadHandle_t *thread_; + + SftpJobNotifyCallbackProto notifyCallback_; + + vector files_; + + // + // Exported public functions. + // + + public: + + SftpJob(int type, SftpClient *sftp, const char *localName, + const char *remoteName, SftpJobNotifyCallbackProto notifyCallback); + + void triggerNotifyCallback(int code); + + // + // Refference counter. + // + + void addRef(); + void release(); + + // + // Setters. + // + + void setState(int state); + + void setThread(ThreadHandle_t *thread); + + const char *getStateString(); + + void updateStatistics(double processedBytes, double totalBytes); + + void clearFiles(); + + void addFile(SftpFileInfo &file); + + // + // Getters. + // + + int getType(); + int getState(); + + SftpClient *getSftpClient(); + + const char *getRemoteName(); + const char *getLocalName(); + + double getAvgRate(); + + double getPercentCompleted(); + + int64_t getTotalBytes(); + int64_t getProcessedBytes(); + + vector &getFiles(); + + // + // Synchronize functinos. + // + + int wait(int timeout = -1); + + void cancel(); + + // + // Private functions. + // + + private: + + ~SftpJob(); + + double getTimeMs(); + }; + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_SftpJob_H */ diff --git a/Source/Net/LibSftp/TODO b/Source/Net/LibSftp/TODO new file mode 100644 index 0000000..a68247f --- /dev/null +++ b/Source/Net/LibSftp/TODO @@ -0,0 +1 @@ +- Where are ThreadJoin / ThreadWait ? \ No newline at end of file diff --git a/Source/Net/LibSftp/Utils.cpp b/Source/Net/LibSftp/Utils.cpp new file mode 100644 index 0000000..2f707d8 --- /dev/null +++ b/Source/Net/LibSftp/Utils.cpp @@ -0,0 +1,203 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 +#include "Utils.h" +#include "Sftp.h" + +namespace Tegenaria +{ + // + // Generate thread-safe, unique number. + // Used internally to generate handles and session IDs. + // + // RETURNS: Number unique inside process. + // + + int GenerateUniqueId() + { + static Mutex mutex("UniqueId"); + + static int count = 1; + + int id = -1; + + mutex.lock(); + + id = count; + count ++; + + mutex.unlock(); + + return id; + } + + #ifdef WIN32 + + // + // Translate {access, create, flags} masks passed to CreateFile() + // into SFTP access mask. + // + // access - dwDesiredAccess mask passed used with CreateFile (IN). + // share - dwShareMode mask passed used with CreateFile (IN). + // create - dwCreationDisposition parameter used with CreateFile (IN). + // flags - dwFlagsAndAttributes parameter used with CreateFile (IN). + // + // RETURNS: SFTP access mask. + // + + int GetSftpFlagFromWinapi(DWORD access, DWORD shared, DWORD create, DWORD flags) + { + int mode = 0; + + if (access & FILE_READ_DATA || access & GENERIC_READ) + { + mode |= SSH2_FXF_READ; + } + + if (access & FILE_WRITE_DATA || access & GENERIC_WRITE) + { + mode |= SSH2_FXF_WRITE; + } + + if (access & FILE_APPEND_DATA) + { + mode |= SSH2_FXF_APPEND; + } + + // + // Process create disposition arg. + // + + switch(create) + { + // + // Create always. If exists open, if not exist open for overwrite. + // + + case CREATE_ALWAYS: + { + mode |= SSH2_FXF_TRUNC; + mode |= SSH2_FXF_CREAT; + + break; + } + + // + // Create new. If exists fail, if not create new. + // + + case CREATE_NEW: + { + mode |= SSH2_FXF_CREAT; + + break; + } + + // + // Open always. If exists open, if not craete new file. + // + + case OPEN_ALWAYS: + { + mode |= SSH2_FXF_CREAT; + + break; + } + + // + // Open existing. If exists open, if not fail. + // + + case OPEN_EXISTING: + { + break; + } + + // + // Truncate existing. If exists open and zero, if not fail. + // + + case TRUNCATE_EXISTING: + { + mode |= SSH2_FXF_TRUNC; + } + } + + + DEBUG3("Translated WINAPI mode {0x%x, 0x%x, 0x%x, 0x%x} into SFTP 0x%x.\n", + access, shared, create, flags, mode); + + return mode; + } + + #endif /* WIN32 */ + + // + // Translate SSH2_FX_XXX code into human readable string. + // + // code - one of SSH2_FX_XXX code defined in Sftp.h (IN). + // + // RETURNS: Error string related to given code, + // or "Unknown" if code not recognized. + // + + const char *TranslateSftpStatus(int code) + { + const char *names[] = + { + "SSH2_FX_OK", // 0 + "SH2_FX_EOF", // 1 + "SSH2_FX_NO_SUCH_FILE", // 2 + "SSH2_FX_PERMISSION_DENIED", // 3 + "SSH2_FX_FAILURE", // 4 + "SSH2_FX_BAD_MESSAGE", // 5 + "SSH2_FX_NO_CONNECTION", // 6 + "SSH2_FX_CONNECTION_LOST", // 7 + "SSH2_FX_OP_UNSUPPORTED" // 8 + }; + + if (code >= 0 && code <= SSH2_FX_MAX) + { + return names[code]; + } + else + { + return "Unknown"; + } + } + + // + // Get current time in ms. + // + + double GetTimeMs() + { + struct timeval tv; + + gettimeofday(&tv, NULL); + + return tv.tv_sec * 1000.0 + tv.tv_usec / 1000.0; + } +} /* namespace Tegenaria */ diff --git a/Source/Net/LibSftp/Utils.h b/Source/Net/LibSftp/Utils.h new file mode 100644 index 0000000..fb83302 --- /dev/null +++ b/Source/Net/LibSftp/Utils.h @@ -0,0 +1,48 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Core_Sftp_Utils_H +#define Tegenaria_Core_Sftp_Utils_H + +#include +#include +#include +#include +#include + +namespace Tegenaria +{ + int GenerateUniqueId(); + + #ifdef WIN32 + int GetSftpFlagFromWinapi(DWORD access, DWORD shared, DWORD create, DWORD flags); + #endif + + const char *TranslateSftpStatus(int code); + + double GetTimeMs(); + +} /* namespace Tegenaria */ + +#endif /* Tegenaria_Core_Sftp_Utils_H */ diff --git a/Source/Net/LibSftp/qcbuild.src b/Source/Net/LibSftp/qcbuild.src new file mode 100644 index 0000000..32e6b05 --- /dev/null +++ b/Source/Net/LibSftp/qcbuild.src @@ -0,0 +1,36 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +TYPE = LIBRARY +TITLE = LibSftp +PURPOSE = SSHFS client library. +AUTHOR = Sylwester Wysocki + +INC_DIR = Tegenaria +ISRC = SftpClient.h Sftp.h SftpJob.h SftpClientCached.h +CXXSRC = SftpClient.cpp Utils.cpp SftpJob.cpp SftpClientCached.cpp + +DEPENDS = LibDebug LibStr LibThread LibLock LibMath LibNet + +LIBS = -llock -lstr -lthread -ldebug -lnet diff --git a/Source/Net/Tegenaria-net.h b/Source/Net/Tegenaria-net.h new file mode 100644 index 0000000..3d2b9a9 --- /dev/null +++ b/Source/Net/Tegenaria-net.h @@ -0,0 +1,33 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Tegenaria_Net_H +#define Tegenaria_Net_H + +#include "Net.h" +#include "NetEx.h" +#include "SftpClient.h" +#include "SftpClientCached.h" + +#endif /* Tegenaria_Net_H */ diff --git a/Source/Net/qcbuild.src b/Source/Net/qcbuild.src new file mode 100644 index 0000000..53f671e --- /dev/null +++ b/Source/Net/qcbuild.src @@ -0,0 +1,52 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki # +# # +# 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. # +# # +################################################################################ + +# +# Libs project's root. +# + +TYPE = MULTI_LIBRARY +TITLE = Tegenaria-net +AUTHOR = Sylwester Wysocki + +INC_DIR = Tegenaria +ISRC = Tegenaria-net.h + +DEPENDS = LibNet LibSftp +LIBS = -levent-static -ltegenaria-core +##LibNetEx + +# +# Auto-documentation flags. +# + +AUTODOC_PRIVATE = 1 + +# +# Link extra libraries on windows. +# + +.section MinGW + LIBS += -lws2_32 -loleaut32 +.endsection diff --git a/Source/Tools/QCBuild/AutoDoc.cpp b/Source/Tools/QCBuild/AutoDoc.cpp new file mode 100644 index 0000000..43f5b50 --- /dev/null +++ b/Source/Tools/QCBuild/AutoDoc.cpp @@ -0,0 +1,1659 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Generate HTML documentation from comments +// inside source code. +// + +#include "AutoDoc.h" +#include "Diagram.h" +#include + +#ifdef WIN32 +# include +#endif + +using namespace Tegenaria; + +int ListComponents(SourceInfo *pi, vector &comps); + +#define HTML_PRE_STYLE "width:720px;" \ + "background:#eee;" \ + "border-style:solid;" \ + "border-color:#888;" \ + "border-width:1px;" \ + "padding: 8px;" +// +// +// + +static string AutoDocHighlightCode(string code) +{ + string oldStr; + string newStr; + + const char *types[] = + { + "int", "double", "float", "vector", "string", "set", "map", "void", + "stack", "const", "unsigned", "signed", "char", "int64_t", "int32_t", + "int8_t", "uint64_t", "uint32_t", "uint16_t", "uint8_t", "int16_t", + "bool", "DWORD", "HANDLE", "BOOL", NULL + }; + + code = " " + code + " "; + + for (int i = 0; types[i]; i++) + { + oldStr = string(" ") + types[i] + string(" "); + newStr = string(" ") + types[i] + string(" "); + StrReplaceString(code, oldStr.c_str(), newStr.c_str()); + } + + return code.substr(1, code.size() - 1); +} + +// +// +// + +static string AutoDocFormatFunctionProto(FunctionInfo *fi) +{ + string rv = ""; + + vector args; + vector argTypes; + vector argNames; + + int argTypeLengthMax = 0; + + rv += StrNormalizeWhiteSpaces(fi -> return_); + + if (!rv.empty()) + { + rv += " "; + } + + rv += StrNormalizeWhiteSpaces(fi -> name_); + rv += "\n"; + rv += "(\n"; + + StrTokenize(args, fi -> args_, ",()"); + + // + // Remove empty tokens from args[]. + // + + for (vector::iterator it = args.begin(); it != args.end(); ) + { + (*it) = StrNormalizeWhiteSpaces(*it); + + if (it -> empty()) + { + it = args.erase(it); + } + else + { + it ++; + } + } + + // + // Split args[] into type and variable name. + // + + for (int i = 0; i < args.size(); i++) + { + string type; + string name; + + // + // Find position of last whitespace. + // + + int lastSpaceIdx = -1; + + for (int j = 0; j < args[i].size(); j++) + { + if (isspace(args[i][j])) + { + lastSpaceIdx = j; + } + } + + if (lastSpaceIdx == -1) + { + // + // Only typename found. + // + + type = args[i]; + name = ""; + } + else + { + // + // Found typename and variable name. + // Split them. + // + + while(lastSpaceIdx < args[i].size() -1 && + (args[i][lastSpaceIdx] == '*') || isspace(args[i][lastSpaceIdx])) + { + lastSpaceIdx ++; + } + + type = StrNormalizeWhiteSpaces(args[i].substr(0, lastSpaceIdx)); + name = StrNormalizeWhiteSpaces(args[i].substr(lastSpaceIdx)); + } + + // + // Save splitted type and variable name. + // + + argTypes.push_back(type); + argNames.push_back(name); + + // + // Count maximum type length. + // + + if (type.size() > argTypeLengthMax) + { + argTypeLengthMax = type.size(); + } + } + + // + // Put args list. + // + + for (int i = 0; i < args.size(); i++) + { + rv += " "; + rv += argTypes[i]; + + for (int j = 0; j < argTypeLengthMax - argTypes[i].size() + 1; j++) + { + rv += " "; + } + + rv += argNames[i]; + + if (i < args.size() - 1) + { + rv += ",\n"; + } + else + { + rv += "\n"; + } + } + + rv += ");"; + + rv = StrEncodeToHtml(rv, 0); //STR_HTML_NON_BREAK_SPACES); + rv = AutoDocHighlightCode(rv); + + return rv; +} + +// +// Parse #pragma qcbuild_xxx(parameter) macro. +// +// TODO: Handle multiple parameters. +// + +static int AutoDocParseQCBuildPragma(QCBuildPragma *pragmaInfo, string line) +{ + int exitCode = -1; + + vector args; + + char *buf = (char *) line.c_str(); + + char *cmd = NULL; + char *argsBegin = NULL; + char *argsEnd = NULL; + char *argsRaw = NULL; + + cmd = strstr(buf, "qcbuild_"); + argsBegin = strchr(buf, '('); + + for (int i = 0; buf[i]; i++) + { + if (buf[i] == ')') + { + argsEnd = buf + i; + } + } + + FAILEX(cmd == NULL, "ERROR: Missing 'qcbuild_' prefix in #pragma macro '%s'.\n", line.c_str()); + FAILEX(argsBegin == NULL, "ERROR: Missing '(' in #pragma macro '%s'.\n", line.c_str()); + FAILEX(argsEnd == NULL, "ERROR: Missing ')' in #pragma macro '%s'.\n", line.c_str()); + + argsBegin[0] = 0; + argsEnd[0] = 0; + argsRaw = argsBegin + 1; + + StrTokenize(args, argsRaw, ",", "\""); + + pragmaInfo -> cmd_ = cmd; + pragmaInfo -> args_.resize(1); + pragmaInfo -> args_ = args; + + DBG_MSG("Decoded [%s][%s] pragma command.\n", cmd, argsRaw); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return exitCode; +} + +// +// Compare source files by number of functions inside. +// + +static bool CompareSourceByNumberOfFunctions(const SourceFile &sf1, + const SourceFile &sf2) +{ + return sf1.functions_.size() > sf2.functions_.size(); +} + +// +// Generate list of functions inside given C/C++ source file. +// +// sourceFile - pointer to SourceFile struct to collect parsed info (OUT). +// fname - name of C/C++ file to search (IN). +// +// RETURNS: 0 if OK. +// + +int CollectFunctionsFromCSource(SourceFile *sourceFile, const char *fname, int privateMode) +{ + DBG_ENTER("CollectFunctionsFromCSource"); + + int exitCode = -1; + + int goOn = 1; + + int deep = 0; + + int tokenId = -1; + int lastTokenId = -1; + + int eolTriggered = 0; + + vector &fi = sourceFile -> functions_; + + string namespaceAtDeep[MAX_DEEP + 1]; + string token; + string lastToken; + string lastComment; + string lastArgs; + + string lastIdent; + string lastLastIdent; + + string returnType; + string args; + + string currentNamespace; + + int privateAtDeep[MAX_DEEP + 1] = {0}; + int functionIdAtDeep[MAX_DEEP + 1] = {0}; + + FunctionInfo fiEntry; + + DBG_MSG("Assigning [%s]...\n", fname); + + sourceFile -> name_ = fname; + + fiEntry.fname_ = fname; + + // + // Open source file. + // + + FILE *f = fopen(fname, "rt"); + + FAILEX(f == NULL, "ERROR: Cannot open file '%s'.\n", fname); + + // + // Init functionIdAtDeep[] array. + // We're not inside any function at the begin. + // + + for (int i = 0; i < MAX_DEEP; i++) + { + functionIdAtDeep[i] = -1; + } + + // + // Scan file. + // + + DEBUG3("CollectFunctionsFromCSource : Initing scanner...\n"); + + ScanInit(f); + + while(goOn) + { + int visible = 1; + + tokenId = ScanPopToken(token); + + // + // Hide content when inside private mode. + // + + if (privateAtDeep[deep] == 1) + { + visible = 0; + } + + // + // Determine are we inside top level deep in current namespace. + // For example: + // + // namespace X + // { + // // top level for X namespace (level 0) + // + // void f() + // { + // // level 1 + // struct MyData = + // { + // // level 2 + // } + // } + // } + // + // + // + + int isTopLevel = 0; + + if (deep == 0 || !namespaceAtDeep[deep].empty()) + { + isTopLevel = 1; + } + + DBG_MSG("[%d][%s][%s]\n", deep, GetTokenName(tokenId), token.c_str()); + + if (!args.empty()) + { + args += token; + } + + switch(tokenId) + { + // + // End of file. + // + + case TOKEN_EOF: + { + goOn = 0; + + break; + } + + // + // TOKEN_IDENT + // + + case TOKEN_IDENT: + { + lastLastIdent = lastIdent; + lastIdent = token; + + break; + } + + // + // Single EOL. + // Reset comments. + // + + case TOKEN_EOL: + { + eolTriggered = 1; + + break; + } + + // + // Comment. Collect comment. + // + + case TOKEN_COMMENT: + { + if (eolTriggered) + { + eolTriggered = 0; + + lastComment.clear(); + } + + if (lastTokenId == TOKEN_COMMENT + || lastTokenId == TOKEN_WHITE + || lastTokenId == TOKEN_EOL) + { + lastComment += "\n"; + lastComment += ' '; + lastComment += token.substr(2); + } + else + { + lastComment += ' '; + lastComment += token.substr(2); + } + + break; + } + + // + // '('. + // Probably begin of function arguments. + // + + case TOKEN_PARENT_BEGIN: + { + if (isTopLevel) + { + if (fiEntry.return_.empty() && fiEntry.name_.empty()) + { + fiEntry.return_ = returnType; + fiEntry.name_ = lastToken; + + DBG_MSG("Argument's begin. Saved identifier [%s].\n", lastToken.c_str()); + DBG_MSG("Argument's begin. Saved return [%s].\n", returnType.c_str()); + + returnType = ""; + args = "("; + } + else + { + DBG_MSG("Skipped false function args. Probably constructor init list found.\n"); + } + } + + break; + } + + // + // ')'. + // End of arguments. + // + + case TOKEN_PARENT_END: + { + DBG_MSG("Argument's end. Saved args [%s].\n", args.c_str()); + + if (fiEntry.args_.empty()) + { + fiEntry.args_ = args; + } + + args.clear(); + + break; + } + + // + // Block begin. + // If found in global space it's probably function declaration. + // + + case TOKEN_BLOCK_BEGIN: + { + // + // Namespace body begin. + // + + if (lastLastIdent == "namespace") + { + DBG_MSG("Entered namespace [%s].\n", lastIdent.c_str()); + + namespaceAtDeep[deep + 1] = lastIdent; + + currentNamespace = lastIdent; + } + + // + // Function body begin. + // Function can be started at top level in given namespace. + // + + else if (isTopLevel && fiEntry.name_.empty() == 0 && fiEntry.args_.empty() == 0) + { + if (visible) + { + fiEntry.comment_ = StrEncodeToHtml(lastComment, STR_HTML_NON_BREAK_SPACES); + + // + // Push recognized function to list. + // + + DBG_MSG("Pushed function [%s][%s][%s]...\n", + fiEntry.return_.c_str(), fiEntry.name_.c_str(), + fiEntry.args_.c_str()); + + fi.push_back(fiEntry); + + functionIdAtDeep[deep + 1] = fi.size() - 1; + } + + // + // Clear function's description struct. + // We're collecting another function from zero. + // + + lastComment.clear(); + + fiEntry.return_.clear(); + fiEntry.args_.clear(); + fiEntry.comment_.clear(); + fiEntry.name_.clear(); + } + + deep ++; + + returnType = ""; + + break; + } + + // + // '}'. + // + // Control deep level. Function declarations are possible + // only in deep=0 (global space) or in deep=1 as inline class/struct. + // + + case TOKEN_BLOCK_END: + { + lastComment.clear(); + returnType.clear(); + + functionIdAtDeep[deep] = -1; + + if (!namespaceAtDeep[deep].empty()) + { + DBG_MSG("Leaved namespace [%s].\n", namespaceAtDeep[deep].c_str()); + + namespaceAtDeep[deep].clear(); + } + + for (int i = deep; i < MAX_DEEP; i++) + { + privateAtDeep[i] = 0; + } + + deep --; + + break; + } + + // + // ';' or C macro. + // + + case TOKEN_SEMICOLON: + case TOKEN_MACRO: + { + DBG_MSG2("[TOKEN_SEMICOLON]: Clearing return type...\n"); + + fiEntry.name_.clear(); + fiEntry.args_.clear(); + fiEntry.return_.clear(); + + args.clear(); + returnType.clear(); + lastComment.clear(); + + if (tokenId == TOKEN_MACRO + && strstr(token.c_str(), "#pragma") + && strstr(token.c_str(), "qcbuild_")) + { + QCBuildPragma pragmaInfo; + + FAIL(AutoDocParseQCBuildPragma(&pragmaInfo, token)); + + // + // Dispatch to proper command. + // + + if (pragmaInfo.cmd_ == "qcbuild_set_private") + { + // + // qcbuild_set_private(bool) + // Mark current namespace as private (not visible in public doc). + // If called inside global space it makes whole source file + // unvisible for public. + // + + if ((pragmaInfo.args_.size() == 1) && (pragmaInfo.args_[0] == "1")) + { + for (int i = deep; i < MAX_DEEP; i++) + { + privateAtDeep[i] = 1; + + // + // Remove current function if any. + // + + if ((functionIdAtDeep[deep] != -1) + && (functionIdAtDeep[deep] == (fi.size() - 1))) + { + FunctionInfo fiEntry = fi[fi.size() - 1]; + + DBG_MSG("Rolled back function [%s][%s][%s]...\n", + fiEntry.return_.c_str(), fiEntry.name_.c_str(), + fiEntry.args_.c_str()); + + fi.resize(fi.size() - 1); + } + } + } + } + else if (pragmaInfo.cmd_ == "qcbuild_set_file_title") + { + // + // qcbuild_set_file_title(title) + // Set title for current source file. + // + + if (pragmaInfo.args_.size() == 1) + { + sourceFile -> title_ = pragmaInfo.args_[0]; + + DBG_MSG("Set file title to [%s] for file [%s].\n", + sourceFile -> title_.c_str(), fname); + } + } + else + { + Fatal("ERROR: Unknown pragma command at '%s'.\n", token.c_str()); + } + } + + break; + } + } + + // + // Collect return type before function prototype. + // + + if (lastTokenId != TOKEN_COMMENT + && lastTokenId != TOKEN_SEMICOLON + && tokenId != TOKEN_SEMICOLON + && lastTokenId != TOKEN_BLOCK_END + && lastTokenId != TOKEN_BLOCK_BEGIN + && lastTokenId != TOKEN_MACRO) + { + returnType += lastToken; + } + + // + // Save last token. + // + + lastToken = token; + lastTokenId = tokenId; + } + + // + // Generate title from source file name in public mode. + // + + if (privateMode == 0 && sourceFile -> title_.empty()) + { + int dotIdx = sourceFile -> name_.find('.'); + + if (dotIdx != string::npos) + { + sourceFile -> title_ = sourceFile -> name_.substr(0, dotIdx); + } + else + { + sourceFile -> title_ = sourceFile -> name_; + } + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot collect functions from '%s' source.\n" + "Error code is : %d.\n", fname, GetLastError()); + } + + if (f) + { + fclose(f); + } + + DBG_LEAVE("CollectFunctionsFromCSource"); + + return exitCode; +} + +// +// Generate HTML code to render 2 columns row: +// +// +// lvalue +// rvalue +// +// +// f - C stream, where to write generated HTML code (e.g. stdout) (IN). +// lvalue - content for left side column ('legend') (IN). +// rvalue - content for right side column ('legend') (IN). +// + +void HtmlPrintRow(FILE *f, const char *lvalue, const char *rvalue) +{ + static int rowSwap = 1; + + string rvalueHtml = StrEncodeToHtml(rvalue); + + fprintf + ( + f, + + /* Begin of row - put >>row color<< here*/ + "" + + /* First column - put >>lvalue<< here */ + "" + "%s" + "" + + /* Second column - put >>rvalue<< here*/ + "" + "%s" + "" + + /* End of row */ + "", + + rowSwap ? "#ddd" : "#eee", + lvalue, + rvalueHtml.c_str() + ); + + rowSwap = !rowSwap; +} + +// +// Load content of given file and put it as HTML data +// on given C stream. +// If file doesn't exist no data written to stream. +// +// f - C stream, where to write HTML data (e.g. stdout) (IN). +// fname - file name to load (e.g. README) (IN). +// title - optional title to put at top of html data (IN/OPT). +// +// RETURNS: 0 if OK. +// + +int HtmlPutFile(FILE *f, const char *fname, const char *title = NULL) +{ + int exitCode = -1; + + char *content = NULL; + + string contentHtml; + + // + // Check args. + // + + FAILEX(f == NULL, "ERROR: 'f' stream cannot be NULL in HtmlPutFile.\n"); + FAILEX(fname == NULL, "ERROR: 'fname' cannot be NULL in HtmlPutFile.\n"); + + // + // Load file. + // + + content = FileLoad(fname); + + FAIL(content == NULL); + + // + // Change CR+LF to LF. + // + + StrRemoveChar(content, 13); + + // + // Encode special chars into html. + // + + contentHtml = content; + + StrReplaceString(contentHtml, "<", "<"); + StrReplaceString(contentHtml, ">", ">"); + + // + // Put encoded content to output C stream. + // + + if (title) + { + fprintf(f, "

%s

\n", title); + } + + fprintf(f, "
%s
\n", HTML_PRE_STYLE, contentHtml.c_str()); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (content) + { + free(content); + } + + return exitCode; +} + +// +// Collect info about every source files inside component. +// +// sourceFiles - generated table with descriptions for every source files +// inside comopnent. (OUT). +// +// si - description of one component to analyze (IN). +// privateMode - show private code too if set to 1 (IN). +// +// RETURNS: 0 if OK. +// + +int CollectSourceFiles(vector &sourceFiles, SourceInfo *si, int privateMode) +{ + DBG_ENTER("CollectSourceFiles"); + + int exitCode = -1; + + vector files; + + // + // Tokenize CXXSRC variable into list of source files. + // + + DEBUG3("CollectSourceFiles : Tokenizing CXXSRC for [%s].\n", si -> get("TITLE")); + + StrTokenize(files, si -> get("CXXSRC")); + + // + // Collect all functions in every source files. + // + + DEBUG3("CollectSourceFiles : Parsing source files for [%s].\n", si -> get("TITLE")); + + for (int i = 0; i < files.size(); i++) + { + SourceFile sf; + + DEBUG3("CollectSourceFiles : Parsing file [%s].\n", files[i].c_str()); + + CollectFunctionsFromCSource(&sf, files[i].c_str(), privateMode); + + sourceFiles.push_back(sf); + } + + // + // Sort source files order by number of functions. + // + + if (sourceFiles.size() > 0) + { + DEBUG3("CollectSourceFiles : Sorting source files for [%s].\n", si -> get("TITLE")); + + sort(sourceFiles.begin(), sourceFiles.end(), CompareSourceByNumberOfFunctions); + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE("CollectSourceFiles"); + + return exitCode; +} + +// +// Generate HTML documentation for given component. +// +// f - C stream, where to print generated HTML (eg. stdout) (IN). +// si - Source info struct describing given component (IN). +// +// RETURNS: 0 if OK. +// + +int GenerateHtmlFromSourceInfo(FILE *f, SourceInfo *si, int privateMode) +{ + int exitCode = -1; + + vector sourceFiles; + + const char *title = NULL; + + // + // Check args. + // + + FAILEX(f == NULL, "ERROR: File stream cannot be NULL in GenerateHtmlFromSourceInfo.\n"); + FAILEX(si == NULL, "ERROR: Source info cannot be NULL in GenerateHtmlFromSourceInfo.\n"); + + // + // Print header table first. + // + + fprintf(f, ""); + { + HtmlPrintRow(f, "Title:", si -> get("TITLE")); + HtmlPrintRow(f, "Type:", si -> get("TYPE")); + HtmlPrintRow(f, "Author(s):", si -> get("AUTHOR")); + HtmlPrintRow(f, "Copyright:", si -> get("COPYRIGHT")); + HtmlPrintRow(f, "License:", si -> get("LICENSE")); + HtmlPrintRow(f, "Purpose:", si -> get("PURPOSE")); + HtmlPrintRow(f, "Description:", si -> get("DESC")); + + if (privateMode) + { + HtmlPrintRow(f, "Sources:", si -> get("CXXSRC")); + } + + HtmlPrintRow(f, "Dependences:", si -> get("DEPENDS")); + HtmlPrintRow(f, "Used by: ", si -> get("USED_BY")); + } + fprintf(f, "
"); + + // + // Collect all functions in every source files. + // + + FAIL(CollectSourceFiles(sourceFiles, si, privateMode)); + + // + // Generate table of content with list of functions: + // + // function1 + // function2 + // function3 + // ... + // + + if (sourceFiles.size() > 0) + { + fprintf(f, "
"); + + fprintf(f, "

Functions list:

\n"); + + title = si -> get("TITLE"); + + for (int i = 0; i < sourceFiles.size(); i++) + { + vector &fi = sourceFiles[i].functions_; + + if (fi.size() > 0) + { + fprintf(f, "
"); + { + // + // Source file div (container). + // + + if (privateMode) + { + fprintf(f, "%s
\n", sourceFiles[i].name_.c_str()); + + if (!sourceFiles[i].title_.empty()) + { + fprintf(f, "(%s)
\n", sourceFiles[i].title_.c_str()); + } + } + else + { + fprintf(f, "%s
\n", sourceFiles[i].title_.c_str()); + } + + for (int j = 0; j < fi.size(); j++) + { + fprintf(f, "%s
\n", title, fi[j].name_.c_str(), i, fi[j].name_.c_str()); + } + } + fprintf(f, "
"); + } + } + + fprintf(f, "
"); + } + + // + // Put README file if exists. + // + + HtmlPutFile(f, "README", "README:"); + HtmlPutFile(f, "TODO", "TODO:"); + HtmlPutFile(f, "CHANGELOG", "CHANGELOG:"); + + // + // Put function's descriptions retrieved from + // comments before every function. + // + + if (sourceFiles.size() > 0) + { + fprintf(f, "

Functions protos:

\n"); + + for (int i = 0; i < sourceFiles.size(); i++) + { + vector &fi = sourceFiles[i].functions_; + + if (fi.size() > 0) + { + const char *fname = sourceFiles[i].name_.c_str(); + + fprintf(f, "

%s

\n", title, fname, fname); + + for (int j = 0; j < fi.size(); j++) + { + // + // Function name. + // + + fprintf(f, "\n", title, fi[j].name_.c_str(), i); + + // + // HTML tag to link it from table of content. + // + + fprintf(f, "

%s

\n", title, fi[j].name_.c_str(), i, fi[j].name_.c_str()); + + // + // Function prototype. + // + + fprintf(f, "
%s
", + HTML_PRE_STYLE, AutoDocFormatFunctionProto(&fi[j]).c_str()); + + // + // Function description retrieved from comment in source code. + // + + if (fi[j].comment_.size() > 16) + { + string comment = fi[j].comment_; + +// comment = StrReplaceString(comment, "TIP", "TIP"); +// comment = StrReplaceString(comment, "WARNING", "WARNING"); + + fprintf(f, "
%s
\n", HTML_PRE_STYLE, comment.c_str()); + } + else + { + fprintf(f, "
Don't be sucker! Describe your function in source code.
", HTML_PRE_STYLE); + } + + // + // Horizontal line before next function. + // + + fprintf(f, "
"); + } + } + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot generate html documentation.\n"); + } + + return exitCode; +} + +// +// Generate HTML table of content for given component. +// Used to generate menu on the left side, where are +// links to components and functions inside components. +// +// It may generate list of links eg: +// +// * LibFile +// * FileLoad +// * FileSave +// * ... +// +// +// f - C stream, where to print generated HTML (eg. stdout) (IN). +// si - Source info struct describing given component (IN). +// +// RETURNS: 0 if OK. +// + +int GenerateHtmlTableOfContent(FILE *f, SourceInfo *si, int privateMode) +{ + DBG_ENTER("GenerateHtmlTableOfContent"); + + int exitCode = -1; + + vector sourceFiles; + + const char *title = si -> get("TITLE"); + + // + // Collect source files inside project. + // + + FAIL(CollectSourceFiles(sourceFiles, si, privateMode)); + + // + // Generate table of content. + // + + fprintf(f, ""); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE("GenerateHtmlTableOfContent"); + + return exitCode; +} + +// +// Generate documentation for whole project and put it to 'doc' directory. +// +// privateMode - show internal data too if set to 1 (IN). +// +// RETURNS: 0 if OK. +// + +int AutoDocGenerate(int privateMode) +{ + int exitCode = -1; + + SourceInfo proj; + + vector comps; + + map > compsInSubdir; + + map >::iterator it; + + char currentDir[MAX_PATH] = {0}; + + FILE *f = NULL; + FILE *ftoc = NULL; + + const char *docRootPath = NULL; + const char *docTocHtmlPath = NULL; + const char *docContentHtmlPath = NULL; + const char *docIndexHtmlPath = NULL; + + int skipExamples = 0; + + // + // Save current directory. + // + + FileGetDir(currentDir, sizeof(currentDir)); + + // + // Load all components from tree. + // + + FAIL(ListComponents(&proj, comps)); + + // + // Assume directories depending on private/public mode. + // + + if (privateMode) + { + docRootPath = "doc/private"; + docTocHtmlPath = "doc/private/toc.html"; + docContentHtmlPath = "doc/private/content.html"; + docIndexHtmlPath = "doc/private/index.html"; + } + else + { + docRootPath = "doc/public"; + docTocHtmlPath = "doc/public/toc.html"; + docContentHtmlPath = "doc/public/content.html"; + docIndexHtmlPath = "doc/public/index.html"; + } + + // + // Remove private components in public mode. + // + + skipExamples = proj.getInt("AUTODOC_SKIP_EXAMPLES"); + + if (privateMode == 0) + { + for (vector::iterator it = comps.begin(); it != comps.end(); ) + { + if ((it -> getInt("AUTODOC_PRIVATE") == 1) + || proj.doesMatchPrivateDir(&(*it)) + || (skipExamples && stristr(it -> get("TITLE"), "example"))) + { + printf("Skipped private component '%s'.\n", it -> get("TITLE")); + + it = comps.erase(it); + } + else + { + it ++; + } + } + } + + // + // Create 'doc' subdirectory if not exists. + // We will store all docuimentation here. + // + + #ifdef WIN32 + mkdir("doc"); + mkdir(docRootPath); + #else + mkdir("doc", S_IRWXU | S_IRGRP | S_IXGRP); + mkdir(docRootPath, S_IRWXU | S_IRGRP | S_IXGRP); + #endif + + // + // Table of content on left frame. + // + + f = fopen(docTocHtmlPath, "wt+"); + + FAILEX(f == NULL, "ERROR: Cannot create 'doc/toc.html' file.\n"); + + fprintf(f, "\n"); + + // + // Javascript code to open/close toc subfolders. + // + + fprintf + ( + f, + "\n" + ); + + // + // Project title. + // + + fprintf(f, "

%s Project

\n", proj.get("TITLE")); + + // + // Main components first. + // + + fprintf(f, "

I. Overview

\n"); + fprintf(f, "

II. Diagram

\n"); + fprintf(f, "

III. Specifications

\n"); + + fprintf(f, "

Main components:

\n"); + + fprintf(f, "
    \n"); + + for (int i = 0; i < comps.size(); i++) + { + if (strstr(comps[i].get("TITLE"), "example") == NULL) + { + FileSetDir(currentDir); + + FileSetDir(comps[i].get("COMP_DIR")); + + fprintf + ( + f, + "
    " + "
  • " + "[+]" + "%s" + "
    • \n", + comps[i].get("TITLE"), + comps[i].get("TITLE"), + comps[i].get("TITLE"), + comps[i].get("TITLE") + ); + + GenerateHtmlTableOfContent(f, &comps[i], privateMode); + } + } + + fprintf(f, "
"); + + // + // Examples after. + // + + fprintf(f, "
    \n"); + fprintf(f, "

    Examples:

    \n"); + + for (int i = 0; i < comps.size(); i++) + { + if (strstr(comps[i].get("TITLE"), "example")) + { + FileSetDir(currentDir); + + FileSetDir(comps[i].get("COMP_DIR")); + + fprintf(f, "
  • %s
    • \n", + comps[i].get("TITLE"), comps[i].get("TITLE")); + + GenerateHtmlTableOfContent(f, &comps[i], privateMode); + } + } + + fprintf(f, "
"); + fprintf(f, ""); + + FileSetDir(currentDir); + + fclose(f); + + // + // Dump content. + // + + f = fopen(docContentHtmlPath, "wt+"); + + FAILEX(f == NULL, "ERROR: Cannot create 'doc/content.html' file.\n"); + + fprintf(f, ""); + + fprintf(f, "

" + " DO NOT EDIT! This file was generated automatically" + " by 'qcbuild --makedoc' tool.\n

"); + + fprintf(f, "

%s project - technical documentation

\n", proj.get("TITLE")); + + // + // Table of content on TOP. + // + + fprintf(f, "

Table of content:

"); + + fprintf(f, ""); + + // + // Segregate components in order to most top subdir e.g. + // Lib, Client, Server etc. + // + + for (int i = 0; i < comps.size(); i++) + { + compsInSubdir[comps[i].get("TOP_SUBDIR")].push_back(comps[i]); + } + + if (compsInSubdir.size() == 1) + { + DBG_MSG("All sources are inside single directory. Going one level deeper..."); + + // + // All modules are inside single directory. + // Go one level down. + // + + compsInSubdir.clear(); + + for (int i = 0; i < comps.size(); i++) + { + string subTop = FilePathGetDirAtDeep(comps[i].get("COMP_DIR"), 1); + + compsInSubdir[subTop].push_back(comps[i]); + } + } + + // + // I. List of components. + // Print list of components grouped by most top subdir, + // but exclude example comopnents. + // + + fprintf(f, ""); + fprintf(f, "

I. Overview:

"); + fprintf(f, "
"); + + for (it = compsInSubdir.begin(); it != compsInSubdir.end(); it ++) + { + vector &comps = it -> second; + + fprintf(f, "
"); + + fprintf(f, "%s
\n", it -> first.c_str()); + + for (int i = 0; i < comps.size(); i++) + { + if (strstr(comps[i].get("TITLE"), "example") == NULL) + { + fprintf(f, "%s
\n", + comps[i].get("TITLE"), comps[i].get("TITLE")); + } + } + + fprintf(f, "
"); + } + + fprintf(f, "
\n"); + + // + // Print list of examples grouped by most top subdir, + // + + fprintf(f, "
"); + fprintf(f, "

Examples:

"); + + for (it = compsInSubdir.begin(); it != compsInSubdir.end(); it ++) + { + vector &comps = it -> second; + + fprintf(f, "
"); + + fprintf(f, "%s
\n", it -> first.c_str()); + + for (int i = 0; i < comps.size(); i++) + { + if (strstr(comps[i].get("TITLE"), "example")) + { + fprintf(f, "%s
\n", + comps[i].get("TITLE"), comps[i].get("TITLE")); + } + } + + fprintf(f, "
"); + } + + fprintf(f, "
\n"); + + // + // II. Components diagram. + // + + fprintf(f, ""); + fprintf(f, "

II. Components diagram:

"); + + FAIL(CreateComponentDiagram(f, comps)); + + // + // III. Generate descriptions for every component. + // + + fprintf(f, ""); + fprintf(f, "

III. Components specifications:

"); + + // + // Dump components specifications. + // + + for (int i = 0; i < comps.size(); i++) + { + printf("Processing '%s'...\n", comps[i].get("TITLE")); + + // + // Dump component. + // + + FileSetDir(currentDir); + + FileSetDir(comps[i].get("COMP_DIR")); + + fprintf(f, "", comps[i].get("TITLE")); + fprintf(f, "

%s component

", comps[i].get("TITLE")); + + GenerateHtmlFromSourceInfo(f, &comps[i], privateMode); + } + + // + // End content. + // + + fprintf(f, ""); + + fclose(f); + + // + // Restore project's root. + // + + FileSetDir(currentDir); + + // + // Main index.html including two frames: + // + // - toc.html on left + // - content.html on right + // + + f = fopen(docIndexHtmlPath, "wt+"); + + FAILEX(f == NULL, "ERROR: Cannot create 'doc/index.html' file.\n"); + + fprintf + ( + f, + "" + "" + "" + "" + "" + "" + "" + "" + "" + ); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return exitCode; +} diff --git a/Source/Tools/QCBuild/AutoDoc.h b/Source/Tools/QCBuild/AutoDoc.h new file mode 100644 index 0000000..c0f26a4 --- /dev/null +++ b/Source/Tools/QCBuild/AutoDoc.h @@ -0,0 +1,63 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef AutoDoc_H +#define AutoDoc_H + +#include "Scan.h" +#include "SourceInfo.h" +#include + +#define MAX_DEEP 16 + +struct FunctionInfo +{ + string name_; + string fname_; + string component_; + string comment_; + string return_; + string args_; +}; + +struct SourceFile +{ + string name_; + string title_; + + vector functions_; +}; + +struct QCBuildPragma +{ + string cmd_; + + vector args_; +}; + +int GenerateHtmlFromSourceInfo(FILE *f, SourceInfo *si, int privateMode); +int GenerateHtmlTableOfContent(FILE *f, SourceInfo *si, int privateMode); +int AutoDocGenerate(int privateMode); + +#endif /* AutoDoc_H */ diff --git a/Source/Tools/QCBuild/Diagram.cpp b/Source/Tools/QCBuild/Diagram.cpp new file mode 100644 index 0000000..bd61e1f --- /dev/null +++ b/Source/Tools/QCBuild/Diagram.cpp @@ -0,0 +1,365 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 "Diagram.h" + +using namespace std; + +struct ComponentBox +{ + string title_; + string desc_; + string purpose_; + string depends_; + + int x_; + int y_; + int w_; + int h_; + + void randomize() + { + x_ = rand() % 800; + y_ = rand() % 600; + + w_ = 150; + h_ = 32; + } + + ComponentBox(const char *title, const char *desc, + const char *purpose, const char *depends) + { + title_ = title; + desc_ = desc; + purpose_ = purpose; + depends_ = depends; + + randomize(); + } + + ComponentBox() + { + } + + void render(FILE *f) + { + string url = string("#comp_") + title_.c_str(); + + SvgRect(f, x_, y_, w_, h_); + SvgLink(f, x_ + 16, y_ + 16, url.c_str(), title_.c_str(), "blue"); + SvgLine(f, x_, y_ + 32, x_ + w_, y_ + 32); + + //SvgText(x_ + 16, y_ + 64, purpose_.c_str()); + } +}; + +// +// Sum all distance beetwen every boxes pair. +// Used to set boxes position. +// +// boxes - vector of boxes to analyze (IN). +// +// RETURNS: Sum of distances beeten all pairs in table. +// + +double SumDist(vector &boxes) +{ + double sum = 0.0; + + double sumDist = 0.0; + + int count = 0; + + for (int i = 0; i < boxes.size(); i++) + { + string depends = boxes[i] -> depends_; + + char *token = strtok(&depends[0], " "); + + while (token) + { + for (int j = 0; j < boxes.size(); j++) + { + int xi = boxes[i] -> x_; + int yi = boxes[i] -> y_; + + int xj = boxes[j] -> x_; + int yj = boxes[j] -> y_; + + if (boxes[j] -> title_ == token) + { + sumDist += sqrt((xi-xj)*(xi-xj) + (yi-yj)*(yi-yj)); + + count ++; + } + } + + token = strtok(NULL, " "); + } + + for (int j = 0; j < boxes.size(); j++) + { + int xi = boxes[i] -> x_; + int yi = boxes[i] -> y_; + + int xj = boxes[j] -> x_; + int yj = boxes[j] -> y_; + + int x1 = max(xi, xj); + int y1 = max(yi, yj); + + int x2 = min(xi + boxes[i] -> w_, xj + boxes[j] -> w_); + int y2 = min(yi + boxes[i] -> h_, yj + boxes[j] -> h_); + + if (x1 < x2 && y1 < y2) + { + sum += fabs(x1 - x2) * fabs(y1 - y2); + } + } + } + + sum += fabs(sumDist / count - 320) * boxes.size() * boxes.size(); + sum += sumDist; + + return sum; +} + +// +// Generate SVG code to render diagram of connections +// beetwen all components inside project. +// +// f - C stream (eg. stdout), where to write generated SVG data (IN). +// si - list of all components to draw (IN). +// +// centerIndex - index in si[] table containing center element. If specified +// diagram is generated around one seleected component only. +// Use -1 to draw all components (IN/OPT). +// +// RETURNS: 0 if OK. +// + +int CreateComponentDiagram(FILE *f, vector &si, int centerIndex) +{ + srand(time(0)); + + vector boxes; + + // + // Create diagram around one selected component only if + // center component specified. + // + + if (centerIndex > 0) + { + // + // Add center element to diagram. + // + + SourceInfo *center = &si[centerIndex]; + + const char *centerTitle = center -> get("TITLE"); + const char *centerDepends = center -> get("DEPENDS"); + + boxes.push_back(new ComponentBox(centerTitle, center -> get("DESC"), + center -> get("PURPOSE"), + centerDepends)); + + // + // Add rest of components, but only if one of below happen: + // + // - Component depends on center component. + // - Component is used by center component. + // + + for (int i = 0; i < si.size(); i++) + { + const char *depends = si[i].get("DEPENDS"); + const char *title = si[i].get("TITLE"); + + // + // Skip examples. + // + + if (strstr(title, "-example")) + { + continue; + } + + if (strstr(centerDepends, title) || strstr(depends, centerTitle)) + { + boxes.push_back(new ComponentBox(title, si[i].get("DESC"), + si[i].get("PURPOSE"), depends)); + } + } + } + + // + // Create diagram boxes for every project's component. + // + else + { + for (int i = 0; i < si.size(); i++) + { + // + // Skip examples. + // + + if (strstr(si[i].get("TITLE"), "-example")) + { + continue; + } + + // + // Add component to diagram. + // + + boxes.push_back(new ComponentBox(si[i].get("TITLE"), si[i].get("DESC"), + si[i].get("PURPOSE"), si[i].get("DEPENDS"))); + } + } + + // + // Localize boxes. + // + + vector best(boxes.size()); + + double minDist = 1e32; + + int width = 1024; + int height = 768; + + for (int i = 0; i < 512; i++) + { + for (int i = 0; i < boxes.size(); i++) + { + boxes[i] -> randomize(); + } + + int dist = SumDist(boxes); + + if (dist < minDist) + { + minDist = dist; + + for (int i = 0; i < boxes.size(); i++) + { + best[i].x_ = boxes[i] -> x_; + best[i].y_ = boxes[i] -> y_; + } + } + } + + for (int i = 0; i < boxes.size(); i++) + { + boxes[i] -> x_ = best[i].x_; + boxes[i] -> y_ = best[i].y_; + } + + // + // Align boxes to left, top corner. + // + + int minX = 10000; + int minY = 10000; + int maxX = 0; + int maxY = 0; + + for (int i = 0; i < boxes.size(); i++) + { + minX = min(boxes[i] -> x_, minX); + minY = min(boxes[i] -> y_, minY); + } + + for (int i = 0; i < boxes.size(); i++) + { + boxes[i] -> x_ -= minX; + boxes[i] -> y_ -= minY - 32; + + maxX = max(boxes[i] -> x_ + boxes[i] -> w_, maxX); + maxY = max(boxes[i] -> y_ + boxes[i] -> h_, maxY); + } + + // + // Render arrows. + // + + SvgBegin(f, maxX + 32, maxY + 32); + + SvgText(f, 16, 16, "This file was automatically generated by qcbuild --diagram.\n"); + + for (int i = 0; i < boxes.size(); i++) + { + string depends = boxes[i] -> depends_; + + char *token = strtok(&depends[0], " "); + + while (token) + { + int found = 0; + + for (int j = 0; found == 0 && j < boxes.size(); j++) + { + if (boxes[j] -> title_ == token) + { + char color[32]; + + int xi = boxes[i] -> x_ + boxes[i] -> w_ / 2; + int yi = boxes[i] -> y_ + boxes[i] -> h_ / 2; + + int xj = boxes[j] -> x_ + boxes[j] -> w_ / 2; + int yj = boxes[j] -> y_ + boxes[j] -> h_ / 2; + + snprintf(color, 32, "RGB(%d,%d,%d)", rand()%255, rand() % 255, rand() % 255); + + SvgLine(f, xi, yi, xj, yj, color); + } + } + + token = strtok(NULL, " "); + } + } + + // + // Render boxes. + // + + for (int i = 0; i < boxes.size(); i++) + { + boxes[i] -> render(f); + } + + SvgEnd(f); + + // + // Clean up. + // + + for (int i = 0; i < boxes.size(); i++) + { + delete boxes[i]; + } + + return 0; +} diff --git a/Source/Tools/QCBuild/Diagram.h b/Source/Tools/QCBuild/Diagram.h new file mode 100644 index 0000000..28c426d --- /dev/null +++ b/Source/Tools/QCBuild/Diagram.h @@ -0,0 +1,41 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Diagram_H +#define Diagram_H + +#include +#include +#include +#include +#include +#include +#include + +#include "SourceInfo.h" +#include "SVG.h" + +int CreateComponentDiagram(FILE *f, std::vector &si, int centerIndex = -1); + +#endif /* Diagram_H */ diff --git a/Source/Tools/QCBuild/Main.cpp b/Source/Tools/QCBuild/Main.cpp new file mode 100644 index 0000000..7a633ee --- /dev/null +++ b/Source/Tools/QCBuild/Main.cpp @@ -0,0 +1,1677 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki */ +/* */ +/* 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 + +#include +#include +#include + +#include "Main.h" +#include "Utils.h" +#include "SourceInfo.h" +#include "Diagram.h" +#include + +using namespace std; +using namespace Tegenaria; + +// +// Global variables. +// + +const char *LogLevel = NULL; +const char *LogFile = NULL; + +// +// Target specific variables. +// + +const char *TargetMachine = HOST_MACHINE; +const char *ExePostfix = EXE_POSTFIX; +const char *DllPostfix = DLL_POSTFIX; +const char *DllPrefix = DLL_PREFIX; + +// +// Host specific variables. +// + +const char *HostMachine = HOST_MACHINE; +const char *ScriptPostfix = SCRIPT_POSTFIX; +const char *ScriptDelCmd = SCRIPT_DEL; +const char *ScriptRmdirCmd = SCRIPT_RMDIR; +const char *ScriptMkdirCmd = SCRIPT_MKDIR; +const char *ScriptCopyCmd = SCRIPT_COPY; +const char *ScriptComment = SCRIPT_COMMENT; +const char *ScriptIntroBlock = SCRIPT_INTRO; +const char *ScriptFailBlock = SCRIPT_FAIL; +const char *ScriptMakeInstall = SCRIPT_MAKE_INSTALL; +const char *CxxCompiler = CXX_COMPILER; +const char *CCompiler = C_COMPILER; + +// +// Detect current running machine, where qcbuild is runned. +// +// RETURNS: Host machine name or NULL if unknown. +// + +const char *DetectHost() +{ + DBG_ENTER("DetectHost"); + + const char *host = NULL; + + // + // On Windows check is it Cygwin or MinGW. + // + + #ifdef WIN32 + { + // + // FIXME: Review plain old native Cygwin (where --mno-cygwin still needed) + // + + /* + char buf[1024] = {0}; + + // + // Run 'uname' command. + // + + FILE *f = _popen("uname", "rt"); + + FAIL(f == NULL); + + fgets(buf, sizeof(buf), f); + + fclose(f); + + // + // Check 'uname' result. + // + + if (strstr(buf, "CYGWIN")) + { + host = "Cygwin"; + } + else + { + host = "MinGW"; + } + */ + + host = "MinGW"; + } + + // + // Linux, MacOS. Use default based on compiler used to build + // current qcbuild binary. + // + + #else + { + host = HostMachine; + } + #endif + + fail: + + DBG_LEAVE("DetectHost"); + + return host; +} + +// +// +// + +int LoadConfig(const char *targetMachine, const char *hostMachine) +{ + int exitCode = -1; + + if (strcmp(hostMachine, "Cygwin") == 0) + { + CxxCompiler = "g++ -mwin32"; + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return exitCode; +} + +// +// Generate makefle in current directory from given +// component's description. +// +// comp - structure describing component (IN). +// +// RETURNS: 0 if OK. +// + +int GenerateMakefile(SourceInfo *comp) +{ + DBG_ENTER("GenerateMakefile"); + + int exitCode = -1; + + string qtLibs; + string qtInclude; + + vector qtModules; + + int useQt = 0; + + char buildInc[MAX_PATH + 1] = {0}; + char buildLib[MAX_PATH + 1] = {0}; + + string titleStr = comp -> get("TITLE"); + + char *title = &titleStr[0]; + + int type = comp -> getType(); + + int library = 0; + + int anythingToCompile = 0; + int anythingToLink = 0; + + + FILE *f = fopen("Makefile", "wt+"); + + FAILEX(f == NULL, "Cannot create 'Makefile' file.\n"); + + // + // Default declared MacOS version if not set. + // + + if (stricmp(HostMachine, "MacOS") == 0) + { + if (stristr(comp -> get("LFLAGS"), "-mmacosx-version-min") == NULL) + { + comp -> cat("LFLAGS", "-mmacosx-version-min=10.7"); + + DBG_INFO("Defaulted mmacosx-version-min to 10.7 for [%s].\n", comp -> get("TITLE")); + } + } + + // + // Warning message. + // + + FilePutComment(f, "DO NOT EDIT! This file was generated automatically from 'qcbuild.src' file."); + + // + // Lowerize title for linux/mac. + // + + if (stricmp(HostMachine, "Linux") == 0 + || stricmp(HostMachine, "MacOS") == 0) + { + for (int i = 0; title[i]; i++) + { + if (title[i] >= 'A' && title[i] <= 'Z') + { + title[i] += 'a' - 'A'; + } + } + } + + // + // Check is there any source files to compile. + // If not we don't build anything, but it may needed to copy + // prebuild files on 'make install'. + // + + if (comp -> isset("CXXSRC") || comp -> isset("CSRC")) + { + if (comp -> getType() != TYPE_MULTI_LIBRARY) + { + anythingToCompile = 1; + } + + anythingToLink = 1; + } + + // + // Check for QT dependency. + // + + if (comp -> isset("QT_MODULES")) + { + useQt = 1; + + qtInclude = QtQueryProperty("QT_INSTALL_HEADERS"); + qtLibs = QtQueryProperty("QT_INSTALL_LIBS"); + + FAIL(qtInclude.empty()); + FAIL(qtLibs.empty()); + + StrTokenize(qtModules, comp -> get("QT_MODULES")); + } + + // + // Paths. + // + + if (type == TYPE_LIBRARY || type == TYPE_SIMPLE_LIBRARY) + { + library = 1; + + if (strncmp(title, "Lib", 3) == 0 || strncmp(title, "lib", 3) == 0) + { + title += 3; + } + } + + comp -> set("REAL_TITLE", title); + + fprintf(f, "TITLE = %s\n", title); + fprintf(f, "ROOT = %s\n", comp -> get("ROOT")); + fprintf(f, "\n"); + + fprintf(f, "BIN_DIR = %s\n", comp -> get("BIN_DIR")); + fprintf(f, "LIB_DIR = %s\n", comp -> get("LIB_DIR")); + fprintf(f, "INC_DIR = %s\n", comp -> get("INC_DIR")); + fprintf(f, "\n"); + + if (type != TYPE_SIMPLE_PROGRAM && type != TYPE_SIMPLE_LIBRARY) + { + fprintf(f, "BUILD_ROOT = $(ROOT)/Build\n"); + fprintf(f, "BUILD_BIN_ROOT = $(ROOT)/Build/Bin\n"); + fprintf(f, "BUILD_LIB_ROOT = $(ROOT)/Build/Lib\n"); + fprintf(f, "BUILD_INC_ROOT = $(ROOT)/Build/Include\n"); + fprintf(f, "\n"); + + // + // Custom 'Build/Bin/$(BIN_DIR)' directory. + // + + if (comp -> isset("BIN_DIR")) + { + fprintf(f, "BUILD_BIN = $(BUILD_BIN_ROOT)/$(BIN_DIR)\n"); + } + else + { + fprintf(f, "BUILD_BIN = $(BUILD_BIN_ROOT)\n"); + } + + // + // Custom 'Build/Lib/$(LIB_DIR)' directory. + // + + if (comp -> isset("LIB_DIR")) + { + fprintf(f, "BUILD_LIB = $(BUILD_LIB_ROOT)/$(LIB_DIR)\n"); + } + else + { + fprintf(f, "BUILD_LIB = $(BUILD_LIB_ROOT)\n"); + } + + // + // Custom 'Build/Inc/$(INC_DIR)' directory. + // + + if (comp -> isset("INC_DIR")) + { + fprintf(f, "BUILD_INC = $(BUILD_INC_ROOT)/$(INC_DIR)\n"); + } + else + { + fprintf(f, "BUILD_INC = $(BUILD_INC_ROOT)\n"); + } + + strncpy(buildInc, "-I $(BUILD_INC_ROOT)", MAX_PATH); + strncpy(buildLib, "-L $(BUILD_LIB_ROOT)", MAX_PATH); + } + + // + // QT sources list if specified. + // + + if (useQt) + { + FilePutComment(f, "QT: headers and UI sources."); + + // + // Declare QT modules, forms and headers. + // + + fprintf(f, "QT_MODULES = %s\n", comp -> get("QT_MODULES")); + fprintf(f, "QT_HEADERS = %s\n", comp -> get("QT_HEADERS")); + fprintf(f, "QT_FORMS = %s\n", comp -> get("QT_FORMS")); + fprintf(f, "QT_LIBS = %s\n", qtLibs.c_str()); + fprintf(f, "QT_INCLUDE = %s\n", qtInclude.c_str()); + + // + // Add to libraries dirs. + // Add to includes dirs. + // + + comp -> cat("LIBS", "-L$(QT_LIBS)"); + comp -> cat("INCLUDE", "-I$(QT_INCLUDE)"); + + // + // For every module add: + // + // - '-I/' to INCLUDE. + // - '-l' to LIBS. + // + + for (int i = 0; i < qtModules.size(); i++) + { + string base; + string inc; + string lib; + + // + // Add Qt prefix if not specified. + // + + if (qtModules[i][0] == 'q' || qtModules[i][0] == 'Q') + { + base = qtModules[i]; + } + else + { + base = "Qt" + qtModules[i]; + } + + if (base[2] > 'a' && base[2] < 'z') + { + base[2] -= 'a' - 'A'; + } + + DBG_MSG("Adding QT module '%s'...\n", base.c_str()); + + // + // Add entries to LIBS and INCLUDE. + // + + inc = "-I$(QT_INCLUDE)/" + base; + lib = "-l" + base; + + comp -> cat("INCLUDE", inc.c_str()); + + // + // FIXME: Detect real library file for given QT module + // e.g. it may be -lqtcore4 for QtCore module. + // + + // comp -> cat("LIBS", lib.c_str()); + } + + // + // Add rules to generate file names: + // + // .cpp |-> moc_.cpp + // .h |-> ui_.h + // + + fprintf(f, "QT_UI_H = $(QT_FORMS:%%.ui=ui_%%.h)\n" + "QT_MOC = $(QT_HEADERS:%%.h=moc_%%.cpp) $(QT_UI_H:%%h=moc_%%cpp)\n" + "QT_MOC_OBJ = $(QT_MOC:.cpp=.o)\n"); + } + + // + // Flex and bison sources if specified. + // + + if (comp -> isset("FLEXSRC")) + { + FilePutComment(f, "FLEX: sources."); + + // + // Add rules to generate file names: + // + // .l |-> .lex.cpp + // + + fprintf(f, "FLEXSRC_CXX = $(FLEXSRC:%%.l=%%.lex.cpp)\n"); + } + + if (comp -> isset("BISONSRC")) + { + FilePutComment(f, "BISON: sources."); + + // + // Add rules to generate file names: + // + // .y |-> .tab.cpp + // .y |-> .tab.hpp + // + + fprintf(f, "BISONSRC_CXX = $(BISONSRC:%%.y=%%.tab.cpp)\n"); + fprintf(f, "BISONSRC_HPP = $(BISONSRC:%%.y=%%.tab.hpp)\n"); + } + + // + // Source list. + // + + FilePutComment(f, "Source lists."); + + fprintf(f, "CSRC = %s\n", comp -> get("CSRC")); + fprintf(f, "CXXSRC = $(FLEXSRC_CXX) $(BISONSRC_CXX) $(QT_MOC) %s\n", comp -> get("CXXSRC")); + fprintf(f, "ISRC = %s\n", comp -> get("ISRC")); + fprintf(f, "FLEXSRC = %s\n", comp -> get("FLEXSRC")); + fprintf(f, "BISONSRC = %s\n", comp -> get("BISONSRC")); + fprintf(f, "PREBUILD_LIBS = %s\n", comp -> get("PREBUILD_LIBS")); + fprintf(f, "PREBUILD_PROGS = %s\n", comp -> get("PREBUILD_PROGS")); + fprintf(f, "DEFINES = %s\n", comp -> get("DEFINES")); + + fprintf(f, "EXE_POSTFIX = %s\n", ExePostfix); + fprintf(f, "DLL_POSTFIX = %s\n", DllPostfix); + fprintf(f, "DLL_PREFIX = %s\n", DllPrefix); + + fprintf(f, "CXXOBJ = $(CXXSRC:.cpp=.o)\n"); + fprintf(f, "COBJ = $(CSRC:.c=.o)\n"); + fprintf(f, "OBJ = $(CXXOBJ) $(COBJ)\n\n"); + + // + // Compiler/linker flags. + // + + FilePutComment(f, "Compiler/linker flags."); + + fprintf(f, "CXX = %s\n", CxxCompiler); + fprintf(f, "CC = %s\n", CCompiler); + + if (stricmp(HostMachine, "Linux") == 0 + || stricmp(HostMachine, "MacOS") == 0) + { + fprintf(f, "CXXFLAGS= -c -g -O3 -fPIC %s %s $(DEFINES)\n", buildLib, buildInc); + fprintf(f, "CFLAGS = -c -g -O3 -fPIC %s %s $(DEFINES)\n", buildLib, buildInc); + } + else + { + fprintf(f, "CXXFLAGS= -c -g -O3 %s %s $(DEFINES)\n", buildLib, buildInc); + fprintf(f, "CFLAGS = -c -g -O3 %s %s $(DEFINES)\n", buildLib, buildInc); + } + + fprintf(f, "LIBS = %s %s\n", comp -> get("LIBS"), buildLib); + fprintf(f, "INCLUDE = %s %s\n", comp -> get("INCLUDE"), buildInc); + fprintf(f, "LFLAGS = %s\n", comp -> get("LFLAGS")); + fprintf(f, "ARCH = %s\n", DetectArch()); + + // + // Build program or library from sources if any sources specified. + // + + if (anythingToCompile) + { + // + // Link objects to executable/library. + // + + FilePutComment(f, "Link objects to executable/library."); + + if (type == TYPE_LIBRARY || type == TYPE_SIMPLE_LIBRARY) + { + fprintf(f, "all: $(OBJ)\n"); + } + else + { + fprintf(f, "all: $(TITLE)$(EXE_POSTFIX)\n"); + + fprintf(f, "$(TITLE)$(EXE_POSTFIX): $(OBJ)\n"); + fprintf(f, "\t@echo Linking %s%s...\n", comp -> get("TITLE"), ExePostfix); + fprintf(f, "\t$(CXX) $(LFLAGS) $(OBJ) $(LIBS) -o $@\n"); + } + + // + // Compile sources to objects. + // + + FilePutComment(f, "Compile sources to objects."); + + fprintf(f, "$(CXXOBJ) : %%.o : %%.cpp\n"); + fprintf(f, "\t@echo Compiling $<...\n"); + fprintf(f, "\t@$(CXX) $(CXXFLAGS) $(INCLUDE) -c $< -o $@\n\n"); + + fprintf(f, "$(COBJ) : %%.o : %%.c\n"); + fprintf(f, "\t@echo Compiling $<...\n"); + fprintf(f, "\t@$(CC) $(CFLAGS) $(INCLUDE) -c $< -o $@\n"); + + if (useQt) + { + // + // QT: Create moc files from QT headers. + // + + FilePutComment(f, "QT: Create moc files from headers."); + + fprintf(f, "$(QT_MOC) : moc_%%.cpp : %%.h $(QT_UI_H)\n"); + fprintf(f, "\t@echo QT: Generating moc file from $<...\n"); + fprintf(f, "\t@moc $< -o $@\n"); + + // + // QT: Create headers from QT forms (UI files). + // + + FilePutComment(f, "QT: Create headers from *.ui files."); + + fprintf(f, "$(QT_UI_H) : ui_%%.h : %%.ui\n"); + fprintf(f, "\t@echo QT: Generating header from $<...\n"); + fprintf(f, "\t@uic $< -o $@\n"); + } + + // + // FLEX and BISON. + // + + if (comp -> isset("FLEXSRC")) + { + FilePutComment(f, "FLEX: Create lex.cpp files from *.l sources."); + + fprintf(f, "$(FLEXSRC_CXX) : %%.lex.cpp : %%.l $(BISONSRC_CXX)\n"); + fprintf(f, "\t@echo FLEX: Generating cpp from $<...\n"); + fprintf(f, "\t@flex -o$@ $<\n"); + } + + if (comp -> isset("BISONSRC")) + { + FilePutComment(f, "BISON: Create tab.cpp files from *.y sources."); + + fprintf(f, "$(BISONSRC_CXX) : %%.tab.cpp : %%.y\n"); + fprintf(f, "\t@echo BISON: Generating cpp from $<...\n"); + fprintf(f, "\t@bison -d -y -v $< -o $@\n"); + } + } + + // + // No source specified. Generate empty 'Makefile'. + // Only 'make install' does real work. + // + + else + { + FilePutComment(f, "No any source to compile."); + + fprintf(f, "all:\n"); + fprintf(f, "\t@echo Nothing to compile.\n"); + } + + // + // Make install. Copy binaries to build. + // + + FilePutComment(f, "Make install. Copy created binaries to build dir."); + + fprintf(f, "install: all\n"); + + if (type != TYPE_SIMPLE_PROGRAM && type != TYPE_SIMPLE_LIBRARY) + { + MakefileMkdir(f, "$(BUILD_ROOT)"); + MakefileMkdir(f, "$(BUILD_INC)"); + MakefileMkdir(f, "$(BUILD_LIB)"); + MakefileMkdir(f, "$(BUILD_BIN)"); + } + +/* + TODO: Obsolete code - remove after review. + + if (comp -> isset("INSTALL")) + { + if (comp -> isset("INSTALL")) MakefileMkdir(f, "$(INSTALL)"); + if (comp -> isset("INSTALL_INC")) MakefileMkdir(f, "$(INSTALL_INC)"); + if (comp -> isset("INSTALL_LIB")) MakefileMkdir(f, "$(INSTALL_LIB)"); + if (comp -> isset("INSTALL_BIN")) MakefileMkdir(f, "$(INSTALL_BIN)"); + } +*/ + + // + // Copy header files. + // + + if (comp -> isset("ISRC")) + { + if (type != TYPE_SIMPLE_PROGRAM && type != TYPE_SIMPLE_LIBRARY) + { + MakefileCopy(f, "$(ISRC)", "$(BUILD_INC)"); + } + + if (comp -> isset("INSTALL_INC")) + { + MakefileCopy(f, "$(ISRC)", "$(INSTALL_INC)"); + } + } + + // + // Copy prebuild if any. + // + + if (comp -> isset("PREBUILD_LIBS")) + { + MakefileCopy(f, "$(PREBUILD_LIBS)", "$(BUILD_LIB)"); + } + + if (comp -> isset("PREBUILD_PROGS")) + { + MakefileCopy(f, "$(PREBUILD_PROGS)", "$(BUILD_BIN)"); + } + + // + // Link program or library from objects if any sources + // was specified. + // + + if (anythingToLink) + { + // + // Link executable program ('exe'). + // + + if (type == TYPE_PROGRAM || type == TYPE_SIMPLE_PROGRAM) + { + if (type != TYPE_SIMPLE_PROGRAM && type != TYPE_SIMPLE_LIBRARY) + { + MakefileCopy(f, "$(TITLE)$(EXE_POSTFIX)", "$(BUILD_BIN)"); + } + + if (comp -> isset("INSTALL")) + { + MakefileCopy(f, "$(TITLE)$(EXE_POSTFIX)", "$(INSTALL)"); + } + + if (comp -> isset("INSTALL_BIN")) + { + MakefileCopy(f, "$(TITLE)$(EXE_POSTFIX)", "$(INSTALL_BIN)"); + } + } + + // + // Link library. + // + + else + { + // + // Link static library. + // We add '-static' postfix to library to switch beetwen + // static/dynamic linking easly by switching name passed to -l option. + // + // '-l-static' : will link with static library. + // '-l<title> : will link with dynamic library. + // + + fprintf(f, "\t@echo Linking static lib$(TITLE)-static.a...\n"); + + MakefileRemove(f, "$(TITLE)-static.a"); + + fprintf(f, "\tar rcs lib$(TITLE)-static.a $(OBJ)\n"); + + // + // Link dynamic library. + // + + fprintf(f, "\t@echo Linking $(TITLE)$(DLL_POSTFIX)...\n"); + + if (stricmp(HostMachine, "MinGW") == 0) + { + fprintf(f, "\t$(CXX) -shared $(LFLAGS) -o $(DLL_PREFIX)$(TITLE)$(DLL_POSTFIX) $(OBJ) $(LIBS) -Wl,--out-implib,lib$(TITLE).a\n"); + } + else + { + fprintf(f, "\t$(CXX) -shared $(LFLAGS) -o $(DLL_PREFIX)$(TITLE)$(DLL_POSTFIX) $(OBJ) $(LIBS)\n"); + } + + if (type != TYPE_SIMPLE_LIBRARY) + { + if (stricmp(HostMachine, "MinGW") == 0) + { + MakefileCopy(f, "lib$(TITLE).a", "$(BUILD_LIB)"); + } + + MakefileCopy(f, "$(DLL_PREFIX)$(TITLE)$(DLL_POSTFIX)", "$(BUILD_LIB)"); + MakefileCopy(f, "lib$(TITLE)-static.a", "$(BUILD_LIB)"); + } + + if (comp -> isset("INSTALL_LIB")) + { + if (stricmp(HostMachine, "MinGW") == 0) + { + MakefileCopy(f, "lib$(TITLE).a", "$(INSTALL_LIB)"); + } + + MakefileCopy(f, "$(DLL_PREFIX)$(TITLE)$(DLL_POSTFIX)", "$(INSTALL_LIB)"); + MakefileCopy(f, "lib$(TITLE)-static.a", "$(INSTALL_LIB)"); + } + } + } + + // + // Make clean. + // + + FilePutComment(f, "Make clean. Remove files created by make and make install."); + + fprintf(f, "clean:\n"); + + MakefileRemove(f, "*.o"); + MakefileRemove(f, "*.log"); + + if (library) + { + MakefileRemove(f, "*$(DLL_POSTFIX)"); + } + else + { + MakefileRemove(f, "$(TITLE)$(EXE_POSTFIX)"); + } + + MakefileRemove(f, "*.a"); + MakefileRemove(f, "*.def"); + + if (useQt) + { + MakefileRemove(f, "$(QT_MOC)"); + MakefileRemove(f, "$(QT_UI_H)"); + } + + if (comp -> isset("FLEXSRC")) + { + MakefileRemove(f, "$(FLEXSRC_CXX)"); + } + + if (comp -> isset("BISONSRC")) + { + MakefileRemove(f, "$(BISONSRC_CXX)"); + MakefileRemove(f, "$(BISONSRC_HPP)"); + } + + // + // Make distclean. + // + + FilePutComment(f, "Make distclean. Make clean + clean Makefile."); + + fprintf(f, "distclean: clean\n"); + + MakefileRemove(f, "Makefile"); + + fprintf(f, "\n"); + fprintf(f, ".PHONY: install clean distclean\n"); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (f) + { + fclose(f); + } + + DBG_LEAVE("GenerateMakefile"); + + return exitCode; +}; + +// +// Append section to build component into main 'Build' script. +// +// f - File, where to write section (IN). +// ci - structure describing component to build (IN). +// +// RETURNS: 0 if OK. +// + +int FilePutBuildSection(FILE *f, SourceInfo *ci) +{ + fprintf(f, "qcbuild --setcolor --color 6\n"); + fprintf(f, "echo -------------------------------------------\n"); + fprintf(f, "echo Building '%s'...\n", ci -> get("TITLE")); + fprintf(f, "echo -------------------------------------------\n"); + fprintf(f, "qcbuild --setcolor --color 7\n"); + + fprintf(f, "cd %s\n", ci -> get("COMP_DIR")); + fprintf(f, "%s\n", ScriptMakeInstall); + fprintf(f, "%s\n", ScriptFailBlock); + fprintf(f, "cd %s\n", ci -> get("ROOT")); + fprintf(f, "\n"); + + return 0; +} + +// +// Append section to clean component into main 'Clean' script. +// +// f - File, where to write section (IN). +// ci - structure describing component to build (IN). +// +// RETURNS: 0 if OK. +// + +int FilePutCleanSection(FILE *f, SourceInfo *ci) +{ + fprintf(f, "qcbuild --setcolor --color 6\n"); + fprintf(f, "echo -------------------------------------------\n"); + fprintf(f, "echo Cleaning '%s'...\n", ci -> get("TITLE")); + fprintf(f, "echo -------------------------------------------\n"); + fprintf(f, "qcbuild --setcolor --color 7\n"); + + fprintf(f, "cd %s\n", ci -> get("COMP_DIR")); + fprintf(f, "%s *.o\n", ScriptDelCmd); + + fprintf(f, "%s %s%s\n", ScriptDelCmd, ci -> getLowered("TITLE").c_str(), ExePostfix); + + fprintf(f, "%s *.a\n", ScriptDelCmd); + fprintf(f, "%s *%s\n", ScriptDelCmd, DllPostfix); + fprintf(f, "%s *.def\n", ScriptDelCmd); + + fprintf(f, "%s Makefile\n", ScriptDelCmd); + + if (ci -> isset("QT_MODULES")) + { + fprintf(f, "%s moc_*.cpp\n", ScriptDelCmd); + fprintf(f, "%s ui_*.h\n", ScriptDelCmd); + } + + fprintf(f, "cd %s\n", ci -> get("ROOT")); + fprintf(f, "\n"); + + return 0; +} + +// +// Resolve dependencies beetwen list of components +// and generate main Build and Clean scripts (for whole project). +// +// comps - list of every components inside project (IN). +// +// RETURNS: 0 if OK. +// + +int GenerateBuildCleanScripts(vector<SourceInfo> comps) +{ + DBG_ENTER("GenerateBuildCleanScripts"); + + int exitCode = -1; + + int iter = 0; + + char buildFileName[MAX_PATH + 1] = {0}; + char cleanFileName[MAX_PATH + 1] = {0}; + + const int maxIter = comps.size(); + + std::set<string> resolvedSet; + + std::set<string>::iterator ri; + + vector<SourceInfo>::iterator ci; + + // + // Create new 'Build' and 'Clean' script files. + // + + snprintf(buildFileName, sizeof(buildFileName), "Build%s", ScriptPostfix); + snprintf(cleanFileName, sizeof(buildFileName), "Clean%s", ScriptPostfix); + + FILE *buildFile = fopen(buildFileName, "wt+"); + FILE *cleanFile = fopen(cleanFileName, "wt+"); + + FAILEX(buildFile == NULL, "ERROR: Cannot create '%s' script.\n", buildFileName); + FAILEX(cleanFile == NULL, "ERROR: Cannot create '%s' script.\n", cleanFileName); + + if (stricmp(HostMachine, "MinGW") != 0) + { + FAILEX(system("chmod a+x Build.sh"), "ERROR: Cannot grant execute right for Build.sh script.\n"); + FAILEX(system("chmod a+x Clean.sh"), "ERROR: Cannot grant execute right for Clean.sh script.\n"); + } + + // + // Write common script header. + // + + fprintf(buildFile, "%s\n", ScriptIntroBlock); + fprintf(cleanFile, "%s\n", ScriptIntroBlock); + + FilePutComment(buildFile, "DO NOT EDIT! This file was generated automatically from 'qcbuild.src' file.", ScriptComment); + FilePutComment(cleanFile, "DO NOT EDIT! This file was generated automatically from 'qcbuild.src' file.", ScriptComment); + + // + // Go on until all dependencies resolved. + // + + while(comps.size() > 0 && iter < maxIter) + { + iter ++; + + // + // Put resolved components first. + // + + for (ci = comps.begin(); ci != comps.end();) + { + // + // Already resolved. Move to resolved set + // and put entry in build/clean scripts. + // + + if (ci -> resolved()) + { + FilePutBuildSection(buildFile, &(*ci)); + FilePutCleanSection(cleanFile, &(*ci)); + + FAILEX(resolvedSet.count(ci -> get("TITLE")), + "ERROR: Component's name '%s' is NOT unique.\n", + ci -> get("TITLE")); + + resolvedSet.insert(ci -> get("TITLE")); + + comps.erase(ci); + } + + // + // Not resolved, go on. + // + + else + { + ci ++; + } + } + + // + // Try resolve another one basing on already resolved. + // + + for (ci = comps.begin(); ci != comps.end();) + { + for (ri = resolvedSet.begin(); ri != resolvedSet.end(); ri ++) + { + ci -> resolve(ri -> c_str()); + } + + if (ci -> resolved()) + { + FilePutBuildSection(buildFile, &(*ci)); + FilePutCleanSection(cleanFile, &(*ci)); + + FAILEX(resolvedSet.count(ci -> get("TITLE")), + "ERROR: Component's name '%s' is NOT unique.\n", + ci -> get("TITLE")); + + resolvedSet.insert(ci -> get("TITLE")); + + comps.erase(ci); + } + else + { + ci ++; + } + } + } + + if (comps.size() > 0) + { + for (int i = 0; i < comps.size(); i++) + { + Error("ERROR: Cannot resolve [%s] dependencies for [%s] component.\n", + comps[i].getDepends().c_str(), comps[i].get("TITLE")); + } + + FAIL(1); + } + + #ifdef WIN32 + fprintf(cleanFile, "rd /S /Q Build\n"); + #else + fprintf(cleanFile, "rm -rf Build\n"); + #endif + + fprintf(cleanFile, "%s Project.info\n", ScriptDelCmd); + fprintf(cleanFile, "%s Build%s\n", ScriptDelCmd, ScriptPostfix); + fprintf(cleanFile, "%s Clean%s\n", ScriptDelCmd, ScriptPostfix); + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot create main Build and/or Clean scripts.\n"); + } + + if (cleanFile) + { + fclose(cleanFile); + } + + if (buildFile) + { + fclose(buildFile); + } + + DBG_LEAVE("GenerateBuildCleanScripts"); + + return exitCode; +}; + + +// +// Generate list of whole components inside project. +// +// pi - Info for root project's component (OUT/OPT). +// comps - list of infos for every components inside project (OUT). +// +// RETURNS: 0 if OK. +// + +int ListComponents(SourceInfo *pi, vector<SourceInfo> &comps) +{ + DBG_ENTER("ListComponents"); + + int exitCode = -1; + + char currentDir[MAX_PATH + 1]; + + vector<string> dirs; + + SourceInfo piLocal; + + // + // 'TITLE' |-> number in comps[] table. + // Internal use only while generatin USED_BY lists. + // + + map<string, int> titleToIdMap; + + // + // Assume: ci = Component Info. + // pi = whole Project Info. + // + + SourceInfo ci; + + // + // Adjust, which variable use to load project info. + // + + if (pi == NULL) + { + pi = &piLocal; + } + + comps.clear(); + + // + // Load project info. + // + + FAILEX(pi -> loadComponent(), "Cannot open 'qcbuild.src' file.\n"); + + // + // Save current working dir. + // + + FileGetDir(currentDir, MAX_PATH); + + // + // Switch to project root dir. + // + + FileSetDir(pi -> get("ROOT")); + + // + // List all subdirs recursively. + // + + ListDirs(".", "*", dirs, true, FILE_SKIP_HIDDEN); + + for (int i = 0; i < dirs.size(); i++) + { + if (dirs[i].find("node_modules") != string::npos) + { + DBG_MSG("Skipped path [%s].\n", dirs[i].c_str()); + + continue; + } + + if (dirs[i].size() >= 240) + { + DBG_INFO("WARNING! Path too long [%s].\n", dirs[i].c_str()); + + continue; + } + + DBG_MSG("Entering [%s]...\n", dirs[i].c_str()); + + FileSetDir(currentDir); + FileSetDir(dirs[i].c_str()); + + // + // Load component info from 'subdir/.../qcbuild.src'. + // + + if (ci.loadComponent() == 0) + { + pi -> loadProject(); + + if (ci.getType() != TYPE_PROJECT) + { + ci.set("ROOT", pi -> get("ROOT")); + ci.set("COMP_DIR_REL", dirs[i].c_str()); + + // + // If copyright not set in component, copyright from main + // qcbuild.src in root directory. + // + + if (ci.isset("COPYRIGHT") == 0 && pi -> isset("COPYRIGHT")) + { + ci.set("COPYRIGHT", pi -> get("COPYRIGHT")); + ci.cat("COPYRIGHT", "(inherited from project's root)"); + } + + // + // If licenset not set in component, copyright from main + // qcbuild.src in root directory. + // + + if ((strcmp(ci.get("LICENSE"), "Unknown") == 0) && pi -> isset("LICENSE")) + { + ci.set("LICENSE", pi -> get("LICENSE")); + ci.cat("LICENSE", "(inherited from project's root)"); + } + + // + // Add component's info to ouput vector. + // + + comps.push_back(ci); + + titleToIdMap[ci.get("TITLE")] = comps.size() - 1; + + DBG_MSG("Imported component '%s'.\n", ci.get("TITLE")); + } + } + } + + // + // Restore original working dir. + // + + FileSetDir(currentDir); + + // + // Generate "USED_BY" list from "DEPENDS" list. + // + + for (int i = 0; i < comps.size(); i++) + { + // + // Get list of dependencies for every component. + // + + const std::set<string> &depends = comps[i].getDependsSet(); + + std::set<string>::iterator it; + + // + // If 'comps[i] depends on X', thens 'X is used by comps[i]' + // + + for (it = depends.begin(); it != depends.end(); it++) + { + int targetId = titleToIdMap[*it]; + + DBG_MSG("[%s] is used by [%s].\n", it -> c_str(), comps[i].get("TITLE")); + + comps[targetId].cat("USED_BY", comps[i].get("TITLE")); + } + } + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot list components.\n"); + } + + DBG_LEAVE("ListComponents"); + + return exitCode; +} + +int AttachDependsToMultiLibrary(SourceInfo *mlib) +{ + int exitCode = -1; + + // + // Multi-library. + // Accumulate sources from all dependent libraries. + // + + if (mlib -> getType() == TYPE_MULTI_LIBRARY) + { + vector<SourceInfo>::iterator ci; + + vector<SourceInfo> comps; + + FAIL(ListComponents(NULL, comps)); + + for (ci = comps.begin(); ci != comps.end(); ci++) + { + if (mlib -> doesDependOn(ci -> get("TITLE"))) + { + mlib -> cat("CSRC", ci -> getPathList("CSRC").c_str()); + mlib -> cat("CXXSRC", ci -> getPathList("CXXSRC").c_str()); + // TODO: Is it really needed: mlib -> cat("LIBS", ci -> get("LIBS")); + } + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + return exitCode; +} + +// +// Entry point. +// + +int main(int argc, char **argv) +{ + DBG_ENTER("main"); + + int exitCode = -1; + + SourceInfo proj; + SourceInfo comp; + + vector<SourceInfo> comps; + + int color = 0; + + // + // Parse arguments. + // + + enum Mode + { + DEFAULT_MODE, + INFO_MODE, + DIAGRAM_MODE, + PRINT_ROOT_MODE, + MAKEDOC_MODE, + SETCOLOR_MODE + }; + + Mode mode = DEFAULT_MODE; + + ArgsObj ao[] = + { + {ARGS_MODE, "--info", &mode, INFO_MODE}, + {ARGS_MODE, "--root", &mode, PRINT_ROOT_MODE}, + {ARGS_MODE, "--diagram", &mode, DIAGRAM_MODE}, + {ARGS_MODE, "--makedoc", &mode, MAKEDOC_MODE}, + {ARGS_MODE, "--setcolor", &mode, SETCOLOR_MODE}, + + {ARGS_STRING, "--target", &TargetMachine, 0}, + {ARGS_STRING, "--loglevel", &LogLevel, 0}, + {ARGS_STRING, "--logfile", &LogFile, 0}, + {ARGS_INT, "--color", &color, 0}, + {ARGS_NULL, NULL, NULL, 0} + }; + + FAIL(ArgsParse(ao, argc, argv)); + + // + // Set log level if specified. + // + + if (LogLevel || LogFile) + { + DBG_INIT_EX(LogFile, LogLevel, DBG_REINIT); + } + + // + // Detect host machine, where compilation is runned. + // + + HostMachine = DetectHost(); + + FAILEX(HostMachine == NULL, "ERROR: Can't detect host machine.\n"); + + // + // Resolve host and target machines. + // + + if (mode != SETCOLOR_MODE) + { + FAIL(LoadConfig(TargetMachine, HostMachine)); + + DBG_MSG("Host machine : [%s].\n", HostMachine); + DBG_MSG("Target machine : [%s].\n", TargetMachine); + DBG_MSG("EXE postfix : [%s].\n", ExePostfix); + DBG_MSG("DLL postfix : [%s].\n", DllPostfix); + + printf("Host : %s\n", HostMachine); + printf("Target : %s\n", TargetMachine); + printf("Architecture : %s\n", DetectArch()); + printf("C++ compiler : %s\n", CxxCompiler); + printf("\n"); + } + + // + // Switch control depending on specified work mode. + // + + switch(mode) + { + // + // Default mode. + // + // - When callet from project's root generate main build/clean + // scripts and makefiles for all compnonents in subdirs recursively. + // + // - If called from components subdir generate makefile for + // current component only. + // + + case DEFAULT_MODE: + { + FAILEX(comp.loadComponent(), "Cannot open 'qcbuild.src' file.\n"); + + // + // Project's root. + // + + if (comp.getType() == TYPE_PROJECT) + { + FAILEX(freopen("Project.info", "wt+", stdout) == NULL, + "ERROR: Cannot redirect stdout to Project.info file.\n"); + + DBG_MSG("Found project '%s'.\n", comp.get("TITLE")); + + comp.print(); + + char currentDir[MAX_PATH + 1] = {0}; + + FileGetDir(currentDir, MAX_PATH); + + vector<string> dirs; + + ListDirs(".", "*", dirs, true, FILE_SKIP_HIDDEN); + + for (int i = 0; i < dirs.size(); i++) + { + if (dirs[i].find("node_modules") != string::npos) + { + DBG_MSG("Skipped path [%s].\n", dirs[i].c_str()); + + continue; + } + + if (dirs[i].size() >= 240) + { + DBG_INFO("WARNING! Path too long [%s].\n", dirs[i].c_str()); + + continue; + } + + DBG_MSG("Entering [%s][%d][%d]...\n", dirs[i].c_str(), dirs[i].size(), MAX_PATH); + + FileSetDir(currentDir); + FileSetDir(dirs[i].c_str()); + + if (comp.loadComponent() == 0) + { + proj.loadProject(); + + comp.set("ROOT", proj.get("ROOT")); + comp.cat("LIBS", proj.get("LIBS")); + comp.cat("INCLUDE", proj.get("INCLUDE")); + comp.cat("DEFINES", proj.get("DEFINES")); + comp.cat("INSTALL", proj.get("INSTALL")); + comp.cat("INSTALL_INC", proj.get("INSTALL_INC")); + comp.cat("INSTALL_LIB", proj.get("INSTALL_LIB")); + comp.cat("INSTALL_BIN", proj.get("INSTALL_BIN")); + + printf("\n"); + + if (comp.getType() != TYPE_PROJECT) + { + comps.push_back(comp); + + // + // Multi-library. + // Attach sources from dependent libraries. + // + + if (comp.getType() == TYPE_MULTI_LIBRARY) + { + FAIL(AttachDependsToMultiLibrary(&comp)); + } + + // + // Set BIN_DIR to Examples if *example* binary name found. + // + + if ((comp.getType() == TYPE_PROGRAM) + && (stristr(comp.get("TITLE"), "example")) + && (!comp.isset("BIN_DIR"))) + { + comp.set("BIN_DIR", "Examples"); + } + + // + // Generate makefile. + // + + GenerateMakefile(&comp); + + comp.print(); + + DBG_MSG("Imported component '%s'.\n", comp.get("TITLE")); + } + } + } + + FileSetDir(currentDir); + + // + // Resolve compoments dependencies and generate + // main Build/Clean scripts for whole project. + // + + FAIL(GenerateBuildCleanScripts(comps)); + } + + // + // Project's Component or stand alone. + // + + else + { + if (comp.getType() != TYPE_SIMPLE_LIBRARY && + comp.getType() != TYPE_SIMPLE_PROGRAM) + { + FAIL(proj.loadProject()); + + comp.set("ROOT", proj.get("ROOT")); + comp.cat("LIBS", proj.get("LIBS")); + comp.cat("INCLUDE", proj.get("INCLUDE")); + comp.cat("DEFINES", proj.get("DEFINES")); + comp.cat("INSTALL", proj.get("INSTALL")); + comp.cat("INSTALL_INC", proj.get("INSTALL_INC")); + comp.cat("INSTALL_LIB", proj.get("INSTALL_LIB")); + comp.cat("INSTALL_BIN", proj.get("INSTALL_BIN")); + + // + // Multi-library. + // Attach sources from dependent libraries. + // + + if (comp.getType() == TYPE_MULTI_LIBRARY) + { + FAIL(AttachDependsToMultiLibrary(&comp)); + } + + proj.print(); + } + + comp.print(); + + FAIL(GenerateMakefile(&comp)); + } + + break; + } + + // + // --root + // Find project's root directory. + // + + case PRINT_ROOT_MODE: + { + FAIL(proj.loadProject()); + + printf("%s\n", proj.get("ROOT")); + + break; + } + + // + // --info + // Print info about current component. + // + + case INFO_MODE: + { + FAIL(proj.loadProject()); + + proj.print(); + + if (comp.loadComponent() == 0) + { + printf("\n"); + + comp.print(); + } + + break; + } + + // + // --diagram + // + // Generate SVG diagram showing connections beetwen components + // inside project. + // + + case DIAGRAM_MODE: + { + // + // Load all components from tree. + // + + FAIL(ListComponents(&proj, comps)); + + // + // Generate diagram on stdout. + // + + FAIL(CreateComponentDiagram(stdout, comps)); + + break; + } + + // + // --makedoc + // + // Generate HTML documentation for whole project in './doc' + // subdirectory. + // + + case MAKEDOC_MODE: + { + printf("Generating public documentation...\n"); + printf("----------------------------------\n"); + AutoDocGenerate(0); + + printf("\n"); + printf("Generating private documentation...\n"); + printf("-----------------------------------\n"); + AutoDocGenerate(1); + + break; + } + + // + // --setcolor --color <colorcode> + // Set current console color. + // + + case SETCOLOR_MODE: + { + #ifdef WIN32 + SetConsoleTextAttribute(GetStdHandle(STD_OUTPUT_HANDLE), color); + #endif + + break; + } + } + + // + // Error handler. + // + + exitCode = 0; + + fail: + + DBG_LEAVE("main"); + + return exitCode; +} diff --git a/Source/Tools/QCBuild/Main.h b/Source/Tools/QCBuild/Main.h new file mode 100644 index 0000000..b8482f3 --- /dev/null +++ b/Source/Tools/QCBuild/Main.h @@ -0,0 +1,113 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef QCBuild_H +#define QCBuild_H + +#include <cstdio> +#include <cstring> +#include <cstdlib> +#include <cctype> +#include <set> +#include "SourceInfo.h" +#include "AutoDoc.h" + +// +// FIXME: Move target specified variables into +// configuration files. +// + +// +// Linux defines. +// + +#ifdef __linux__ +# define EXE_POSTFIX "" +# define DLL_PREFIX "lib" +# define DLL_POSTFIX ".so" +# define HOST_MACHINE "Linux" + +# define CXX_COMPILER "g++" +# define C_COMPILER "gcc" + +# define SCRIPT_POSTFIX ".sh" +# define SCRIPT_DEL "rm -rf" +# define SCRIPT_RMDIR "rmdir" +# define SCRIPT_MKDIR "mkdir" +# define SCRIPT_COPY "cp" +# define SCRIPT_COMMENT "#" +# define SCRIPT_INTRO "#!/bin/sh" +# define SCRIPT_FAIL "if [ $? -ne 0 ]\nthen\n exit -1\nfi" +# define SCRIPT_MAKE_INSTALL "make install" +#endif + +// +// Windows defines. +// + +#ifdef WIN32 +# define EXE_POSTFIX ".exe" +# define DLL_PREFIX "" +# define DLL_POSTFIX ".dll" +# define HOST_MACHINE "MinGW" +# define CXX_COMPILER "g++" +# define C_COMPILER "gcc" + +# define SCRIPT_POSTFIX ".bat" +# define SCRIPT_DEL "del" +# define SCRIPT_RMDIR "rmdir" +# define SCRIPT_MKDIR "mkdir" +# define SCRIPT_COPY "copy" +# define SCRIPT_COMMENT "rem" +# define SCRIPT_INTRO "@echo off" +# define SCRIPT_FAIL "if %ERRORLEVEL% neq 0 exit /b %ERRORLEVEL%" +# define SCRIPT_MAKE_INSTALL "call make install" +#endif /* WIN32 */ + +// +// MacOS defines. +// + +#ifdef __APPLE__ +# define EXE_POSTFIX "" +# define DLL_PREFIX "lib" +# define DLL_POSTFIX ".dylib" +# define HOST_MACHINE "MacOS" + +# define CXX_COMPILER "g++" +# define C_COMPILER "gcc" + +# define SCRIPT_POSTFIX ".sh" +# define SCRIPT_DEL "rm" +# define SCRIPT_RMDIR "rmdir" +# define SCRIPT_MKDIR "mkdir" +# define SCRIPT_COPY "cp" +# define SCRIPT_COMMENT "#" +# define SCRIPT_INTRO "#!/bin/sh" +# define SCRIPT_FAIL "if [ $? -ne 0 ]\n then\n exit(-1) \nfi" +# define SCRIPT_MAKE_INSTALL "make install" +#endif /* __APPLE__ */ + + +#endif /* QCBuild_H */ diff --git a/Source/Tools/QCBuild/Prebuild/Linux/qcbuild b/Source/Tools/QCBuild/Prebuild/Linux/qcbuild new file mode 100644 index 0000000..de5b909 Binary files /dev/null and b/Source/Tools/QCBuild/Prebuild/Linux/qcbuild differ diff --git a/Source/Tools/QCBuild/Prebuild/Win32/hgroups.ini b/Source/Tools/QCBuild/Prebuild/Win32/hgroups.ini new file mode 100644 index 0000000..a15d2be --- /dev/null +++ b/Source/Tools/QCBuild/Prebuild/Win32/hgroups.ini @@ -0,0 +1,55 @@ +[Group #1] +IsDir=0 +UseDefaultBG=1 +Index=0 +Color=138 +Mask=*.exe;*.com;*.bat;*.sh + +[Group #2] +IsDir=0 +UseDefaultBG=1 +Index=0 +Color=130 +Mask=*.dll;*.so;*.a;*.lib;*.o + +[Group #3] +IsDir=0 +UseDefaultBG=1 +Index=0 +Color=131 +Mask=*.asm;*.c;*.cpp;*.pas;*.h;*.php;*.js;*.coffee;*.py;*.mold + +[Group #4] +IsDir=0 +UseDefaultBG=1 +Index=0 +Color=133 +Mask=*.mp3;*.wav;*.pcm + +[Group #5] +IsDir=0 +UseDefaultBG=1 +Index=0 +Color=129 +Mask=*.jpg;*.png;*.gif;*.bmp;*.jpeg;*.ico;*.tif;*.cur + +[Group #6] +IsDir=0 +UseDefaultBG=1 +Index=0 +Color=134 +Mask=makefile*.*;*.pro;*.rc;*.cfg;*.ini;*.qrc;qcbuild.src;*.y;*.l;*.lex + +[Group #7] +IsDir=1 +UseDefaultBG=1 +Index=0 +Color=143 +Mask=*.* + +[Group #8] +IsDir=0 +UseDefaultBG=1 +Index=0 +Color=1 +Mask=*.txt;*.doc;readme;*.ods;*.xls;*.html;*.htm;todo diff --git a/Source/Tools/QCBuild/Prebuild/Win32/ndn.hgl b/Source/Tools/QCBuild/Prebuild/Win32/ndn.hgl new file mode 100644 index 0000000..42f9191 --- /dev/null +++ b/Source/Tools/QCBuild/Prebuild/Win32/ndn.hgl @@ -0,0 +1,2090 @@ +; Necromancer's Dos Navigator Editor Syntax Highlight configuration file... ³ +;ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; See details on keywords in the online help +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; HGL file +; +; Macros: +; 1 FILES *.1/END +; 2 Macro 1/Endmacro +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.HGL; + CommentStart ; + GeneralFLAGS 0 + StringFLAGS 12 + colorkeywords on + BracketPairs macro endmacro files end + Keywords1 Keywords1,default,files,macro,endmacro,end,generalflags,stringflags + Keywords1 octonumflags,octqnumflags,octbnumflags,autowrap,leftmargin, + Keywords1 rightmargin,paragraph + Keywords1 binnumflags,hexnumflags,decnumflags,commentstart,colorkeywords + Keywords1 comment,commentstring,keywords,MultiLineComment,AutoBrackets + KeyWords1 regkeywords,multilinestring,bracketpairs,optimalfill,tabsize + KeyWords1 LeftMargin,RightMargin,Paragraph,ForceNewlineAtEOF + KeyWords1 Highlight,H_Line,H_Row,H_Column,WrapJustify + KeyWords1 ForceCRLF,ForceCR,forceLF,commentstartpos + keywords2 KeyWords2,on,off,yes,no,color + keywords2 darkgray,lightblue,lightgreen,lightcyan,lightred,yellow,white + keywords2 lightmagenta,black,blue,green,cyan,red,magenta,brown,lightgray + KeyWords3 KeyWords3 + keywords3 Print,GotoXY,GotoX,GotoY,Mark,Goto +;warning: this commands are taken from edcom.dnr dated 22-Dec-2005 +;some of them may not work in all versions +;end is not listed because it is keyword1 too + Keywords3 AsciiTable,BlockDown,BlockEnd,BlockLeft,BlockPrint,BlockRead + Keywords3 BlockRight,BlockStart,BlockUp,BlockWrite,BracketPair,CalcBlock + Keywords3 CapBlock,CapString,CapWord,CaseBlock,CaseChar,CaseString + Keywords3 CaseWord,Close,ContSearch,Copy,CopyBlock,Cut,DelBackChar + Keywords3 DelBlock,DelChar,DelLine,DelToSOL,DelWordLeft,DelWordRight + Keywords3 DeltoEOLN,Enter,ExecFile,FCenter,FJustify,FLeft,FRight + KeyWords3 FileEnd,FilePrint,FileStart,GotoLineNumber,GotoMarker1 + KeyWords3 GotoMarker2,GotoMarker3,GotoMarker4,GotoMarker5,GotoMarker6 + KeyWords3 GotoMarker7,GotoMarker8,GotoMarker9,HideBlock,Home + KeyWords3 IndentBlock,IndentOff,IndentOn,InsLine,InsertDate,InsertOff + Keywords3 InsertOn,InsertTime,InsertVersion,LCenter,LJustify,LLeft + Keywords3 LRight,LoadText,LowBlock,LowString,LowWord,MarkAll,MarkLine + Keywords3 MarkWord,Menu,MoveBlock,MoveBlockEnd,MoveBlockStart,MoveDown + Keywords3 MoveLeft,MoveRight,MoveUp,Paste,PgDn,PgUp,PlaceMarker1 + Keywords3 PlaceMarker2,PlaceMarker3,PlaceMarker4,PlaceMarker5 + Keywords3 PlaceMarker6,PlaceMarker7,PlaceMarker8,PlaceMarker9,Play0,Play1 + KeyWords3 Play2,Play3,Play4,Play5,Play6,Play7,Play8,Play9,Redo,Replace + KeyWords3 RevSearch,SaveText,SaveTextAs,ScreenBottom,ScreenTop,ScrollDn + KeyWords3 ScrollUp,SortBlock,SortBlockRev,StartSearch,SwitchBack + KeyWords3 SwitchBlock,SwitchDrawMode,SwitchFill,SwitchHiColumn + KeyWords3 SwitchHiLine,SwitchHighLight,SwitchIndent,SwitchIns,SwitchSave + KeyWords3 SwitchWrap,Tab,TabBack,UnIndentBlock,Undo,UpBlock,UpString + KeyWords3 UpWord,WindowsCopy,WindowsCut,WindowsPaste,WordCount,WordLeft + KeyWords3 WordRight,SwapLines,SwapWords,SwapWordsAlt + KeyWords4 KeyWords4 + KeyWords5 KeyWords5 + KeyWords6 KeyWords6 + KeyWords7 KeyWords7 + KeyWords8 KeyWords8 + Macro 1 + GoToX 0 + InsLine + Print ';ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ'^M^S + Print ';'^M^S + Print ';ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ'^M^S + Print ^X^E^E^D^D + EndMacro + Macro 2 + Print #1'FILES'#32'*.'#6^M^M'END'^M#5 + End + Print #1#5#9 + EndMacro + Macro 3 + Print #1'Macro'#32#6^M^M'EndMacro'^M#5 + End + Print #1#5#9 + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Necromancer's Dos Navigator configuration files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES NDN.INI;ARCHIVER.INI + CommentStart ; + GeneralFLAGS 14 +; [section] constructs + RegKeywords color red \[[^\]\[]+\] +; value= constructs + RegKeywords color lightred ^\w[^=]*(?==) +END + +FILES hgroups.ini +;warning: ndn deletes all comments from hgroups.ini + RegKeywords color red ^\[group #\d\d?\] + RegKeywords color lightred ^(IsDir|UseDefaultBG|Index|Color|Mask)(?==) +END + +FILES ftp.ini + CommentStart ; + GeneralFlags 14 + RegKeywords color white ftp:// + RegKeywords color lightgreen \[\d+\,\d+\,\d+\] +END + +FILES ndn.spf + CommentString ; + RegKeywords color white ;\s1*(\+|\*)?,^\s*(\+|\*) + RegKeywords color red ^\s*\[[^\[\]\\/\*\:\?\"\<\>\.]+\] +END + +FILES NDN.EXT + CommentStart ; +;regkeywords2 + RegKeywords color white ^\s*([^\]\[\\/\*\:\?\"\<\>\.]+|\*\s*)(?=[\[\{\(]) +;regkeywords5 + RegKeywords color blue ~~~~,!!,\$\$ +;regkeywords4 + RegKeywords color green !\\ + RegKeywords color green !~\\ + RegKeywords color green \$\\ + RegKeywords color green \$~\\ + RegKeywords color green ~!,\.!~,\.!,!/,!~/,!:,! + RegKeywords color green ~\$,\.\$~,\.\$,\$/,\$~/,\$:,\$ +;regkeywords3 + RegKeywords color red (?<=[\[\{\(])\s*>?>(?=\ ?\d+(\s|$)),~,^\s*<=? + RegKeywords color red ^\s*>?>(?=\ ?\d+(\s|$)) +;regkeywords comment + regkeywords color cyan ^\s*rem[^\|]*,(?<=\|)\s*rem[^\|]*,^\s*::.*$ +;regkeywords1 + regKeywords color white ^\s*@?\s*[A-Za-z]:$ + regKeywords color white ^\s*@?\s*(break|call|cd|chdir|chcp|cls|command|copy|ctty|date|del|erase|dir|exit|goto|lfnfor|lock|loadhigh|lh|md|mkdir|path|pause|prompt|rd|rmdir|ren|rename|set|shift|time|truename|type|unlock|ver|verify|vol)($|\s) + regKeywords color white ^\s*@?\s*echo(\.|\s+(on|off)$)? + regKeywords color white ^\s*@?\s*if(\s+not)?\s+(exist\ |errorlevel\ |(?=.*==)) + regKeywords color white ^\s*@?\s*for(?=\s+%%[^\d]\s+in\s+\([^\(\)]\)\s+do) +;regkeywords2 + regkeywords color lightgreen in(?=\s+\([^\(\)]*\)\s+do),(?<=\))\s+do + regkeywords color lightgreen ^\s*:.*$ + Keywords5 >,<,| +;regkewords5 + regkeywords color blue %% +;regkewords3 + regkeywords color red %\d,%\D[^%]*%,% +END + +FILES ndn.vwr;ndn.edt + CommentStart ; +;regkeywords comment + RegKeyWords color cyan ^\s*;.*$ +;regkeywords1 + RegKeywords color white : +;regkeywords2 + RegKeywords color red ^\s*[^\]\[\\/\*\:\?\"\<\>\.]+(?=:) +;regkeywords4 + RegKeywords color green !\\ + RegKeywords color green !~\\ + RegKeywords color green \$\\ + RegKeywords color green \$~\\ + RegKeywords color green ~!,\.!~,\.!,!/,!~/,!:,! + RegKeywords color green ~\$,\.\$~,\.\$,\$/,\$~/,\$:,\$ +END + +FILES ndn.mnu;ndn.mn2 +;comments in menu can appear only before first menu item +;strange: there can 0 or 1 spaces between > and number + CommentStart ; +;regkeywords5 + RegKeywords color blue ~~~~,!!,\$\$ +;regkeywords4 + RegKeywords color green !\\ + RegKeywords color green !~\\ + RegKeywords color green \$\\ + RegKeywords color green \$~\\ + RegKeywords color green ~!,\.!~,\.!,!/,!~/,!:,! + RegKeywords color green ~\$,\.\$~,\.\$,\$/,\$~/,\$:,\$ +;regkeywords3 + RegKeywords color red ^\s*>?>(?=\ ?\d+(\s|$)),~,^\s*<=? + RegKeywords color red (?<={)(nc)?menufile(?=="[^"]+"}) +;regkeywords comment + regkeywords color cyan ^\s*rem[^\|]*,(?<=\|)\s*rem[^\|]*,^\s*::.*$ +;regkeywords1 + regKeywords color white ^\s*@?\s*[A-Za-z]:$ + regKeywords color white ^\s*@?\s*(break|call|cd|chdir|chcp|cls|command|copy|ctty|date|del|erase|dir|exit|goto|lfnfor|lock|loadhigh|lh|md|mkdir|path|pause|prompt|rd|rmdir|ren|rename|set|shift|time|truename|type|unlock|ver|verify|vol)($|\s) + regKeywords color white ^\s*@?\s*echo(\.|\s+(on|off)$)? + regKeywords color white ^\s*@?\s*if(\s+not)?\s+(exist\ |errorlevel\ |(?=.*==)) + regKeywords color white ^\s*@?\s*for(?=\s+%%[^\d]\s+in\s+\([^\(\)]\)\s+do) +;regkeywords2 + regkeywords color lightgreen in(?=\s+\([^\(\)]*\)\s+do),(?<=\))\s+do + regkeywords color lightgreen ^\s*:.*$ + Keywords5 >,<,| +;regkewords5 + regkeywords color blue %% +;regkewords3 + regkeywords color red %\d,%\D[^%]*%,% +END + +FILES ndn.xrn + CommentStart ; +;regkeywords comment + RegKeyWords color cyan ^\s*;.*$ +;regkeywords5 + RegKeywords color blue ~~~~,!!,\$\$ +;regkeywords4 + RegKeywords color green !\\ + RegKeywords color green !~\\ + RegKeywords color green \$\\ + RegKeywords color green \$~\\ + RegKeywords color green ~!,\.!~,\.!,!/,!~/,!:,! + RegKeywords color green ~\$,\.\$~,\.\$,\$/,\$~/,\$:,\$ +;regkeywords3 + RegKeywords color red ^>[><\[\]]?(?=\s*(10|1|2|3|4|5|6|7|8|9)$),~,^\s*<=? +;regkeywords comment + regkeywords color cyan ^\s*rem[^\|]*,(?<=\|)\s*rem[^\|]*,^\s*::.*$ +;regkeywords1 + regKeywords color white ^\s*@?\s*[A-Za-z]:$ + regKeywords color white ^\s*@?\s*(break|call|cd|chdir|chcp|cls|command|copy|ctty|date|del|erase|dir|exit|goto|lfnfor|lock|loadhigh|lh|md|mkdir|path|pause|prompt|rd|rmdir|ren|rename|set|shift|time|truename|type|unlock|ver|verify|vol)($|\s) + regKeywords color white ^\s*@?\s*echo(\.|\s+(on|off)$)? + regKeywords color white ^\s*@?\s*if(\s+not)?\s+(exist\ |errorlevel\ |(?=.*==)) + regKeywords color white ^\s*@?\s*for(?=\s+%%[^\d]\s+in\s+\([^\(\)]\)\s+do) +;regkeywords2 + regkeywords color lightgreen in(?=\s+\([^\(\)]*\)\s+do),(?<=\))\s+do + regkeywords color lightgreen ^\s*:.*$ + Keywords5 >,<,| +;regkewords5 + regkeywords color blue %% +;regkewords3 + regkeywords color red %\d,%\D[^%]*%,% +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; NDN Language/Dialog Files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.DNL;*.HTX + CommentStart ; + OptimalFill Off +END + +FILES *.DNR + CommentString ; + OptimalFill Off +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; QCBuild files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES qcbuild.src + CommentString # + Keywords2 type, title, include, libs, cxxsrc, csrc, isrc, defines, depends, + Keywords2 desc, purpose, license, author, qt_headers, qt_forms, qt_modules + Keywords2 copyright, prebuild_progs, prebuild_libs, flexsrc, bisonsrc + Keywords3 .section, .endsection +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; *.SC files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.sc + CommentString # + + StringFlags 255 + +; regkeywords color lightred %\d,%\D[^%]*%,% + + regkeywords color lightred %\d,%\D[^%]*%,% + Keywords2 Host, Url, ListAlgo, NewOnly, Prioritet, LinkPattern, PageIdMin + Keywords2 Include, BiustScale, Delim, Region, HiddenTelephone, BiustScaleEx + Keywords2 IndexUrl, ExcludeUrl, ExcludeImg, GoOnIfIdle, pageIdMax, Debug, PageIdStep + Keywords2 ClearUrls, UseRegExp + + Keywords2 RemoveVarFromUrl, RegisterKeyword + + Keywords1 Goto, GetTagText, ParseList, DumpUrl, Exit, GetTagTextEx + Keywords1 ParseOrdTable, ParsePrefs, StrExportWord, DumpVar, ScanVar + Keywords1 Begin +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Include files, usually assembler but also pascal and other. +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.INC + MultiLineComment 1 + CommentStart $,% + CommentString file://,#,; + Comment /* */,(* *),{ } +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Assembler files *.S35;*.S03;*.S01;*.S90 +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.ASM;*.S??;*.A86;*.EQU + CommentString ; + HexNumFLAGS 31 + DecNumFLAGS 31 + OctoNumFLAGS 31 + BinNumFLAGS 31 + GeneralFlags 16 + BracketPairs macro endm proc endp + Keywords1 public,extern,extrn,include,includelib,macro,endm,segment,ideal,model,ends + Keywords1 proc,end,endp,title,subtitle,module,code,flat,jumps,data + Keywords1 const,rcode,equ,global,name,group,assume,nojumps,locals,org + Keywords1 if,ifdef,ifndef,elif,else,endif,define,undef,local,dup + Keywords1 p386,.386,p486,.486,p586,.586,.586p,.data,dataseg,.code + Keywords1 codeseg,.udata,udataseg,short,offset,near,end,struc + +; Registers and size related + KeyWords3 db,dw,dd,dq,dt,tiny,large,word,dword,byte,ptr + RegKeywords Color lightgray \b[abcd][lh]\b, \be?[abcd]x\b, \bmm[0-7]\b + RegKeywords Color lightgray \b[cdefgs]s\b, \be?[ds]i\b, \be?[bs]p\b +; Instructions + Keywords2 add,adc,aaa,sub,sbb,int,test,cmp,and,or,xor,dec,inc,nop,loop, movq + Keywords2 call,not,neg,div,idiv,mul,imul,daa,xchg,cld,std,lea,out,in, clc, stc + + RegKeywords Color green \bjn?([abcelgopzs]|[ablg]e|e?cxz|mp|po)\b + RegKeywords Color green \brepn?[ez]?\b, \bmov([sz]x)?\b, \bl[defgs]s\b + RegKeywords Color green \b(cmp|sto|lod|mov|sca)s[bwd]\b + RegKeywords Color green \br[co][lr]\b, \bsh[rl]\b, \bi?retd?\b + RegKeywords Color green \b(push|pop)(fd|f)?\b + Macro 1 + GoToX 0 + InsLine + Print ';ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ'^M^S + Print ';'^M^S + Print ';'^M^S + Print ';'^M^S + Print ';ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ'^M^S + Print ^X^E^E^E^E^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print ';'^M^S + Print ';'^M^S + Print ';'^M^S + Print ^X^E^G^E^E^D^D + EndMacro + Macro 3 + GotoX 0 + Print 'IDEAL'^M'P386'^M'MODEL TINY'^M'JUMPS'^M'CODESEG'^M'STARTUPCODE'^M^M + Print ' ret'^M + GotoX 0 + Print 'UDATASEG'^M'DATASEG'^M'END'^M^M + Print ^E^E^E^E^E^E + GotoX 8 + EndMacro + Macro 4 + GotoX 0 + Print 'IDEAL'^M'P386'^M'MODEL FLAT'^M'UDATASEG'^M'DATASEG'^M'CODESEG'^M'Start:'^M^M + Print ' mov ax,4C00h ; Termiate the program'^M + GotoX 0 + Print ' int 21h ; with exit code 0'^M + GotoX 0 + Print 'END Start'^M^M + Print ^E^E^E^E^E + GotoX 8 + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Configuration files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.CFG;*.EVT; + CommentStart ;,#,$,% + CommentString // + GeneralFLAGS 14 +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Batch/Config.sys files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.bat;autoexec.nt + CommentStart REM ,:: +;regkeywords comment +; regkeywords color cyan ^\s*rem[^\|]*,(?<=\|)\s*rem[^\|]*,^\s*::.*$ +;regkeywords1 + regKeywords color white ^\s*@?\s*[A-Za-z]:$ + regKeywords color white ^\s*@?\s*(break|call|cd|chdir|chcp|cls|command|copy|ctty|date|del|erase|dir|exit|goto|lfnfor|lock|loadhigh|lh|md|mkdir|path|pause|prompt|rd|rmdir|ren|rename|set|shift|time|truename|type|unlock|ver|verify|vol)($|\s) + regKeywords color white ^\s*@?\s*echo(\.|\s+(on|off)$)? + regKeywords color white ^\s*@?\s*if(\s+not)?\s+(exist\ |errorlevel\ |(?=.*==)) + regKeywords color white ^\s*@?\s*for(?=\s+%%[^\d]\s+in\s+\([^\(\)]\)\s+do) +;regkeywords2 + regkeywords color lightgreen in(?=\s+\([^\(\)]*\)\s+do),(?<=\))\s+do + regkeywords color lightgreen ^\s*:.*$ + Keywords5 >,<,| +;regkewords5 + regkeywords color blue %% +;regkewords3 + regkeywords color red %\d,%\D[^%]*%,% + tabsize 8 +END + +FILES config.sys;config.nt;config.dos + CommentStart ; +;regkeywords comment + regkeywords color cyan ^\s*(rem|;).*$ +;regkeywords1 + regKeywords color white ^\s*(accdate|break|country|dos(data)?|drivparam|lastdrive|logo|numlock|multitrack|shell|switches)\s*(?==) + regKeywords color white ^\s*(buffers|fcbs|files|install|stacks)(high)?\s*(?==) + regKeywords color white ^\s*device(high)?(?=.*=) + regKeywords color white ^\s*set(?=\s*\D.*=) + keywords2 on,off,high,low,umb,noumb,auto,noauto +;menu commands +;regkeywords1 + regKeywords color white ^\s*(menuitem|menucolor|menudefault|submenu|include)\s*(?==) +;regkeywords3 + regKeywords color red ^\s*\[\s*(menu|common)\s*\] +;regkeywords2 + regKeywords color lightgreen ^\s*\[[^\[\]]+\] +;NT extensions +;regkeywords1 + regKeywords color white ^\s*(echoconfig|ntcmdpropt|dosonly|emm\s*(?==)) +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; (Visual) Basic files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.VBS;*.BAS;*.FRM + Regkeywords Color Lightgreen \<[^\>]+\>,\[[^\]]+\],\([^\)]+\) + Keywords1 dim,set,sub,begin,end,for,each,in,next,if,then,to + Keywords1 vbOKCancel,vbInformation,function,else,vbOkOnly,vbCancel, + Keywords1 input,print,not,and,or,public,private,const,attribute,option + Keywords1 select,case,as + Keywords2 MsgBox,call,chr,exit,explicit,false,true,nothing,object,string + Keywords2 integer,long,boolean + CommentString REM ,' + BracketPairs begin end if then for to + StringFlags 32 +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; C files (*.h is in C++ section) +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.c;*.l;*.y +; AutoBrackets Off + MultiLineComment 1 + CommentString // + Comment /* */ + ForceNewlineAtEOF On +; turned off number highlighting + GeneralFLAGS 467 + StringFLAGS 3 + keywords1 auto,break,case,char,const,continue,default,do,double,else,enum + keywords1 extern,float,for,goto,if,inline,int,long,register,restrict,return + keywords1 short,signed,sizeof,static,struct,switch,typedef,union,unsigned + keywords1 void,volatile,while,_Bool,_Complex,_Imaginary +;this is added due to NDN bug + Keywords2 #if,#ifdef,#ifndef,#endif,#else,#elif,#define,#undef,#pragma,#line,#include,#error +;RegKeyWords2 + regKeywords color lightgreen ^\s*#\s*(if(n?def)?|endif|else|elif|define|undef|pragma|line|include|error)\b + keywords2 defined,# +;regkeywords number + regkeywords color lightcyan (?<!\w)\.\d+([eE][+-]?\d+)?[fFlL]?\b,\b\d+\.(?!\w) + regkeywords color lightcyan \b(\d+[eE][+-]?\d+|\d+\.\d+([eE][+-]?\d+)?|0[xX]([0-9A-Fa-f]+\.?|[0-9A-Fa-f]*\.[0-9A-Fa-f]+)[pP][+-]?\d+)[fFlL]?\b + regkeywords color lightcyan (?<!\.)\b(0+|[1-9]\d*|0[xX][0-9A-Fa-f]+)([uU](l|L|ll|LL)?|(l|L|ll|LL)[uU]?)?(?!\.)\b +;octal + regkeywords color cyan (?<!\.)\b(0[0-7]+)([uU](l|L|ll|LL)?|(l|L|ll|LL)[uU]?)?(?!\.)\b +;regkeywords string + regkeywords color lightmagenta L(?=[\'\"]) + Macro 1 + GoToX 0 + InsLine + Print '/*****************************************************************'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *****************************************************************/'^M^S + Print ^X^E^E^E^E^D^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print '/*'^M^S + Print ' *'^M^S + Print ' */'^M^S + Print ^X^E^G^E^E^D^D^D + EndMacro + Macro 3 + GotoX 0 + Print '#include <stdio.h>'^M^M + Print 'int main ( int argc , char* argv[] )'^M + Print '{'^M^M + Print ' return 0;'^M + GotoX 0 + Print '}'^M + Print ^E^E^E^D^D^D^D + EndMacro + Macro 4 + GoToX 0 + Print '/*******************************************************************************/'^M^S + Print '/*---- ------------------------------------------------------------------------*/'^M^S + Print '/*******************************************************************************/'^M^S + Print ^E^E^D^D^D^D^D^D^D + SwitchIns + EndMacro + Macro 5 + GoToX 0 + Print '/* --------------------------------------- */'^M^S + Print '/* */'^M^S + Print '/* --------------------------------------- */'^M^S + Print ^E^E^D^D^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; MOLD files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.mold +; AutoBrackets Off + MultiLineComment 1 + CommentString # + Comment /* */ + ForceNewlineAtEOF On +; turned off number highlighting + GeneralFLAGS 467 + StringFLAGS 3 + + keywords1 integer, boolean, float, double + keywords1 if, else, endif, while, for, switch, then, elif + keywords1 is, isnt, in + keywords1 function, endfunction, fail, body + keywords1 for, while, endfor, endwhile, step + keywords2 and, or + keywords3 reduce, to + keywords1 typeof + +;regkeywords number + regkeywords color lightcyan (?<!\w)\.\d+([eE][+-]?\d+)?[fFlL]?\b,\b\d+\.(?!\w) + regkeywords color lightcyan \b(\d+[eE][+-]?\d+|\d+\.\d+([eE][+-]?\d+)?|0[xX]([0-9A-Fa-f]+\.?|[0-9A-Fa-f]*\.[0-9A-Fa-f]+)[pP][+-]?\d+)[fFlL]?\b + regkeywords color lightcyan (?<!\.)\b(0+|[1-9]\d*|0[xX][0-9A-Fa-f]+)([uU](l|L|ll|LL)?|(l|L|ll|LL)[uU]?)?(?!\.)\b +;octal + regkeywords color cyan (?<!\.)\b(0[0-7]+)([uU](l|L|ll|LL)?|(l|L|ll|LL)[uU]?)?(?!\.)\b +;regkeywords string + regkeywords color lightmagenta L(?=[\'\"]) +END + +FILES *.mold.test +; AutoBrackets Off + MultiLineComment 1 + CommentString # + Comment /* */ + ForceNewlineAtEOF On +; turned off number highlighting + GeneralFLAGS 467 + StringFLAGS 3 + + keywords1 integer, boolean, float, double + keywords1 if, else, endif, while, for, switch, then, elif + keywords1 is, isnt, in + keywords1 function, endfunction, fail, body + keywords1 for, while, endfor, endwhile, step + keywords2 and, or + keywords3 reduce, to + keywords1 typeof + +; Tests specific + regkeywords color green TEST + regkeywords color green EXPECTED_OUTPUT + regkeywords color green EXPECTED_ERROR + +;regkeywords number + regkeywords color lightcyan (?<!\w)\.\d+([eE][+-]?\d+)?[fFlL]?\b,\b\d+\.(?!\w) + regkeywords color lightcyan \b(\d+[eE][+-]?\d+|\d+\.\d+([eE][+-]?\d+)?|0[xX]([0-9A-Fa-f]+\.?|[0-9A-Fa-f]*\.[0-9A-Fa-f]+)[pP][+-]?\d+)[fFlL]?\b + regkeywords color lightcyan (?<!\.)\b(0+|[1-9]\d*|0[xX][0-9A-Fa-f]+)([uU](l|L|ll|LL)?|(l|L|ll|LL)[uU]?)?(?!\.)\b +;octal + regkeywords color cyan (?<!\.)\b(0[0-7]+)([uU](l|L|ll|LL)?|(l|L|ll|LL)[uU]?)?(?!\.)\b +;regkeywords string + regkeywords color lightmagenta L(?=[\'\"]) +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; C++ files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.CPP;*.H;*.HPP;*.R;*.HH;*.HXX;*.CXX;*.CC +; AutoBrackets Off + MultiLineComment 1 + ForceNewlineAtEOF On + CommentString // + Comment /* */ + +; GeneralFLAGS 467 ;kolorowanie liczb + GeneralFLAGS 80 + + StringFLAGS 3 + keywords1 asm,auto,bool,break,case,catch,char,class,const,const_cast + keywords1 continue,default,delete,do,double,dynamic_cast,else,enum + keywords1 explicit,export,extern,false,float,for,friend,goto,if,inline,int + keywords1 long,mutable,namespace,new,operator,private,protected,public + keywords1 register,reinterpret_cast,return,short,signed,sizeof,static + keywords1 static_cast,struct,switch,template,this,throw,true,try,return + keywords1 short,signed,sizeof,static,static_cast,struct,switch,template + keywords1 this,throw,true,try,typedef,typeid,typename,union,unsigned + keywords1 using,virtual,void,volatile,wchar_t,while + keywords2 and,and_eq,bitand,bitor,compl,not,not_eq,or,or_eq,xor,xor_eq +;this is added due to NDN bug + Keywords2 #if,#ifdef,#ifndef,#endif,#else,#elif,#define,#undef,#pragma,#line,#include,#error +;RegKeyWords2 + regKeywords color lightgreen ^\s*#\s*(if(n?def)?|endif|else|elif|define|undef|pragma|line|include|error)\b + keywords2 defined,# +;regkeywords number + regkeywords color lightcyan (?<!\w)\.\d+([eE][+-]?\d+)?[fFlL]?\b,\b\d+\.(?!\w) + regkeywords color lightcyan \b(\d+[eE][+-]?\d+|\d+\.\d+([eE][+-]?\d+)?)[fFlL]?\b + regkeywords color lightcyan (?<!\.)\b(0+|[1-9]\d*|0[xX][0-9A-Fa-f]+)([uU](l|L)?|(l|L)[uU]?)?(?!\.)\b +;octal + regkeywords color cyan (?<!\.)\b(0[0-7]+)([uU](l|L)?|(l|L)[uU]?)?(?!\.)\b +;regkeywords string + regkeywords color lightmagenta L(?=[\'\"]) + + Macro 1 + GoToX 0 + InsLine + Print '/*****************************************************************'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *****************************************************************/'^M^S + Print ^X^E^E^E^E^D^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print '/*'^M^S + Print ' *'^M^S + Print ' */'^M^S + Print ^X^E^G^E^E^D^D^D + EndMacro + Macro 3 + GotoX 0 + Print '#include <iostream>'^M'#include <stdlib.h>'^M^M + Print 'using namespace std;'^M^M + Print 'int main ( int argc , char* argv[] )'^M + Print '{'^M^M + Print ' return 0;'^M + GotoX 0 + Print '}'^M + Print ^E^E^E^D^D^D^D + EndMacro + Macro 4 + GoToX 0 + Print '/*******************************************************************************/'^M^S + Print '/*---- ------------------------------------------------------------------------*/'^M^S + Print '/*******************************************************************************/'^M^S + Print ^E^E^D^D^D^D^D^D^D + SwitchIns + EndMacro + Macro 5 + GoToX 0 + Print '/* --------------------------------------- */'^M^S + Print '/* */'^M^S + Print '/* --------------------------------------- */'^M^S + Print ^E^E^D^D^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; D files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.D +; AutoBrackets Off + MultiLineComment 1 + ForceNewlineAtEOF On + CommentString // + Comment /* */ + +; GeneralFLAGS 467 ;kolorowanie liczb + GeneralFLAGS 80 + + StringFLAGS 3 + keywords1 asm,auto,bool,break,case,catch,char,class,const,const_cast + keywords1 continue,default,delete,do,double,dynamic_cast,else,enum + keywords1 explicit,export,extern,false,float,for,foreach,friend,goto,if,inline,int + keywords1 long,mutable,namespace,new,operator,private,protected,public + keywords1 register,reinterpret_cast,return,short,signed,sizeof,static + keywords1 static_cast,struct,switch,template,this,throw,true,try,return + keywords1 short,signed,sizeof,static,static_cast,struct,switch,template + keywords1 this,throw,true,try,typedef,typeid,typename,union,unsigned + keywords1 using,virtual,void,volatile,wchar_t,while + keywords2 and,and_eq,bitand,bitor,compl,not,not_eq,or,or_eq,xor,xor_eq +;this is added due to NDN bug + Keywords2 #if,#ifdef,#ifndef,#endif,#else,#elif,#define,#undef,#pragma,#line,import,#error +;RegKeyWords2 + regKeywords color lightgreen ^\s*#\s*(if(n?def)?|endif|else|elif|define|undef|pragma|line|include|error)\b + keywords2 defined,# +;regkeywords number + regkeywords color lightcyan (?<!\w)\.\d+([eE][+-]?\d+)?[fFlL]?\b,\b\d+\.(?!\w) + regkeywords color lightcyan \b(\d+[eE][+-]?\d+|\d+\.\d+([eE][+-]?\d+)?)[fFlL]?\b + regkeywords color lightcyan (?<!\.)\b(0+|[1-9]\d*|0[xX][0-9A-Fa-f]+)([uU](l|L)?|(l|L)[uU]?)?(?!\.)\b +;octal + regkeywords color cyan (?<!\.)\b(0[0-7]+)([uU](l|L)?|(l|L)[uU]?)?(?!\.)\b +;regkeywords string + regkeywords color lightmagenta L(?=[\'\"]) + +END + + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Haskell files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.HS +; AutoBrackets Off + MultiLineComment 1 + ForceNewlineAtEOF On +; CommentString // +; Comment /* */ + CommentString -- + +; GeneralFLAGS 467 ;kolorowanie liczb + GeneralFLAGS 80 + + StringFLAGS 3 + keywords1 Int,Double,Bool, if, then, else + + regkeywords color lightcyan (?<!\w)\.\d+([eE][+-]?\d+)?[fFlL]?\b,\b\d+\.(?!\w) + regkeywords color lightcyan \b(\d+[eE][+-]?\d+|\d+\.\d+([eE][+-]?\d+)?)[fFlL]?\b + regkeywords color lightcyan (?<!\.)\b(0+|[1-9]\d*|0[xX][0-9A-Fa-f]+)([uU](l|L)?|(l|L)[uU]?)?(?!\.)\b +;octal + regkeywords color cyan (?<!\.)\b(0[0-7]+)([uU](l|L)?|(l|L)[uU]?)?(?!\.)\b +;regkeywords string + regkeywords color lightmagenta L(?=[\'\"]) + +END + + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; JAVA files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.JAVA + AutoBrackets Off + MultiLineComment 1 + CommentString // + Comment /* */ + GeneralFLAGS 465 + StringFLAGS 3 + Keywords1 break,case,const,continue,default,do,else,super,new,final + Keywords1 for,goto,if,return,sizeof,static,switch,do,abstract,private + Keywords1 void,while,auto,typedef,public,try,catch,extends,protected + Keywords1 import,package,exception,throws,throw,finally,instanceof + Keywords1 System.in,System.out,System.err,interface,implements + Keywords2 char,int,long,short,String,signed,double,float,union,boolean + Keywords2 unsigned,struct,class,StringBuffer,true,false,this,null + Keywords2 FileInputStream,FileOutputStream,InputStreamReader + Keywords2 OutputStreamReader + COLORKEYWORDS on + Macro 1 + GoToX 0 + InsLine + Print '/*****************************************************************'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *****************************************************************/'^M^S + Print ^X^E^E^E^E^D^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print '/*'^M^S + Print ' *'^M^S + Print ' */'^M^S + Print ^X^E^G^E^E^D^D^D + EndMacro + Macro 3 + GotoX 0 + Print 'package ;'^M^M + Print 'import ;'^M^M + Print 'public class Main'^M'{'^M^M + Print ' public static void main(String []args)'^M'{'^M^M'}'^M + GotoX 0 + Print '}'^M + Print ^E^E^E^D^D^D^D^D^D^D^D + EndMacro + Macro 4 + GoToX 0 + Print '/*******************************************************************************/'^M^S + Print '/*---- ------------------------------------------------------------------------*/'^M^S + Print '/*******************************************************************************/'^M^S + Print ^E^E^D^D^D^D^D^D^D + SwitchIns + EndMacro + Macro 5 + GoToX 0 + Print '/* --------------------------------------- */'^M^S + Print '/* */'^M^S + Print '/* --------------------------------------- */'^M^S + Print ^E^E^D^D^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; C# files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.CS + AutoBrackets On + MultiLineComment 1 + CommentString // + Comment /* */ + GeneralFLAGS 465 + StringFLAGS 3 + Keywords1 break,case,const,continue,default,do,else,new,namespace + Keywords1 for,goto,if,return,sizeof,static,switch,abstract,private + Keywords1 void,while,public,try,catch,protected,as,base,checked,unchecked + Keywords1 using,throw,finally,System,Console,interface,delegate,explicit + Keywords1 extern,fixed,foreach,implicit,internal,is,lock,object,operator + Keywords1 out,override,params,readonly,ref,sealed,stackalloc,typeof + Keywords1 unchecked,unsafe,virtual,volatile + Keywords2 byte,char,int,long,short,string,double,float,bool,uint,ulong,ushort + Keywords2 struct,class,true,false,this,null,decimal,enum,event,sbyte + COLORKEYWORDS on + Macro 1 + GoToX 0 + InsLine + Print '/*****************************************************************'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *****************************************************************/'^M^S + Print ^X^E^E^E^E^D^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print '/*'^M^S + Print ' *'^M^S + Print ' */'^M^S + Print ^X^E^G^E^E^D^D^D + EndMacro + Macro 3 + GotoX 0 + Print 'using System;'^M^M + Print 'public class main'^M'{'^M^M + Print ' static void Main()'^M'{'^M^M'}'^M + GotoX 0 + Print '}'^M + Print ^E^E^E^D^D^D^D^D^D^D^D + EndMacro + Macro 4 + GoToX 0 + Print '/*******************************************************************************/'^M^S + Print '/*---- ------------------------------------------------------------------------*/'^M^S + Print '/*******************************************************************************/'^M^S + Print ^E^E^D^D^D^D^D^D^D + SwitchIns + EndMacro + Macro 5 + GoToX 0 + Print '/* --------------------------------------- */'^M^S + Print '/* */'^M^S + Print '/* --------------------------------------- */'^M^S + Print ^E^E^D^D^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Pascal/Delphi files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.DPK;*.DPR;*.PAS;*.PP + AutoBrackets Off + MultiLineComment 1 + Comment (* *),{ } + CommentString // + GeneralFLAGS 32 + StringFLAGS 204 + + BracketPairs asm;begin;case;dialog;try;record end try except;finally ifdef;ifndef endif repeat until if then while;for do + ; Reserved words + Keywords1 and,array,as,at,asm,begin,break,case,class,const,constructor + Keywords1 dec,continue,destructor,dispinterface,div,do,downto,else,end + Keywords1 except,exclude,exports,false,file,final,finalization,finally + Keywords1 for,function,goto,if,include,implementation,in,inc,inherited + Keywords1 initialization,interface,is,label,library,mod,nil,not,object + Keywords1 of,on,or,out,interface,packed,procedure,program,property + Keywords1 raise,record,repeat,resourcestring,result,sealed,set,shl,shr + Keywords1 sizeof,static,string,then,threadvar,to,true,try,type,unit + Keywords1 unsafe,until,uses,var,while,with,xor + ; Directives + Keywords2 absolute,abstract,assembler,automated,cdecl,contains,default + Keywords2 deprecated,dispid,dynamic,export,external,far,forward + Keywords2 implements,index,inline,interrupt,local,message,name,near + Keywords2 nodefault,overload,override,package,pascal,platform,private + Keywords2 protected,public,published,read,readonly,register + Keywords2 reintroduce,requires,resident,safecall,stdcall,stored,strict + Keywords2 varargs,virtual,write,writeonly + ; Base types + Keywords3 ansistring,bool,boolean,byte,cardinal,char,comp,currency + Keywords3 double,extended,longbool,longint,longword,real,real48,int64 + Keywords3 integer,pchar,pointer,shortint,single,smallint,shortstring + Keywords3 string,uint64,variant,widechar,widestring,word,wordbool + ; VP specific type? + Keywords3 smallword + + COLORKEYWORDS on + KEYWORDS COLOR BLACK Necromancer + KEYWORDS COLOR YELLOW/DARKGRAY NDN + RegKeywords Color lightgreen \{\$[^\}\{]+\} + Macro 1 + GoToX 0 + InsLine + Print '(*****************************************************************'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print '*****************************************************************)'^M^S + Print ^X^E^E^E^E^D^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print '(*'^M^S + Print ' *'^M^S + Print ' *)'^M^S + Print ^X^E^G^E^E^D^D^D + EndMacro + Macro 3 + Print 'begin'^M^M + Print 'end;' + WordLeft + MoveUp + EndMacro + Macro 4 + Print '{AH ' + Insertdate + Print ' }' + MoveLeft + EndMacro + Macro 5 + InsLine + Home + Print {²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²²} + Home + EndMacro + Macro 6 + InsLine + Home + Print {±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±} + Home + EndMacro + Macro 7 + InsLine + Home + Print {°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°} + Home + EndMacro + Macro 8 + GotoX 0 + Print 'program ;'^M^M + Print 'uses ;'^M^M + Print 'begin'^M^M + Print 'end.'^M + Print ^E^E^D^D + EndMacro + Macro 9 + GotoX 0 + Print 'unit ;'^M^M + Print 'interface'^M^M + Print 'uses ;'^M^M + Print 'implementation'^M^M + Print 'end.'^M + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Modula II files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.MOD,*.DEF + MultiLineComment 10 + Comment (* *) + CommentStart // + GeneralFLAGS 1 + HEXNUMFLAGS 1 + StringFLAGS 92 + OCTQNUMFLAGS 1 + Keywords1 AND,FOR,OR,ARRAY,FORWARD,POINTER,GOTO,RECORD,CASE,IF,REPEAT,CONST + Keywords1 SET,DIV,IN,THEN,DO,LABEL,TO,ELSE,LOOP,TYPE,ELSIF,MOD,UNTIL,EXIT + Keywords1 NOT,WHILE,EXPORT,OF,WITH + Keywords2 PROCEDURE,MODULE,END,BEGIN,FROM,BY,IMPLEMENTATION,RETURN + Keywords2 VAR,IMPORT,DEFINITION + Macro 1 + GoToX 0 + InsLine + Print '(*****************************************************************'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *****************************************************************)'^M^S + Print ^X^E^E^E^E^D^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print '(*'^M^S + Print ' *'^M^S + Print ' *)'^M^S + Print ^X^E^G^E^E^D^D^D + EndMacro + Macro 3 + Print 'begin'^M^M + Print 'end;' + WordLeft + MoveUp + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Makefiles (Borlands TASM Make) +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.MAK;MAKEFILE*.*;MAKE + GeneralFlags 8 + CommentStart # + OptimalFill On + RegKeywords color lightred \$\([\w]*?\) + + KeyWords1 !if,!ifdef,!ifndef,!elif,!endif,!else,.suffixes + RegKeywords color red \$[d]\([\w]*?\) + + RegKeywords color green \$(\*\*|\*|<|:|\.|&|@|\?) + RegKeywords color green \$\(<[DFBR]{1}\) +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Make files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.MAK;MAKEFILE.*;MAKE;configure.in + CommentString # + OptimalFill On + Keywords1 .NEWSOURCES,.SOURCE,.SOURCES,.TARGET,.TARGETROOT + Keywords1 .VERSION,BUILTINS,CWD,FIRSTTARGET,INPUTFILE + Keywords1 MAKEARGS,MAKEDIR,MAKEMACROS,MAKEPID,MAKESTATUS + Keywords1 MAKETARGETS,MAKEVERSION,status + Keywords2 %if,%ifdef,%ifndef,%elif,%elseif,%else,%endif + Keywords2 %foreach,%while,%end,%break,%continue,%abort + Keywords2 %chdir,%do,%echo,%error,%exec,%getenv,%include + Keywords2 %restart,%set,%setenv,%undef,%defined,%dir,%empty + Keywords2 %exists,%file,%length,%make,%member,%null, + Keywords2 %readable,%time,%writable + Macro 1 + GoToX 0 + InsLine + Print '#################################################################'^M^S + Print '#'^M^S + Print '#'^M^S + Print '#'^M^S + Print '#################################################################'^M^S + Print ^X^E^E^E^E^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print '#'^M^S + Print '#'^M^S + Print '#'^M^S + Print ^X^E^G^E^E^D^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Text files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.TXT;*.FMT;*.SMP + COLORKEYWORDS Off + AutoBrackets On +; AUTOWRAP On +; LEFTMARGIN 5 +; RIGHTMARGIN 60 +; PARAGRAPH 5 + CommentStart ; + GeneralFLAGS 526 + STRINGFLAGS 224 + Macro 1 + GoToX 0 + InsLine + Print ';================================================================'^M^S + Print ';'^M^S + Print ';'^M^S + Print ';'^M^S + Print ';================================================================'^M^S + Print ^X^E^E^E^E^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print ';'^M^S + Print ';'^M^S + Print ';'^M^S + Print ^X^E^G^E^E^D^D + EndMacro +; Swap Chars (as in vi "xp"). Place cursor on SECOND character + Macro 3 + BlockStart + Print ^D + BlockEnd + Cut + Print ^S + Paste + EndMacro +;Join Lines + Macro 4 + Print ^E + End + DelWordRight + Print ' ' + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; IAR Linker files. +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.XCL + MultiLineComment 10 + AutoBrackets Off + CommentString // + Comment /* */ + Comment -! -! + Macro 1 + GoToX 0 + InsLine + Print '//////////////////////////////////////////////////////////////////'^M^S + Print '//'^M^S + Print '//'^M^S + Print '//'^M^S + Print '//////////////////////////////////////////////////////////////////'^M^S + Print ^X^E^E^E^E^D^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print '//'^M^S + Print '//'^M^S + Print '//'^M^S + Print ^X^E^G^E^E^D^D^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; HTML Files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.htm;*.html;*.erb;*.asx;*.htt;*.htz;<<htm>,<<td> + Keywords1 A,ABBR,ACRONYM,ADDRESS,APPLET,AREA,B,BASE,BASEFONT,BDO,BIG,BLOCKQUOTE,BODY + Keywords1 BR,BUTTON,CAPTION,CENTER,CITE,CODE,COL,COLGROUP,DD,DEL,DFN,DIR,DIV,DL,DT,EM + Keywords1 FIELDSET,FONT,FORM,FRAME,FRAMESET,H1,H2,H3,H4,H5,H6,HEAD,HR,HTML,I,IFRAME,IMG + Keywords1 INPUT,INS,ISINDEX,KBD,LABEL,LEGEND,LI,LINK,MAP,MENU,META,NOFRAMES,NOSCRIPT + Keywords1 OBJECT,OL,OPTGROUP,OPTION,P,PARAM,PRE,Q,S,SAMP,SCRIPT,SELECT,SMALL,SPAN,STRIKE + Keywords1 STRONG,STYLE,SUB,SUP,TABLE,TBODY,TD,TEXTAREA,TFOOT,TH,THEAD,TITLE,TR,TT,U,UL,VAR + Keywords2 abbr,accept,accept-charset,accesskey,action,align,alink,alt,archive,axis + Keywords2 background,bgcolor,border,cellpadding,cellspacing,char,charoff,charset + Keywords2 checked,cite,class,classid,clear,code,codebase,codetype,color,cols,colspan + Keywords2 compact,content,coords,data,datetime,declare,defer,dir,disabled,enctype + Keywords2 face,for,frame,frameborder,headers,height,href,hreflang,hspace,http-equiv + Keywords2 id,ismap,label,lang,language,link,longdesc,marginheight,marginwidth,maxlength + Keywords2 media,method,multiple,name,noresize,noshade,nowrap,object,onblur,onchange + Keywords2 onclick,ondblclick,onfocus,onkeydown,onkeypress,onkeyup,onload,onmousedown + Keywords2 onmousemove,onmouseout,onmouseover,onmouseup,onreset,onselect,onsubmit,onunload + Keywords2 onunload,profile,prompt,readonly,readonly,rel,rev,rows,rows,rowspan,rules + Keywords2 scheme,scope,scrolling,selected,shape,size,span,src,standby,start,style + Keywords2 summary,tabindex,target,text,title,type,usemap,valign,value,valuetype,version + Keywords2 vlink,vspace,width + RegKeyWords color lightred class[a-z]*, + RegKeywords color lightgreen [a-z]*frame[a-z]*,margin[a-z]+,h[0-9], + Comment <!-- --> + MultiLineComment 1 + Macro 1 + GoToX 0 + InsLine + Print '<html>'^M + Print '<style type="text/css">'^M^M + Print '</style>'^M + Print '<body>'^M^M + Print '</body>'^M + Print '</html>' + Home + Print ^E^E^D^D^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; XML +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.XML;*.bdsproj;*.vlp;<<?xml> + GeneralFlags 1 + StringFlags 128 + + Keywords1 xml,version,encoding,standalone + Keywords2 no,yes,DOCTYPE,ELEMENT,ATTLIST + Comment <!-- --> + MultiLineComment 1 + RegKeyWords color lightred <[^/][^> ]+ + RegKeyWords color lightred </[^> ]+> + Macro 1 + GoToX 0 + InsLine + Print '<?xml version="1.0" encoding="UTF-8"?>'^M + Print '<>'^M^M + Print '</>' + Home + Print ^E^E^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; JAVASCRIPT, Proxy auto configuration files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.JS;*.PAC + MultiLineComment 1 + CommentString // + Comment /* */ + GeneralFLAGS 465 + StringFLAGS 3 + Keywords1 language,if,else,var,function,return + Keywords2 prompt,window,alert,null,location,{window,{,} + Keywords2 open,close,document,target,write,writeln, + Keywords2 onmousedown,captureevents,click,event,layers + Keywords2 button,mousedown,true,false,which + Macro 1 + GoToX 0 + Print '/*******************************************************************************/'^M^S + Print '/*---- ------------------------------------------------------------------------*/'^M^S + Print '/*******************************************************************************/'^M^S + Print ^E^E^D^D^D^D^D^D^D + SwitchIns + EndMacro + Macro 2 + GoToX 0 + Print '/* --------------------------------------- */'^M^S + Print '/* */'^M^S + Print '/* --------------------------------------- */'^M^S + Print ^E^E^D^D^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; JSON +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.json + MultiLineComment 1 + GeneralFLAGS 465 + StringFLAGS 3 + RegKeywords COLOR lightmagenta [a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*\: + RegKeywords COLOR lightmagenta "[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*"\: +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; COFFEE-SCRIPT +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.coffee + MultiLineComment 1 + CommentString # +; GeneralFLAGS 16 + GeneralFLAGS 465 + StringFLAGS 3 + Keywords1 language,if,else,var,function,return, for, while, in, class, extends, is, then + Keywords1 throw, of, when, switch, isnt, break, loop, unless + Keywords2 prompt,window,alert,null,location,{window,{,}, not, and, or + Keywords2 open,close,document,target,write,writeln, + Keywords2 onmousedown,captureevents,click,event,layers + Keywords2 button,mousedown,true,false,which + RegKeywords COLOR Yellow \@[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]* + RegKeywords COLOR Yellow \@ + RegKeywords COLOR lightmagenta [a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*\: +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; PYTHON +ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.py + MultiLineComment 1 + CommentString # + Comment """ /""" +; GeneralFLAGS 16 + GeneralFLAGS 465 + StringFLAGS 3 + Keywords1 False, class, finally, is, return + Keywords1 None, continue, for, lambda, try + Keywords1 True, from, nonlocal, while + Keywords1 and, del, global, not, with + Keywords1 as, elif, if, or, yield + Keywords1 assert, else, import, pass + Keywords1 break, except, in, raise + Keywords2 self + Keywords3 def + RegKeywords COLOR Yellow \@[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]* + RegKeywords COLOR Yellow \@ +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; SONG +ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.song + MultiLineComment 1 + CommentString # +; GeneralFLAGS 16 + GeneralFLAGS 465 + StringFLAGS 3 + Keywords1 harmony, end_harmony + Keywords1 song, end_song + Keywords1 pattern, end_pattern + Keywords1 melody, end_melody + Keywords1 arrangement, end_arrangement + Keywords1 at + Keywords1 drums, harmony, bass, guitar, melody, solo, backmelody + Keywords2 extends, none, hits, chords, notes, octave, length, delta + Keywords3 use, play, set, apply, push, replace +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; .htaccess +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES .htaccess + CommentString # +; GeneralFLAGS 16 + GeneralFLAGS 465 + StringFLAGS 3 + Keywords1 + Keywords2 RewriteEngine, RewriteRule + Keywords2 order, deny, allow + Keywords3 + RegKeywords COLOR Yellow \@[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]* + RegKeywords COLOR Yellow \@ + RegKeywords COLOR lightmagenta [a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*\: +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Ruby +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.rb; *.yml + MultiLineComment 1 + CommentString # +; GeneralFLAGS 16 + GeneralFLAGS 465 + StringFLAGS 3 + Keywords1 language,if,else,var,function,return, for, while, in, class, extends, is, then + Keywords1 throw, of, when, switch, isnt, break, loop, unless, module, end + Keywords2 prompt,window,alert,null,location,{window,{,}, not, and, or + Keywords2 open,close,document,target,write,writeln, + Keywords2 onmousedown,captureevents,click,event,layers + Keywords2 button,mousedown,true,false,which + RegKeywords COLOR Yellow \@[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]* + RegKeywords COLOR Yellow \@ + RegKeywords COLOR lightmagenta [a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*\: +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; WINDOWS Files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.INI;*.INF;MSDOS.SYS;*.REG + Keywords1 file://Folder.htt, + Keywords2 Clsid,UICLSID,InfoTip,Default,Logo,WideLogo, + Keywords2 ConfirmFileOp,cdfurl,Icon,Type,Order, + Keywords2 Zoom,Sort,Direct,Color,PatternId,MenuName,ToolTipText, + Keywords2 HelpText,Attributes,IconIndex,Solid,Width,WebViewTemplate,NT5, + Keywords color cyan HTMLInfoTipFile + Regkeywords color lightgreen Owner,Personal[^=]*,BuyURL,PersistMoniker(Preview)? + Regkeywords color Red \[[^\]]+\] + Regkeywords color lightBLUE,Icon[^=]* + Regkeywords color lightmagenta LocalizedResourceName, + Regkeywords color yellow .*\.lnk + Keywords1 WinDir,WinBootDir,HostWinBootDrv,SystemReg,LoadTop, + Keywords1 DoubleBuffer,AutoScan,WinVer,Network,DisableLog, + RegKeyWords color white Boot[a-z]*, + Keywords color lightblue Logo + Regkeywords color LightRed ^[^=]*= + commentstring ; +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; Shell scripts, files starting with "#!" +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.SH,>#![ ]*/bin/<,.bashrc,.profile,interfaces + GeneralFLAGS 17 + STRINGFLAGS 7 + CommentString # + BracketPairs if;elif then while do case esac for do + Keywords1 if,then,while,do,case,esac,done,test,else,in,break,elif,fi,for,function,export + Keywords2 exit,echo,shift,cd,rm,mv,cp,mkdir,rmdir,chmod,pushd,popd,ln,eval,clear + Macro 1 + FileStart + Home + InsLine + Print '#!/bin/bash' + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; PERL files: GENERALFLAGS = case sensitive + C numbers +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.PL, *.PM, *.SH, *.SUB;*.MU; + GeneralFlags 81 + StringFlags 131 + MultilineComment 1 + CommentString # + Comment __END__ _-_-_ + Keywords1 cmp,eq,gt,lt,ne,and,not,or,xor + Keywords1 continue,do,else,elsif,for,foreach,goto,if,last,next,return, + Keywords1 unless,until,while + Keywords1 package,sub,require,use,x,local,my,our + Keywords2 __LINE__, __FILE__ + Keywords2 abs,atan2,cos,exp,int,log,rand,sin,sqrt,srand,wantarray + Keywords2 pop, push, shift, splice, unshift, delete, each, exists, keys, + Keywords2 grep,join,map,reverse,sort,values,defined,scalar,ref,undef + Keywords2 seek, sysread, sysseek, syswrite, tell, truncate, + Keywords2 binmode, close, eof, fileno, flock, open, rename, select, unlink, utime + Keywords2 eval,exit,die, glob, read, readline, print, printf, warn + Keywords2 alarm,sleep,pos,quotemeta,split, + Keywords2 chomp,chop,index,lc,length,sprintf,substr,uc + Keywords2 localtime,gmtime,time,pack,unpack,vec,chr,ord,hex,ord + Keywords3 $_,@_,$! + RegKeywords COLOR LightBlue \$[0-9]+ + RegKeywords COLOR Yellow \$([a-zA-Z][_a-zA-Z0-9]*|_[_a-zA-Z0-9]+) + RegKeywords COLOR LightMagenta @([a-zA-Z][_a-zA-Z0-9]*|_[_a-zA-Z0-9]+) + RegKeywords COLOR LightCyan [_a-zA-Z0-9]+ *(?==>) + Macro 1 + Print '#! perl -w'^M'use strict;'^M^M + EndMacro + Macro 2 + Print 'while (<>) {'^M^M'}'^M#5#5' ' + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; PHP files: GENERALFLAGS = case sensitive + C numbers; Comments: #, // +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.PHP + GeneralFLAGS 16 + STRINGFLAGS 7 + CommentString #, // + MultiLineComment 1 + Comment /* */ + Keywords1 as,else,for,foreach,function,global,if,return,xor, + Keywords1 array,list + Keywords1 new,class,?PHP,protected,private,public,var,include,require_once + Keywords1 EOD,__construct + Keywords2 array_slice,array_pop,date,define + Keywords2 echo,print,print_r,sprintf,error_log,trigger_error + Keywords2 fclose,file,fopen,fwrite,is_readable,readfile,basename + Keywords2 isset,is_null,mktime,setcookie + Keywords2 implode,explode,bin2hex,crc32,md5,str_pad,strlen,trim,strstr,strpos + Keywords2 preg_match,error_reporting,set_error_handler + RegKeywords COLOR Yellow \$[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]* + Macro 1 + GoToX 0 + Print '/*******************************************************************************/'^M^S + Print '/*---- ------------------------------------------------------------------------*/'^M^S + Print '/*******************************************************************************/'^M^S + Print ^E^E^D^D^D^D^D^D^D + SwitchIns + EndMacro + Macro 2 + GoToX 0 + Print '/* --------------------------------------- */'^M^S + Print '/* */'^M^S + Print '/* --------------------------------------- */'^M^S + Print ^E^E^D^D^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; RESOURCES +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.rc + Keywords1 menuitem, + Keywords2 separator,popup, + Commentstart # + Commentstring # +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; FOXPRO/SQL +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.PRG;*.QPR;*.SQL + Keywords1 order,by,on,inner,join,=,<,>,<=,>=,<>,or,and,not,with, + Keywords1 go,execute,if,insert,nodelete,double,skip,.null., + Keywords1 define,of,on,popup,do,if,zoom,parameter,MAX,NORMAL,deactiv, + Keywords1 shadow,push,append,close,release,exit,recno,quit, + Keywords1 activate,deactivate,then,else,for,case,browse,eof,norm,@, + Keywords1 FUNCTION,PROCEDURE,endif,read,say,locate,endcase,return,pop,get, + Keywords1 menu,pad,window,bar,prompt,selection,parametr,clear,show,list, + Keywords1 database,from,to,set,title,endfor,footer,message,talk,off, + Keywords1 multi,margin,mark,all,font,picture,size,default,windows,cycle, + Keywords1 float,grow,minimize,color,top,bottom,noshow,fields,lock,noappend, + Keywords1 select,from,in,where,begin,end,delete,hide,index, + Keywords1 safety,replicate,otherwise + Keywords2 alltrim,year,date,use,empty,mline,lower,vartype,newobject, + Keywords2 addproperty,evaluate,substr,file,len,asc, + Keywords2 count + Commentstart *,&& + Commentstring && + Comment (* *) +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; ORACLE/SQL +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.SQL + StringFlags 64 + MultiLineComment 1 + Commentstring -- + Comment /* */ + Keywords1 order,by,on,inner,join,=,<,>,<=,>=,<>,or,and,not, + Keywords1 declare,undefine,define,if,elsif,then,else,for,case,decode,is,as + Keywords1 function,procedure,loop,default,first,last,while,between,exit + Keywords1 select,from,in,out,where,begin,end,type,const,set,return,when + Keywords1 drop,table,create,alter,insert,into,values,cursor,row,execute,add + Keywords1 open,fetch,close,update,commit,rollback,desc,describe,like,pragma + Keywords1 trigger,disable,enable,replace,all,triggers,default,constraint,check + Keywords1 show,errors,exception,raise,raise_application_error,exception_init + Keywords1 current,of,distinct,before,each + Regkeywords color red %rowcount,%found,%notfound,%isopen,:new,:old + Keywords2 substr,max,avg,min,dbms_output.put_line,sysdate,lower,upper,others + Keywords2 sqlcode,sqlerrm,trunc,round,months_between,no_data_found + Keywords3 null,date,varchar2,number,boolean + Regkeywords color lightgray %type,%rowtype +; highlight labels + Regkeywords color lightred <<[^ \>]+>> , &[\w]+ +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; URL Files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.url + Keywords1 URL,=,Modified,baseurl,description + Keywords2 [InternetShortcut],http://www,[DEFAULT],[CeQuadrat] + Regkeywords color lightblue http:.*,ftp:.*,[^\x20\.]*@[^\x20]*,www\..* +end + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; OS/2 Command File +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.cmd + Keywords1 say,if,then,do,end,else,cls,call,echo,@goto, + Keywords1 @echo,exit,parse,return,while,forever,title, + Keywords1 until,arg,rem,set,copy,del,pause,when,otherwise, + Keywords1 location,class,setupstring,ObjMode,background,SysOs2Ver, + Keywords2 sysloadfuncs,rxfuncadd,LastPos,syscreateobject,word, + Keywords2 translate,getyesno,charout,sysgetkey,Directory, + Keywords2 lineout,linein,sysfiledelete,syscls,sysmkdir,enter,pull,signal, + Keywords2 lines,beep,goto,SubStr,errorlevel,filespec,sysgetmessage,left, + Keywords2 reverse,drive,subword,words,strip,word,sysdrivemap,RxFuncQuery, + Keywords2 date,sysini,pos,value,GetBootDrive,Stream,CharIn,c2x,x2c,EXIST + comment /*,*/ + commentstart *, + SwitchHighLight=ON + MultiLineComment 20 +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; FORTRAN !does not support tabs in files -> fixed format! +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.F;*.FPP;*.FTN;*.FOR;*.I;*.F90;*.I90;*.F66;*.F77 + GeneralFLAGS 80 + StringFlags 192 + CommentStart c,C,* + CommentString ! + + Keywords1 function,parameter,data,program, module, subroutine, class, procedure + Keywords1 contains, type, public, use + + Keywords2 true,false,not,and,or,eqv,neqv,lt,le,eq,ge,gt,ne + Keywords2 if,goto,then,endif,elseif,else,do,continue,dowhile,enddo,cycle + Keywords2 exit,return,end,mod,pause,print,read,stop + Keywords3 integer,real,double precision,complex,logical,character,record + Keywords3 structure,dimension, + Keywords2 implicit none +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; LISP (AutoCAD AutoLisp) +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.LSP;*.MNL + GeneralFlags 64 + StringFlags 33 + Comment ;| |; + CommentString ; + MultiLineComment 1 + RegKeywords Color LightRed ' + RegKeywords Color LightCyan \(,\) + RegKeywords Color LightMagenta \*[^\x20]*?[^\x20]\* + RegKeywords Color LightBlue vla-[^\x20\)]* + Keywords1 +,-,*,/,=,/=,<,<=,>,>=,~,1+,1- + Keywords1 abs,acad_colordlg,acad_helpdlg,acad_strlsort,action_tile + Keywords1 add_list,alert,alloc,and,angle,angtof,angtos,append,apply + Keywords1 arx,arxload,arxunload,ascii,assoc,atan,atof,atoi,atom + Keywords1 atoms-family,autoarxload,autoload,Boole,boundp,caddr,cadr + Keywords1 car,cdr,chr,client_data_tile,close,command,cond,cons,cos + Keywords1 cvunit,defun,defun-q,defun-q-list-ref,defun-q-list-set + Keywords1 dictadd,dictnext,dictremove,dictrename,dictsearch + Keywords1 dimx_tile,dimy_tile,distance,distof,done_dialog,end_image + Keywords1 end_list,entdel,entget,entlast,entmake,entmakex,entmod + Keywords1 entnext,entsel,entupd,eq,equal,*error*,eval,exit,exp,expand + Keywords1 expt,fill_image,findfile,fix,float,foreach,function,gc,gcd + Keywords1 get_attr,get_tile,getangle,getcfg,getcname,getcorner,getdist + Keywords1 getenv,getfiled,getint,getkword,getorient,getpoint,getreal + Keywords1 getstring,getvar,graphscr,grclear,grdraw,grread,grtext,grvecs + Keywords1 handent,help,if,initdia,initget,inters,itoa,lambda,last + Keywords1 layoutlist,length,list,listp,load,load_dialog,log,logand + Keywords1 logior,lsh,mapcar,max,mem,member,menucmd,menugroup,min + Keywords1 minusp,mode_tile,namedobjdict,nentsel,nentselp,new_dialog + Keywords1 nil,not,nth,null,numberp,open,or,osnap,pause,pi,polar,prin1 + Keywords1 princ,print,progn,prompt,quit,quote,read,read-char,read-line + Keywords1 redraw,regapp,rem,repeat,reverse,rtos,set,set_tile,setcfg + Keywords1 setenv,setfunhelp,setq,setvar,setview,sin,slide_image,snvalid + Keywords1 sqrt,ssadd,ssdel,ssget,ssgetfirst,sslength,ssmemb,ssname + Keywords1 ssnamex,sssetfirst,startapp,start_dialog,start_image + Keywords1 start_list,strcase,strcat,strlen,subst,substr,T,tablet + Keywords1 tblnext,tblobjname,tblsearch,term_dialog,terpri,textbox + Keywords1 textpage,textscr,trace,trans,type,unload_dialog,untrace + Keywords1 vector_image,ver,vports,wcmatch,while,write-char,write-line + Keywords1 xdroom,xdsize,zerop + Keywords2 vl-acad-defun,vl-acad-undefun,vl-arx-import,vl-bb-ref + Keywords2 vl-bb-set,vl-catch-all-apply,vl-catch-all-error-message + Keywords2 vl-catch-all-error-p,vl-cmdf,vl-consp,vl-directory-files + Keywords2 vl-doc-export,vl-doc-import,vl-doc-ref,vl-doc-set,vl-every + Keywords2 vl-exit-with-error,vl-exit-with-value,vl-file-copy + Keywords2 vl-file-delete,vl-file-directory-p,vl-file-rename + Keywords2 vl-file-size,vl-file-systime,vi-filename-base + Keywords2 vl-filename-directory,vl-filename-extension + Keywords2 vl-filename-mktemp,vl-get-resource,vl-list*,vl-list->string + Keywords2 vl-list-exported-functions,vl-list-length,vl-list-loaded-vix + Keywords2 vl-load-all,vl-load-com,vl-load-reactors,vl-member-if + Keywords2 vl-member-if-not,vl-position,vl-prin1-to-string + Keywords2 vl-princ-to-string,vl-propagate,vl-registry-delete + Keywords2 vl-registry-descendents,vl-registry-read,vl-registry-write + Keywords2 vl-remove,vl-remove-if,vl-remove-if-not,vl-some,vl-sort + Keywords2 vl-sort-i,vl-string->list,vl-string-elt,vl-string-left-trim + Keywords2 vl-string-mismatch,vl-string-position,vl-string-right-trim + Keywords2 vl-string-search,vl-string-subst,vl-string-translate + Keywords2 vl-string-trim,vl-symbol-name,vl-symbol-value,vl-symbolp + Keywords2 vl-unload-vix,vl-vbaload,vl-vbarun,vl-vlx-loaded-p + Keywords2 vlax-3D-point,vlax-add-cmd,vlax-create-object + Keywords2 vlax-curve-getArea,vlax-curve-getDistAtParam + Keywords2 vlax-curve-getDistAtPoint,vlax-curve-getEndParam + Keywords2 vlax-curve-getEndPoint,vlax-curve-getParamAtDist + Keywords2 vlax-curve-getParamAtPoint,vlax-curve-getPointAtDist + Keywords2 vlax-curve-getPointAtParam,vlax-curve-getStartParam + Keywords2 vlax-curve-getStartPoint,vlax-curve-isClosed + Keywords2 vlax-curve-isPeriodic,vlax-curve-isPlanar + Keywords2 vlax-curve-getClosestPointTo + Keywords2 vlax-curve-getClosestPointToProjection + Keywords2 vlax-curve-getFirstDeriv,vlax-curve-getSecondDeriv + Keywords2 vlax-dump-object,vlax-ename->vla-object,vlax-erased-p + Keywords2 vlax-for,vlax-get-acad-object,vlax-get-object + Keywords2 vlax-get-or-create-object,vlax-get-property + Keywords2 vlax-import-type-library,vlax-invoke-method + Keywords2 vlax-ldata-delete,vlax-ldata-get,vlax-ldata-list + Keywords2 vlax-ldata-put,vlax-ldata-test,vlax-make-safearray + Keywords2 vlax-make-variant,vlax-map-collection + Keywords2 vlax-method-applicable-p,vlax-object-released-p + Keywords2 vlax-product-key,vlax-property-available-p + Keywords2 vlax-put-property,vlax-read-enabled-p,vlax-release-object + Keywords2 vlax-remove-cmd,vlax-safearray-fill,vlax-safearray-get-dim + Keywords2 vlax-safearray-get-element,vlax-safearray-get-l-bound + Keywords2 vlax-safearray-get-u-bound,vlax-safearray-put-element + Keywords2 vlax-safearray-type,vlax-safearray->list,vlax-tmatrix + Keywords2 vlax-typeinfo-available-p,vlax-variant-change-type + Keywords2 vlax-variant-type,vlax-variant-value,vlax-vla-object->ename + Keywords2 vlax-write-enabled-p,vlisp-compile,vlr-acdb-reactor + Keywords2 vlr-add,vlr-added-p,vlr-beep-reaction,vlr-command-reactor + Keywords2 vlr-current-reaction-name,vlr-data,vlr-data-set + Keywords2 vlr-deepclone-reactor,vlr-docmanager-reactor,vlr-dwg-reactor + Keywords2 vlr-dxf-reactor,vlr-editor-reactor,vlr-insert-reactor + Keywords2 vlr-linker-reactor,vlr-lisp-reactor,vlr-miscellaneous-reactor + Keywords2 vlr-mouse-reactor,vlr-notification,vlr-object-reactor + Keywords2 vlr-owner-add,vlr-owner-remove,vlr-owners,vlr-pers + Keywords2 vlr-pers-list,vlr-pers-p,vlr-pers-release,vlr-reaction-names + Keywords2 vlr-reaction-set,vlr-reactions,vlr-reactors,vlr-remove + Keywords2 vlr-remove-all,vlr-set-notification,vlr-sysvar-reactor + Keywords2 vlr-toolbar-reactor,vlr-trace-reaction,vlr-type,vlr-types + Keywords2 vlr-undo-reactor,vlr-wblock-reactor,vlr-window-reactor + Keywords2 vlr-xref-reactor +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; DCL (AutoCAD dialogs) +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.DCL + GeneralFlags 65 + StringFlags 33 + Comment /* */ + CommentString // + MultiLineComment 1 + RegKeywords Color LightCyan {,} + RegKeywords Color White :,=,; + Keywords1 action,alignment,allow_accept,aspect_ratio,big_increment + Keywords1 children_alignment,children_fixed_height + Keywords1 children_fixed_width,color,edit_limit,edit_width,fixed_height + Keywords1 fixed_width,fixed_width_font,height,initial_focus,is_bold + Keywords1 is_cancel,is_default,is_enabled,is_tab_stop,key,label,layout + Keywords1 list,max_value,min_value,mnemonic,multiple_select + Keywords1 password_char,small_increment,tabs,tab_truncate,value,width + Keywords1 horizontal_margin,vertical_margin,type,boxed + Keywords1 dialog,cluster,radio_cluster,tile,text,image,button + Keywords1 image_button,toggle,radio_button,list_box,edit_box,popup_list + Keywords1 slider,spacer,errmsg,horizontal_alignment,vertiacal_alignment + Keywords2 row,column,boxed_row,boxed_column,radio_row,radio_column + Keywords2 boxed_radio_row,boxed_radio_column,concatenation,paragraph + Keywords2 text_part,text_25,spacer_0,spacer_1,default_button + Keywords2 retirement_button,ok_button,cancel_button,help_button + Keywords2 info_button,ok_only,ok_cancel,ok_cancel_help + Keywords2 ok_cancel_help_info,errtile,ok_cancel_help_errtile + Keywords2 ok_cancel_err,default_dcl_settings,image_block,icon_image + Keywords2 edit12_box,edit32_box,swatch,color_palette_1_7 + Keywords2 color_palette_1_9,color_palette_0_9,color_palette_250_255 + Keywords2 std_rq_color,files_topdf,files_bottomdf,fcf_ibut,fcf_ebox + Keywords2 fcf_ebox1,fcf_ibut1 + Keywords3 none,true,false,left,top,right,bottom,centered,horizontal + Keywords3 vertical,audit_level,max_lines,help_on_help_filename + Keywords3 help_on_help_label + Keywords3 dialog_line,dialog_foreground,dialog_background + Keywords3 graphics_background,black,red,yellow,green,cyan,blue,magenta + Keywords3 white,graphics_foreground +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; TeX +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.TEX;*.DTX;*.STY;*.BST;*.IST + GeneralFLAGS 88 + StringFlags 192 + CommentString % + OptimalFill On + BracketPairs begin end +; COLORKEYWORDS On + AutoBrackets On + Keywords1 document,bold,italic,margin,newpage,bigskip,noindent + RegKeyWords Color red \\footnote{[a-z].*} + RegKeyWords Color yellow {[a-z].*} +; this should highlight all chapter lines... + RegKeyWords Color white \\((sub|)*paragraph|(sub|)*section|chapter|part)(\[.*\]|)\{.*\} +; RegKeyWords Color white/lightblue \\((sub|)*paragraph|(sub|)*section|chapter|part)(\[.*\]|)\{.*\} +; this should highlight all keywords + RegKeywords color lightred \\[\w]* + Macro 1 + GoToX 0 + InsLine + Print '%==============================================='^M^S + Print '%'^M^S + Print '%'^M^S + Print '%'^M^S + Print '%==============================================='^M^S + EndMacro + Macro 2 + GotoX 0 + InsLine + Print '%'^M^S + Print '%'^M^S + Print '%'^M^S + EndMacro + Macro 3 +; Swap Chars (as in vi "xp"). Place cursor on SECOND character + BlockStart + Print ^D + BlockEnd + Cut + Print ^S + Paste + EndMacro +;Join Lines + Macro 4 + Print ^E + End + DelWordRight + Print ' ' + EndMacro + Macro 5 + Print '\textit{ }' + MoveLeft 2 + EndMacro + Macro 6 + Print '\textbf{ }' + MoveLeft 2 + EndMacro + Macro 7 + Print '\textit{888 }' + MoveLeft 2 + EndMacro + Macro 8 + GoToX 0 + InsLine + Print ' \marginpar{\scriptsize{}}' + MoveLeft 2 + EndMacro + Macro 9 + GotoX 0 + Print '\bigskip' + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; V+ +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.V2 + AutoBrackets Off + MultiLineComment 0 + CommentString ; + GeneralFLAGS 64 + StringFLAGS 32 + Keywords1 auto,global,local,.program,if,not,define,.end,end,then,else + Keywords1 .doubles,.locations,.strings,.reals + Keywords2 call,type,abs,do,exit,for,to,until,case,value,of,true,false,any + Keywords2 and,or,return,while,enable,disable,attach,detach,$encode,getc + Keywords2 $mid,len,abort,execute,fopen,fclose,fcmnd,read,write,$chr,sig + Keywords2 tool,break,close,closei,move,moves,departs,below,ready,iostat + Keywords2 goto,strdif,val,wait,min,max,open,openi,trans,mod,fset,gpanel + Keywords2 gcolor,gtype,getevent,garc,gflood,gtexture,fdelete,speed,decompose + Keywords2 here,prompt,ignore,set,calibrate,react,dos,reacte,bits,accel,drive + BracketPairs program;case;if;for end until;while do +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; CSS Files: case insensitive; adapted from the CSS1 W3C specification at http://www.w3.org/TR/REC-CSS1 +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.CSS + MultiLineComment 1 + GeneralFlags 0 + Comment /* */ + Keywords1 A,BODY,DIV,EM,H1,H2,H3,HTML,P + Keywords2 link,visited,active,first-line,first-letter + Keywords3 font-family,font-style,font-weight,font-variant,font + Keywords4 bold,bolder,lighter, + Keywords4 italic,small-caps + Keywords4 xx-small,x-small,small,medium,large,x-large,xx-large,larger,smaller + Keywords4 normal,none,url + Keywords3 word-spacing,letter-spacing,text-decoration + Keywords4 underline,overline,line-through,blink + Keywords3 color,background-color,background,background-image,background-attachment,background-repeat,background-position + Keywords4 transparent,rgb + Keywords3 vertical-align + Keywords4 baseline,sub,super,top,text-top,middle,bottom,text-bottom,top,bottom + Keywords3 text-transform + Keywords4 capitalize,uppercase,lowercase + Keywords3 text-align + Keywords4 left,right,center,justify + Keywords3 text-indent,line-height + Keywords3 margin-top,margin-right,margin-bottom,margin-left,margin + Keywords3 padding-top,padding-right,padding-bottom,padding-left,,padding + Keywords3 border-top-width,border-right-width,border-bottom-width,border-left-width,border-width + Keywords4 thin,medium,thick + Keywords3 border-color + Keywords3 border-style + + KeyWords COLOR lightcyan aqua + KeyWords COLOR black black + KeyWords COLOR lightblue blue + KeyWords COLOR lightmagenta fuchsia + KeyWords COLOR darkgray gray + KeyWords COLOR green green + KeyWords COLOR lightgreen lime + KeyWords COLOR red maroon + KeyWords COLOR blue navy + KeyWords COLOR brown olive + KeyWords COLOR magenta purple + KeyWords COLOR lightred red + KeyWords COLOR lightgray silver + KeyWords COLOR cyan teal + KeyWords COLOR white white + KeyWords COLOR yellow yellow + + RegKeywords color lightred \$\([\w|\-|\+]*?\) + +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; LUA files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.LUA + AutoBrackets Off + CommentString -- + GeneralFLAGS 65 + StringFLAGS 3 + BracketPairs function;do;then end for do + Keywords1 and,break,do,else,elseif,false,for,function,if,end + Keywords1 in,local,nil,not,or,repeat,return,then,true,until,while + Keywords2 assert,collectgarbage,dofile,error,gcinfo,loadfile,loadstring + Keywords2 print,tonumber,tostring,type,unpack + Keywords3 call,dostring,foreach,foreachi,getn,globals,newtype + Keywords3 rawget,rawset,require,sort,tinsert,tremove + Keywords4 abs,acos,asin,atan,atan2,ceil,cos,deg,exp + Keywords4 floor,format,frexp,gsub,ldexp,log,log10,max,min,mod,rad,random,randomseed + Keywords4 sin,sqrt,strbyte,strchar,strfind,strlen,strlower,strrep,strsub,strupper,tan + Keywords5 openfile,closefile,readfrom,writeto,appendto + Keywords5 remove,rename,flush,seek,tmpfile,tmpname,read,write + Keywords5 clock,date,difftime,execute,exit,getenv,setlocale,time + Keywords6 string.byte,string.char,string.dump,string.find,string.len + Keywords6 string.lower,string.rep,string.sub,string.upper,string.format,string.gfind,string.gsub + Keywords6 table.concat,table.foreach,table.foreachi,table.getn,table.sort,table.insert,table.remove,table.setn + Keywords6 math.abs,math.acos,math.asin,math.atan,math.atan2,math.ceil,math.cos,math.deg,math.exp + Keywords6 math.floor,math.frexp,math.ldexp,math.log,math.log10,math.max,math.min,math.mod + Keywords6 math.pi,math.rad,math.random,math.randomseed,math.sin,math.sqrt,math.tan + COLORKEYWORDS on + HIGHLIGHT on + Macro 1 + GoToX 0 + InsLine + Print '/*****************************************************************'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *'^M^S + Print ' *****************************************************************/'^M^S + Print ^X^E^E^E^E^D^D^D + EndMacro + Macro 2 + GotoX 0 + InsLine + Print '/*'^M^S + Print ' *'^M^S + Print ' */'^M^S + Print ^X^E^G^E^E^D^D^D + EndMacro + Macro 3 + GoToX 0 + Print '/*******************************************************************************/'^M^S + Print '/*---- ------------------------------------------------------------------------*/'^M^S + Print '/*******************************************************************************/'^M^S + Print ^E^E^D^D^D^D^D^D^D + SwitchIns + EndMacro + Macro 4 + GoToX 0 + Print '/* --------------------------------------- */'^M^S + Print '/* */'^M^S + Print '/* --------------------------------------- */'^M^S + Print ^E^E^D^D^D + EndMacro +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; GRUB config files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES MENU.LST;GRUB.CONF + GeneralFlags 8 + CommentStart # + ColorKeywords On + RegKeywords color red \([hf]d\d{1}(|\,\d{1})\) + RegKeywords color lightgray ^title.+$ + KeyWords1 color,timeout,default + KeyWords2 find,chainloader,savedefault,configfile,root,rootnoverify,boot + KeyWords2 reboot,quit,commandline,halt,map + RegKeywords color green ^fallback[ ]\d*$ +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; TCL-Script files +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.tcl + Generalflags 1 + Stringflags 1 + Commentstring # + Colorkeywords ON + TabSize 4 + +; internal keywords + KeyWords1 set,unset,incr,string,length,bytelength,compare,equal,index,is,map,match + KeyWords1 range,repeat,replace,tolower,totitle,toupper,trim,trimleft,trimright + KeyWords1 puts,regexp,llength,lrange,lsearch,lindex,lsort,linsert,expr,catch + KeyWords1 if,elseif,else,for,foreach,while,proc,namespace,eval,default,variable + KeyWords1 regsub,append,lappend,binary,format,scan,split,global,socket +; common keywords + KeyWords2 argc,argv,argv0 +; type identifiers + KeyWords3 list,array +; TK commands + KeyWords4 bell,entry,loadTk,raise,tk_focusFollowsMouse,tk_textPaste + KeyWords4 bind,event,lower,scale,tk_focusNext,tkerror + KeyWords4 bindtags,focus,menu,scrollbar,tk_focusPrev,tkvars + KeyWords4 bitmap,font,menubutton,selection,tk_getOpenFile,tkwait + KeyWords4 button,frame,message,send,tk_getSaveFile,toplevel + KeyWords4 canvas,grab,option,spinbox,tk_menuSetFocus,winfo + KeyWords4 checkbutton,grid,options,text,tk_messageBox,wm + KeyWords4 clipboard,image,pack,tk,tk_optionMenu + KeyWords4 colors,keysyms,panedwindow,tk_bisque,tk_popup + KeyWords4 console,label,photo,tk_chooseColor,tk_setPalette + KeyWords4 labelframe,place,tk_chooseDirectory,tk_textCopy + KeyWords4 destroy,listbox,radiobutton,tk_dialog,tk_textCut +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; COBOL +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.CBL;*.COB + StringFlags 131 + CommentStart *,*> + CommentStartPos 6 + RegKeywords color lightgray [A-Z]*\-[A-Z]* + RegKeywords color LightRed [.] + RegKeywords color LightRed [:] + RegKeywords color Lightgray [A-Z]*\-[0-9]* + BracketPairs IF END-IF PERFORM END-PERFORM + Keywords2 ACCEPT,ACCESS,ADD,ADDRESS,ADVANCING,AFTER,ALL,ALLOWING, + Keywords2 ALPHABET,ALPHABETIC,ALPHABETIC-LOWER,ALPHABETIC-UPPER, + Keywords2 ALPHANUMERIC,ALPHANUMERIC-EDITED,ALSO,ALTER,ALTERNATE, + Keywords2 AND,ANY,APPLY,ARE,AREA,AREAS,ARITHMETIC,AS,ASCENDING, + Keywords2 ASSIGN,AT,AUTHOR,B-AND,BASED-STORAGE,BASED,STORAGE,BASIS,BEFORE,BEGIN + Keywords2 BEGINNING,B-EXOR + Keywords2 BETWEEN,BINARY,BIT,BITS,BLANK,B-LESS,BLOCK,B-NOT,BOOLEAN,B-OR, + Keywords2 BOTTOM,BY,CALL,CANCEL,CBL,CD,CF,CH,CHARACTER,CHARACTERS, + Keywords2 CLASS,CLASS-ID,CLOCK-UNITS,COBOL,CODE,CODE-SET, + Keywords2 COLLATING,COLUMN,COMMA,COMMAND,COMMON,COMMUNICATION,COMPUTE, + Keywords2 COM-REG,CONFIGURATION,CONTAINED,CONTAINS, + Keywords2 CONTENT,CONTINUE,CONTROL,CONTROL-AREA,CONTROLS,CONSOLE,CONSTANT, + Keywords2 CONVERTING,COPY,CORR,CORRESPONDING,COUNT,CURRENCY, + Keywords2 CURRENT,CURSOR,CUSTOM-ATTRIBUTE,CYCLE,DATE,DATE-COMPILED,DATE-WRITTEN,DAY, + Keywords2 DAY-OF-WEEK,DB,DB-ACCESS-CONTROL-KEY,DBCS,DB-DATA-NAME, + Keywords2 DB-EXCEPTION,DB-RECORD-NAME,DB-SET-NAME,DB-STATUS,DE,DEBUG + Keywords2 ITEM,DEBUG-NAME,DEBUG-SUB,DEBUG-CONTENTS,DEBUGGING, + Keywords2 DEBUG-ITEM,DEBUG-LINE,DEBUG-SUB-1, + Keywords2 DEBUG-SUB-2,DEBUG-SUB-3,DECIMAL-POINT,DECLARATIVES, + Keywords2 DEFAULT,DELEGATE,DELEGATE-ID, + Keywords2 DELIMITED,DELIMITER,DEPENDING,DESCENDING, + Keywords2 DESTINATION,DESTINATION-,DETAIL,DISABLE,DISPLAY,DISPLAY-, + Keywords2 DISPLAY-1,DISPLAY-2,DISPLAY-3,DISPLAY-4,DISPLAY-5, + Keywords2 DISPLAY-6,DISPLAY-7,DISPLAY-8,DISPLAY-9,DIVIDE,DOWN, + Keywords2 DUPLICATE,DUPLICATES,DYNAMIC,EGCS,EGI,EJECT,ELSE,EMI, + Keywords2 EMPTY,ENABLE,END,END-ADD,END-CALL,END-CLASS,END-COMPUTE,END + Keywords2 END-DELEGATE, END DELEGATE, + Keywords2 END-DISABLE,END-DIVIDE,END-ENABLE,END-ENUM,END-EVALUATE, + Keywords2 END-IF,ENDING,END-INVOKE,END-MULTIPLY,END-OF-PAGE,END-PERFORM, + Keywords2 END-RECEIVE,END-RETURN,END-CH, + Keywords2 END-SEND,END-START,END-STRING,END-SUBTRACT,END- + Keywords2 TRANSCEIVE,END-UNSTRING,ENTER,ENTRY,ENUM,ENUM-ID,ENUM ID,EOP, + Keywords2 EQUAL,EQUALS,ERASE,ERROR,ESI,EVALUATE,EVERY,EXACT,EXAMINE,EXCEEDS + Keywords2 EXCEPTION,EXCEPTION-OBJECT,EXCLUSIVE,EXIST,EXIT,EXTEND,EXTERNAL,F,FACTORY,FALSE,FD, + Keywords2 FILE-CONTROL,FILE-LIMITS,FILE,FILES, + Keywords2 FINAL,FIND,FINISH,FIRST,FOOTING,FORM,FORMAT,FREE,FROM, + Keywords2 FUNCTION,GENERATE,GET,GIVING,GLOBAL,GO,GOBACK, + Keywords2 GREATER,GROUP,HAVING,HEADING,HIGH VALUE,HIGH-VALUE,HIGH-VALUES, + Keywords2 ID,IF,IN,INPUT-OUTPUT,INCLUDE,INDEX,INDEXED, + Keywords2 INDICATE,INHERITS,INITIAL,INITIALIZE,INITIATE,INPUT, + Keywords2 INSPECT,INSTALLATION,INTERFACE,INTERFACE-ID,INTO,INVALID, + Keywords2 INVOKE,I-O,I-O-CONTROL,IS,JUST,JUSTIFIED,KANJI,KEEP,KEY, + Keywords2 LABEL,LAST,LD,LEADING,LEFT,LENGTH,LESS,LIMIT,LIMITS, + Keywords2 LINAGE,LINAGE-COUNTER,LINE,LINE COUNTER,LINE-COUNTER, + Keywords2 LINES,LINKAGE,LIKE,LOCALLY,LOCAL-STORAGE,LOCK,LOW-VALUE,LOW- + Keywords2 VALUES,LS-AREA,MEMBER,MEMORY,MERGE,MESSAGE,METACLASS, + Keywords2 METHOD,METHOD-ID,MODE,MODE-,MODIFY,MODULES,MORE LABELS,MORE- + Keywords2 LABELS,MOVE,MULTIPLE,MULTIPLY,NATIVE,NEGATIVE,NEXT,NO, + Keywords2 NORMAL,NOT,NULL,NULLS,NUMBER,NUMERIC,NUMERIC EDITED, + Keywords2 NUMERIC-EDITED,OBJECT-COMPUTER,OBJECT,OCCURS,OF,OFF, + Keywords2 OMITTED,ON,ONLY,OPTIONAL,OR,ORDER,ORGANIZATION, + Keywords2 OTHER,OUTPUT,OVERFLOW,OVERRIDE,OWNER, + Keywords2 PADDING,PAGE,PAGE COUNTER,PAGE-COUNTER, + Keywords2 PASSWORD,PERFORM,PF,PH,PLUS, + Keywords2 POINTER,POSITION,POSITIONING,POSITIVE,PRESENT,PREVIOUS,PRINTING,PRIOR, + Keywords2 PRIVATE,PROCEDURE-POINTER,PROCEDURES,PROCEED,PROCESS,PROCESSING, + Keywords2 PROGRAM,PROGRAM-ID,PROTECTED,PROTOTYPE,PUBLIC,PURGE,QUEUE,QUOTE,QUOTES, + Keywords2 RAISE,RAISING,RANDOM,RANGE,RD,READY,REALM,RECEIVE,RECONNECT,RECORD, + Keywords2 RECORDING,RECORD-NAME,RECORDS,RECURSIVE,REDEFINES,REEL, + Keywords2 REFERENCE,REFERENCES,RELATION,RELATIVE,RELEASE,RELOAD, + Keywords2 REMAINDER,REMARKS,REMOVAL,RENAMES,REPEATED,REPLACE,REPLACING, + Keywords2 REPORT,REPORTING,REPORTS,REPOSITORY,RERUN,RESERVE,RESET, + Keywords2 RETAINING,RETRIEVAL,RETURN,RETURN-CODE,RETURNING, + Keywords2 REVERSED,REWIND,RF,RH,RIGHT,ROUNDED, + Keywords2 RUN,SAME,SCREEN,SD,SEARCH,SECURITY,SEGMENT,SEGMENT- + Keywords2 LIMIT,SELF,SEND,SENTENCE,SEPARATE,SEQUENCE, + Keywords2 SEQUENTIAL,SERVICE,SESSION,SESSION-ID,SET,SHARED,SHIFT-IN,SHIFT- + Keywords2 OUT,SIGN,SIZE,SKIP,SORT,SORT-CONTROL + Keywords2 SORT-CORE-SIZE,SORT-FILE-SIZE,SORT-MERGE,SORT-MESSAGE, + Keywords2 SORT-MODE-SIZE,SORT-RETURN,SORT-STATUS,SOURCE,SOURCE-COMPUTER,SPACE, + Keywords2 SPACES,SPECIAL-NAMES,STANDARD,STANDARD-,START,STATIC, + Keywords2 STATUS,STOP,STORE,STRING, + Keywords2 SUB-QUEUE-,SUB-SCHEMA,SUBTRACT,SUFFIX,SUM,SUPER, + Keywords2 SUPPRESS,SYMBOLIC,SYNC,SYNCHRONIZED,TABLE,TALLY, + Keywords2 TALLYING,TAPE,TENANT,TERMINAL,TERMINATE,TEST,TEXT,THAN, + Keywords2 THEN,THROUGH,THRU,TIME,TIMEOUT,TIMES,TITLE,TO,TOP,TRACE, + Keywords2 TRAILING,TRANSCEIVE,TRUE,TYPE,TYPEDEF,UNEQUAL,UNIT,UNSTRING, + Keywords2 UNLOCK,UNTIL,UP,UPON,USAGE,USAGE-MODE,USE,USING,VALID, + Keywords2 VALIDATE,VALUE,VALUES,VARYING,WAIT,WHEN,WHENEVER,WHEN-COMPILED,WHERE, + Keywords2 WITH,WITHIN,WORDS,WORKING-STORAGE,WRITE-ONLY,ZERO,ZEROES,ZEROS, + Keywords2 BINARY,BINARY-,BIT,BYTE,COMPUTATIONAL,COMPUTATIONAL-1,COMPUTATIONAL-2,COMPUTATIONAL-3, + Keywords2 COMPUTATIONAL-4,COMPUTATIONAL-5,COMPUTATIONAL-X,COMPUTATIONAL-N, + Keywords2 COMPUTATIONAL-4,COMPUTATIONAL-5,COMPUTATIONAL-X,COMPUTATIONAL-N, + Keywords2 REFERENCE,SIGNED,UNSIGNED,POINTER,PROPERTY, + Keywords2 PACKED-DECIMAL,COMP-6,COMP-7,COMP-8,COMP-X,COMP-N,COMPLEX + keywords2 PIC,PICTURE,COMP-1,COMP2-,COMP-3,COMP-5,COMP-9,PACKED DECIMAL + Keywords1 ENVIRONMENT DIVISION,DATA DIVISION,PROGRAM,PROCEDURE DIVISION, + Keywords1 IDENTIFICATION DIVISION,SECTION,PARAGRAPH, + Keywords1 END-PROGRAM,END PROGRAM, + keywords4 S9,V9 + Keywords6 CONNECT,COMMIT,DECLARE,DELETE,DISCONNECT,EXEC,EXECUTE, + Keywords6 EXECUTE IMMEDIATE,END-EXEC,FETCH,FOR,INSERT, + Keywords6 PREPARE,ROLLBACK,SELECT,UPDATE, + Keywords6 CLOSE,OPEN,READ,REWRITE,WRITE,END-READ,END-WRITE,END-REWRITE,END-DELETE +END + +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +; DEFAULT +;ÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ +FILES *.* + GeneralFLAGS 526 +end diff --git a/Source/Tools/QCBuild/Prebuild/Win32/qcbuild.exe b/Source/Tools/QCBuild/Prebuild/Win32/qcbuild.exe new file mode 100644 index 0000000..fd74ca5 Binary files /dev/null and b/Source/Tools/QCBuild/Prebuild/Win32/qcbuild.exe differ diff --git a/Source/Tools/QCBuild/SVG.cpp b/Source/Tools/QCBuild/SVG.cpp new file mode 100644 index 0000000..5240568 --- /dev/null +++ b/Source/Tools/QCBuild/SVG.cpp @@ -0,0 +1,133 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Functions to generate SVG vector graphics, ready to +// embeded on www directly. +// We use it to generate component diagrams. +// + +#include "SVG.h" + +// +// Begin SVG document. This function writes to stdout +// header SVG header. +// +// f - C stream (e.g. stdout), where to write generated SVG data (IN). +// width - width of SVG document in pixels (IN). +// height - height of SVG document in pixels (IN). +// + +void SvgBegin(FILE *f, int width, int height) +{ + fprintf(f, "<svg xmlns=\"http://www.w3.org/2000/svg\\" + "version=\"1.1\" width=\"%dpx\" height=\"%dpx\">\n", + width, height); +} + +// +// End SVG document. This function writes end of SVG tag +// on stdout. +// +// f - C stream (e.g. stdout), where to write generated SVG data (IN). +// + +void SvgEnd(FILE *f) +{ + fprintf(f, "</svg>\n"); +} + +// +// Generate SVG code to draw rectangle and write it on stdout. +// +// f - C stream (e.g. stdout), where to write generated SVG data (IN). +// x, y - position of top, left corner of rectangle in pixels (IN). +// w, h - width and height of rectangle in pixels (IN). +// color - html color name (e.g. 'red' or 'RGB(r,g,b)' (IN/OPT). +// border - html border's color (IN/OPT). +// + +void SvgRect(FILE *f, int x, int y, int w, int h, + const char *color, const char *border) +{ + fprintf(f, "<rect x='%d' y='%d' width='%d' height='%d'style='fill:%s;stroke:%s;' />\n", + x, y, w, h, color, border); +} + +// +// Generate SVG code to draw line beetwen (x1,y1) and (x2,y2) points +// and print it on stdout. +// +// f - C stream (e.g. stdout), where to write generated SVG data (IN). +// x1,y1 - coordinates of line's begin in pixels (IN). +// x2,y2 - coordinates of line's end in pixels (IN). +// color - html color (e.g. 'red' or 'RGB(r,g,b)' (IN/OPT). +// width - width of line if pixels (IN/OPT). +// + +void SvgLine(FILE *f, int x1, int y1, int x2, int y2, const char *color, int width) +{ + fprintf(f, "<line x1='%d' y1='%d' x2='%d' y2='%d' style='stroke:%s;stroke-width:%d' />\n", + x1, y1, x2, y2, color, width); +} + +// +// Generate SVG code to draw text and print it on stdout. +// +// f - C stream (e.g. stdout), where to write generated SVG data (IN). +// x,y - coordinates, where to begin to draw in pixels (IN). +// text - ASCIZ message to write (e.g. 'some text') (IN). +// color - html color name (e.g. 'red' or 'RGB(r,g,b)') (IN/OPT). +// + +void SvgText(FILE *f, int x, int y, const char *text, const char *color) +{ + fprintf(f, "<text x='%d' y='%d' fill='%s'>%s</text>\n", x, y, color, text); +} + +// +// Generate SVG code to create text link and print it on stdout. +// +// f - C stream (e.g. stdout), where to write generated SVG data (IN). +// x,y - coordinates, where to begin to draw in pixels (IN). +// url - target url (IN). +// text - ASCIZ message to write (e.g. 'some text') (IN). +// color - html color name (e.g. 'red' or 'RGB(r,g,b)') (IN/OPT). +// + +void SvgLink(FILE *f, int x, int y, const char *url, const char *text, const char *color) +{ + fprintf + ( + f, + "<a xlink:href='%s'>" + "<text x='%d' y='%d' fill='%s'>%s</text>" + "</a>", + url, + x, + y, + color, + text + ); +} diff --git a/Source/Tools/QCBuild/SVG.h b/Source/Tools/QCBuild/SVG.h new file mode 100644 index 0000000..24f267b --- /dev/null +++ b/Source/Tools/QCBuild/SVG.h @@ -0,0 +1,43 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef SVG_H +#define SVG_H + +#include <cstdio> + +void SvgBegin(FILE *f, int width, int height); + +void SvgEnd(FILE *f); + +void SvgRect(FILE *f, int x, int y, int w, int h, + const char *color = "lightgray", + const char *border = "black"); + +void SvgLine(FILE *f, int x1, int y1, int x2, int y2, const char *color = "black", int width = 2); + +void SvgText(FILE *f, int x, int y, const char *text, const char *color = "black"); +void SvgLink(FILE *f, int x, int y, const char *url, const char *text, const char *color = "black"); + +#endif /* SVG_H */ diff --git a/Source/Tools/QCBuild/Scan.cpp b/Source/Tools/QCBuild/Scan.cpp new file mode 100644 index 0000000..f236be7 --- /dev/null +++ b/Source/Tools/QCBuild/Scan.cpp @@ -0,0 +1,571 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +// +// Purpose: Pop single chars from given C stream and tokenize them +// into known token (e.g. number, indentifier, C macro, +// C comment etc.). +// +// + +#include "Scan.h" + +using namespace Tegenaria; + +// +// Global variables. +// Internal use only. +// + +static int ScanBuf = 0; + +static FILE *ScanFile = stdin; + +// +// Initialize scanner. MUST be called once time before +// any ScanXXX function used. +// +// f - pointer to opened C stream file (IN). +// + +void ScanInit(FILE *f) +{ + ScanFile = f; + ScanBuf = fgetc(ScanFile); +} + +// +// Pop next byte from stream. +// +// RETURNS: Next character in scanner stream or +// value < 0 if EOF reached. +// + +const int ScanPop() +{ + int ret = ScanBuf; + + ScanBuf = fgetc(ScanFile); + + DBG_MSG3("ScanNextChar : Popped [%c] from stream.\n", ScanBuf); + + return ret; +} + +// +// Check next byte in scanner, but do NOT pop it. +// +// RETURNS: Next character in scanner stream or +// value < 0 if EOF reached. +// + +const int ScanPeek() +{ + DBG_MSG3("ScanPeek : Peeked [%c].\n", ScanBuf); + + return ScanBuf; +} + +// +// Skip one byte in scanner stream. +// + +void ScanEat() +{ + DBG_MSG3("ScanNextChar : Eated [%c] from stream.\n", ScanBuf); + + ScanBuf = fgetc(ScanFile); +} + +// +// Convert token ID into human readable string. +// See Scan.h for possible token IDs. +// +// id - one of token's ID defined in Scan.h (IN). +// +// RETURNS: Name of token ID +// or 'TOKEN_UNKNOWN" if given ID not recognised. +// + +const char *GetTokenName(int id) +{ + switch(id) + { + case TOKEN_ERROR : return "TOKEN_ERROR"; + case TOKEN_EOF : return "TOKEN_EOF"; + case TOKEN_EOL : return "TOKEN_EOL"; + case TOKEN_NUMBER : return "TOKEN_NUMBER"; + case TOKEN_CLASS : return "TOKEN_CLASS"; + case TOKEN_STRUCT : return "TOKEN_STRUCT"; + case TOKEN_ENUM : return "TOKEN_ENUM"; + case TOKEN_IDENT : return "TOKEN_IDENT"; + case TOKEN_MACRO : return "TOKEN_MACRO"; + case TOKEN_BLOCK_BEGIN : return "TOKEN_BLOCK_BEGIN"; + case TOKEN_BLOCK_END : return "TOKEN_BLOCK_END"; + case TOKEN_PARENT_BEGIN : return "TOKEN_PARENT_BEGIN"; + case TOKEN_PARENT_END : return "TOKEN_PARENT_END"; + case TOKEN_OPERATOR : return "TOKEN_OPERATOR"; + case TOKEN_COMMENT : return "TOKEN_COMMENT"; + case TOKEN_WHITE : return "TOKEN_WHITE"; + case TOKEN_DELIM : return "TOKEN_DELIM"; + case TOKEN_SEMICOLON : return "TOKEN_SEMICOLON"; + case TOKEN_STRING : return "TOKEN_STRING"; + case TOKEN_CHAR : return "TOKEN_CHAR"; + case TOKEN_INDEX_BEGIN : return "TOKEN_INDEX_BEGIN"; + case TOKEN_INDEX_END : return "TOKEN_INDEX_END"; + } + + return "TOKEN_UNKNOWN"; +} + +// +// Pop next token from stream. +// We pop next bytes from stream until we recognize one of +// known token. For list of known tokens see Scan.h. +// +// token - reference to C++ string, where to store retrieved token +// (e.g. '#define N 1234') (OUT). +// +// RETURNS: ID of recognized token (e.g. TOKEN_MACRO) +// or TOKEN_ERROR if error. +// + +int ScanPopToken(string &token) +{ + DBG_ENTER3("ScanPopToken"); + + int tokenId = TOKEN_ERROR; + + int goOn = 1; + + token.clear(); + + while(goOn) + { + int c = ScanPeek(); + + switch(c) + { + // + // EOF. + // + + case -1: + case 0: + { + DBG_MSG2("[EOF]\n"); + + tokenId = TOKEN_EOF; + + goOn = 0; + + break; + } + + // + // White and control. + // Ignore. + // + + case 1 ... 9: + case 11 ... 12: + case 14 ... 32: + { + DBG_MSG2("[TOKEN_WHITE]"); + + tokenId = TOKEN_WHITE; + + while(ScanPeek() > 0 && ScanPeek() <= 32 && ScanPeek() != 13 && ScanPeek() != 10) + { + ScanEat(); + } + + token = " "; + + goOn = 0; + + break; + } + + // + // End of line. + // Ignore. + // + + case 10: + case 13: + { + DBG_MSG2("[TOKEN_EOL]"); + + tokenId = TOKEN_EOL; + + if (c == 13 && ScanPeek() == 10) + { + ScanEat(); + } + + ScanEat(); + + token = " "; + + goOn = 0; + + break; + } + + case ',': + { + DBG_MSG2("[TOKEN_DELIM]"); + + tokenId = TOKEN_DELIM; + + token = ScanPop(); + + goOn = 0; + } + + // + // Identifier. + // + + case 'a'...'z': + case 'A'...'Z': + case '_': + { + DBG_MSG2("[IDENT]\n"); + + tokenId = TOKEN_IDENT; + + while(isalnum(ScanPeek()) || ScanPeek() == '_' || ScanPeek() == ':' || ScanPeek() == '~') + { + token += ScanPop(); + } + + goOn = 0; + + break; + } + + // + // Number. + // + + case '0'...'9': + { + DBG_MSG2("[NUMBER]\n"); + + tokenId = TOKEN_NUMBER; + + while(isdigit(ScanPeek()) || ScanPeek() == '.') + { + token += ScanPop(); + } + + goOn = 0; + + break; + } + + // + // C Macro. + // Skip. + // + + case '#': + { + DBG_MSG2("[MACRO]\n"); + + int insideMacro = 1; + int joined = 0; + + tokenId = TOKEN_MACRO; + + while(insideMacro) + { + token += ScanPop(); + + switch(ScanPeek()) + { + case 10: + case 13: + { + if (joined == 0) + { + insideMacro = 0; + } + else + { + joined = 0; + } + + break; + } + + case '\\': + { + joined = 1; + + break; + } + } + } + + goOn = 0; + + break; + } + + case '{': + case '}': + case '(': + case ')': + { + token = ScanPop(); + + goOn = 0; + + switch(c) + { + case '{': tokenId = TOKEN_BLOCK_BEGIN; break; + case '}': tokenId = TOKEN_BLOCK_END; break; + case '(': tokenId = TOKEN_PARENT_BEGIN; break; + case ')': tokenId = TOKEN_PARENT_END; break; + } + + break; + } + + case '+': + case '-': + case '/': + case '=': + case '*': + case '&': + case '|': + case '%': + case '<': + case '>': + { + goOn = 0; + + token += ScanPop(); + + // + // '//' - One line comment. + // + + if (c == '/' && ScanPeek() == '/') + { + DBG_MSG2("[COMMENT]\n"); + + tokenId = TOKEN_COMMENT; + + while(ScanPeek() != 10 && ScanPeek() != 13) + { + token += ScanPop(); + } + + if (ScanPeek() == 13) + { + ScanEat(); + + if (ScanPeek() == 10) + { + ScanEat(); + } + } + else if (ScanPeek() == 10) + { + ScanEat(); + } + } + + // + // '/*' - multiple line comment. + // + + else if (c == '/' && ScanPeek() == '*') + { + DBG_MSG2("[LONG_COMMENT]"); + + tokenId = TOKEN_COMMENT; + + int insideComment = 1; + + while(insideComment) + { + token += ScanPop(); + + int len = token.size(); + + if (len > 2 && strcmp(&token[len - 2], "*/") == 0) + { + insideComment = 0; + } + } + + while(ScanPeek() == 10 || ScanPeek() == 13) + { + ScanEat(); + } + } + + // + // Operator. + // + + else + { + DBG_MSG2("[OPERATOR]\n"); + + tokenId = TOKEN_OPERATOR; + } + + break; + } + + // + // ';' - end of instruction. + // + + case ';': + { + DBG_MSG2("[SEMICOLON]\n"); + + tokenId = TOKEN_SEMICOLON; + + token = ScanPop(); + + goOn = 0; + + break; + } + + // + // '"' Begin of string. + // + + case '"': + { + DBG_MSG2("[STRING]\n"); + + tokenId = TOKEN_STRING; + + token += ScanPop(); + + while(ScanPeek() != '"' || ScanPeek() == '\\') + { + if (ScanPeek() == '\\') + { + token += ScanPop(); + token += ScanPop(); + } + else + { + token += ScanPop(); + } + } + + token += ScanPop(); + + goOn = 0; + + break; + } + + // + // ' Begin of char. + // + + case '\'': + { + DBG_MSG2("[CHAR]\n"); + + tokenId = TOKEN_CHAR; + + token += ScanPop(); + + while(ScanPeek() != '\'' || ScanPeek() == '\\') + { + if (ScanPeek() == '\\') + { + token += ScanPop(); + token += ScanPop(); + } + else + { + token += ScanPop(); + } + } + + token += ScanPop(); + + goOn = 0; + + break; + } + + // + // Index brackets []. + // + + case '[': + { + DBG_MSG2("[TOKEN_INDEX_BEGIN]\n"); + + tokenId = TOKEN_INDEX_BEGIN; + + token += ScanPop(); + + goOn = 0; + + break; + } + + case ']': + { + DBG_MSG2("[TOKEN_INDEX_END]\n"); + + tokenId = TOKEN_INDEX_END; + + token += ScanPop(); + + goOn = 0; + + break; + } + + default: + { + ScanEat(); + } + } + } + + fail: + + DBG_LEAVE3("ScanPopToken"); + + return tokenId; +} diff --git a/Source/Tools/QCBuild/Scan.h b/Source/Tools/QCBuild/Scan.h new file mode 100644 index 0000000..ca8727d --- /dev/null +++ b/Source/Tools/QCBuild/Scan.h @@ -0,0 +1,79 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Scan_H +#define Scan_H + +#include <cstdio> +#include <cctype> +#include <string> +#include <vector> + +#include <Tegenaria/File.h> +#include <Tegenaria/Str.h> +#include <Tegenaria/Debug.h> + +using std::string; +using std::vector; + +#define TOKEN_ERROR -1 +#define TOKEN_EOF 0 +#define TOKEN_NUMBER 1 +#define TOKEN_CLASS 2 +#define TOKEN_STRUCT 3 +#define TOKEN_ENUM 4 +#define TOKEN_IDENT 5 +#define TOKEN_MACRO 6 +#define TOKEN_EOL 7 + +#define TOKEN_BLOCK_BEGIN 8 +#define TOKEN_BLOCK_END 9 + +#define TOKEN_PARENT_BEGIN 10 +#define TOKEN_PARENT_END 11 + +#define TOKEN_OPERATOR 13 +#define TOKEN_COMMENT 14 +#define TOKEN_WHITE 15 +#define TOKEN_DELIM 16 +#define TOKEN_SEMICOLON 17 + +#define TOKEN_STRING 18 +#define TOKEN_CHAR 19 + +#define TOKEN_INDEX_BEGIN 20 +#define TOKEN_INDEX_END 21 + +void ScanInit(FILE *f); + +const int ScanNextChar(); +const int ScanPop(); + +const int ScanPeek(); + +const char *GetTokenName(int id); + +int ScanPopToken(string &token); + +#endif /* Scan_H */ diff --git a/Source/Tools/QCBuild/SourceInfo.cpp b/Source/Tools/QCBuild/SourceInfo.cpp new file mode 100644 index 0000000..4c03879 --- /dev/null +++ b/Source/Tools/QCBuild/SourceInfo.cpp @@ -0,0 +1,744 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> */ +/* */ +/* 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 "SourceInfo.h" + +using namespace Tegenaria; + +extern const char *TargetMachine; + +SourceInfo::SourceInfo() +{ + clear(); +} + +// +// +// + +int SourceInfo::set(const char *lvalue, const char *rvalue, int concat) +{ + DBG_ENTER3("SourceIinfo::set"); + + FAIL(lvalue == NULL); + FAIL(rvalue == NULL); + + if (stricmp(lvalue, "TYPE") == 0) + { + if (stricmp(rvalue, "PROJECT") == 0) type_ = TYPE_PROJECT; + else if (stricmp(rvalue, "PROGRAM") == 0) type_ = TYPE_PROGRAM; + else if (stricmp(rvalue, "LIBRARY") == 0) type_ = TYPE_LIBRARY; + else if (stricmp(rvalue, "SIMPLE_LIBRARY") == 0) type_ = TYPE_SIMPLE_LIBRARY; + else if (stricmp(rvalue, "SIMPLE_PROGRAM") == 0) type_ = TYPE_SIMPLE_PROGRAM; + else if (stricmp(rvalue, "MULTI_LIBRARY") == 0) type_ = TYPE_MULTI_LIBRARY; + else type_ = TYPE_UNKNOWN; + + vars_[lvalue] = rvalue; + } + else + { + if (concat) + { + if (isset(lvalue)) + { + vars_[lvalue] += " "; + vars_[lvalue] += rvalue; + } + else + { + vars_[lvalue] = rvalue; + } + } + else + { + if (rvalue[0] == 0) + { + vars_.erase(rvalue); + } + else + { + vars_[lvalue] = rvalue; + } + } + } + + // + // Convert DEPENDS string to STL set<>. + // + + if (stricmp(lvalue, "DEPENDS") == 0) + { + // + // Split DEPENDS string into titles list (tokens). + // + + std::set<string> tokens; + std::set<string>::iterator it; + + StrTokenize(tokens, rvalue, " \t", "\""); + + // + // Concat mode. Add more tokens to current set. + // + + if (concat) + { + for (it = tokens.begin(); it != tokens.end(); it++) + { + dependsSet_.insert(*it); + } + } + + // + // Assign mode. Simple copy tokens into current set. + // + + else + { + dependsSet_ = tokens; + } + + // + // Review resolved state. + // + + if (dependsSet_.empty()) + { + dependsResolved_ = 1; + } + else + { + dependsResolved_ = 0; + } + } + + // + // Convert AUTODOC_PRIVATE_DIRS string to STL set<>. + // + + else if (stricmp(lvalue, "AUTODOC_PRIVATE_DIRS") == 0) + { + if (this -> getType() != TYPE_PROJECT) + { + Fatal("ERROR: Improper use of AUTODOC_PRIVATE_DIRS in '%s' component.\n" + "This option can be used for project root only.\n", get("TITLE")); + } + + // + // Split AUTODOC_PRIVATE_DIRS string into titles list (tokens). + // + + std::set<string> tokens; + std::set<string>::iterator it; + + StrTokenize(tokens, rvalue, " \t", "\""); + + // + // Concat mode. Add more tokens to current set. + // + + if (concat) + { + for (it = tokens.begin(); it != tokens.end(); it++) + { + privateDirsSet_.insert(*it); + } + } + + // + // Assign mode. Simple copy tokens into current set. + // + + else + { + privateDirsSet_ = tokens; + } + } + + // + // Convert absolute component path to relative to ROOT + // for project's components. + // + + else if ((type_ == TYPE_PROGRAM || type_ == TYPE_LIBRARY || type_ == TYPE_MULTI_LIBRARY) && + stricmp(lvalue, "ROOT") == 0) + { + string compDir = get("COMP_DIR"); + string root = get("ROOT"); + + set("COMP_DIR", CreateRelativePath(&compDir[0], &root[0])); + + // + // Find top-subdir for component e.g. 'Lib' for 'Lib/LibFoo'. + // + + this -> set("TOP_SUBDIR", FilePathGetTopDir(this -> get("COMP_DIR")).c_str()); + } + + fail: + + DBG_LEAVE3("SourceIinfo::set"); + + return 0; +} + +// +// +// + +int SourceInfo::cat(const char *lvalue, const char *rvalue) +{ + set(lvalue, rvalue, 1); +} + +// +// +// + +const char *SourceInfo::get(const char *lvalue) +{ + map<string, string>::iterator it = vars_.find(lvalue); + + if (it != vars_.end()) + { + return it -> second.c_str(); + } + + return ""; +} + +string SourceInfo::getLowered(const char *lvalue) +{ + map<string, string>::iterator it = vars_.find(lvalue); + + if (it != vars_.end()) + { + string ret = it -> second.c_str(); + + for (int i = 0; i < ret.size(); i++) + { + if (ret[i] >= 'A' && ret[i] <= 'Z') + { + ret[i] += 'z' - 'Z'; + } + } + + return ret; + } + + return ""; +} + +int SourceInfo::isset(const char *lvalue) +{ + if (get(lvalue)[0]) + { + return 1; + } + + return 0; +} + +int SourceInfo::getInt(const char *lvalue) +{ + return atoi(get(lvalue)); +} + +// +// +// + +void SourceInfo::print() +{ + if (type_ == TYPE_PROJECT) + { + printf("Project '%s':\n" + "--------------------------\n\n", get("TITLE")); + } + else + { + printf("Component '%s':\n" + "--------------------------\n\n", get("TITLE")); + } + + if (isset("TITLE")) printf("Title : %s\n", get("TITLE")); + if (isset("ROOT")) printf("Root : %s\n", get("ROOT")); + if (isset("COMP_DIR")) printf("Path : %s\n", get("COMP_DIR")); + if (isset("LIBS")) printf("LIBS : %s\n", get("LIBS")); + if (isset("INCLUDE")) printf("INCLUDE : %s\n", get("INCLUDE")); + if (isset("CSRC")) printf("CSRC : %s\n", get("CSRC")); + if (isset("CXXSRC")) printf("CXXSRC : %s\n", get("CXXSRC")); + if (isset("ISRC")) printf("ISRC : %s\n", get("ISRC")); + if (isset("DEFINES")) printf("DEFINES : %s\n", get("DEFINES")); + if (isset("DEPENDS")) printf("DEPENDS : %s\n", get("DEPENDS")); +} + +// +// Check does component has resolved all dependencies. +// + +int SourceInfo::resolved() +{ + if (dependsResolved_ == 1 || dependsSet_.empty()) + { + dependsResolved_ = 1; + + return 1; + } + + return 0; +} + +// +// Resolve dependencies on given component. +// + +void SourceInfo::resolve(const char *compTitle) +{ + dependsSet_.erase(compTitle); + + if (dependsSet_.empty()) + { + dependsResolved_ = 1; + } +} + +// +// +// + +void SourceInfo::clear() +{ + type_ = TYPE_UNKNOWN; + + vars_.clear(); + + vars_["TITLE"] = "Untitled"; + vars_["LICENSE"] = "Unknown"; + vars_["AUTHOR"] = "Unknown"; + vars_["DESC"] = "-"; + vars_["PURPOSE"] = "-"; + + dependsSet_.clear(); + + dependsResolved_ = 0; +} + +string SourceInfo::getDepends() +{ + string ret; + + std::set<string>::iterator it; + + int delimCount = dependsSet_.size() - 1; + + for (it = dependsSet_.begin(); it != dependsSet_.end(); it++) + { + ret += *it; + + if (delimCount > 0) + { + ret += " "; + + delimCount --; + } + } + + return ret; +} + +string SourceInfo::getPathList(const char *lvalue) +{ + string rv; + + string value = this -> get(lvalue); + + if (!value.empty()) + { + vector<string> tokens; + + StrTokenize(tokens, value, " \t", "\""); + + for (int i = 0; i < tokens.size(); i++) + { + rv += this -> get("COMP_DIR_REL"); + rv += "/"; + rv += tokens[i]; + rv += " "; + } + } + + return rv; +} + +const std::set<string> &SourceInfo::getDependsSet() +{ + return dependsSet_; +} + +// +// Load data for current component from 'qcbuild.src' file. +// +// RETURNS: 0 if OK. +// + +int SourceInfo::loadComponent() +{ + DBG_ENTER3("SourceInfo::loadComponent"); + + char path[MAX_PATH + 1] = {0}; + + FileGetDir(path, MAX_PATH); + + strncat(path, "/qcbuild.src", MAX_PATH); + + this -> set("ROOT", "."); + + DBG_LEAVE3("SourceInfo::loadComponent"); + + return this -> loadFromFile(path); +} + +// +// Load root project data from 'qcbuild.src' file. +// +// RETURNS: 0 if OK. +// + +int SourceInfo::loadProject() +{ + DBG_ENTER("SourceInfo::loadProject"); + + int exitCode = -1; + + char rootDir[MAX_PATH + 1] = {0}; + char sourceFilePath[MAX_PATH + 1] = {0}; + char currentDir[MAX_PATH + 1] = {0}; + char relRootDir[MAX_PATH + 1] = "."; + + FILE *f = NULL; + + int found = 0; + int goOn = 1; + + FileGetDir(currentDir, MAX_PATH); + + while(goOn) + { + FileGetDir(rootDir, MAX_PATH); + + if (strlen(rootDir) <= 3) + { + goOn = 0; + } + else + { + strncpy(sourceFilePath, rootDir, MAX_PATH); + strncat(sourceFilePath, "/qcbuild.src", MAX_PATH); + + if (loadFromFile(sourceFilePath) == 0) + { + if (type_ == TYPE_PROJECT) + { + found = 1; + goOn = 0; + + this -> set("ROOT", relRootDir); + } + } + + if (found == 0) + { + strncat(rootDir, "/..", MAX_PATH); + strncat(relRootDir, "/..", MAX_PATH); + + FileSetDir(rootDir); + } + } + } + + FAILEX(found == 0, "ERROR: Cannot recognise project's root directory.\n"); + + this -> set("COMP_DIR", "."); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + FileSetDir(currentDir); + + DBG_LEAVE("SourceInfo::loadProject"); + + return exitCode; +} + +// +// Load componend data from file. +// +// si - buffer where to store loaded component's description (OUT). +// fname - path to .src file with component's descritpion (IN). +// +// RETURNS: 0 if OK. +// + +int SourceInfo::loadFromFile(const char *fname) +{ + DBG_ENTER3("SourceInfo::loadFromFile"); + + int exitCode = -1; + + char *buf = FileLoad(fname); + char *p = buf; + char *next = NULL; + char *lvalue = NULL; + char *rvalue = NULL; + char *eqPtr = NULL; + char *catPtr = NULL; + char *eol = NULL; + + char currentDir[MAX_PATH + 1] = {0}; + + string currentSection = "COMMON"; + + std::set<string> currentSectionsSet; + + FAIL(buf == NULL); + + clear(); + + while(*p) + { + p = CleanToken(p); + + next = SkipLine(p); + + // + // Remove EOL. + // + + eol = p + strlen(p) - 1; + + while(eol > p && (eol[0] == 13 || eol[0] == 10)) + { + eol[0] = 0; + + eol --; + } + + DBG_MSG3("[%s] : Parsing line [%s]...\n", currentSection.c_str(), p); + + switch(p[0]) + { + // + // Comment. + // + + case '#': + { + break; + }; + + // + // Empty line. + // + + case 0: + case 13: + case 10: + { + break; + } + + // + // Section tag. Possible tags are: + // + // .section + // .sectionend + // + + case '.': + { + // + // Enter into new section. + // + + if (strncmp(p, ".section", sizeof(".section") - 1) == 0) + { + std::vector<string> tokens; + + char *section = p + sizeof(".section"); + + CleanToken(section); + + DBG_MSG("Entering section [%s]...\n", section); + + StrTokenize(tokens, section, ","); + + for (int i = 0; i < tokens.size(); i ++) + { + currentSectionsSet.insert(CleanToken(&tokens[i][0])); + } + + currentSection = section; + } + + // + // Leave current section and back to 'COMMON' section. + // + + else if (strncmp(p, ".endsection", sizeof(".endsection") - 1) == 0) + { + DBG_MSG("Leaving [%s] section...\n", currentSection.c_str()); + + currentSection = "COMMON"; + + currentSectionsSet.clear(); + } + + break; + } + + // + // Default. Possible syntax are: + // <lvalue> = <rvalue> + // <lvalue> += <rvalue> + // + + default: + { + // + // Skip line if it's not targeted for target machine. + // + + DBG_MSG3("[%s] : [%s]\n", currentSection.c_str(), p); + + if (currentSection != "COMMON" && currentSectionsSet.count(TargetMachine) == 0) + { + DBG_MSG3("[%s] : Skipped [%s].\n", currentSection.c_str(), p); + + break; + } + + // + // Split line into three <lvalue>, <operator>, <rvalue> parts. + // + + eqPtr = strchr(p, '='); + catPtr = strstr(p, "+="); + + // + // <lvalue> += <rvalue> + // Append another value to existing one. + // E.g. expand LIBS defined in COMMON section by '-ldl' entry + // only in 'Linux' section. + // + + if (catPtr) + { + catPtr[0] = 0; + lvalue = CleanToken(p); + rvalue = CleanToken(catPtr + 2); + + this -> cat(lvalue, rvalue); + } + + // + // <lvalue> = <rvalue> + // Assign new value to variable. If variable already set + // old value is overwritten. + // + + else if (eqPtr) + { + eqPtr[0] = 0; + lvalue = CleanToken(p); + rvalue = CleanToken(eqPtr + 1); + + this -> set(lvalue, rvalue); + } + + // + // Unknown operator. + // + + else + { + fprintf(stderr, "ERROR: '=' or '+=' expected.\n"); + + goto fail; + } + } + } + + p = next; + } + + FileGetDir(currentDir, MAX_PATH); + + this -> set("COMP_DIR", currentDir); + + // + // Error handler. + // + + exitCode = 0; + + fail: + + if (buf) + { + free(buf); + } + + DBG_LEAVE3("SourceInfo::loadFromFile"); + + return exitCode; +} + +int SourceInfo::doesDependOn(const char *compTitle) +{ + return dependsSet_.count(compTitle); +} + +int SourceInfo::doesMatchPrivateDir(SourceInfo *ci) +{ + for (std::set<string>::iterator it = privateDirsSet_.begin(); it != privateDirsSet_.end(); it++) + { + const char *privatePrefix = it -> c_str(); + const char *compDir = ci -> get("COMP_DIR"); + + const char *ptr = strstr(compDir, privatePrefix); + + if ((ptr == compDir) && (ptr[0] == '/' || ptr[0] == '\\' == ptr[0] == 0)) + { + return 1; + } + } + + return 0; +} diff --git a/Source/Tools/QCBuild/SourceInfo.h b/Source/Tools/QCBuild/SourceInfo.h new file mode 100644 index 0000000..e6c30d1 --- /dev/null +++ b/Source/Tools/QCBuild/SourceInfo.h @@ -0,0 +1,107 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef SourceInfo_H +#define SourceInfo_H + +#include <cstdio> +#include <set> +#include <map> +#include <string> + +#include <Tegenaria/Str.h> +#include <Tegenaria/File.h> + +#include "Utils.h" + +using std::string; +using std::map; +using std::set; + +#define TYPE_PROJECT 0 +#define TYPE_PROGRAM 1 +#define TYPE_LIBRARY 2 +#define TYPE_SIMPLE_LIBRARY 3 +#define TYPE_SIMPLE_PROGRAM 4 +#define TYPE_MULTI_LIBRARY 5 +#define TYPE_UNKNOWN -1 + +class SourceInfo +{ + int type_; + + int dependsResolved_; + + std::map<string, string> vars_; + + std::set<string> dependsSet_; + std::set<string> privateDirsSet_; + + public: + + SourceInfo(); + + const char *get(const char *lvalue); + + int getInt(const char *lvalue); + + string getPathList(const char *lvalue); + + string getLowered(const char *lvalue); + + int set(const char *lvalue, const char *rvalue, int concat = 0); + + int cat(const char *lvalue, const char *rvalue); + + int isset(const char *lvalue); + + int getType() + { + return type_; + } + + void print(); + + int resolved(); + + void resolve(const char *compTitle); + + void clear(); + + string getDepends(); + + const std::set<string> &getDependsSet(); + + int doesDependOn(const char *compTitle); + + int loadProject(); + + int loadComponent(); + + int loadFromFile(const char *fname); + + int doesMatchPrivateDir(SourceInfo *ci); +}; + +#endif /* SourceInfo_H */ diff --git a/Source/Tools/QCBuild/Temp/Makefile-macos-exe b/Source/Tools/QCBuild/Temp/Makefile-macos-exe new file mode 100644 index 0000000..5a80838 --- /dev/null +++ b/Source/Tools/QCBuild/Temp/Makefile-macos-exe @@ -0,0 +1,98 @@ + +# +# DO NOT EDIT! This file was generated automatically from 'qcbuild.src' file. +# + +TITLE = liberror-example01-system-codes +ROOT = ./../../.. +INSTALL = +BUILD = $(ROOT)/Build +BUILD_BIN = $(ROOT)/Build/Bin +BUILD_LIB = $(ROOT)/Build/Lib +BUILD_INC = $(ROOT)/Build/Include +INSTALL_BIN = +INSTALL_LIB = +INSTALL_INC = + +# +# Source lists. +# + +CSRC = +CXXSRC = $(QT_MOC) Main.cpp +ISRC = +PREBUILD_LIBS = +PREBUILD_PROGS = +DEFINES = -DDEBUG -DDEBUG_STATE -DDLVERSION=\"0.6\" +EXE_POSTFIX = +DLL_POSTFIX = .dylib +DLL_PREFIX = lib +CXXOBJ = $(CXXSRC:.cpp=.o) +COBJ = $(CSRC:.c=.o) +OBJ = $(CXXOBJ) $(COBJ) + + +# +# Compiler/linker flags. +# + +CXX = g++ +CC = gcc +CXXFLAGS= -c -g -O3 -fPIC -L $(BUILD_LIB) -I $(BUILD_INC) $(DEFINES) +CFLAGS = -c -g -O3 -fPIC -L $(BUILD_LIB) -I $(BUILD_INC) $(DEFINES) +LIBS = -lerror -lpthread -ldl -stdlib=libc++ -L $(BUILD_LIB) +INCLUDE = -I $(BUILD_INC) +LFLAGS = -mmacosx-version-min=10.7 +ARCH = x86_64 + +# +# Link objects to executable/library. +# + +all: $(TITLE)$(EXE_POSTFIX) +$(TITLE)$(EXE_POSTFIX): $(OBJ) + @echo Linking LibError-example01-system-codes... + $(CXX) $(LFLAGS) $(OBJ) $(LIBS) -o $@ + +# +# Compile sources to objects. +# + +$(CXXOBJ) : %.o : %.cpp + @echo Compiling $<... + @$(CXX) $(CXXFLAGS) $(INCLUDE) -c $< -o $@ + +$(COBJ) : %.o : %.c + @echo Compiling $<... + @$(CC) $(CFLAGS) $(INCLUDE) -c $< -o $@ + +# +# Make install. Copy created binaries to build dir. +# + +install: all + mkdir -p $(BUILD) + mkdir -p $(BUILD_INC) + mkdir -p $(BUILD_LIB) + mkdir -p $(BUILD_BIN) + cp -rp $(TITLE)$(EXE_POSTFIX) $(BUILD_BIN) + +# +# Make clean. Remove files created by make and make install. +# + +clean: + rm -f *.o + rm -f *.log + rm -f $(TITLE)$(EXE_POSTFIX) + rm -f *.a + rm -f *.def + +# +# Make distclean. Make clean + clean Makefile. +# + +distclean: clean + rm -f Makefile + +.PHONY: install clean distclean diff --git a/Source/Tools/QCBuild/Temp/Makefile-macos-lib b/Source/Tools/QCBuild/Temp/Makefile-macos-lib new file mode 100644 index 0000000..fbcc6c0 --- /dev/null +++ b/Source/Tools/QCBuild/Temp/Makefile-macos-lib @@ -0,0 +1,102 @@ + +# +# DO NOT EDIT! This file was generated automatically from 'qcbuild.src' file. +# + +TITLE = error +ROOT = ./../.. +INSTALL = +BUILD = $(ROOT)/Build +BUILD_BIN = $(ROOT)/Build/Bin +BUILD_LIB = $(ROOT)/Build/Lib +BUILD_INC = $(ROOT)/Build/Include +INSTALL_BIN = +INSTALL_LIB = +INSTALL_INC = + +# +# Source lists. +# + +CSRC = +CXXSRC = $(QT_MOC) Error.cpp +ISRC = Error.h +PREBUILD_LIBS = +PREBUILD_PROGS = +DEFINES = -DDEBUG -DDEBUG_STATE -DDLVERSION=\"0.6\" +EXE_POSTFIX = +DLL_POSTFIX = .dylib +DLL_PREFIX = lib +CXXOBJ = $(CXXSRC:.cpp=.o) +COBJ = $(CSRC:.c=.o) +OBJ = $(CXXOBJ) $(COBJ) + + +# +# Compiler/linker flags. +# + +CXX = g++ +CC = gcc +CXXFLAGS= -c -g -O3 -fPIC -L $(BUILD_LIB) -I $(BUILD_INC) $(DEFINES) +CFLAGS = -c -g -O3 -fPIC -L $(BUILD_LIB) -I $(BUILD_INC) $(DEFINES) +LIBS = -lpthread -ldl -stdlib=libc++ -L $(BUILD_LIB) +INCLUDE = -I $(BUILD_INC) +LFLAGS = -mmacosx-version-min=10.7 +ARCH = x86_64 + +# +# Link objects to executable/library. +# + +all: $(OBJ) + +# +# Compile sources to objects. +# + +$(CXXOBJ) : %.o : %.cpp + @echo Compiling $<... + @$(CXX) $(CXXFLAGS) $(INCLUDE) -c $< -o $@ + +$(COBJ) : %.o : %.c + @echo Compiling $<... + @$(CC) $(CFLAGS) $(INCLUDE) -c $< -o $@ + +# +# Make install. Copy created binaries to build dir. +# + +install: all + mkdir -p $(BUILD) + mkdir -p $(BUILD_INC) + mkdir -p $(BUILD_LIB) + mkdir -p $(BUILD_BIN) + cp -rp $(ISRC) $(BUILD_INC) + @echo Linking static lib$(TITLE)-static.a... + rm -f $(TITLE)-static.a + ar rcs lib$(TITLE)-static.a $(OBJ) + @echo Linking $(TITLE)$(DLL_POSTFIX)... + $(CXX) -shared $(LFLAGS) -o $(DLL_PREFIX)$(TITLE)$(DLL_POSTFIX) $(OBJ) $(LIBS) + cp -rp $(DLL_PREFIX)$(TITLE)$(DLL_POSTFIX) $(BUILD_LIB) + cp -rp lib$(TITLE)-static.a $(BUILD_LIB) + +# +# Make clean. Remove files created by make and make install. +# + +clean: + rm -f *.o + rm -f *.log + rm -f *$(DLL_POSTFIX) + rm -f *.a + rm -f *.def + +# +# Make distclean. Make clean + clean Makefile. +# + +distclean: clean + rm -f Makefile + +.PHONY: install clean distclean diff --git a/Source/Tools/QCBuild/Temp/Makefile-qcbuild-macos b/Source/Tools/QCBuild/Temp/Makefile-qcbuild-macos new file mode 100644 index 0000000..3b09dec --- /dev/null +++ b/Source/Tools/QCBuild/Temp/Makefile-qcbuild-macos @@ -0,0 +1,98 @@ + +# +# DO NOT EDIT! This file was generated automatically from 'qcbuild.src' file. +# + +TITLE = qcbuild +ROOT = ./../.. +INSTALL = +BUILD = $(ROOT)/Build +BUILD_BIN = $(ROOT)/Build/Bin +BUILD_LIB = $(ROOT)/Build/Lib +BUILD_INC = $(ROOT)/Build/Include +INSTALL_BIN = +INSTALL_LIB = +INSTALL_INC = + +# +# Source lists. +# + +CSRC = +CXXSRC = $(QT_MOC) Main.cpp Utils.cpp SourceInfo.cpp SVG.cpp Diagram.cpp Scan.cpp AutoDoc.cpp +ISRC = +PREBUILD_LIBS = +PREBUILD_PROGS = +DEFINES = -DDEBUG -DDEBUG_STATE -DDLVERSION=\"0.6\" +EXE_POSTFIX = +DLL_POSTFIX = .dylib +DLL_PREFIX = lib +CXXOBJ = $(CXXSRC:.cpp=.o) +COBJ = $(CSRC:.c=.o) +OBJ = $(CXXOBJ) $(COBJ) + + +# +# Compiler/linker flags. +# + +CXX = g++ +CC = gcc +CXXFLAGS= -c -g -O3 -fPIC -L $(BUILD_LIB) -I $(BUILD_INC) $(DEFINES) +CFLAGS = -c -g -O3 -fPIC -L $(BUILD_LIB) -I $(BUILD_INC) $(DEFINES) +LIBS = -static -lfile-static -lstr-static -largs-static -ldebug-static -ldl -stdlib=libc++ -L $(BUILD_LIB) +INCLUDE = -I $(BUILD_INC) +LFLAGS = -mmacosx-version-min=10.7 +ARCH = i386 + +# +# Link objects to executable/library. +# + +all: $(TITLE)$(EXE_POSTFIX) +$(TITLE)$(EXE_POSTFIX): $(OBJ) + @echo Linking qcbuild... + $(CXX) $(LFLAGS) $(OBJ) $(LIBS) -o $@ + +# +# Compile sources to objects. +# + +$(CXXOBJ) : %.o : %.cpp + @echo Compiling $<... + @$(CXX) $(CXXFLAGS) $(INCLUDE) -c $< -o $@ + +$(COBJ) : %.o : %.c + @echo Compiling $<... + @$(CC) $(CFLAGS) $(INCLUDE) -c $< -o $@ + +# +# Make install. Copy created binaries to build dir. +# + +install: all + mkdir -p $(BUILD) + mkdir -p $(BUILD_INC) + mkdir -p $(BUILD_LIB) + mkdir -p $(BUILD_BIN) + cp -rp $(TITLE)$(EXE_POSTFIX) $(BUILD_BIN) + +# +# Make clean. Remove files created by make and make install. +# + +clean: + rm -f *.o + rm -f *.log + rm -f $(TITLE)$(EXE_POSTFIX) + rm -f *.a + rm -f *.def + +# +# Make distclean. Make clean + clean Makefile. +# + +distclean: clean + rm -f Makefile + +.PHONY: install clean distclean diff --git a/Source/Tools/QCBuild/Todo b/Source/Tools/QCBuild/Todo new file mode 100644 index 0000000..bf76218 --- /dev/null +++ b/Source/Tools/QCBuild/Todo @@ -0,0 +1,9 @@ +Autodoc: +-------- + +- Fix handling constructors and destructors in autodoc. + +Makefile generation: +-------------------- + +- Detect properly qt libs from QT_MODULES. diff --git a/Source/Tools/QCBuild/Utils.cpp b/Source/Tools/QCBuild/Utils.cpp new file mode 100644 index 0000000..a7eefd4 --- /dev/null +++ b/Source/Tools/QCBuild/Utils.cpp @@ -0,0 +1,378 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifdef WIN32 +# define WINVER 0x501 +# include <windows.h> +#endif + +#include "Utils.h" + +using namespace Tegenaria; + +using std::string; + +int MakefileMkdir(FILE *f, const char *path) +{ + fprintf(f, "\tmkdir -p %s\n", path); +} + +int MakefileRemove(FILE *f, const char *path) +{ + return fprintf(f, "\trm -f %s\n", path); +} + +int MakefileCopy(FILE *f, const char *src, const char *dst) +{ + return fprintf(f, "\tcp -rp %s %s\n", src, dst); +} + +// +// Put comment into script file. +// +// f - file, where to write comment (IN). +// str - message to put inside comment (IN). +// comment - tag used for one line comment (e.g. '#' in bash) (IN). +// + +void FilePutComment(FILE *f, const char *str, const char *comment) +{ + fprintf(f, "\n"); + fprintf(f, "%s\n", comment); + fprintf(f, "%s %s\n", comment, str); + fprintf(f, "%s\n", comment); + fprintf(f, "\n"); +} + + +// +// Skip white chars. +// +// buf[] - pointer to ASCIZ string (IN). +// +// RETURNS: pointer to first non-white char in string. +// + +char *SkipWhites(char *buf) +{ + while(isspace(*buf)) + { + buf ++; + } + + return buf; +} + +// +// Remove white chars from left and right sides of string. +// White chars on right hand are filled by zeros. +// +// p[] - pointer to ASCIZ string (IN/OUT). +// +// RETURNS: pointer to first non-white char in string. +// + +char *CleanToken(char *p) +{ + p = SkipWhites(p); + + int len = strlen(p); + + while(len > 0 && isspace(p[len - 1])) + { + len --; + + p[len] = 0; + } + + return p; +} + +// +// Go to next line at buffer. +// +// p[] - Pointer to ASCIZ string (IN/OUT). +// +// RETURNS: Pointer to begin of next line. +// + +char *SkipLine(char *p) +{ + while((*p) && (*p != 13) && (*p != 10)) + { + p ++; + } + + while((*p) && ((*p == 13) || (*p == 10))) + { + p ++; + } + + if (p[0]) + { + p[-1] = 0; + } + + return p; +} + +// +// Convert absolute component path to relative to root. +// +// path - abosolute component's path e.g. 'C:/proj/comp' (IN). +// relRoot - relative root path e.g. './../' (IN). +// +// RETURNS: pointer to relative part of component's path. +// + +char *CreateRelativePath(char *path, char *relRoot) +{ + int count = 0; + + char *p = relRoot; + + int len = strlen(path); + + while(p = strstr(p, "..")) + { + count ++; + + p += 2; + } + + p = path + len; + + if (len > 0) p --; + + while(count > 0 && len > 0) + { + p --; + + while(p > path && p[0] != '\\' && p[0] != '/') + { + p --; + } + + count --; + } + + // + // Normalize path. + // + + for (int i = 0; p[i]; i++) + { + if (p[i] == '\\') + { + p[i] = '/'; + } + } + + p ++; + + return p; +} + +// +// Retrieve QT property by 'qmake -query <property>'. +// +// lvalue - name of property to retrieve e.g. QT_INSTALL_LIBS (IN). +// +// RERUTNS: Retrieved proeprty +// or empty string if error. +// + +string QtQueryProperty(const char *lvalue) +{ + DBG_ENTER("QtQueryProperty"); + + int exitCode = -1; + + char cmd[1024]; + + char *rvalueBuf = NULL; + + string rvalue; + + // + // Run qmake -query <lvalue> + // and redirect stdout to temp file. + // + + snprintf(cmd, sizeof(cmd), "qmake -query %s > .qcbuild.tmp", lvalue); + + FAIL(system(cmd)); + + // + // Retrieve returned <rvalue> from temp file. + // + + rvalueBuf = FileLoad(".qcbuild.tmp"); + + FAIL(rvalueBuf == NULL); + + // + // Remove EOL. + // Change \\ to / for cygwin compatible. + // + + for (int i = 0; rvalueBuf[i]; i++) + { + if (rvalueBuf[i] == 10 || rvalueBuf[i] == 13) + { + rvalueBuf[i] = 0; + } + else if (rvalueBuf[i] == '\\') + { + rvalueBuf[i] = '/'; + } + } + + rvalue = rvalueBuf; + + // + // Clean up. + // + + exitCode = 0; + + fail: + + if (exitCode) + { + Error("ERROR: Cannot run qmake tool.\n" + "ERROR: Please ensure does QT is properly installed.\n"); + } + + if (rvalueBuf) + { + free(rvalueBuf); + } + + #ifdef WIN32 + DeleteFile(".qcbuild.tmp"); + #else + unlink(".qcbuild.tmp"); + #endif + + DBG_LEAVE("QtQueryProperty"); + + return rvalue; +} + +// +// Detect current running architecture. +// +// RETURNS: Returns i386, amd64 or Unknown. +// + +const char *DetectArch() +{ + DBG_ENTER("DetectArch"); + + const char *arch = "unknown"; + + // + // Windows. + // + + #ifdef WIN32 + { + // + // FIXME! + // + + arch = "i386"; + + /* + SYSTEM_INFO si = {0}; + + GetNativeSystemInfo(&si); + + switch(si.wProcessorArchitecture) + { + case PROCESSOR_ARCHITECTURE_INTEL: arch = "i386"; break; + case PROCESSOR_ARCHITECTURE_AMD64: arch = "amd64"; break; + } + */ + } + + // + // Linux, MacOS. + // + + #else + { + char cmd[1024] = {0}; + + char *unameResult = NULL; + + // + // Run 'uname -m'. + // and redirect stdout to temp file. + // + + snprintf(cmd, sizeof(cmd), "uname -m > .qcbuild.uname.tmp"); + + FAIL(system(cmd)); + + // + // Check for '64' string in uname result. + // If not found assume i386. + // + + unameResult = FileLoad(".qcbuild.uname.tmp"); + + FAIL(unameResult == NULL); + + if (strstr(unameResult, "64")) + { + arch = "amd64"; + } + else + { + arch = "i386"; + } + + // + // Clean up. + // + + fail: + + unlink(".qcbuild.uname.tmp"); + + if (unameResult) + { + free(unameResult); + } + } + #endif + + DBG_MSG("Detected architecture is [%s].\n", arch); + + DBG_LEAVE("DetectArch"); + + return arch; +} diff --git a/Source/Tools/QCBuild/Utils.h b/Source/Tools/QCBuild/Utils.h new file mode 100644 index 0000000..2b272df --- /dev/null +++ b/Source/Tools/QCBuild/Utils.h @@ -0,0 +1,52 @@ +/******************************************************************************/ +/* */ +/* Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> */ +/* */ +/* 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. */ +/* */ +/******************************************************************************/ + +#ifndef Utils_H +#define Utils_H + +#include <cstdio> +#include <string> +#include <cstring> +#include <cctype> + +#include <Tegenaria/Str.h> +#include <Tegenaria/File.h> + +int MakefileMkdir(FILE *f, const char *path); +int MakefileRemove(FILE *f, const char *path); +int MakefileCopy(FILE *f, const char *src, const char *dst); + +void FilePutComment(FILE *f, const char *str, const char *comment = "#"); + +char *CleanToken(char *p); +char *SkipLine(char *p); +char *SkipWhites(char *p); + +char *CreateRelativePath(char *path, char *relRoot); + +std::string QtQueryProperty(const char *lvalue); + +const char *DetectArch(); + +#endif /* Utils_H */ diff --git a/Source/Tools/QCBuild/qcbuild.src b/Source/Tools/QCBuild/qcbuild.src new file mode 100644 index 0000000..42eb521 --- /dev/null +++ b/Source/Tools/QCBuild/qcbuild.src @@ -0,0 +1,192 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> # +# # +# 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. # +# # +################################################################################ + +# +# Component's type. MUST set. Possible types are: +# +# PROJECT - Root component of project. All components will inherit +# compilation flags, defines etc. from it recursiely +# (see below). +# +# SIMPLE_PROGRAM - Stand alone executable ('exe') without whole project stuff. +# This means simply one component project. +# +# SIMPLE_LIBRARY - Stand alone library ('dll') without whole project stuff. +# This means simply one component project. +# +# PROGRAM - Executable ('exe'), which is part of bigger project. +# Definition of root component (in qcbuild.src) MUST exists +# in parent (grandparnet, grandgrandparent etc) directory. +# +# LIBRARY - Library ('dll'), which is part of bigger project. +# Definition of root component (in qcbuild.src) MUST exists +# in parent (grandparnet, grandgrandparent etc) directory. +# + +TYPE = PROGRAM + +# +# Title of component. SHOULD set. +# If skipped 'Untitled' will be used instead. +# + +TITLE = qcbuild + +# +# List of sources files. +# MUST be set if any sources to build. +# If only prebuild, it MUST be skipped. OPTIONAL. +# + +CXXSRC = Main.cpp Utils.cpp SourceInfo.cpp SVG.cpp Diagram.cpp +CXXSRC += Scan.cpp AutoDoc.cpp + +# +# Header files exported by component to others. OPTIONAL. +# + +ISRC = + +# +# List of prebuild programs (exes) and libraries. +# +# PREBUILD_PROGS will be copied into Build/Bin +# PREBUILD_LIBS will be copied into Build/Lib +# +# $(ARCH) keyword in filenames will be replaced by i386 or amd64 +# while makefile created. +# +# Example: +# PREBUILD_LIBS = Prebuild/$(ARCH)/driver.sys will become: +# +# 'Prebuild/i386/driver.sys' on IA32 target, +# 'Prebuild/amd64/driver.sys' on AMD64 target. +# +# To use differente prebuild on differente OSes use .section syntax +# (see below for .section example). +# + +PREBUILD_PROGS = +PREBUILD_LIBS = + +# +# Path where to find external headers. OPTIONAL. +# + +INCLUDE = + +# +# Defines for C/C++ preprocessor. If specified inside root component +# (PROJECT type) all components will inherit it recursively. +# We can use it for example to enable DEBUG flag in whole project. +# OPTIONAL. +# + +#DEFINES = -DDEBUG -DDEBUG_LEVEL=3 + +# +# List of libraries to link. OPTIONAL. +# + +LIBS = -static -lfile-static -lstr-static -largs-static -ldebug-static + +# +# Used license (GPL, BSD, Commercial etc.). +# OPTIONAL. If skipped will be defaulted to 'Unknown' keyword. +# + +LICENSE = GPL + +# +# List of author(s). OPTIONAL. +# If skipped will be deafulted to 'Unknown' keyword. +# + +AUTHOR = Sylwester Wysocki <sw143@wp.pl> + +# +# Short list, what does component do and why we need it. +# Used by auto-documentation tools. OPTIONAL. +# + +PURPOSE = Convert platform independend 'qcbuild.src' file(s) +PURPOSE += into script(s) ready to build project on target platform. +PURPOSE += Ships auto-documentation tool. + +# +# Longer description for auto-documentation tools. OPTIONAL. +# + +DESC = - + +# +# List of another components (inside project), which MUST be +# built before this one. Needed to resolve dependencies while +# generating main Build/Clean scripts and by auto-documentation +# tools. +# MUST set if any dependencies exist. +# + +DEPENDS = LibFile LibStr LibDebug LibArgs + +# +# QT Specific. Optionals. +# + +QT_HEADERS = +QT_FORMS = +QT_MODULES = +LIBS += + +# +# Platform specific variables. OPTIONAL. +# If one of above variables is platform specific we can: +# +# - redefine it by '=' operator (old value will be overwritten). +# +# - expand existing value by '+=' operator. E.g. we can add '-ldl' +# to LIBS only on Linux platform. +# + +.section Linux +.endsection + +.section MacOS +.endsection + +.section MinGW +.endsection + +.section iOS +.endsection + +.section Android +.endsection + +# +# Multiple OS section example. +# + +.section iOS, MacOS, MinGW +.endsection diff --git a/qcbuild.src b/qcbuild.src new file mode 100644 index 0000000..c2adeca --- /dev/null +++ b/qcbuild.src @@ -0,0 +1,73 @@ +################################################################################ +# # +# Copyright (c) 2010, 2014 Sylwester Wysocki <sw143@wp.pl> # +# # +# LibLock, LibProcess, LibThread: # +# Copyright (c) 2010, 2014 Lukasz Bienczyk <lukasz.bienczyk@gmail.com>, # +# Radoslaw Kolodziejczyk <radek.kolodziejczyk@gmail.com>, # +# Sylwester Wysocki <sw143@wp.pl> # +# # +# 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. # +# # +################################################################################ + +# +# Libs project's root. +# + +TYPE = PROJECT +TITLE = Tegenaria +INCLUDE = +LIBS = + +# +# Enable compilation of DBG_XXX code. +# + +# DEFINES = -DDEBUG -DDEBUG_STATE + +# +# Add default copyright and license. +# If needed, can be overwritten in selected component. +# + +COPYRIGHT = (C) Sylwester Wysocki 2010, 2014 +LICENSE = MIT (See LICENSE.txt file) +VERSION = 0.5 + +# +# Linux specified. +# Add -lpthread to every components. +# + +.section MinGW + LIBS += -Wno-deprecated -lws2_32 -lnetapi32 -lgdi32 -lwinspool + LIBS += -luserenv -lshlwapi -lole32 -lstdc++ -lWtsapi32 +.endsection + +.section Linux + LIBS += -lpthread -lrt +.endsection + +# +# Auto-documentation flags. +# + +AUTODOC_PRIVATE_DIRS = Source/Import Source/Tools +AUTODOC_SKIP_EXAMPLES = 1