Merge newsgroup--room name conversion functions
[citadel.git] / citadel / modules / nntp / serv_nntp.c
1 /*
2  * NNTP server module FIXME THIS IS NOT FINISHED
3  *
4  * Copyright (c) 2014 by the citadel.org team
5  *
6  * This program is open source software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 3.
8  *  
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  */
14
15 #include "sysdep.h"
16 #include <stdlib.h>
17 #include <unistd.h>
18 #include <stdio.h>
19 #include <termios.h>
20 #include <fcntl.h>
21 #include <signal.h>
22 #include <pwd.h>
23 #include <errno.h>
24 #include <sys/types.h>
25 #include <syslog.h>
26
27 #if TIME_WITH_SYS_TIME
28 # include <sys/time.h>
29 # include <time.h>
30 #else
31 # if HAVE_SYS_TIME_H
32 #  include <sys/time.h>
33 # else
34 #  include <time.h>
35 # endif
36 #endif
37
38 #include <sys/wait.h>
39 #include <ctype.h>
40 #include <string.h>
41 #include <limits.h>
42 #include <sys/socket.h>
43 #include <netinet/in.h>
44 #include <arpa/inet.h>
45 #include <libcitadel.h>
46 #include "citadel.h"
47 #include "server.h"
48 #include "citserver.h"
49 #include "support.h"
50 #include "config.h"
51 #include "control.h"
52 #include "user_ops.h"
53 #include "room_ops.h"
54 #include "database.h"
55 #include "msgbase.h"
56 #include "internet_addressing.h"
57 #include "genstamp.h"
58 #include "domain.h"
59 #include "clientsocket.h"
60 #include "locate_host.h"
61 #include "citadel_dirs.h"
62 #include "ctdl_module.h"
63
64
65
66
67 /****************** BEGIN UTILITY FUNCTIONS THAT COULD BE MOVED ELSEWHERE LATER **************/
68
69
70 /*
71  * Tests whether the supplied string is a valid newsgroup name
72  * Returns true (nonzero) or false (0)
73  */
74 int is_valid_newsgroup_name(char *name) {
75         char *ptr = name;
76         int has_a_letter = 0;
77
78         if (!ptr) return(0);
79         if (!strncasecmp(name, "ctdl.", 5)) return(0);
80
81         while (*ptr != 0) {
82
83                 if (isalpha(ptr[0])) {
84                         has_a_letter = 1;
85                 }
86
87                 if (    (isalnum(ptr[0]))
88                         || (ptr[0] == '.')
89                         || (ptr[0] == '+')
90                         || (ptr[0] == '-')
91                 ) {
92                         ++ptr;
93                 }
94                 else {
95                         return(0);
96                 }
97         }
98         return(has_a_letter);
99 }
100
101
102
103 /*
104  * Convert a Citadel room name to a valid newsgroup name
105  */
106 void room_to_newsgroup(char *target, char *source, size_t target_size) {
107
108         if (!target) return;
109         if (!source) return;
110
111         if (is_valid_newsgroup_name(source)) {
112                 strncpy(target, source, target_size);
113                 return;
114         }
115
116         strcpy(target, "ctdl.");
117         int len = 5;
118         char *ptr = source;
119         char ch;
120
121         while (ch=*ptr++, ch!=0) {
122                 if (len >= target_size) return;
123                 if (    (isalnum(ch))
124                         || (ch == '.')
125                         || (ch == '-')
126                 ) {
127                         target[len++] = ch;
128                         target[len] = 0;
129                 }
130                 else {
131                         target[len++] = '+' ;
132                         sprintf(&target[len], "%02x", ch);
133                         len += 2;
134                         target[len] = 0;
135                 }
136         }
137 }
138
139
140 /*
141  * Convert a newsgroup name to a Citadel room name.
142  * This function recognizes names converted with room_to_newsgroup() and restores them with full fidelity.
143  */
144 void newsgroup_to_room(char *target, char *source, size_t target_size) {
145
146         if (!target) return;
147         if (!source) return;
148
149         if (strncasecmp(source, "ctdl.", 5)) {                  // not a converted room name; pass through as-is
150                 strncpy(target, source, target_size);
151                 return;
152         }
153
154         target[0] = 0;
155         int len = 0;
156         char *ptr = &source[5];
157         char ch;
158
159         while (ch=*ptr++, ch!=0) {
160                 if (len >= target_size) return;
161                 if (ch == '+') {
162                         char hex[3];
163                         long digit;
164                         hex[0] = *ptr++;
165                         hex[1] = *ptr++;
166                         hex[2] = 0;
167                         digit = strtol(hex, NULL, 16);
168                         ch = (char)digit;
169                 }
170                 target[len++] = ch;
171                 target[len] = 0;
172         }
173 }
174
175
176 /******************  END  UTILITY FUNCTIONS THAT COULD BE MOVED ELSEWHERE LATER **************/
177
178
179
180 /*
181  * Here's where our NNTP session begins its happy day.
182  */
183 void nntp_greeting(void)
184 {
185         strcpy(CC->cs_clientname, "NNTP session");
186         CC->cs_flags |= CS_STEALTH;
187
188         /* CC->session_specific_data = malloc(sizeof(citnntp));
189         memset(NNTP, 0, sizeof(citnntp));
190         */
191
192         if (CC->nologin==1) {
193                 cprintf("451 Too many connections are already open; please try again later.\r\n");
194                 CC->kill_me = KILLME_MAX_SESSIONS_EXCEEDED;
195                 return;
196         }
197
198         /* Note: the FQDN *must* appear as the first thing after the 220 code.
199          * Some clients (including citmail.c) depend on it being there.
200          */
201         cprintf("200 %s NNTP Citadel server is not finished yet\r\n", config.c_fqdn);
202 }
203
204
205 /*
206  * NNTPS is just like NNTP, except it goes crypto right away.
207  */
208 void nntps_greeting(void) {
209         CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
210 #ifdef HAVE_OPENSSL
211         if (!CC->redirect_ssl) CC->kill_me = KILLME_NO_CRYPTO;          /* kill session if no crypto */
212 #endif
213         nntp_greeting();
214 }
215
216
217
218 /*
219  * implements the STARTTLS command
220  */
221 void nntp_starttls(void)
222 {
223         char ok_response[SIZ];
224         char nosup_response[SIZ];
225         char error_response[SIZ];
226
227         sprintf(ok_response, "382 Begin TLS negotiation now\r\n");
228         sprintf(nosup_response, "502 Can not initiate TLS negotiation\r\n");
229         sprintf(error_response, "580 Internal error\r\n");
230         CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
231 }
232
233
234 void nntp_noop(void)
235 {
236         cprintf("250 NOOP\r\n");
237 }
238
239
240 void nntp_capabilities(void)
241 {
242         cprintf("101 Capability list:\r\n");
243 #ifdef HAVE_OPENSSL
244         cprintf("STARTTLS\r\n");
245 #endif
246         if (!CC->logged_in) {
247                 cprintf("AUTHINFO USER\r\n");
248         }
249         cprintf(".\r\n");
250 }
251
252
253 void nntp_quit(void)
254 {
255         cprintf("221 Goodbye...\r\n");
256         CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
257 }
258
259
260 void nntp_cleanup(void)
261 {
262         /* nothing here yet */
263 }
264
265
266
267 /*
268  * Implements the AUTHINFO USER command (RFC 4643)
269  */
270 void nntp_authinfo_user(const char *username)
271 {
272         int a = CtdlLoginExistingUser(NULL, username);
273         switch (a) {
274         case login_already_logged_in:
275                 cprintf("482 Already logged in\r\n");
276                 return;
277         case login_too_many_users:
278                 cprintf("481 Too many users are already online (maximum is %d)\r\n", config.c_maxsessions);
279                 return;
280         case login_ok:
281                 cprintf("381 Password required for %s\r\n", CC->curr_user);
282                 return;
283         case login_not_found:
284                 cprintf("481 %s not found\r\n", username);
285                 return;
286         default:
287                 cprintf("502 Internal error\r\n");
288         }
289 }
290
291
292 /*
293  * Implements the AUTHINFO PASS command (RFC 4643)
294  */
295 void nntp_authinfo_pass(const char *buf)
296 {
297         int a;
298
299         a = CtdlTryPassword(buf, strlen(buf));
300
301         switch (a) {
302         case pass_already_logged_in:
303                 cprintf("482 Already logged in\r\n");
304                 return;
305         case pass_no_user:
306                 cprintf("482 Authentication commands issued out of sequence\r\n");
307                 return;
308         case pass_wrong_password:
309                 cprintf("481 Authentication failed\r\n");
310                 return;
311         case pass_ok:
312                 cprintf("281 Authentication accepted\r\n");
313                 return;
314         }
315 }
316
317
318
319 /*
320  * Implements the AUTHINFO extension (RFC 4643) in USER/PASS mode
321  */
322 void nntp_authinfo(const char *cmd) {
323
324         if (!strncasecmp(cmd, "authinfo user ", 14)) {
325                 nntp_authinfo_user(&cmd[14]);
326         }
327
328         else if (!strncasecmp(cmd, "authinfo pass ", 14)) {
329                 nntp_authinfo_pass(&cmd[14]);
330         }
331
332         else {
333                 cprintf("502 command unavailable\r\n");
334         }
335 }
336
337
338
339 /* 
340  * Main command loop for NNTP server sessions.
341  */
342 void nntp_command_loop(void)
343 {
344         StrBuf *Cmd = NewStrBuf();
345         char cmdname[16];
346
347         time(&CC->lastcmd);
348         if (CtdlClientGetLine(Cmd) < 1) {
349                 syslog(LOG_CRIT, "NNTP: client disconnected: ending session.\n");
350                 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
351                 FreeStrBuf(&Cmd);
352                 return;
353         }
354         syslog(LOG_DEBUG, "NNTP server: %s\n", ChrPtr(Cmd));
355         extract_token(cmdname, ChrPtr(Cmd), 0, ' ', sizeof cmdname);
356
357         /*
358          * Rumpelstiltskin lookups are awesome
359          */
360
361         if (!strcasecmp(cmdname, "quit")) {
362                 nntp_quit();
363         }
364
365         else if (!strcasecmp(cmdname, "capabilities")) {
366                 nntp_capabilities();
367         }
368
369         else if (!strcasecmp(cmdname, "starttls")) {
370                 nntp_starttls();
371         }
372
373         else if (!strcasecmp(cmdname, "noop")) {
374                 nntp_noop();
375         }
376
377         else if (!strcasecmp(cmdname, "authinfo")) {
378                 nntp_authinfo(ChrPtr(Cmd));
379         }
380
381         else {
382                 cprintf("500 I'm afraid I can't do that.\r\n");
383         }
384
385         FreeStrBuf(&Cmd);
386 }
387
388
389 /*****************************************************************************/
390 /*                      MODULE INITIALIZATION STUFF                          */
391 /*****************************************************************************/
392
393
394 /*
395  * This cleanup function blows away the temporary memory used by
396  * the NNTP server.
397  */
398 void nntp_cleanup_function(void)
399 {
400         /* Don't do this stuff if this is not an NNTP session! */
401         if (CC->h_command_function != nntp_command_loop) return;
402
403         syslog(LOG_DEBUG, "Performing NNTP cleanup hook\n");
404 }
405
406 const char *CitadelServiceNNTP="NNTP";
407
408 CTDL_MODULE_INIT(nntp)
409 {
410         if (!threading)
411         {
412                 CtdlRegisterServiceHook(119,                    // FIXME config.c_nntp_port,
413                                         NULL,
414                                         nntp_greeting,
415                                         nntp_command_loop,
416                                         NULL, 
417                                         CitadelServiceNNTP);
418
419 #ifdef HAVE_OPENSSL
420                 CtdlRegisterServiceHook(563,                    // FIXME config.c_nntps_port,
421                                         NULL,
422                                         nntps_greeting,
423                                         nntp_command_loop,
424                                         NULL,
425                                         CitadelServiceNNTP);
426 #endif
427
428                 CtdlRegisterCleanupHook(nntp_cleanup);
429                 CtdlRegisterSessionHook(nntp_cleanup_function, EVT_STOP, PRIO_STOP + 250);
430         }
431         
432         /* return our module name for the log */
433         return "nntp";
434 }