2 * NNTP server module FIXME THIS IS NOT FINISHED
4 * Copyright (c) 2014 by the citadel.org team
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.
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.
24 #include <sys/types.h>
27 #if TIME_WITH_SYS_TIME
28 # include <sys/time.h>
32 # include <sys/time.h>
42 #include <sys/socket.h>
43 #include <netinet/in.h>
44 #include <arpa/inet.h>
45 #include <libcitadel.h>
48 #include "citserver.h"
56 #include "internet_addressing.h"
59 #include "clientsocket.h"
60 #include "locate_host.h"
61 #include "citadel_dirs.h"
62 #include "ctdl_module.h"
63 #include "serv_nntp.h"
67 /****************** BEGIN UTILITY FUNCTIONS THAT COULD BE MOVED ELSEWHERE LATER **************/
71 * Tests whether the supplied string is a valid newsgroup name
72 * Returns true (nonzero) or false (0)
74 int is_valid_newsgroup_name(char *name) {
79 if (!strncasecmp(name, "ctdl.", 5)) return(0);
83 if (isalpha(ptr[0])) {
87 if ( (isalnum(ptr[0]))
104 * Convert a Citadel room name to a valid newsgroup name
106 void room_to_newsgroup(char *target, char *source, size_t target_size) {
111 if (is_valid_newsgroup_name(source)) {
112 strncpy(target, source, target_size);
116 strcpy(target, "ctdl.");
121 while (ch=*ptr++, ch!=0) {
122 if (len >= target_size) return;
131 target[len++] = '+' ;
132 sprintf(&target[len], "%02x", ch);
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.
144 void newsgroup_to_room(char *target, char *source, size_t target_size) {
149 if (strncasecmp(source, "ctdl.", 5)) { // not a converted room name; pass through as-is
150 strncpy(target, source, target_size);
156 char *ptr = &source[5];
159 while (ch=*ptr++, ch!=0) {
160 if (len >= target_size) return;
167 digit = strtol(hex, NULL, 16);
176 /****************** END UTILITY FUNCTIONS THAT COULD BE MOVED ELSEWHERE LATER **************/
181 * Here's where our NNTP session begins its happy day.
183 void nntp_greeting(void)
185 strcpy(CC->cs_clientname, "NNTP session");
186 CC->cs_flags |= CS_STEALTH;
188 /* CC->session_specific_data = malloc(sizeof(citnntp));
189 memset(NNTP, 0, sizeof(citnntp));
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;
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.
201 cprintf("200 %s NNTP Citadel server is not finished yet\r\n", config.c_fqdn);
206 * NNTPS is just like NNTP, except it goes crypto right away.
208 void nntps_greeting(void) {
209 CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
211 if (!CC->redirect_ssl) CC->kill_me = KILLME_NO_CRYPTO; /* kill session if no crypto */
219 * implements the STARTTLS command
221 void nntp_starttls(void)
223 char ok_response[SIZ];
224 char nosup_response[SIZ];
225 char error_response[SIZ];
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);
236 cprintf("250 NOOP\r\n");
240 void nntp_capabilities(void)
242 cprintf("101 Capability list:\r\n");
244 cprintf("STARTTLS\r\n");
246 if (!CC->logged_in) {
247 cprintf("AUTHINFO USER\r\n");
255 cprintf("221 Goodbye...\r\n");
256 CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
260 void nntp_cleanup(void)
262 /* nothing here yet */
268 * Implements the AUTHINFO USER command (RFC 4643)
270 void nntp_authinfo_user(const char *username)
272 int a = CtdlLoginExistingUser(NULL, username);
274 case login_already_logged_in:
275 cprintf("482 Already logged in\r\n");
277 case login_too_many_users:
278 cprintf("481 Too many users are already online (maximum is %d)\r\n", config.c_maxsessions);
281 cprintf("381 Password required for %s\r\n", CC->curr_user);
283 case login_not_found:
284 cprintf("481 %s not found\r\n", username);
287 cprintf("502 Internal error\r\n");
293 * Implements the AUTHINFO PASS command (RFC 4643)
295 void nntp_authinfo_pass(const char *buf)
299 a = CtdlTryPassword(buf, strlen(buf));
302 case pass_already_logged_in:
303 cprintf("482 Already logged in\r\n");
306 cprintf("482 Authentication commands issued out of sequence\r\n");
308 case pass_wrong_password:
309 cprintf("481 Authentication failed\r\n");
312 cprintf("281 Authentication accepted\r\n");
320 * Implements the AUTHINFO extension (RFC 4643) in USER/PASS mode
322 void nntp_authinfo(const char *cmd) {
324 if (!strncasecmp(cmd, "authinfo user ", 14)) {
325 nntp_authinfo_user(&cmd[14]);
328 else if (!strncasecmp(cmd, "authinfo pass ", 14)) {
329 nntp_authinfo_pass(&cmd[14]);
333 cprintf("502 command unavailable\r\n");
339 * Utility function to fetch the current list of message numbers in a room
341 struct nntp_msglist nntp_fetch_msglist(struct ctdlroom *qrbuf) {
342 struct nntp_msglist nm;
343 struct cdbdata *cdbfr;
345 cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf->QRnumber, sizeof(long));
347 nm.msgnums = (long*)cdbfr->ptr;
349 nm.num_msgs = cdbfr->len / sizeof(long);
362 * Various output formats for the LIST commands
366 NNTP_LIST_ACTIVE_TIMES,
367 NNTP_LIST_DISTRIB_PATS,
369 NNTP_LIST_NEWSGROUPS,
370 NNTP_LIST_OVERVIEW_FMT
375 * Output a room name (newsgroup name) in formats required for LIST and NEWGROUPS command
377 void output_roomname_in_list_format(struct ctdlroom *qrbuf, int which_format) {
379 struct nntp_msglist nm;
380 long low_water_mark = 0;
381 long high_water_mark = 0;
383 room_to_newsgroup(n_name, qrbuf->QRname, sizeof n_name);
384 nm = nntp_fetch_msglist(qrbuf);
385 if ((nm.num_msgs > 0) && (nm.msgnums != NULL)) {
386 low_water_mark = nm.msgnums[0];
387 high_water_mark = nm.msgnums[nm.num_msgs - 1];
390 switch(which_format) {
391 case NNTP_LIST_ACTIVE:
392 // FIXME we have hardcoded "n" for "no posting allowed" -- fix when we add posting
393 cprintf("%s %ld %ld n\r\n", n_name, high_water_mark, low_water_mark);
395 case NNTP_LIST_NEWSGROUPS:
396 cprintf("%s %s\r\n", n_name, qrbuf->QRname);
399 // FIXME do all the other formats, bitch
401 if (nm.msgnums != NULL) {
409 * Called once per room by nntp_newgroups() to qualify and possibly output a single room
411 void nntp_newgroups_backend(struct ctdlroom *qrbuf, void *data)
415 time_t thetime = *(time_t *)data;
417 CtdlRoomAccess(qrbuf, &CC->user, &ra, &view);
420 * The "created after <date/time>" heuristics depend on the happy coincidence
421 * that for a very long time we have used a unix timestamp as the room record's
422 * generation number (QRgen). When this module is merged into the master
423 * source tree we should rename QRgen to QR_create_time or something like that.
427 if (qrbuf->QRgen >= thetime) {
428 output_roomname_in_list_format(qrbuf, NNTP_LIST_ACTIVE);
435 * Implements the NEWGROUPS command
437 void nntp_newgroups(const char *cmd) {
439 * HACK: this works because the 5XX series error codes from citadel
440 * protocol will also be considered error codes by an NNTP client
442 if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
445 char stringy_date[16];
446 char stringy_time[16];
447 char stringy_gmt[16];
451 extract_token(stringy_date, cmd, 1, ' ', sizeof stringy_date);
452 extract_token(stringy_time, cmd, 2, ' ', sizeof stringy_time);
453 extract_token(stringy_gmt, cmd, 3, ' ', sizeof stringy_gmt);
455 memset(&tm, 0, sizeof tm);
456 if (strlen(stringy_date) == 6) {
457 sscanf(stringy_date, "%2d%2d%2d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday);
461 sscanf(stringy_date, "%4d%2d%2d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday);
464 tm.tm_mon -= 1; // tm_mon is zero based (0=January)
465 tm.tm_isdst = (-1); // let the C library figure out whether DST is in effect
466 sscanf(stringy_time, "%2d%2d%2d", &tm.tm_hour, &tm.tm_min ,&tm.tm_sec);
467 thetime = mktime(&tm);
468 if (!strcasecmp(stringy_gmt, "GMT")) {
474 cprintf("231 list of new newsgroups follows\r\n");
475 CtdlGetUser(&CC->user, CC->curr_user);
476 CtdlForEachRoom(nntp_newgroups_backend, &thetime);
482 * Called once per room by nntp_list() to qualify and possibly output a single room
484 void nntp_list_backend(struct ctdlroom *qrbuf, void *data)
488 struct nntp_list_data *nld = (struct nntp_list_data *)data;
490 CtdlRoomAccess(qrbuf, &CC->user, &ra, &view);
492 output_roomname_in_list_format(qrbuf, nld->list_format);
498 * Implements the LIST commands
500 void nntp_list(const char *cmd) {
502 * HACK: this works because the 5XX series error codes from citadel
503 * protocol will also be considered error codes by an NNTP client
505 if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
507 char list_format[64];
509 struct nntp_list_data nld;
511 extract_token(list_format, cmd, 1, ' ', sizeof list_format);
512 extract_token(wildmat, cmd, 2, ' ', sizeof wildmat);
514 if ( (strlen(cmd) < 6) || (!strcasecmp(list_format, "ACTIVE")) ) {
515 nld.list_format = NNTP_LIST_ACTIVE;
517 else if (!strcasecmp(list_format, "NEWSGROUPS")) {
518 nld.list_format = NNTP_LIST_NEWSGROUPS;
521 cprintf("501 syntax error , unsupported list format\r\n");
524 // FIXME do all of the other variants, bitch
527 cprintf("231 list of newsgroups follows\r\n");
528 CtdlGetUser(&CC->user, CC->curr_user);
529 CtdlForEachRoom(nntp_list_backend, &nld);
535 * Main command loop for NNTP server sessions.
537 void nntp_command_loop(void)
539 StrBuf *Cmd = NewStrBuf();
543 if (CtdlClientGetLine(Cmd) < 1) {
544 syslog(LOG_CRIT, "NNTP: client disconnected: ending session.\n");
545 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
549 syslog(LOG_DEBUG, "NNTP server: %s\n", ChrPtr(Cmd));
550 extract_token(cmdname, ChrPtr(Cmd), 0, ' ', sizeof cmdname);
553 * Rumpelstiltskin lookups are awesome
556 if (!strcasecmp(cmdname, "quit")) {
560 else if (!strcasecmp(cmdname, "capabilities")) {
564 else if (!strcasecmp(cmdname, "starttls")) {
568 else if (!strcasecmp(cmdname, "noop")) {
572 else if (!strcasecmp(cmdname, "authinfo")) {
573 nntp_authinfo(ChrPtr(Cmd));
576 else if (!strcasecmp(cmdname, "newgroups")) {
577 nntp_newgroups(ChrPtr(Cmd));
580 else if (!strcasecmp(cmdname, "list")) {
581 nntp_list(ChrPtr(Cmd));
585 cprintf("500 I'm afraid I can't do that.\r\n");
592 /*****************************************************************************/
593 /* MODULE INITIALIZATION STUFF */
594 /*****************************************************************************/
598 * This cleanup function blows away the temporary memory used by
601 void nntp_cleanup_function(void)
603 /* Don't do this stuff if this is not an NNTP session! */
604 if (CC->h_command_function != nntp_command_loop) return;
606 syslog(LOG_DEBUG, "Performing NNTP cleanup hook\n");
609 const char *CitadelServiceNNTP="NNTP";
611 CTDL_MODULE_INIT(nntp)
615 CtdlRegisterServiceHook(119, // FIXME config.c_nntp_port,
623 CtdlRegisterServiceHook(563, // FIXME config.c_nntps_port,
631 CtdlRegisterCleanupHook(nntp_cleanup);
632 CtdlRegisterSessionHook(nntp_cleanup_function, EVT_STOP, PRIO_STOP + 250);
635 /* return our module name for the log */