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         /* Callback for update on whether the IPC is locked */
  47         void (*network_status_cb)(int state);
  48 } CtdlIPC;
  49
  50 /* C constructor */
  51 CtdlIPC* CtdlIPC_new(int argc, char **argv, char *hostbuf, char *portbuf);
  52 /* C destructor */
  53 void CtdlIPC_delete(CtdlIPC* ipc);
  54 /* Convenience destructor; also nulls out caller's pointer */
  55 void CtdlIPC_delete_ptr(CtdlIPC** pipc);
  56 /* Read a line from server, discarding newline */
  57 void CtdlIPC_getline(CtdlIPC* ipc, char *buf);
  58 /* Write a line to server, adding newline */
  59 void CtdlIPC_putline(CtdlIPC* ipc, const char *buf);
  60
  61 struct ctdlipcroom {
  62         char RRname[ROOMNAMELEN];       /* Name of room */
  63         long RRunread;                  /* Number of unread messages */
  64         long RRtotal;                   /* Total number of messages in room */
  65         char RRinfoupdated;             /* Nonzero if info was updated */
  66         unsigned RRflags;               /* Various flags (see LKRN) */
  67         long RRhighest;                 /* Highest message number in room */
  68         long RRlastread;                /* Highest message user has read */
  69         char RRismailbox;               /* Is this room a mailbox room? */
  70         char RRaide;                    /* User can do aide commands in room */
  71         long RRnewmail;                 /* Number of new mail messages */
  72         char RRfloor;                   /* Which floor this room is on */
  73 };
  74
  75
  76 struct parts {
  77         struct parts *next;
  78         char number[16];                /* part number */
  79         char name[PATH_MAX];            /* Name */
  80         char filename[PATH_MAX];        /* Suggested filename */
  81         char mimetype[SIZ];             /* MIME type */
  82         char disposition[SIZ];          /* Content disposition */
  83         unsigned long length;           /* Content length */
  84 };
  85
  86
  87 struct ctdlipcmessage {
  88         char msgid[SIZ];                /* Original message ID */
  89         char path[SIZ];                 /* Return path to sender */
  90         char zaps[SIZ];                 /* Message ID that this supersedes */
  91         char subject[SIZ];              /* Message subject */
  92         char email[SIZ];                /* Email address of sender */
  93         char author[USERNAME_SIZE];     /* Sender of message */
  94         char recipient[USERNAME_SIZE];  /* Recipient of message */
  95         char room[ROOMNAMELEN];         /* Originating room */
  96         char node[16];                  /* Short nodename of origin system */
  97         char hnod[21];                  /* Humannode of origin system */
  98         struct parts *attachments;      /* Available attachments */
  99         char *text;                     /* Message text */
 100         int type;                       /* Message type */
 101         time_t time;                    /* Time message was posted */
 102         char nhdr;                      /* Suppress message header? */
 103         char anonymous;                 /* An anonymous message */
 104         char mime_chosen[SIZ];          /* Chosen MIME part to output */
 105         char content_type[SIZ];         /* How would you like that? */
 106 };
 107
 108
 109 struct ctdlipcfile {
 110         char remote_name[PATH_MAX];     /* Filename on server */
 111         char local_name[PATH_MAX];      /* Filename on client */
 112         char description[80];           /* Description on server */
 113         FILE *local_fd;                 /* Open file on client */
 114         size_t size;                    /* Size of file in octets */
 115         int upload:1;                   /* uploading? 0 if downloading */
 116         int complete:1;                 /* Transfer has finished? */
 117 };
 118
 119
 120 struct ctdlipcmisc {
 121         long newmail;                   /* Number of new Mail messages */
 122         char needregis;                 /* Nonzero if user needs to register */
 123         char needvalid;                 /* Nonzero if users need validation */
 124 };
 125
 126 enum RoomList {
 127         SubscribedRooms,
 128         SubscribedRoomsWithNewMessages,
 129         SubscribedRoomsWithNoNewMessages,
 130         UnsubscribedRooms,
 131         AllAccessibleRooms,
 132         AllPublicRooms,
 133 };
 134 #define AllFloors -1
 135 enum MessageList {
 136         AllMessages,
 137         OldMessages,
 138         NewMessages,
 139         LastMessages,
 140         FirstMessages,
 141         MessagesGreaterThan,
 142         MessagesLessThan,
 143 };
 144 enum MessageDirection {
 145         ReadReverse = -1,
 146         ReadForward = 1,
 147 };
 148
 149 /* Shared Diffie-Hellman parameters */
 150 #define DH_P            "1A74527AEE4EE2568E85D4FB2E65E18C9394B9C80C42507D7A6A0DBE9A9A54B05A9A96800C34C7AA5297095B69C88901EEFD127F969DCA26A54C0E0B5C5473EBAEB00957D2633ECAE3835775425DE66C0DE6D024DBB17445E06E6B0C78415E589B8814F08531D02FD43778451E7685541079CFFB79EF0D26EFEEBBB69D1E80383"
 151 #define DH_G            "2"
 152 #define DH_L            1024
 153 #define CIT_CIPHERS     "ALL:RC4+RSA:+SSLv2:@STRENGTH"  /* see ciphers(1) */
 154
 155 int CtdlIPCNoop(CtdlIPC *ipc);
 156 int CtdlIPCEcho(CtdlIPC *ipc, const char *arg, char *cret);
 157 int CtdlIPCQuit(CtdlIPC *ipc);
 158 int CtdlIPCLogout(CtdlIPC *ipc);
 159 int CtdlIPCTryLogin(CtdlIPC *ipc, const char *username, char *cret);
 160 int CtdlIPCTryPassword(CtdlIPC *ipc, const char *passwd, char *cret);
 161 int CtdlIPCTryApopPassword(CtdlIPC *ipc, const char *response, char *cret);
 162 int CtdlIPCCreateUser(CtdlIPC *ipc, const char *username, int selfservice,
 163                 char *cret);
 164 int CtdlIPCChangePassword(CtdlIPC *ipc, const char *passwd, char *cret);
 165 int CtdlIPCKnownRooms(CtdlIPC *ipc, enum RoomList which, int floor,
 166                 struct march **listing, char *cret);
 167 int CtdlIPCGetConfig(CtdlIPC *ipc, struct ctdluser **uret, char *cret);
 168 int CtdlIPCSetConfig(CtdlIPC *ipc, struct ctdluser *uret, char *cret);
 169 int CtdlIPCGotoRoom(CtdlIPC *ipc, const char *room, const char *passwd,
 170                 struct ctdlipcroom **rret, char *cret);
 171 int CtdlIPCGetMessages(CtdlIPC *ipc, enum MessageList which, int whicharg,
 172                 const char *mtemplate, unsigned long **mret, char *cret);
 173 int CtdlIPCGetSingleMessage(CtdlIPC *ipc, long msgnum, int headers, int as_mime,
 174                 struct ctdlipcmessage **mret, char *cret);
 175 int CtdlIPCWhoKnowsRoom(CtdlIPC *ipc, char **listing, char *cret);
 176 int CtdlIPCServerInfo(CtdlIPC *ipc, struct CtdlServInfo *ServInfo, char *cret);
 177 /* int CtdlIPCReadDirectory(CtdlIPC *ipc, struct ctdlipcfile **files, char *cret); */
 178 int CtdlIPCReadDirectory(CtdlIPC *ipc, char **listing, char *cret);
 179 int CtdlIPCSetLastRead(CtdlIPC *ipc, long msgnum, char *cret);
 180 int CtdlIPCInviteUserToRoom(CtdlIPC *ipc, const char *username, char *cret);
 181 int CtdlIPCKickoutUserFromRoom(CtdlIPC *ipc, const char *username, char *cret);
 182 int CtdlIPCGetRoomAttributes(CtdlIPC *ipc, struct ctdlroom **qret, char *cret);
 183 int CtdlIPCSetRoomAttributes(CtdlIPC *ipc, int forget, struct ctdlroom *qret,
 184                 char *cret);
 185 int CtdlIPCGetRoomAide(CtdlIPC *ipc, char *cret);
 186 int CtdlIPCSetRoomAide(CtdlIPC *ipc, const char *username, char *cret);
 187 int CtdlIPCPostMessage(CtdlIPC *ipc, int flag, const struct ctdlipcmessage *mr,
 188                 char *cret);
 189 int CtdlIPCRoomInfo(CtdlIPC *ipc, char **iret, char *cret);
 190 int CtdlIPCDeleteMessage(CtdlIPC *ipc, long msgnum, char *cret);
 191 int CtdlIPCMoveMessage(CtdlIPC *ipc, int copy, long msgnum,
 192                 const char *destroom, char *cret);
 193 int CtdlIPCDeleteRoom(CtdlIPC *ipc, int for_real, char *cret);
 194 int CtdlIPCCreateRoom(CtdlIPC *ipc, int for_real, const char *roomname,
 195                 int type, const char *password, int floor, char *cret);
 196 int CtdlIPCForgetRoom(CtdlIPC *ipc, char *cret);
 197 int CtdlIPCSystemMessage(CtdlIPC *ipc, const char *message, char **mret,
 198                 char *cret);
 199 int CtdlIPCNextUnvalidatedUser(CtdlIPC *ipc, char *cret);
 200 int CtdlIPCGetUserRegistration(CtdlIPC *ipc, const char *username, char **rret,
 201                 char *cret);
 202 int CtdlIPCValidateUser(CtdlIPC *ipc, const char *username, int axlevel,
 203                 char *cret);
 204 int CtdlIPCSetRoomInfo(CtdlIPC *ipc, int for_real, const char *info,
 205                 char *cret);
 206 int CtdlIPCUserListing(CtdlIPC *ipc, char **list, char *cret);
 207 int CtdlIPCSetRegistration(CtdlIPC *ipc, const char *info, char *cret);
 208 int CtdlIPCMiscCheck(CtdlIPC *ipc, struct ctdlipcmisc *chek, char *cret);
 209 int CtdlIPCDeleteFile(CtdlIPC *ipc, const char *filename, char *cret);
 210 int CtdlIPCMoveFile(CtdlIPC *ipc, const char *filename, const char *destroom,
 211                 char *cret);
 212 int CtdlIPCNetSendFile(CtdlIPC *ipc, const char *filename,
 213                 const char *destnode, char *cret);
 214 int CtdlIPCOnlineUsers(CtdlIPC *ipc, char **listing, time_t *stamp, char *cret);
 215 int CtdlIPCFileDownload(CtdlIPC *ipc, const char *filename, void **buf,
 216                 size_t resume,
 217                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 218                 char *cret);
 219 int CtdlIPCAttachmentDownload(CtdlIPC *ipc, long msgnum, const char *part,
 220                 void **buf,
 221                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 222                 char *cret);
 223 int CtdlIPCImageDownload(CtdlIPC *ipc, const char *filename, void **buf,
 224                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 225                 char *cret);
 226 int CtdlIPCFileUpload(CtdlIPC *ipc, const char *save_as, const char *comment,
 227                 const char *path,
 228                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 229                 char *cret);
 230 int CtdlIPCImageUpload(CtdlIPC *ipc, int for_real, const char *path,
 231                 const char *save_as,
 232                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 233                 char *cret);
 234 int CtdlIPCQueryUsername(CtdlIPC *ipc, const char *username, char *cret);
 235 int CtdlIPCFloorListing(CtdlIPC *ipc, char **listing, char *cret);
 236 int CtdlIPCCreateFloor(CtdlIPC *ipc, int for_real, const char *name,
 237                 char *cret);
 238 int CtdlIPCDeleteFloor(CtdlIPC *ipc, int for_real, int floornum, char *cret);
 239 int CtdlIPCEditFloor(CtdlIPC *ipc, int floornum, const char *floorname,
 240                 char *cret);
 241 int CtdlIPCIdentifySoftware(CtdlIPC *ipc, int developerid, int clientid,
 242                 int revision, const char *software_name, const char *hostname,
 243                 char *cret);
 244 int CtdlIPCSendInstantMessage(CtdlIPC *ipc, const char *username,
 245                 const char *text, char *cret);
 246 int CtdlIPCGetInstantMessage(CtdlIPC *ipc, char **listing, char *cret);
 247 int CtdlIPCEnableInstantMessageReceipt(CtdlIPC *ipc, int mode, char *cret);
 248 int CtdlIPCSetBio(CtdlIPC *ipc, char *bio, char *cret);
 249 int CtdlIPCGetBio(CtdlIPC *ipc, const char *username, char **listing,
 250                 char *cret);
 251 int CtdlIPCListUsersWithBios(CtdlIPC *ipc, char **listing, char *cret);
 252 int CtdlIPCStealthMode(CtdlIPC *ipc, int mode, char *cret);
 253 int CtdlIPCTerminateSession(CtdlIPC *ipc, int sid, char *cret);
 254 int CtdlIPCTerminateServerNow(CtdlIPC *ipc, char *cret);
 255 int CtdlIPCTerminateServerScheduled(CtdlIPC *ipc, int mode, char *cret);
 256 int CtdlIPCEnterSystemMessage(CtdlIPC *ipc, const char *filename, const char *text,
 257                 char *cret);
 258 int CtdlIPCChangeHostname(CtdlIPC *ipc, const char *hostname, char *cret);
 259 int CtdlIPCChangeRoomname(CtdlIPC *ipc, const char *roomname, char *cret);
 260 int CtdlIPCChangeUsername(CtdlIPC *ipc, const char *username, char *cret);
 261 time_t CtdlIPCServerTime(CtdlIPC *ipc, char *crert);
 262 int CtdlIPCAideGetUserParameters(CtdlIPC *ipc, const char *who,
 263                                  struct ctdluser **uret, char *cret);
 264 int CtdlIPCAideSetUserParameters(CtdlIPC *ipc, const struct ctdluser *uret, char *cret);
 265 int CtdlIPCGetMessageExpirationPolicy(CtdlIPC *ipc, int which,
 266                 struct ExpirePolicy **policy, char *cret);
 267 int CtdlIPCSetMessageExpirationPolicy(CtdlIPC *ipc, int which,
 268                 struct ExpirePolicy *policy, char *cret);
 269 int CtdlIPCGetSystemConfig(CtdlIPC *ipc, char **listing, char *cret);
 270 int CtdlIPCSetSystemConfig(CtdlIPC *ipc, const char *listing, char *cret);
 271 int CtdlIPCGetSystemConfigByType(CtdlIPC *ipc, const char *mimetype,
 272                 char **listing, char *cret);
 273 int CtdlIPCSetSystemConfigByType(CtdlIPC *ipc, const char *mimetype,
 274                const char *listing, char *cret);
 275 int CtdlIPCRequestClientLogout(CtdlIPC *ipc, int session, char *cret);
 276 int CtdlIPCSetMessageSeen(CtdlIPC *ipc, long msgnum, int seen, char *cret);
 277 int CtdlIPCStartEncryption(CtdlIPC *ipc, char *cret);
 278 int CtdlIPCDirectoryLookup(CtdlIPC *ipc, const char *address, char *cret);
 279 int CtdlIPCSpecifyPreferredFormats(CtdlIPC *ipc, char *cret, char *formats);
 280 int CtdlIPCInternalProgram(CtdlIPC *ipc, int secret, char *cret);
 281 int CtdlIPCMessageBaseCheck(CtdlIPC *ipc, char **mret, char *cret);
 282
 283 /* ************************************************************************** */
 284 /*             Stuff below this line is not for public consumption            */
 285 /* ************************************************************************** */
 286
 287 inline void CtdlIPC_lock(CtdlIPC *ipc);
 288 inline void CtdlIPC_unlock(CtdlIPC *ipc);
 289 char *CtdlIPCReadListing(CtdlIPC *ipc, char *dest);
 290 int CtdlIPCSendListing(CtdlIPC *ipc, const char *listing);
 291 size_t CtdlIPCPartialRead(CtdlIPC *ipc, void **buf, size_t offset,
 292                 size_t bytes, char *cret);
 293 int CtdlIPCEndUpload(CtdlIPC *ipc, int discard, char *cret);
 294 int CtdlIPCWriteUpload(CtdlIPC *ipc, const char *path,
 295                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 296                 char *cret);
 297 int CtdlIPCEndDownload(CtdlIPC *ipc, char *cret);
 298 int CtdlIPCReadDownload(CtdlIPC *ipc, void **buf, size_t bytes, size_t resume,
 299                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 300                 char *cret);
 301 int CtdlIPCHighSpeedReadDownload(CtdlIPC *ipc, void **buf, size_t bytes,
 302                 size_t resume,
 303                 void (*progress_gauge_callback)(unsigned long, unsigned long),
 304                 char *cret);
 305 int CtdlIPCGenericCommand(CtdlIPC *ipc, const char *command,
 306                 const char *to_send, size_t bytes_to_send, char **to_receive,
 307                 size_t *bytes_to_receive, char *proto_response);
 308
 309 /* Internals */
 310 int starttls(CtdlIPC *ipc);
 311 void setCryptoStatusHook(void (*hook)(char *s));
 312 void CtdlIPC_SetNetworkStatusCallback(CtdlIPC *ipc, void (*hook)(int state));
 313 /* This is all Ford's doing.  FIXME: figure out what it's doing */
 314 extern int (*error_printf)(char *s, ...);
 315 void setIPCDeathHook(void (*hook)(void));
 316 void setIPCErrorPrintf(int (*func)(char *s, ...));
 317 void connection_died(CtdlIPC *ipc);
 318 int CtdlIPC_getsockfd(CtdlIPC* ipc);
 319 char CtdlIPC_get(CtdlIPC* ipc);
 320
 321 #ifdef __cplusplus
 322 }
 323 #endif