5 #define DEFAULT_HOST "localhost"
7 #define DEFAULT_HOST UDS
9 #define DEFAULT_PORT "citadel"
17 #include <openssl/ssl.h>
18 #include <openssl/err.h>
19 #include <openssl/rand.h>
26 /* Quick and dirty hack; we don't want to use malloc() in C++ */
28 #define ialloc(t) new t()
29 #define ifree(o) delete o
31 #define ialloc(t) malloc(sizeof(t))
32 #define ifree(o) free(o);
51 /* This class is responsible for the server connection */
52 typedef struct _CtdlIPC {
53 /* The server info for this connection */
54 struct CtdlServInfo ServInfo;
56 #if defined(HAVE_OPENSSL)
57 /* NULL if not encrypted, non-NULL otherwise */
60 #if defined(HAVE_PTHREAD_H)
61 /* Fast mutex, call CtdlIPC_lock() or CtdlIPC_unlock() to use */
62 pthread_mutex_t mutex;
64 /* -1 if not connected, >= 0 otherwise */
66 /* 1 if server is local, 0 otherwise or if not connected */
68 /* 1 if a download is open on the server, 0 otherwise */
70 /* 1 if an upload is open on the server, 0 otherwise */
72 /* Time the last command was sent to the server */
73 time_t last_command_sent;
74 /* Callback for update on whether the IPC is locked */
75 void (*network_status_cb)(int state);
79 CtdlIPC* CtdlIPC_new(int argc, char **argv, char *hostbuf, char *portbuf);
81 void CtdlIPC_delete(CtdlIPC* ipc);
82 /* Convenience destructor; also nulls out caller's pointer */
83 void CtdlIPC_delete_ptr(CtdlIPC** pipc);
84 /* Read a line from server, discarding newline, for chat, will go away */
85 void CtdlIPC_chat_recv(CtdlIPC* ipc, char *buf);
86 /* Write a line to server, adding newline, for chat, will go away */
87 void CtdlIPC_chat_send(CtdlIPC* ipc, const char *buf);
90 char RRname[ROOMNAMELEN]; /* Name of room */
91 long RRunread; /* Number of unread messages */
92 long RRtotal; /* Total number of messages in room */
93 char RRinfoupdated; /* Nonzero if info was updated */
94 unsigned RRflags; /* Various flags (see LKRN) */
95 long RRhighest; /* Highest message number in room */
96 long RRlastread; /* Highest message user has read */
97 char RRismailbox; /* Is this room a mailbox room? */
98 char RRaide; /* User can do aide commands in room */
99 long RRnewmail; /* Number of new mail messages */
100 char RRfloor; /* Which floor this room is on */
106 char number[16]; /* part number */
107 char name[PATH_MAX]; /* Name */
108 char filename[PATH_MAX]; /* Suggested filename */
109 char mimetype[SIZ]; /* MIME type */
110 char disposition[SIZ]; /* Content disposition */
111 unsigned long length; /* Content length */
115 struct ctdlipcmessage {
116 char msgid[SIZ]; /* Original message ID */
117 char path[SIZ]; /* Return path to sender */
118 char zaps[SIZ]; /* Message ID that this supersedes */
119 char subject[SIZ]; /* Message subject */
120 char email[SIZ]; /* Email address of sender */
121 char author[SIZ]; /* Sender of message */
122 char recipient[SIZ]; /* Recipient of message */
123 char room[SIZ]; /* Originating room */
124 char node[SIZ]; /* Short nodename of origin system */
125 char hnod[SIZ]; /* Humannode of origin system */
126 struct parts *attachments; /* Available attachments */
127 char *text; /* Message text */
128 int type; /* Message type */
129 time_t time; /* Time message was posted */
130 char nhdr; /* Suppress message header? */
131 char anonymous; /* An anonymous message */
132 char mime_chosen[SIZ]; /* Chosen MIME part to output */
133 char content_type[SIZ]; /* How would you like that? */
138 char remote_name[PATH_MAX]; /* Filename on server */
139 char local_name[PATH_MAX]; /* Filename on client */
140 char description[80]; /* Description on server */
141 FILE *local_fd; /* Open file on client */
142 size_t size; /* Size of file in octets */
143 int upload:1; /* uploading? 0 if downloading */
144 int complete:1; /* Transfer has finished? */
149 long newmail; /* Number of new Mail messages */
150 char needregis; /* Nonzero if user needs to register */
151 char needvalid; /* Nonzero if users need validation */
156 SubscribedRoomsWithNewMessages,
157 SubscribedRoomsWithNoNewMessages,
172 enum MessageDirection {
177 /* Shared Diffie-Hellman parameters */
178 #define DH_P "1A74527AEE4EE2568E85D4FB2E65E18C9394B9C80C42507D7A6A0DBE9A9A54B05A9A96800C34C7AA5297095B69C88901EEFD127F969DCA26A54C0E0B5C5473EBAEB00957D2633ECAE3835775425DE66C0DE6D024DBB17445E06E6B0C78415E589B8814F08531D02FD43778451E7685541079CFFB79EF0D26EFEEBBB69D1E80383"
181 #define CIT_CIPHERS "ALL:RC4+RSA:+SSLv2:@STRENGTH" /* see ciphers(1) */
183 int CtdlIPCNoop(CtdlIPC *ipc);
184 int CtdlIPCEcho(CtdlIPC *ipc, const char *arg, char *cret);
185 int CtdlIPCQuit(CtdlIPC *ipc);
186 int CtdlIPCLogout(CtdlIPC *ipc);
187 int CtdlIPCTryLogin(CtdlIPC *ipc, const char *username, char *cret);
188 int CtdlIPCTryPassword(CtdlIPC *ipc, const char *passwd, char *cret);
189 int CtdlIPCTryApopPassword(CtdlIPC *ipc, const char *response, char *cret);
190 int CtdlIPCCreateUser(CtdlIPC *ipc, const char *username, int selfservice,
192 int CtdlIPCChangePassword(CtdlIPC *ipc, const char *passwd, char *cret);
193 int CtdlIPCKnownRooms(CtdlIPC *ipc, enum RoomList which, int floor,
194 struct march **listing, char *cret);
195 int CtdlIPCGetConfig(CtdlIPC *ipc, struct ctdluser **uret, char *cret);
196 int CtdlIPCSetConfig(CtdlIPC *ipc, struct ctdluser *uret, char *cret);
197 int CtdlIPCGotoRoom(CtdlIPC *ipc, const char *room, const char *passwd,
198 struct ctdlipcroom **rret, char *cret);
199 int CtdlIPCGetMessages(CtdlIPC *ipc, enum MessageList which, int whicharg,
200 const char *mtemplate, unsigned long **mret, char *cret);
201 int CtdlIPCGetSingleMessage(CtdlIPC *ipc, long msgnum, int headers, int as_mime,
202 struct ctdlipcmessage **mret, char *cret);
203 int CtdlIPCWhoKnowsRoom(CtdlIPC *ipc, char **listing, char *cret);
204 int CtdlIPCServerInfo(CtdlIPC *ipc, char *cret);
205 /* int CtdlIPCReadDirectory(CtdlIPC *ipc, struct ctdlipcfile **files, char *cret); */
206 int CtdlIPCReadDirectory(CtdlIPC *ipc, char **listing, char *cret);
207 int CtdlIPCSetLastRead(CtdlIPC *ipc, long msgnum, char *cret);
208 int CtdlIPCInviteUserToRoom(CtdlIPC *ipc, const char *username, char *cret);
209 int CtdlIPCKickoutUserFromRoom(CtdlIPC *ipc, const char *username, char *cret);
210 int CtdlIPCGetRoomAttributes(CtdlIPC *ipc, struct ctdlroom **qret, char *cret);
211 int CtdlIPCSetRoomAttributes(CtdlIPC *ipc, int forget, struct ctdlroom *qret,
213 int CtdlIPCGetRoomAide(CtdlIPC *ipc, char *cret);
214 int CtdlIPCSetRoomAide(CtdlIPC *ipc, const char *username, char *cret);
215 int CtdlIPCPostMessage(CtdlIPC *ipc, int flag, const struct ctdlipcmessage *mr,
217 int CtdlIPCRoomInfo(CtdlIPC *ipc, char **iret, char *cret);
218 int CtdlIPCDeleteMessage(CtdlIPC *ipc, long msgnum, char *cret);
219 int CtdlIPCMoveMessage(CtdlIPC *ipc, int copy, long msgnum,
220 const char *destroom, char *cret);
221 int CtdlIPCDeleteRoom(CtdlIPC *ipc, int for_real, char *cret);
222 int CtdlIPCCreateRoom(CtdlIPC *ipc, int for_real, const char *roomname,
223 int type, const char *password, int floor, char *cret);
224 int CtdlIPCForgetRoom(CtdlIPC *ipc, char *cret);
225 int CtdlIPCSystemMessage(CtdlIPC *ipc, const char *message, char **mret,
227 int CtdlIPCNextUnvalidatedUser(CtdlIPC *ipc, char *cret);
228 int CtdlIPCGetUserRegistration(CtdlIPC *ipc, const char *username, char **rret,
230 int CtdlIPCValidateUser(CtdlIPC *ipc, const char *username, int axlevel,
232 int CtdlIPCSetRoomInfo(CtdlIPC *ipc, int for_real, const char *info,
234 int CtdlIPCUserListing(CtdlIPC *ipc, char **list, char *cret);
235 int CtdlIPCSetRegistration(CtdlIPC *ipc, const char *info, char *cret);
236 int CtdlIPCMiscCheck(CtdlIPC *ipc, struct ctdlipcmisc *chek, char *cret);
237 int CtdlIPCDeleteFile(CtdlIPC *ipc, const char *filename, char *cret);
238 int CtdlIPCMoveFile(CtdlIPC *ipc, const char *filename, const char *destroom,
240 int CtdlIPCNetSendFile(CtdlIPC *ipc, const char *filename,
241 const char *destnode, char *cret);
242 int CtdlIPCOnlineUsers(CtdlIPC *ipc, char **listing, time_t *stamp, char *cret);
243 int CtdlIPCFileDownload(CtdlIPC *ipc, const char *filename, void **buf,
245 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
247 int CtdlIPCAttachmentDownload(CtdlIPC *ipc, long msgnum, const char *part,
249 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
251 int CtdlIPCImageDownload(CtdlIPC *ipc, const char *filename, void **buf,
252 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
254 int CtdlIPCFileUpload(CtdlIPC *ipc, const char *save_as, const char *comment,
256 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
258 int CtdlIPCImageUpload(CtdlIPC *ipc, int for_real, const char *path,
260 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
262 int CtdlIPCQueryUsername(CtdlIPC *ipc, const char *username, char *cret);
263 int CtdlIPCFloorListing(CtdlIPC *ipc, char **listing, char *cret);
264 int CtdlIPCCreateFloor(CtdlIPC *ipc, int for_real, const char *name,
266 int CtdlIPCDeleteFloor(CtdlIPC *ipc, int for_real, int floornum, char *cret);
267 int CtdlIPCEditFloor(CtdlIPC *ipc, int floornum, const char *floorname,
269 int CtdlIPCIdentifySoftware(CtdlIPC *ipc, int developerid, int clientid,
270 int revision, const char *software_name, const char *hostname,
272 int CtdlIPCSendInstantMessage(CtdlIPC *ipc, const char *username,
273 const char *text, char *cret);
274 int CtdlIPCGetInstantMessage(CtdlIPC *ipc, char **listing, char *cret);
275 int CtdlIPCEnableInstantMessageReceipt(CtdlIPC *ipc, int mode, char *cret);
276 int CtdlIPCSetBio(CtdlIPC *ipc, char *bio, char *cret);
277 int CtdlIPCGetBio(CtdlIPC *ipc, const char *username, char **listing,
279 int CtdlIPCListUsersWithBios(CtdlIPC *ipc, char **listing, char *cret);
280 int CtdlIPCStealthMode(CtdlIPC *ipc, int mode, char *cret);
281 int CtdlIPCTerminateSession(CtdlIPC *ipc, int sid, char *cret);
282 int CtdlIPCTerminateServerNow(CtdlIPC *ipc, char *cret);
283 int CtdlIPCTerminateServerScheduled(CtdlIPC *ipc, int mode, char *cret);
284 int CtdlIPCEnterSystemMessage(CtdlIPC *ipc, const char *filename, const char *text,
286 int CtdlIPCChangeHostname(CtdlIPC *ipc, const char *hostname, char *cret);
287 int CtdlIPCChangeRoomname(CtdlIPC *ipc, const char *roomname, char *cret);
288 int CtdlIPCChangeUsername(CtdlIPC *ipc, const char *username, char *cret);
289 time_t CtdlIPCServerTime(CtdlIPC *ipc, char *crert);
290 int CtdlIPCAideGetUserParameters(CtdlIPC *ipc, const char *who,
291 struct ctdluser **uret, char *cret);
292 int CtdlIPCAideSetUserParameters(CtdlIPC *ipc, const struct ctdluser *uret, char *cret);
293 int CtdlIPCGetMessageExpirationPolicy(CtdlIPC *ipc, int which,
294 struct ExpirePolicy **policy, char *cret);
295 int CtdlIPCSetMessageExpirationPolicy(CtdlIPC *ipc, int which,
296 struct ExpirePolicy *policy, char *cret);
297 int CtdlIPCGetSystemConfig(CtdlIPC *ipc, char **listing, char *cret);
298 int CtdlIPCSetSystemConfig(CtdlIPC *ipc, const char *listing, char *cret);
299 int CtdlIPCGetSystemConfigByType(CtdlIPC *ipc, const char *mimetype,
300 char **listing, char *cret);
301 int CtdlIPCSetSystemConfigByType(CtdlIPC *ipc, const char *mimetype,
302 const char *listing, char *cret);
303 int CtdlIPCGetRoomNetworkConfig(CtdlIPC *ipc, char **listing, char *cret);
304 int CtdlIPCSetRoomNetworkConfig(CtdlIPC *ipc, const char *listing, char *cret);
305 int CtdlIPCRequestClientLogout(CtdlIPC *ipc, int session, char *cret);
306 int CtdlIPCSetMessageSeen(CtdlIPC *ipc, long msgnum, int seen, char *cret);
307 int CtdlIPCStartEncryption(CtdlIPC *ipc, char *cret);
308 int CtdlIPCDirectoryLookup(CtdlIPC *ipc, const char *address, char *cret);
309 int CtdlIPCSpecifyPreferredFormats(CtdlIPC *ipc, char *cret, char *formats);
310 int CtdlIPCInternalProgram(CtdlIPC *ipc, int secret, char *cret);
311 int CtdlIPCMessageBaseCheck(CtdlIPC *ipc, char **mret, char *cret);
313 /* ************************************************************************** */
314 /* Stuff below this line is not for public consumption */
315 /* ************************************************************************** */
317 INLINE void CtdlIPC_lock(CtdlIPC *ipc);
318 INLINE void CtdlIPC_unlock(CtdlIPC *ipc);
319 char *CtdlIPCReadListing(CtdlIPC *ipc, char *dest);
320 int CtdlIPCSendListing(CtdlIPC *ipc, const char *listing);
321 size_t CtdlIPCPartialRead(CtdlIPC *ipc, void **buf, size_t offset,
322 size_t bytes, char *cret);
323 int CtdlIPCEndUpload(CtdlIPC *ipc, int discard, char *cret);
324 int CtdlIPCWriteUpload(CtdlIPC *ipc, const char *path,
325 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
327 int CtdlIPCEndDownload(CtdlIPC *ipc, char *cret);
328 int CtdlIPCReadDownload(CtdlIPC *ipc, void **buf, size_t bytes, size_t resume,
329 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
331 int CtdlIPCHighSpeedReadDownload(CtdlIPC *ipc, void **buf, size_t bytes,
333 void (*progress_gauge_callback)(CtdlIPC*, unsigned long, unsigned long),
335 int CtdlIPCGenericCommand(CtdlIPC *ipc, const char *command,
336 const char *to_send, size_t bytes_to_send, char **to_receive,
337 size_t *bytes_to_receive, char *proto_response);
340 int starttls(CtdlIPC *ipc);
341 void setCryptoStatusHook(void (*hook)(char *s));
342 void CtdlIPC_SetNetworkStatusCallback(CtdlIPC *ipc, void (*hook)(int state));
343 /* This is all Ford's doing. FIXME: figure out what it's doing */
344 extern int (*error_printf)(char *s, ...);
345 void setIPCDeathHook(void (*hook)(void));
346 void setIPCErrorPrintf(int (*func)(char *s, ...));
347 void connection_died(CtdlIPC* ipc, int using_ssl);
348 int CtdlIPC_getsockfd(CtdlIPC* ipc);
349 char CtdlIPC_get(CtdlIPC* ipc);