citadel/citadel_ipc.h

   1 /* $Id$ */
   2
   3 #include "sysdep.h"
   4 #ifdef HAVE_PTHREAD_H
   5 #include <pthread.h>
   6 #endif
   7 #ifdef HAVE_OPENSSL
   8 #include <openssl/ssl.h>
   9 #include <openssl/err.h>
  10 #include <openssl/rand.h>
  11 #endif
  12
  13 #ifdef __cplusplus
  14 extern "C" {
  15 #endif
  16
  17 /* Quick and dirty hack; we don't want to use malloc() in C++ */
  18 #ifdef __cplusplus
  19 #define ialloc(t)       new t()
  20 #define ifree(o)        delete o
  21 #else
  22 #define ialloc(t)       malloc(sizeof(t))
  23 #define ifree(o)        free(o);
  24 #endif
  25
  26 /* This class is responsible for the server connection */
  27 typedef struct _CtdlIPC {
  28 #if defined(HAVE_OPENSSL)
  29         /* NULL if not encrypted, non-NULL otherwise */
  30         SSL *ssl;
  31 #endif
  32 #if defined(HAVE_PTHREAD_H)
  33         /* Fast mutex, call CtdlIPC_lock() or CtdlIPC_unlock() to use */
  34         pthread_mutex_t mutex;
  35 #endif
  36         /* -1 if not connected, >= 0 otherwise */
  37         int sock;
  38         /* 1 if server is local, 0 otherwise or if not connected */
  39         int isLocal;
  40         /* 1 if a download is open on the server, 0 otherwise */
  41         int downloading;
  42         /* 1 if an upload is open on the server, 0 otherwise */
  43         int uploading;
  44         /* Time the last command was sent to the server */
  45         time_t last_command_sent;
  46 } CtdlIPC;
  47
  48 /* C constructor */
  49 CtdlIPC* CtdlIPC_new(int argc, char **argv, char *hostbuf, char *portbuf);
  50 /* C destructor */
  51 void CtdlIPC_delete(CtdlIPC* ipc);
  52 /* Convenience destructor; also nulls out caller's pointer */
  53 void CtdlIPC_delete_ptr(CtdlIPC** pipc);
  54 /* Read a line from server, discarding newline */
  55 void CtdlIPC_getline(CtdlIPC* ipc, char *buf);
  56 /* Write a line to server, adding newline */
  57 void CtdlIPC_putline(CtdlIPC* ipc, const char *buf);
  58
  59 struct ctdlipcroom {
  60         char RRname[ROOMNAMELEN];       /* Name of room */
  61         long RRunread;                  /* Number of unread messages */
  62         long RRtotal;                   /* Total number of messages in room */
  63         char RRinfoupdated;             /* Nonzero if info was updated */
  64         unsigned RRflags;               /* Various flags (see LKRN) */
  65         long RRhighest;                 /* Highest message number in room */
  66         long RRlastread;                /* Highest message user has read */
  67         char RRismailbox;               /* Is this room a mailbox room? */
  68         char RRaide;                    /* User can do aide commands in room */
  69         long RRnewmail;                 /* Number of new mail messages */
  70         char RRfloor;                   /* Which floor this room is on */
  71 };
  72
  73
  74 struct parts {
  75         struct parts *next;
  76         char number[16];                /* part number */
  77         char name[PATH_MAX];            /* Name */
  78         char filename[PATH_MAX];        /* Suggested filename */
  79         char mimetype[SIZ];             /* MIME type */
  80         char disposition[SIZ];          /* Content disposition */
  81         unsigned long length;           /* Content length */
  82 };
  83
  84
  85 struct ctdlipcmessage {
  86         char msgid[SIZ];                /* Original message ID */
  87         char path[SIZ];                 /* Return path to sender */
  88         char zaps[SIZ];                 /* Message ID that this supersedes */
  89         char subject[SIZ];              /* Message subject */
  90         char email[SIZ];                /* Email address of sender */
  91         char author[USERNAME_SIZE];     /* Sender of message */
  92         char recipient[USERNAME_SIZE];  /* Recipient of message */
  93         char room[ROOMNAMELEN];         /* Originating room */
  94         char node[16];                  /* Short nodename of origin system */
  95         char hnod[21];                  /* Humannode of origin system */
  96         struct parts *attachments;      /* Available attachments */
  97         char *text;                     /* Message text */
  98         int type;                       /* Message type */
  99         time_t time;                    /* Time message was posted */
 100         char nhdr;                      /* Suppress message header? */
 101         char anonymous;                 /* An anonymous message */
 102         char mime_chosen[SIZ];          /* Chosen MIME part to output */
 103         char content_type[SIZ];         /* How would you like that? */
 104 };
 105
 106
 107 struct ctdlipcmisc {
 108         long newmail;                   /* Number of new Mail messages */
 109         char needregis;                 /* Nonzero if user needs to register */
 110         char needvalid;                 /* Nonzero if users need validation */
 111 };
 112
 113 /* Shared Diffie-Hellman parameters */
 114 #define DH_P            "1A74527AEE4EE2568E85D4FB2E65E18C9394B9C80C42507D7A6A0DBE9A9A54B05A9A96800C34C7AA5297095B69C88901EEFD127F969DCA26A54C0E0B5C5473EBAEB00957D2633ECAE3835775425DE66C0DE6D024DBB17445E06E6B0C78415E589B8814F08531D02FD43778451E7685541079CFFB79EF0D26EFEEBBB69D1E80383"
 115 #define DH_G            "2"
 116 #define DH_L            1024
 117 #define CIT_CIPHERS     "ALL:RC4+RSA:+SSLv2:@STRENGTH"  /* see ciphers(1) */
 118
 119 int CtdlIPCNoop(CtdlIPC *ipc);
 120 int CtdlIPCEcho(CtdlIPC *ipc, const char *arg, char *cret);
 121 int CtdlIPCQuit(CtdlIPC *ipc);
 122 int CtdlIPCLogout(CtdlIPC *ipc);
 123 int CtdlIPCTryLogin(CtdlIPC *ipc, const char *username, char *cret);
 124 int CtdlIPCTryPassword(CtdlIPC *ipc, const char *passwd, char *cret);
 125 int CtdlIPCCreateUser(CtdlIPC *ipc, const char *username, int selfservice, char *cret);
 126 int CtdlIPCChangePassword(CtdlIPC *ipc, const char *passwd, char *cret);
 127 int CtdlIPCKnownRooms(CtdlIPC *ipc, int which, int floor, struct march **listing, char *cret);
 128 int CtdlIPCGetConfig(CtdlIPC *ipc, struct usersupp **uret, char *cret);
 129 int CtdlIPCSetConfig(CtdlIPC *ipc, struct usersupp *uret, char *cret);
 130 int CtdlIPCGotoRoom(CtdlIPC *ipc, const char *room, const char *passwd,
 131                 struct ctdlipcroom **rret, char *cret);
 132 int CtdlIPCGetMessages(CtdlIPC *ipc, int which, int whicharg, const char *template,
 133                 long **mret, char *cret);
 134 int CtdlIPCGetSingleMessage(CtdlIPC *ipc, long msgnum, int headers, int as_mime,
 135                 struct ctdlipcmessage **mret, char *cret);
 136 int CtdlIPCWhoKnowsRoom(CtdlIPC *ipc, char **listing, char *cret);
 137 int CtdlIPCServerInfo(CtdlIPC *ipc, struct CtdlServInfo *ServInfo, char *cret);
 138 int CtdlIPCReadDirectory(CtdlIPC *ipc, char **listing, char *cret);
 139 int CtdlIPCSetLastRead(CtdlIPC *ipc, long msgnum, char *cret);
 140 int CtdlIPCInviteUserToRoom(CtdlIPC *ipc, const char *username, char *cret);
 141 int CtdlIPCKickoutUserFromRoom(CtdlIPC *ipc, const char *username, char *cret);
 142 int CtdlIPCGetRoomAttributes(CtdlIPC *ipc, struct quickroom **qret, char *cret);
 143 int CtdlIPCSetRoomAttributes(CtdlIPC *ipc, int forget, struct quickroom *qret, char *cret);
 144 int CtdlIPCGetRoomAide(CtdlIPC *ipc, char *cret);
 145 int CtdlIPCSetRoomAide(CtdlIPC *ipc, const char *username, char *cret);
 146 int CtdlIPCPostMessage(CtdlIPC *ipc, int flag, const struct ctdlipcmessage *mr, char *cret);
 147 int CtdlIPCRoomInfo(CtdlIPC *ipc, char **iret, char *cret);
 148 int CtdlIPCDeleteMessage(CtdlIPC *ipc, long msgnum, char *cret);
 149 int CtdlIPCMoveMessage(CtdlIPC *ipc, int copy, long msgnum, const char *destroom, char *cret);
 150 int CtdlIPCDeleteRoom(CtdlIPC *ipc, int for_real, char *cret);
 151 int CtdlIPCCreateRoom(CtdlIPC *ipc, int for_real, const char *roomname, int type,
 152                 const char *password, int floor, char *cret);
 153 int CtdlIPCForgetRoom(CtdlIPC *ipc, char *cret);
 154 int CtdlIPCSystemMessage(CtdlIPC *ipc, const char *message, char **mret, char *cret);
 155 int CtdlIPCNextUnvalidatedUser(CtdlIPC *ipc, char *cret);
 156 int CtdlIPCGetUserRegistration(CtdlIPC *ipc, const char *username, char **rret, char *cret);
 157 int CtdlIPCValidateUser(CtdlIPC *ipc, const char *username, int axlevel, char *cret);
 158 int CtdlIPCSetRoomInfo(CtdlIPC *ipc, int for_real, const char *info, char *cret);
 159 int CtdlIPCUserListing(CtdlIPC *ipc, char **list, char *cret);
 160 int CtdlIPCSetRegistration(CtdlIPC *ipc, const char *info, char *cret);
 161 int CtdlIPCMiscCheck(CtdlIPC *ipc, struct ctdlipcmisc *chek, char *cret);
 162 int CtdlIPCDeleteFile(CtdlIPC *ipc, const char *filename, char *cret);
 163 int CtdlIPCMoveFile(CtdlIPC *ipc, const char *filename, const char *destroom, char *cret);
 164 int CtdlIPCNetSendFile(CtdlIPC *ipc, const char *filename, const char *destnode, char *cret);
 165 int CtdlIPCOnlineUsers(CtdlIPC *ipc, char **listing, time_t *stamp, char *cret);
 166 int CtdlIPCFileDownload(CtdlIPC *ipc, const char *filename, void **buf,
 167                 size_t resume, void (*progress_gauge_callback)(long, long),
 168                 char *cret);
 169 int CtdlIPCAttachmentDownload(CtdlIPC *ipc, long msgnum, const char *part, void **buf,
 170                 void (*progress_gauge_callback)(long, long), char *cret);
 171 int CtdlIPCImageDownload(CtdlIPC *ipc, const char *filename, void **buf,
 172                 void (*progress_gauge_callback)(long, long), char *cret);
 173 int CtdlIPCFileUpload(CtdlIPC *ipc, const char *save_as, const char *comment,
 174                 const char *path, void (*progress_gauge_callback)(long, long),
 175                 char *cret);
 176 int CtdlIPCImageUpload(CtdlIPC *ipc, int for_real, const char *path,
 177                 const char *save_as,
 178                 void (*progress_gauge_callback)(long, long), char *cret);
 179 int CtdlIPCQueryUsername(CtdlIPC *ipc, const char *username, char *cret);
 180 int CtdlIPCFloorListing(CtdlIPC *ipc, char **listing, char *cret);
 181 int CtdlIPCCreateFloor(CtdlIPC *ipc, int for_real, const char *name, char *cret);
 182 int CtdlIPCDeleteFloor(CtdlIPC *ipc, int for_real, int floornum, char *cret);
 183 int CtdlIPCEditFloor(CtdlIPC *ipc, int floornum, const char *floorname, char *cret);
 184 int CtdlIPCIdentifySoftware(CtdlIPC *ipc, int developerid, int clientid, int revision,
 185                 const char *software_name, const char *hostname, char *cret);
 186 int CtdlIPCSendInstantMessage(CtdlIPC *ipc, const char *username, const char *text,
 187                 char *cret);
 188 int CtdlIPCGetInstantMessage(CtdlIPC *ipc, char **listing, char *cret);
 189 int CtdlIPCEnableInstantMessageReceipt(CtdlIPC *ipc, int mode, char *cret);
 190 int CtdlIPCSetBio(CtdlIPC *ipc, char *bio, char *cret);
 191 int CtdlIPCGetBio(CtdlIPC *ipc, const char *username, char **listing, char *cret);
 192 int CtdlIPCListUsersWithBios(CtdlIPC *ipc, char **listing, char *cret);
 193 int CtdlIPCStealthMode(CtdlIPC *ipc, int mode, char *cret);
 194 int CtdlIPCTerminateSession(CtdlIPC *ipc, int sid, char *cret);
 195 int CtdlIPCTerminateServerNow(CtdlIPC *ipc, char *cret);
 196 int CtdlIPCTerminateServerScheduled(CtdlIPC *ipc, int mode, char *cret);
 197 int CtdlIPCEnterSystemMessage(CtdlIPC *ipc, const char *filename, const char *text,
 198                 char *cret);
 199 int CtdlIPCChangeHostname(CtdlIPC *ipc, const char *hostname, char *cret);
 200 int CtdlIPCChangeRoomname(CtdlIPC *ipc, const char *roomname, char *cret);
 201 int CtdlIPCChangeUsername(CtdlIPC *ipc, const char *username, char *cret);
 202 time_t CtdlIPCServerTime(CtdlIPC *ipc, char *crert);
 203 int CtdlIPCAideGetUserParameters(CtdlIPC *ipc, const char *who,
 204                                  struct usersupp **uret, char *cret);
 205 int CtdlIPCAideSetUserParameters(CtdlIPC *ipc, const struct usersupp *uret, char *cret);
 206 int CtdlIPCGetMessageExpirationPolicy(CtdlIPC *ipc, int which, char *cret);
 207 int CtdlIPCSetMessageExpirationPolicy(CtdlIPC *ipc, int which, int policy, int value,
 208                 char *cret);
 209 int CtdlGetSystemConfig(CtdlIPC *ipc, char **listing, char *cret);
 210 int CtdlSetSystemConfig(CtdlIPC *ipc, const char *listing, char *cret);
 211 int CtdlGetSystemConfigByType(CtdlIPC *ipc, const char *mimetype,
 212                 char **listing, char *cret);
 213 int CtdlSetSystemConfigByType(CtdlIPC *ipc, const char *mimetype,
 214                const char *listing, char *cret);
 215 int CtdlIPCModerateMessage(CtdlIPC *ipc, long msgnum, int level, char *cret);
 216 int CtdlIPCRequestClientLogout(CtdlIPC *ipc, int session, char *cret);
 217 int CtdlIPCSetMessageSeen(CtdlIPC *ipc, long msgnum, int seen, char *cret);
 218 int CtdlIPCStartEncryption(CtdlIPC *ipc, char *cret);
 219 int CtdlIPCDirectoryLookup(CtdlIPC *ipc, const char *address, char *cret);
 220 int CtdlIPCSpecifyPreferredFormats(CtdlIPC *ipc, char *cret, char *formats);
 221 int CtdlIPCInternalProgram(CtdlIPC *ipc, int secret, char *cret);
 222
 223 /* ************************************************************************** */
 224 /*             Stuff below this line is not for public consumption            */
 225 /* ************************************************************************** */
 226
 227 inline void CtdlIPC_lock(CtdlIPC *ipc);
 228 inline void CtdlIPC_unlock(CtdlIPC *ipc);
 229 char *CtdlIPCReadListing(CtdlIPC *ipc, char *dest);
 230 int CtdlIPCSendListing(CtdlIPC *ipc, const char *listing);
 231 size_t CtdlIPCPartialRead(CtdlIPC *ipc, void **buf, size_t offset,
 232                 size_t bytes, char *cret);
 233 int CtdlIPCEndUpload(CtdlIPC *ipc, int discard, char *cret);
 234 int CtdlIPCWriteUpload(CtdlIPC *ipc, const char *path,
 235                 void (*progress_gauge_callback)(long, long), char *cret);
 236 int CtdlIPCEndDownload(CtdlIPC *ipc, char *cret);
 237 int CtdlIPCReadDownload(CtdlIPC *ipc, void **buf, size_t bytes, size_t resume,
 238                 void (*progress_gauge_callback)(long, long), char *cret);
 239 int CtdlIPCHighSpeedReadDownload(CtdlIPC *ipc, void **buf, size_t bytes,
 240                 size_t resume, void (*progress_gauge_callback)(long, long),
 241                 char *cret);
 242 int CtdlIPCGenericCommand(CtdlIPC *ipc, const char *command,
 243                 const char *to_send, size_t bytes_to_send, char **to_receive,
 244                 size_t *bytes_to_receive, char *proto_response);
 245
 246 /* Internals */
 247 int starttls(CtdlIPC *ipc);
 248 void setCryptoStatusHook(void (*hook)(char *s));
 249 /* This is all Ford's doing.  FIXME: figure out what it's doing */
 250 extern int (*error_printf)(char *s, ...);
 251 void setIPCDeathHook(void (*hook)(void));
 252 void setIPCErrorPrintf(int (*func)(char *s, ...));
 253
 254 #ifdef __cplusplus
 255 }
 256 #endif