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