src/ngircd/parse.c

   1 /*
   2  * ngIRCd -- The Next Generation IRC Daemon
   3  * Copyright (c)2001-2010 Alexander Barton (alex@barton.de)
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  * Please read the file COPYING, README and AUTHORS for more information.
  10  */
  11
  12 #include "portab.h"
  13
  14 /**
  15  * @file
  16  * IRC command parser and validator.
  17  */
  18
  19 #include "imp.h"
  20 #include <assert.h>
  21 #include <stdlib.h>
  22 #include <stdio.h>
  23 #include <string.h>
  24 #include <strings.h>
  25
  26 #include "ngircd.h"
  27 #include "defines.h"
  28 #include "conn-func.h"
  29 #include "channel.h"
  30 #include "log.h"
  31 #include "messages.h"
  32 #include "tool.h"
  33
  34 #include "exp.h"
  35 #include "parse.h"
  36
  37 #include "imp.h"
  38 #include "irc.h"
  39 #include "irc-cap.h"
  40 #include "irc-channel.h"
  41 #include "irc-encoding.h"
  42 #include "irc-info.h"
  43 #include "irc-login.h"
  44 #include "irc-mode.h"
  45 #include "irc-op.h"
  46 #include "irc-oper.h"
  47 #include "irc-server.h"
  48 #include "irc-write.h"
  49 #include "numeric.h"
  50
  51 #include "exp.h"
  52 #include "conf.h"
  53
  54 struct _NUMERIC {
  55         int numeric;
  56         bool (*function) PARAMS(( CLIENT *Client, REQUEST *Request ));
  57 };
  58
  59
  60 static COMMAND My_Commands[] =
  61 {
  62         { "ADMIN", IRC_ADMIN, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  63         { "AWAY", IRC_AWAY, CLIENT_USER, 0, 0, 0 },
  64         { "CAP", IRC_CAP, 0xFFFF, 0, 0, 0 },
  65         { "CONNECT", IRC_CONNECT, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  66         { "DIE", IRC_DIE, CLIENT_USER, 0, 0, 0 },
  67         { "DISCONNECT", IRC_DISCONNECT, CLIENT_USER, 0, 0, 0 },
  68         { "ERROR", IRC_ERROR, 0xFFFF, 0, 0, 0 },
  69         { "GLINE", IRC_xLINE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  70         { "HELP", IRC_HELP, CLIENT_USER, 0, 0, 0 },
  71         { "INFO", IRC_INFO, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  72         { "INVITE", IRC_INVITE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  73         { "ISON", IRC_ISON, CLIENT_USER, 0, 0, 0 },
  74         { "JOIN", IRC_JOIN, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  75         { "KICK", IRC_KICK, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  76         { "KILL", IRC_KILL, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  77         { "KLINE", IRC_xLINE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  78         { "LINKS", IRC_LINKS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  79         { "LIST", IRC_LIST, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  80         { "LUSERS", IRC_LUSERS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  81         { "MODE", IRC_MODE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  82         { "MOTD", IRC_MOTD, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  83         { "NAMES", IRC_NAMES, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  84         { "NICK", IRC_NICK, 0xFFFF, 0, 0, 0 },
  85         { "NJOIN", IRC_NJOIN, CLIENT_SERVER, 0, 0, 0 },
  86         { "NOTICE", IRC_NOTICE, 0xFFFF, 0, 0, 0 },
  87         { "OPER", IRC_OPER, CLIENT_USER, 0, 0, 0 },
  88         { "PART", IRC_PART, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  89         { "PASS", IRC_PASS, 0xFFFF, 0, 0, 0 },
  90         { "PING", IRC_PING, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  91         { "PONG", IRC_PONG, 0xFFFF, 0, 0, 0 },
  92         { "PRIVMSG", IRC_PRIVMSG, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
  93         { "QUIT", IRC_QUIT, 0xFFFF, 0, 0, 0 },
  94         { "REHASH", IRC_REHASH, CLIENT_USER, 0, 0, 0 },
  95         { "RESTART", IRC_RESTART, CLIENT_USER, 0, 0, 0 },
  96         { "SERVER", IRC_SERVER, 0xFFFF, 0, 0, 0 },
  97         { "SERVICE", IRC_SERVICE, 0xFFFF, 0, 0, 0 },
  98         { "SERVLIST", IRC_SERVLIST, CLIENT_USER, 0, 0, 0 },
  99         { "SQUERY", IRC_SQUERY, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 100         { "SQUIT", IRC_SQUIT, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 101         { "STATS", IRC_STATS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 102         { "SVSNICK", IRC_SVSNICK, CLIENT_SERVER, 0, 0, 0 },
 103         { "SUMMON", IRC_SUMMON, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 104         { "TIME", IRC_TIME, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 105         { "TOPIC", IRC_TOPIC, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 106         { "TRACE", IRC_TRACE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 107         { "USER", IRC_USER, 0xFFFF, 0, 0, 0 },
 108         { "USERHOST", IRC_USERHOST, CLIENT_USER, 0, 0, 0 },
 109         { "USERS", IRC_USERS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 110         { "VERSION", IRC_VERSION, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 111         { "WALLOPS", IRC_WALLOPS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 112         { "WEBIRC", IRC_WEBIRC, CLIENT_UNKNOWN, 0, 0, 0 },
 113         { "WHO", IRC_WHO, CLIENT_USER, 0, 0, 0 },
 114         { "WHOIS", IRC_WHOIS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 115         { "WHOWAS", IRC_WHOWAS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
 116
 117 #ifdef IRCPLUS
 118         { "CHANINFO", IRC_CHANINFO, CLIENT_SERVER, 0, 0, 0 },
 119 # ifdef ICONV
 120         { "CHARCONV", IRC_CHARCONV, CLIENT_USER, 0, 0, 0 },
 121 # endif
 122 #endif
 123
 124 #ifndef STRICT_RFC
 125         { "GET",  IRC_QUIT_HTTP, CLIENT_UNKNOWN, 0, 0, 0 },
 126         { "POST", IRC_QUIT_HTTP, CLIENT_UNKNOWN, 0, 0, 0 },
 127 #endif
 128         { NULL, NULL, 0x0, 0, 0, 0 } /* Ende-Marke */
 129 };
 130
 131 static void Init_Request PARAMS(( REQUEST *Req ));
 132
 133 static bool Validate_Prefix PARAMS(( CONN_ID Idx, REQUEST *Req, bool *Closed ));
 134 static bool Validate_Command PARAMS(( CONN_ID Idx, REQUEST *Req, bool *Closed ));
 135 static bool Validate_Args PARAMS(( CONN_ID Idx, REQUEST *Req, bool *Closed ));
 136
 137 static bool Handle_Request PARAMS(( CONN_ID Idx, REQUEST *Req ));
 138
 139 static bool ScrubCTCP PARAMS((char *Request));
 140
 141 /**
 142  * Return the pointer to the global "IRC command structure".
 143  * This structure, an array of type "COMMAND" describes all the IRC commands
 144  * implemented by ngIRCd and how to handle them.
 145  * @return Pointer to the global command structure.
 146  */
 147 GLOBAL COMMAND *
 148 Parse_GetCommandStruct( void )
 149 {
 150         return My_Commands;
 151 } /* Parse_GetCommandStruct */
 152
 153
 154 /**
 155  * Parse a command ("request") received from a client.
 156  *
 157  * This function is called after the connection layer received a valid CR+LF
 158  * terminated line of text: we asume that this is a valid IRC command and
 159  * try to do something useful with it :-)
 160  *
 161  * All errors are reported to the client from which the command has been
 162  * received, and if the error is fatal this connection is closed down.
 163  *
 164  * This function is able to parse the syntax as described in RFC 2812,
 165  * section 2.3.
 166  *
 167  * @param Idx Index of the connection from which the command has been received.
 168  * @param Request NULL terminated line of text (the "command").
 169  * @return true on success (valid command or "regular" error), false if a
 170  *      fatal error occured and the connection has been shut down.
 171  */
 172 GLOBAL bool
 173 Parse_Request( CONN_ID Idx, char *Request )
 174 {
 175         REQUEST req;
 176         char *start, *ptr;
 177         bool closed;
 178
 179         assert( Idx >= 0 );
 180         assert( Request != NULL );
 181
 182 #ifdef SNIFFER
 183         if( NGIRCd_Sniffer ) Log( LOG_DEBUG, " <- connection %d: '%s'.", Idx, Request );
 184 #endif
 185
 186         Init_Request( &req );
 187
 188         /* remove leading & trailing whitespace */
 189         ngt_TrimStr( Request );
 190
 191         if (Conf_ScrubCTCP && ScrubCTCP(Request))
 192                 return true;
 193
 194         if (Request[0] == ':') {
 195                 /* Prefix */
 196                 req.prefix = Request + 1;
 197                 ptr = strchr( Request, ' ' );
 198                 if( ! ptr )
 199                 {
 200                         LogDebug("Connection %d: Parse error: prefix without command!?", Idx);
 201                         return Conn_WriteStr(Idx, "ERROR :Prefix without command");
 202                 }
 203                 *ptr = '\0';
 204 #ifndef STRICT_RFC
 205                 /* ignore multiple spaces between prefix and command */
 206                 while( *(ptr + 1) == ' ' ) ptr++;
 207 #endif
 208                 start = ptr + 1;
 209         }
 210         else start = Request;
 211
 212         ptr = strchr( start, ' ' );
 213         if( ptr )
 214         {
 215                 *ptr = '\0';
 216 #ifndef STRICT_RFC
 217                 /* ignore multiple spaces between parameters */
 218                 while( *(ptr + 1) == ' ' ) ptr++;
 219 #endif
 220         }
 221         req.command = start;
 222
 223         /* Arguments, Parameters */
 224         if( ptr )
 225         {
 226                 start = ptr + 1;
 227                 while( start )
 228                 {
 229                         if( start[0] == ':' )
 230                         {
 231                                 req.argv[req.argc] = start + 1;
 232                                 ptr = NULL;
 233                         }
 234                         else
 235                         {
 236                                 req.argv[req.argc] = start;
 237                                 ptr = strchr( start, ' ' );
 238                                 if( ptr )
 239                                 {
 240                                         *ptr = '\0';
 241 #ifndef STRICT_RFC
 242                                         while( *(ptr + 1) == ' ' ) ptr++;
 243 #endif
 244                                 }
 245                         }
 246
 247                         req.argc++;
 248
 249                         if( start[0] == ':' ) break;
 250                         if( req.argc > 14 ) break;
 251
 252                         if( ptr ) start = ptr + 1;
 253                         else start = NULL;
 254                 }
 255         }
 256
 257         if( ! Validate_Prefix( Idx, &req, &closed )) return ! closed;
 258         if( ! Validate_Command( Idx, &req, &closed )) return ! closed;
 259         if( ! Validate_Args( Idx, &req, &closed )) return ! closed;
 260
 261         return Handle_Request( Idx, &req );
 262 } /* Parse_Request */
 263
 264
 265 /**
 266  * Initialize request structure.
 267  * @param Req Request structure to be initialized.
 268  */
 269 static void
 270 Init_Request( REQUEST *Req )
 271 {
 272         /* Neue Request-Struktur initialisieren */
 273
 274         int i;
 275
 276         assert( Req != NULL );
 277
 278         Req->prefix = NULL;
 279         Req->command = NULL;
 280         for( i = 0; i < 15; Req->argv[i++] = NULL );
 281         Req->argc = 0;
 282 } /* Init_Request */
 283
 284
 285 static bool
 286 Validate_Prefix( CONN_ID Idx, REQUEST *Req, bool *Closed )
 287 {
 288         CLIENT *client, *c;
 289
 290         assert( Idx >= 0 );
 291         assert( Req != NULL );
 292
 293         *Closed = false;
 294
 295         client = Conn_GetClient( Idx );
 296         assert( client != NULL );
 297
 298         if (!Req->prefix && Client_Type(client) == CLIENT_SERVER
 299             && !(Conn_Options(Idx) & CONN_RFC1459)
 300             && strcasecmp(Req->command, "ERROR") != 0
 301             && strcasecmp(Req->command, "PING") != 0)
 302         {
 303                 Log(LOG_ERR,
 304                     "Received command without prefix (connection %d, command \"%s\")!?",
 305                     Idx, Req->command);
 306                 if (!Conn_WriteStr(Idx, "ERROR :Prefix missing"))
 307                         *Closed = true;
 308                 return false;
 309         }
 310
 311         if (!Req->prefix)
 312                 return true;
 313
 314         /* only validate if this connection is already registered */
 315         if (Client_Type(client) != CLIENT_USER
 316             && Client_Type(client) != CLIENT_SERVER
 317             && Client_Type(client) != CLIENT_SERVICE) {
 318                 /* not registered, ignore prefix */
 319                 Req->prefix = NULL;
 320                 return true;
 321         }
 322
 323         /* check if client in prefix is known */
 324         c = Client_Search( Req->prefix );
 325         if (!c) {
 326                 Log(LOG_ERR,
 327                     "Invalid prefix \"%s\", client not known (connection %d, command \"%s\")!?",
 328                     Req->prefix, Idx, Req->command);
 329                 if (!Conn_WriteStr(Idx,
 330                                    "ERROR :Invalid prefix \"%s\", client not known",
 331                                    Req->prefix))
 332                         *Closed = true;
 333                 return false;
 334         }
 335
 336         /* check if the client named in the prefix is expected
 337          * to come from that direction */
 338         if (Client_NextHop(c) != client) {
 339                 if (Client_Type(c) != CLIENT_SERVER) {
 340                         Log(LOG_ERR,
 341                             "Spoofed prefix \"%s\" from \"%s\" (connection %d, command \"%s\")!",
 342                             Req->prefix, Client_Mask(Conn_GetClient(Idx)), Idx,
 343                             Req->command);
 344                         Conn_Close(Idx, NULL, "Spoofed prefix", true);
 345                         *Closed = true;
 346                 } else {
 347                         Log(LOG_INFO,
 348                             "Ignoring spoofed prefix \"%s\" from \"%s\" (connection %d, command \"%s\").",
 349                             Req->prefix, Client_Mask(Conn_GetClient(Idx)), Idx,
 350                             Req->command);
 351                 }
 352                 return false;
 353
 354         }
 355
 356         return true;
 357 } /* Validate_Prefix */
 358
 359
 360 static bool
 361 Validate_Command( UNUSED CONN_ID Idx, UNUSED REQUEST *Req, bool *Closed )
 362 {
 363         assert( Idx >= 0 );
 364         assert( Req != NULL );
 365         *Closed = false;
 366
 367         return true;
 368 } /* Validate_Comman */
 369
 370
 371 static bool
 372 #ifdef STRICT_RFC
 373 Validate_Args(CONN_ID Idx, REQUEST *Req, bool *Closed)
 374 #else
 375 Validate_Args(UNUSED CONN_ID Idx, UNUSED REQUEST *Req, bool *Closed)
 376 #endif
 377 {
 378 #ifdef STRICT_RFC
 379         int i;
 380 #endif
 381
 382         *Closed = false;
 383
 384 #ifdef STRICT_RFC
 385         assert( Idx >= 0 );
 386         assert( Req != NULL );
 387
 388         /* CR and LF are never allowed in command parameters.
 389          * But since we do accept lines terminated only with CR or LF in
 390          * "non-RFC-compliant mode" (besides the correct CR+LF combination),
 391          * this check can only trigger in "strict RFC" mode; therefore we
 392          * optimize it away otherwise ... */
 393         for (i = 0; i < Req->argc; i++) {
 394                 if (strchr(Req->argv[i], '\r') || strchr(Req->argv[i], '\n')) {
 395                         Log(LOG_ERR,
 396                             "Invalid character(s) in parameter (connection %d, command %s)!?",
 397                             Idx, Req->command);
 398                         if (!Conn_WriteStr(Idx,
 399                                            "ERROR :Invalid character(s) in parameter!"))
 400                                 *Closed = true;
 401                         return false;
 402                 }
 403         }
 404 #endif
 405
 406         return true;
 407 } /* Validate_Args */
 408
 409
 410 /* Command is a status code ("numeric") from another server */
 411 static bool
 412 Handle_Numeric(CLIENT *client, REQUEST *Req)
 413 {
 414         static const struct _NUMERIC Numerics[] = {
 415                 {   5, IRC_Num_ISUPPORT },
 416                 {  20, NULL },
 417                 { 376, IRC_Num_ENDOFMOTD }
 418         };
 419         int i, num;
 420         char str[LINE_LEN];
 421         CLIENT *prefix, *target = NULL;
 422
 423         /* Determine target */
 424         if (Req->argc > 0) {
 425                 if (strcmp(Req->argv[0], "*") != 0)
 426                         target = Client_Search(Req->argv[0]);
 427                 else
 428                         target = Client_ThisServer();
 429         }
 430
 431         if (!target) {
 432                 /* Status code without target!? */
 433                 if (Req->argc > 0)
 434                         Log(LOG_WARNING,
 435                             "Unknown target for status code %s: \"%s\"",
 436                             Req->command, Req->argv[0]);
 437                 else
 438                         Log(LOG_WARNING,
 439                             "Unknown target for status code %s!",
 440                             Req->command);
 441                 return true;
 442         }
 443         if (target == Client_ThisServer()) {
 444                 /* This server is the target of the numeric */
 445                 num = atoi(Req->command);
 446
 447                 for (i = 0; i < (int) C_ARRAY_SIZE(Numerics); i++) {
 448                         if (num == Numerics[i].numeric) {
 449                                 if (!Numerics[i].function)
 450                                         return CONNECTED;
 451                                 return Numerics[i].function(client, Req);
 452                         }
 453                 }
 454
 455                 LogDebug("Ignored status code %s from \"%s\".",
 456                          Req->command, Client_ID(client));
 457                 return true;
 458         }
 459
 460         /* Determine source */
 461         if (! Req->prefix[0]) {
 462                 /* Oops, no prefix!? */
 463                 Log(LOG_WARNING, "Got status code %s from \"%s\" without prefix!?",
 464                                                 Req->command, Client_ID(client));
 465                 return true;
 466         }
 467
 468         prefix = Client_Search(Req->prefix);
 469         if (! prefix) { /* Oops, unknown prefix!? */
 470                 Log(LOG_WARNING, "Got status code %s from unknown source: \"%s\"", Req->command, Req->prefix);
 471                 return true;
 472         }
 473
 474         /* Forward status code */
 475         strlcpy(str, Req->command, sizeof(str));
 476         for (i = 0; i < Req->argc; i++) {
 477                 if (i < Req->argc - 1)
 478                         strlcat(str, " ", sizeof(str));
 479                 else
 480                         strlcat(str, " :", sizeof(str));
 481                 strlcat(str, Req->argv[i], sizeof(str));
 482         }
 483         return IRC_WriteStrClientPrefix(target, prefix, "%s", str);
 484 }
 485
 486 static bool
 487 Handle_Request( CONN_ID Idx, REQUEST *Req )
 488 {
 489         CLIENT *client;
 490         bool result = true;
 491         int client_type;
 492         COMMAND *cmd;
 493
 494         assert( Idx >= 0 );
 495         assert( Req != NULL );
 496         assert( Req->command != NULL );
 497
 498         client = Conn_GetClient( Idx );
 499         assert( client != NULL );
 500
 501         /* Numeric? */
 502         client_type = Client_Type(client);
 503         if ((client_type == CLIENT_SERVER ||
 504              client_type == CLIENT_UNKNOWNSERVER)
 505             && strlen(Req->command) == 3 && atoi(Req->command) > 1)
 506                 return Handle_Numeric(client, Req);
 507
 508         cmd = My_Commands;
 509         while (cmd->name) {
 510                 if (strcasecmp(Req->command, cmd->name) != 0) {
 511                         cmd++;
 512                         continue;
 513                 }
 514
 515                 if (!(client_type & cmd->type))
 516                         return IRC_WriteStrClient(client, ERR_NOTREGISTERED_MSG, Client_ID(client));
 517
 518                 /* Command is allowed for this client: call it and count produced bytes */
 519                 Conn_ResetWCounter();
 520                 result = (cmd->function)(client, Req);
 521                 cmd->bytes += Conn_WCounter();
 522
 523                 /* Adjust counters */
 524                 if (client_type != CLIENT_SERVER)
 525                         cmd->lcount++;
 526                 else
 527                         cmd->rcount++;
 528                 return result;
 529         }
 530
 531         if (client_type != CLIENT_USER &&
 532             client_type != CLIENT_SERVER &&
 533             client_type != CLIENT_SERVICE )
 534                 return true;
 535
 536         /* Unknown command and registered connection: generate error: */
 537         LogDebug("Connection %d: Unknown command \"%s\", %d %s,%s prefix.",
 538                         Client_Conn( client ), Req->command, Req->argc,
 539                         Req->argc == 1 ? "parameter" : "parameters",
 540                         Req->prefix ? "" : " no" );
 541
 542         if (Client_Type(client) != CLIENT_SERVER) {
 543                 result = IRC_WriteStrClient(client, ERR_UNKNOWNCOMMAND_MSG,
 544                                 Client_ID(client), Req->command);
 545                 Conn_SetPenalty(Idx, 1);
 546         }
 547         return result;
 548 } /* Handle_Request */
 549
 550
 551 /**
 552  * Check if incoming messages contains CTCP commands and should be dropped.
 553  *
 554  * @param Request NULL terminated incoming command.
 555  * @returns true, when the message should be dropped.
 556  */
 557 static bool
 558 ScrubCTCP(char *Request)
 559 {
 560         static const char me_cmd[] = "ACTION ";
 561         static const char ctcp_char = 0x1;
 562         bool dropCommand = false;
 563         char *ptr = Request;
 564         char *ptrEnd = strchr(Request, '\0');
 565
 566         if (Request[0] == ':' && ptrEnd > ptr)
 567                 ptr++;
 568
 569         while (ptr != ptrEnd && *ptr != ':')
 570                 ptr++;
 571
 572         if ((ptrEnd - ptr) > 1) {
 573                 ptr++;
 574                 if (*ptr == ctcp_char) {
 575                         dropCommand = true;
 576                         ptr++;
 577                         /* allow /me commands */
 578                         if ((size_t)(ptrEnd - ptr) >= strlen(me_cmd)
 579                             && !strncmp(ptr, me_cmd, strlen(me_cmd)))
 580                                 dropCommand = false;
 581                 }
 582         }
 583         return dropCommand;
 584 }
 585
 586 /* -eof- */