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);
234 void nntp_capabilities(void)
236 cprintf("101 Capability list:\r\n");
237 cprintf("VERSION 2\r\n");
238 cprintf("READER\r\n");
239 cprintf("LIST ACTIVE NEWSGROUPS\r\n");
240 cprintf("IMPLEMENTATION Citadel v%d.%02d\r\n", (REV_LEVEL/100), (REV_LEVEL%100));
242 cprintf("STARTTLS\r\n");
244 if (!CC->logged_in) {
245 cprintf("AUTHINFO USER\r\n");
253 cprintf("221 Goodbye...\r\n");
254 CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
258 void nntp_cleanup(void)
260 /* nothing here yet */
266 * Implements the AUTHINFO USER command (RFC 4643)
268 void nntp_authinfo_user(const char *username)
270 int a = CtdlLoginExistingUser(NULL, username);
272 case login_already_logged_in:
273 cprintf("482 Already logged in\r\n");
275 case login_too_many_users:
276 cprintf("481 Too many users are already online (maximum is %d)\r\n", config.c_maxsessions);
279 cprintf("381 Password required for %s\r\n", CC->curr_user);
281 case login_not_found:
282 cprintf("481 %s not found\r\n", username);
285 cprintf("502 Internal error\r\n");
291 * Implements the AUTHINFO PASS command (RFC 4643)
293 void nntp_authinfo_pass(const char *buf)
297 a = CtdlTryPassword(buf, strlen(buf));
300 case pass_already_logged_in:
301 cprintf("482 Already logged in\r\n");
304 cprintf("482 Authentication commands issued out of sequence\r\n");
306 case pass_wrong_password:
307 cprintf("481 Authentication failed\r\n");
310 cprintf("281 Authentication accepted\r\n");
318 * Implements the AUTHINFO extension (RFC 4643) in USER/PASS mode
320 void nntp_authinfo(const char *cmd) {
322 if (!strncasecmp(cmd, "authinfo user ", 14)) {
323 nntp_authinfo_user(&cmd[14]);
326 else if (!strncasecmp(cmd, "authinfo pass ", 14)) {
327 nntp_authinfo_pass(&cmd[14]);
331 cprintf("502 command unavailable\r\n");
337 * Utility function to fetch the current list of message numbers in a room
339 struct nntp_msglist nntp_fetch_msglist(struct ctdlroom *qrbuf) {
340 struct nntp_msglist nm;
341 struct cdbdata *cdbfr;
343 cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf->QRnumber, sizeof(long));
345 nm.msgnums = (long*)cdbfr->ptr;
347 nm.num_msgs = cdbfr->len / sizeof(long);
360 * Various output formats for the LIST commands
364 NNTP_LIST_ACTIVE_TIMES,
365 NNTP_LIST_DISTRIB_PATS,
367 NNTP_LIST_NEWSGROUPS,
368 NNTP_LIST_OVERVIEW_FMT
373 * Output a room name (newsgroup name) in formats required for LIST and NEWGROUPS command
375 void output_roomname_in_list_format(struct ctdlroom *qrbuf, int which_format, char *wildmat_pattern) {
377 struct nntp_msglist nm;
378 long low_water_mark = 0;
379 long high_water_mark = 0;
381 room_to_newsgroup(n_name, qrbuf->QRname, sizeof n_name);
383 if ((wildmat_pattern != NULL) && (!IsEmptyStr(wildmat_pattern))) {
384 if (!wildmat(n_name, wildmat_pattern)) {
389 nm = nntp_fetch_msglist(qrbuf);
390 if ((nm.num_msgs > 0) && (nm.msgnums != NULL)) {
391 low_water_mark = nm.msgnums[0];
392 high_water_mark = nm.msgnums[nm.num_msgs - 1];
395 // Only the mandatory formats are supported
396 switch(which_format) {
397 case NNTP_LIST_ACTIVE:
398 // FIXME we have hardcoded "n" for "no posting allowed" -- fix when we add posting
399 cprintf("%s %ld %ld n\r\n", n_name, high_water_mark, low_water_mark);
401 case NNTP_LIST_NEWSGROUPS:
402 cprintf("%s %s\r\n", n_name, qrbuf->QRname);
406 if (nm.msgnums != NULL) {
414 * Called once per room by nntp_newgroups() to qualify and possibly output a single room
416 void nntp_newgroups_backend(struct ctdlroom *qrbuf, void *data)
420 time_t thetime = *(time_t *)data;
422 CtdlRoomAccess(qrbuf, &CC->user, &ra, &view);
425 * The "created after <date/time>" heuristics depend on the happy coincidence
426 * that for a very long time we have used a unix timestamp as the room record's
427 * generation number (QRgen). When this module is merged into the master
428 * source tree we should rename QRgen to QR_create_time or something like that.
432 if (qrbuf->QRgen >= thetime) {
433 output_roomname_in_list_format(qrbuf, NNTP_LIST_ACTIVE, NULL);
440 * Implements the NEWGROUPS command
442 void nntp_newgroups(const char *cmd) {
444 * HACK: this works because the 5XX series error codes from citadel
445 * protocol will also be considered error codes by an NNTP client
447 if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
450 char stringy_date[16];
451 char stringy_time[16];
452 char stringy_gmt[16];
456 extract_token(stringy_date, cmd, 1, ' ', sizeof stringy_date);
457 extract_token(stringy_time, cmd, 2, ' ', sizeof stringy_time);
458 extract_token(stringy_gmt, cmd, 3, ' ', sizeof stringy_gmt);
460 memset(&tm, 0, sizeof tm);
461 if (strlen(stringy_date) == 6) {
462 sscanf(stringy_date, "%2d%2d%2d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday);
466 sscanf(stringy_date, "%4d%2d%2d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday);
469 tm.tm_mon -= 1; // tm_mon is zero based (0=January)
470 tm.tm_isdst = (-1); // let the C library figure out whether DST is in effect
471 sscanf(stringy_time, "%2d%2d%2d", &tm.tm_hour, &tm.tm_min ,&tm.tm_sec);
472 thetime = mktime(&tm);
473 if (!strcasecmp(stringy_gmt, "GMT")) {
479 cprintf("231 list of new newsgroups follows\r\n");
480 CtdlGetUser(&CC->user, CC->curr_user);
481 CtdlForEachRoom(nntp_newgroups_backend, &thetime);
487 * Called once per room by nntp_list() to qualify and possibly output a single room
489 void nntp_list_backend(struct ctdlroom *qrbuf, void *data)
493 struct nntp_list_data *nld = (struct nntp_list_data *)data;
495 CtdlRoomAccess(qrbuf, &CC->user, &ra, &view);
497 output_roomname_in_list_format(qrbuf, nld->list_format, nld->wildmat_pattern);
503 * Implements the LIST commands
505 void nntp_list(const char *cmd) {
507 * HACK: this works because the 5XX series error codes from citadel
508 * protocol will also be considered error codes by an NNTP client
510 if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
512 char list_format[64];
513 char wildmat_pattern[1024];
514 struct nntp_list_data nld;
516 extract_token(list_format, cmd, 1, ' ', sizeof list_format);
517 extract_token(wildmat_pattern, cmd, 2, ' ', sizeof wildmat_pattern);
519 if (strlen(wildmat_pattern) > 0) {
520 nld.wildmat_pattern = wildmat_pattern;
523 nld.wildmat_pattern = NULL;
526 if ( (strlen(cmd) < 6) || (!strcasecmp(list_format, "ACTIVE")) ) {
527 nld.list_format = NNTP_LIST_ACTIVE;
529 else if (!strcasecmp(list_format, "NEWSGROUPS")) {
530 nld.list_format = NNTP_LIST_NEWSGROUPS;
533 cprintf("501 syntax error , unsupported list format\r\n");
537 cprintf("231 list of newsgroups follows\r\n");
538 CtdlGetUser(&CC->user, CC->curr_user);
539 CtdlForEachRoom(nntp_list_backend, &nld);
545 * Implement HELP command.
547 void nntp_help(void) {
548 cprintf("100 This is the Citadel NNTP service.\r\n");
549 cprintf("RTFM http://www.ietf.org/rfc/rfc3977.txt\r\n");
555 * Implements the GROUP command
557 void nntp_group(const char *cmd) {
559 * HACK: this works because the 5XX series error codes from citadel
560 * protocol will also be considered error codes by an NNTP client
562 if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
564 char requested_group[1024];
565 char requested_room[ROOMNAMELEN];
566 char augmented_roomname[ROOMNAMELEN];
570 struct ctdlroom QRscratch;
574 extract_token(requested_group, cmd, 1, ' ', sizeof requested_group);
575 newsgroup_to_room(requested_room, requested_group, sizeof requested_room);
577 /* First try a regular match */
578 c = CtdlGetRoom(&QRscratch, requested_room);
580 /* Then try a mailbox name match */
582 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, requested_room);
583 c = CtdlGetRoom(&QRscratch, augmented_roomname);
585 safestrncpy(requested_room, augmented_roomname, sizeof(requested_room));
589 /* If the room exists, check security/access */
591 /* See if there is an existing user/room relationship */
592 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
594 /* normal clients have to pass through security */
600 /* Fail here if no such room */
602 cprintf("411 no such newsgroup\r\n");
608 * CtdlUserGoto() formally takes us to the desired room, happily returning
609 * the number of messages and number of new messages.
611 memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
612 CtdlUserGoto(NULL, 0, 0, &msgs, &new, &oldest, &newest);
613 cprintf("211 %d %ld %ld %s\r\n", msgs, oldest, newest, requested_group);
618 * Main command loop for NNTP server sessions.
620 void nntp_command_loop(void)
622 StrBuf *Cmd = NewStrBuf();
626 if (CtdlClientGetLine(Cmd) < 1) {
627 syslog(LOG_CRIT, "NNTP: client disconnected: ending session.\n");
628 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
632 syslog(LOG_DEBUG, "NNTP server: %s\n", ChrPtr(Cmd));
633 extract_token(cmdname, ChrPtr(Cmd), 0, ' ', sizeof cmdname);
636 * Rumpelstiltskin lookups are awesome
639 if (!strcasecmp(cmdname, "quit")) {
643 else if (!strcasecmp(cmdname, "help")) {
647 else if (!strcasecmp(cmdname, "capabilities")) {
651 else if (!strcasecmp(cmdname, "starttls")) {
655 else if (!strcasecmp(cmdname, "authinfo")) {
656 nntp_authinfo(ChrPtr(Cmd));
659 else if (!strcasecmp(cmdname, "newgroups")) {
660 nntp_newgroups(ChrPtr(Cmd));
663 else if (!strcasecmp(cmdname, "list")) {
664 nntp_list(ChrPtr(Cmd));
667 else if (!strcasecmp(cmdname, "group")) {
668 nntp_group(ChrPtr(Cmd));
672 cprintf("500 I'm afraid I can't do that.\r\n");
679 /*****************************************************************************/
680 /* MODULE INITIALIZATION STUFF */
681 /*****************************************************************************/
685 * This cleanup function blows away the temporary memory used by
688 void nntp_cleanup_function(void)
690 /* Don't do this stuff if this is not an NNTP session! */
691 if (CC->h_command_function != nntp_command_loop) return;
693 syslog(LOG_DEBUG, "Performing NNTP cleanup hook\n");
696 const char *CitadelServiceNNTP="NNTP";
698 CTDL_MODULE_INIT(nntp)
702 CtdlRegisterServiceHook(119, // FIXME config.c_nntp_port,
710 CtdlRegisterServiceHook(563, // FIXME config.c_nntps_port,
718 CtdlRegisterCleanupHook(nntp_cleanup);
719 CtdlRegisterSessionHook(nntp_cleanup_function, EVT_STOP, PRIO_STOP + 250);
722 /* return our module name for the log */