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 #include "serv_nntp.h"
  64
  65 extern long timezone;
  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         cprintf("VERSION 2\r\n");
 244         cprintf("READER\r\n");
 245         cprintf("LIST ACTIVE NEWSGROUPS\r\n");
 246         cprintf("IMPLEMENTATION Citadel v%d.%02d\r\n", (REV_LEVEL/100), (REV_LEVEL%100));
 247 #ifdef HAVE_OPENSSL
 248         cprintf("STARTTLS\r\n");
 249 #endif
 250         if (!CC->logged_in) {
 251                 cprintf("AUTHINFO USER\r\n");
 252         }
 253         cprintf(".\r\n");
 254 }
 255
 256
 257 void nntp_quit(void)
 258 {
 259         cprintf("221 Goodbye...\r\n");
 260         CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
 261 }
 262
 263
 264 void nntp_cleanup(void)
 265 {
 266         /* nothing here yet */
 267 }
 268
 269
 270
 271 /*
 272  * Implements the AUTHINFO USER command (RFC 4643)
 273  */
 274 void nntp_authinfo_user(const char *username)
 275 {
 276         int a = CtdlLoginExistingUser(NULL, username);
 277         switch (a) {
 278         case login_already_logged_in:
 279                 cprintf("482 Already logged in\r\n");
 280                 return;
 281         case login_too_many_users:
 282                 cprintf("481 Too many users are already online (maximum is %d)\r\n", config.c_maxsessions);
 283                 return;
 284         case login_ok:
 285                 cprintf("381 Password required for %s\r\n", CC->curr_user);
 286                 return;
 287         case login_not_found:
 288                 cprintf("481 %s not found\r\n", username);
 289                 return;
 290         default:
 291                 cprintf("502 Internal error\r\n");
 292         }
 293 }
 294
 295
 296 /*
 297  * Implements the AUTHINFO PASS command (RFC 4643)
 298  */
 299 void nntp_authinfo_pass(const char *buf)
 300 {
 301         int a;
 302
 303         a = CtdlTryPassword(buf, strlen(buf));
 304
 305         switch (a) {
 306         case pass_already_logged_in:
 307                 cprintf("482 Already logged in\r\n");
 308                 return;
 309         case pass_no_user:
 310                 cprintf("482 Authentication commands issued out of sequence\r\n");
 311                 return;
 312         case pass_wrong_password:
 313                 cprintf("481 Authentication failed\r\n");
 314                 return;
 315         case pass_ok:
 316                 cprintf("281 Authentication accepted\r\n");
 317                 return;
 318         }
 319 }
 320
 321
 322
 323 /*
 324  * Implements the AUTHINFO extension (RFC 4643) in USER/PASS mode
 325  */
 326 void nntp_authinfo(const char *cmd) {
 327
 328         if (!strncasecmp(cmd, "authinfo user ", 14)) {
 329                 nntp_authinfo_user(&cmd[14]);
 330         }
 331
 332         else if (!strncasecmp(cmd, "authinfo pass ", 14)) {
 333                 nntp_authinfo_pass(&cmd[14]);
 334         }
 335
 336         else {
 337                 cprintf("502 command unavailable\r\n");
 338         }
 339 }
 340
 341
 342 /*
 343  * Utility function to fetch the current list of message numbers in a room
 344  */
 345 struct nntp_msglist nntp_fetch_msglist(struct ctdlroom *qrbuf) {
 346         struct nntp_msglist nm;
 347         struct cdbdata *cdbfr;
 348
 349         cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf->QRnumber, sizeof(long));
 350         if (cdbfr != NULL) {
 351                 nm.msgnums = (long*)cdbfr->ptr;
 352                 cdbfr->ptr = NULL;
 353                 nm.num_msgs = cdbfr->len / sizeof(long);
 354                 cdbfr->len = 0;
 355                 cdb_free(cdbfr);
 356         } else {
 357                 nm.num_msgs = 0;
 358                 nm.msgnums = NULL;
 359         }
 360         return(nm);
 361 }
 362
 363
 364
 365 /*
 366  * Various output formats for the LIST commands
 367  */
 368 enum {
 369         NNTP_LIST_ACTIVE,
 370         NNTP_LIST_ACTIVE_TIMES,
 371         NNTP_LIST_DISTRIB_PATS,
 372         NNTP_LIST_HEADERS,
 373         NNTP_LIST_NEWSGROUPS,
 374         NNTP_LIST_OVERVIEW_FMT
 375 };
 376
 377
 378 /*
 379  * Output a room name (newsgroup name) in formats required for LIST and NEWGROUPS command
 380  */
 381 void output_roomname_in_list_format(struct ctdlroom *qrbuf, int which_format, char *wildmat_pattern) {
 382         char n_name[1024];
 383         struct nntp_msglist nm;
 384         long low_water_mark = 0;
 385         long high_water_mark = 0;
 386
 387         room_to_newsgroup(n_name, qrbuf->QRname, sizeof n_name);
 388
 389         if ((wildmat_pattern != NULL) && (!IsEmptyStr(wildmat_pattern))) {
 390                 if (!wildmat(n_name, wildmat_pattern)) {
 391                         return;
 392                 }
 393         }
 394
 395         nm = nntp_fetch_msglist(qrbuf);
 396         if ((nm.num_msgs > 0) && (nm.msgnums != NULL)) {
 397                 low_water_mark = nm.msgnums[0];
 398                 high_water_mark = nm.msgnums[nm.num_msgs - 1];
 399         }
 400
 401         // Only the mandatory formats are supported
 402         switch(which_format) {
 403         case NNTP_LIST_ACTIVE:
 404                 // FIXME we have hardcoded "n" for "no posting allowed" -- fix when we add posting
 405                 cprintf("%s %ld %ld n\r\n", n_name, high_water_mark, low_water_mark);
 406                 break;
 407         case NNTP_LIST_NEWSGROUPS:
 408                 cprintf("%s %s\r\n", n_name, qrbuf->QRname);
 409                 break;
 410         }
 411
 412         if (nm.msgnums != NULL) {
 413                 free(nm.msgnums);
 414         }
 415 }
 416
 417
 418
 419 /*
 420  * Called once per room by nntp_newgroups() to qualify and possibly output a single room
 421  */
 422 void nntp_newgroups_backend(struct ctdlroom *qrbuf, void *data)
 423 {
 424         int ra;
 425         int view;
 426         time_t thetime = *(time_t *)data;
 427
 428         CtdlRoomAccess(qrbuf, &CC->user, &ra, &view);
 429
 430         /*
 431          * The "created after <date/time>" heuristics depend on the happy coincidence
 432          * that for a very long time we have used a unix timestamp as the room record's
 433          * generation number (QRgen).  When this module is merged into the master
 434          * source tree we should rename QRgen to QR_create_time or something like that.
 435          */
 436
 437         if (ra & UA_KNOWN) {
 438                 if (qrbuf->QRgen >= thetime) {
 439                         output_roomname_in_list_format(qrbuf, NNTP_LIST_ACTIVE, NULL);
 440                 }
 441         }
 442 }
 443
 444
 445 /*
 446  * Implements the NEWGROUPS command
 447  */
 448 void nntp_newgroups(const char *cmd) {
 449         /*
 450          * HACK: this works because the 5XX series error codes from citadel
 451          * protocol will also be considered error codes by an NNTP client
 452          */
 453         if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
 454
 455
 456         char stringy_date[16];
 457         char stringy_time[16];
 458         char stringy_gmt[16];
 459         struct tm tm;
 460         time_t thetime;
 461
 462         extract_token(stringy_date, cmd, 1, ' ', sizeof stringy_date);
 463         extract_token(stringy_time, cmd, 2, ' ', sizeof stringy_time);
 464         extract_token(stringy_gmt, cmd, 3, ' ', sizeof stringy_gmt);
 465
 466         memset(&tm, 0, sizeof tm);
 467         if (strlen(stringy_date) == 6) {
 468                 sscanf(stringy_date, "%2d%2d%2d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday);
 469                 tm.tm_year += 100;
 470         }
 471         else {
 472                 sscanf(stringy_date, "%4d%2d%2d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday);
 473                 tm.tm_year -= 1900;
 474         }
 475         tm.tm_mon -= 1;         // tm_mon is zero based (0=January)
 476         tm.tm_isdst = (-1);     // let the C library figure out whether DST is in effect
 477         sscanf(stringy_time, "%2d%2d%2d", &tm.tm_hour, &tm.tm_min ,&tm.tm_sec);
 478         thetime = mktime(&tm);
 479         if (!strcasecmp(stringy_gmt, "GMT")) {
 480                 tzset();
 481                 thetime += timezone;
 482         }
 483
 484
 485         cprintf("231 list of new newsgroups follows\r\n");
 486         CtdlGetUser(&CC->user, CC->curr_user);
 487         CtdlForEachRoom(nntp_newgroups_backend, &thetime);
 488         cprintf(".\r\n");
 489 }
 490
 491
 492 /*
 493  * Called once per room by nntp_list() to qualify and possibly output a single room
 494  */
 495 void nntp_list_backend(struct ctdlroom *qrbuf, void *data)
 496 {
 497         int ra;
 498         int view;
 499         struct nntp_list_data *nld = (struct nntp_list_data *)data;
 500
 501         CtdlRoomAccess(qrbuf, &CC->user, &ra, &view);
 502         if (ra & UA_KNOWN) {
 503                 output_roomname_in_list_format(qrbuf, nld->list_format, nld->wildmat_pattern);
 504         }
 505 }
 506
 507
 508 /*
 509  * Implements the LIST commands
 510  */
 511 void nntp_list(const char *cmd) {
 512         /*
 513          * HACK: this works because the 5XX series error codes from citadel
 514          * protocol will also be considered error codes by an NNTP client
 515          */
 516         if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
 517
 518         char list_format[64];
 519         char wildmat_pattern[1024];
 520         struct nntp_list_data nld;
 521
 522         extract_token(list_format, cmd, 1, ' ', sizeof list_format);
 523         extract_token(wildmat_pattern, cmd, 2, ' ', sizeof wildmat_pattern);
 524
 525         if (strlen(wildmat_pattern) > 0) {
 526                 nld.wildmat_pattern = wildmat_pattern;
 527         }
 528         else {
 529                 nld.wildmat_pattern = NULL;
 530         }
 531
 532         if ( (strlen(cmd) < 6) || (!strcasecmp(list_format, "ACTIVE")) ) {
 533                 nld.list_format = NNTP_LIST_ACTIVE;
 534         }
 535         else if (!strcasecmp(list_format, "NEWSGROUPS")) {
 536                 nld.list_format = NNTP_LIST_NEWSGROUPS;
 537         }
 538         else {
 539                 cprintf("501 syntax error , unsupported list format\r\n");
 540                 return;
 541         }
 542
 543         cprintf("231 list of newsgroups follows\r\n");
 544         CtdlGetUser(&CC->user, CC->curr_user);
 545         CtdlForEachRoom(nntp_list_backend, &nld);
 546         cprintf(".\r\n");
 547 }
 548
 549
 550 /*
 551  * Main command loop for NNTP server sessions.
 552  */
 553 void nntp_command_loop(void)
 554 {
 555         StrBuf *Cmd = NewStrBuf();
 556         char cmdname[16];
 557
 558         time(&CC->lastcmd);
 559         if (CtdlClientGetLine(Cmd) < 1) {
 560                 syslog(LOG_CRIT, "NNTP: client disconnected: ending session.\n");
 561                 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
 562                 FreeStrBuf(&Cmd);
 563                 return;
 564         }
 565         syslog(LOG_DEBUG, "NNTP server: %s\n", ChrPtr(Cmd));
 566         extract_token(cmdname, ChrPtr(Cmd), 0, ' ', sizeof cmdname);
 567
 568         /*
 569          * Rumpelstiltskin lookups are awesome
 570          */
 571
 572         if (!strcasecmp(cmdname, "quit")) {
 573                 nntp_quit();
 574         }
 575
 576         else if (!strcasecmp(cmdname, "capabilities")) {
 577                 nntp_capabilities();
 578         }
 579
 580         else if (!strcasecmp(cmdname, "starttls")) {
 581                 nntp_starttls();
 582         }
 583
 584         else if (!strcasecmp(cmdname, "noop")) {
 585                 nntp_noop();
 586         }
 587
 588         else if (!strcasecmp(cmdname, "authinfo")) {
 589                 nntp_authinfo(ChrPtr(Cmd));
 590         }
 591
 592         else if (!strcasecmp(cmdname, "newgroups")) {
 593                 nntp_newgroups(ChrPtr(Cmd));
 594         }
 595
 596         else if (!strcasecmp(cmdname, "list")) {
 597                 nntp_list(ChrPtr(Cmd));
 598         }
 599
 600         else {
 601                 cprintf("500 I'm afraid I can't do that.\r\n");
 602         }
 603
 604         FreeStrBuf(&Cmd);
 605 }
 606
 607
 608 /*****************************************************************************/
 609 /*                    MODULE INITIALIZATION STUFF                         */
 610 /*****************************************************************************/
 611
 612
 613 /*
 614  * This cleanup function blows away the temporary memory used by
 615  * the NNTP server.
 616  */
 617 void nntp_cleanup_function(void)
 618 {
 619         /* Don't do this stuff if this is not an NNTP session! */
 620         if (CC->h_command_function != nntp_command_loop) return;
 621
 622         syslog(LOG_DEBUG, "Performing NNTP cleanup hook\n");
 623 }
 624
 625 const char *CitadelServiceNNTP="NNTP";
 626
 627 CTDL_MODULE_INIT(nntp)
 628 {
 629         if (!threading)
 630         {
 631                 CtdlRegisterServiceHook(119,                    // FIXME config.c_nntp_port,
 632                                         NULL,
 633                                         nntp_greeting,
 634                                         nntp_command_loop,
 635                                         NULL,
 636                                         CitadelServiceNNTP);
 637
 638 #ifdef HAVE_OPENSSL
 639                 CtdlRegisterServiceHook(563,                    // FIXME config.c_nntps_port,
 640                                         NULL,
 641                                         nntps_greeting,
 642                                         nntp_command_loop,
 643                                         NULL,
 644                                         CitadelServiceNNTP);
 645 #endif
 646
 647                 CtdlRegisterCleanupHook(nntp_cleanup);
 648                 CtdlRegisterSessionHook(nntp_cleanup_function, EVT_STOP, PRIO_STOP + 250);
 649         }
 650
 651         /* return our module name for the log */
 652         return "nntp";
 653 }
 654