2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
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.
15 static char UNUSED id[] = "$Id: parse.c,v 1.72 2008/02/17 13:26:42 alex Exp $";
19 * IRC command parser and validator.
31 #include "conn-func.h"
43 #include "irc-channel.h"
45 #include "irc-login.h"
49 #include "irc-server.h"
50 #include "irc-write.h"
57 bool (*function) PARAMS(( CLIENT *Client, REQUEST *Request ));
61 static COMMAND My_Commands[] =
63 { "ADMIN", IRC_ADMIN, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
64 { "AWAY", IRC_AWAY, CLIENT_USER, 0, 0, 0 },
65 { "CONNECT", IRC_CONNECT, CLIENT_USER, 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 { "HELP", IRC_HELP, CLIENT_USER, 0, 0, 0 },
70 { "INFO", IRC_INFO, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
71 { "INVITE", IRC_INVITE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
72 { "ISON", IRC_ISON, CLIENT_USER, 0, 0, 0 },
73 { "JOIN", IRC_JOIN, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
74 { "KICK", IRC_KICK, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
75 { "KILL", IRC_KILL, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
76 { "LINKS", IRC_LINKS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
77 { "LIST", IRC_LIST, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
78 { "LUSERS", IRC_LUSERS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
79 { "MODE", IRC_MODE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
80 { "MOTD", IRC_MOTD, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
81 { "NAMES", IRC_NAMES, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
82 { "NICK", IRC_NICK, 0xFFFF, 0, 0, 0 },
83 { "NJOIN", IRC_NJOIN, CLIENT_SERVER, 0, 0, 0 },
84 { "NOTICE", IRC_NOTICE, 0xFFFF, 0, 0, 0 },
85 { "OPER", IRC_OPER, CLIENT_USER, 0, 0, 0 },
86 { "PART", IRC_PART, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
87 { "PASS", IRC_PASS, 0xFFFF, 0, 0, 0 },
88 { "PING", IRC_PING, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
89 { "PONG", IRC_PONG, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
90 { "PRIVMSG", IRC_PRIVMSG, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
91 { "QUIT", IRC_QUIT, 0xFFFF, 0, 0, 0 },
92 { "REHASH", IRC_REHASH, CLIENT_USER, 0, 0, 0 },
93 { "RESTART", IRC_RESTART, CLIENT_USER, 0, 0, 0 },
94 { "SERVER", IRC_SERVER, 0xFFFF, 0, 0, 0 },
95 { "SERVICE", IRC_SERVICE, 0xFFFF, 0, 0, 0 },
96 { "SERVLIST", IRC_SERVLIST, CLIENT_USER, 0, 0, 0 },
97 { "SQUERY", IRC_SQUERY, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
98 { "SQUIT", IRC_SQUIT, CLIENT_SERVER, 0, 0, 0 },
99 { "STATS", IRC_STATS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
100 { "SUMMON", IRC_SUMMON, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
101 { "TIME", IRC_TIME, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
102 { "TOPIC", IRC_TOPIC, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
103 { "TRACE", IRC_TRACE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
104 { "USER", IRC_USER, 0xFFFF, 0, 0, 0 },
105 { "USERHOST", IRC_USERHOST, CLIENT_USER, 0, 0, 0 },
106 { "USERS", IRC_USERS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
107 { "VERSION", IRC_VERSION, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
108 { "WALLOPS", IRC_WALLOPS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
109 { "WHO", IRC_WHO, CLIENT_USER, 0, 0, 0 },
110 { "WHOIS", IRC_WHOIS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
111 { "WHOWAS", IRC_WHOWAS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
113 { "CHANINFO", IRC_CHANINFO, CLIENT_SERVER, 0, 0, 0 },
115 { NULL, NULL, 0x0, 0, 0, 0 } /* Ende-Marke */
118 static void Init_Request PARAMS(( REQUEST *Req ));
120 static bool Validate_Prefix PARAMS(( CONN_ID Idx, REQUEST *Req, bool *Closed ));
121 static bool Validate_Command PARAMS(( CONN_ID Idx, REQUEST *Req, bool *Closed ));
122 static bool Validate_Args PARAMS(( CONN_ID Idx, REQUEST *Req, bool *Closed ));
124 static bool Handle_Request PARAMS(( CONN_ID Idx, REQUEST *Req ));
126 #define ARRAY_SIZE(x) (sizeof(x)/sizeof((x)[0]))
129 * Return the pointer to the global "IRC command structure".
130 * This structure, an array of type "COMMAND" describes all the IRC commands
131 * implemented by ngIRCd and how to handle them.
132 * @return Pointer to the global command structure.
135 Parse_GetCommandStruct( void )
138 } /* Parse_GetCommandStruct */
142 * Parse a command ("request") received from a client.
144 * This function is called after the connection layer received a valid CR+LF
145 * terminated line of text: we asume that this is a valid IRC command and
146 * try to do something useful with it :-)
148 * All errors are reported to the client from which the command has been
149 * received, and if the error is fatal this connection is closed down.
151 * This function is able to parse the syntax as described in RFC 2812,
154 * @param Idx Index of the connection from which the command has been received.
155 * @param Request NULL terminated line of text (the "command").
156 * @return true on success (valid command or "regular" error), false if a
157 * fatal error occured and the connection has been shut down.
160 Parse_Request( CONN_ID Idx, char *Request )
167 assert( Request != NULL );
170 if( NGIRCd_Sniffer ) Log( LOG_DEBUG, " <- connection %d: '%s'.", Idx, Request );
173 Init_Request( &req );
175 /* Fuehrendes und folgendes "Geraffel" verwerfen */
176 ngt_TrimStr( Request );
178 /* gibt es ein Prefix? */
179 if( Request[0] == ':' )
181 /* Prefix vorhanden */
182 req.prefix = Request + 1;
183 ptr = strchr( Request, ' ' );
186 Log( LOG_DEBUG, "Connection %d: Parse error: prefix without command!?", Idx );
187 return Conn_WriteStr( Idx, "ERROR :Prefix without command!?" );
191 /* multiple Leerzeichen als Trenner zwischen
192 * Prefix und Befehl ignorieren */
193 while( *(ptr + 1) == ' ' ) ptr++;
197 else start = Request;
200 ptr = strchr( start, ' ' );
205 /* multiple Leerzeichen als Trenner vor
206 * Parametern ignorieren */
207 while( *(ptr + 1) == ' ' ) ptr++;
212 /* Argumente, Parameter */
215 /* Prinzipiell gibt es welche :-) */
219 /* Parameter-String "zerlegen" */
220 if( start[0] == ':' )
222 req.argv[req.argc] = start + 1;
227 req.argv[req.argc] = start;
228 ptr = strchr( start, ' ' );
233 /* multiple Leerzeichen als
234 * Parametertrenner ignorieren */
235 while( *(ptr + 1) == ' ' ) ptr++;
242 if( start[0] == ':' ) break;
243 if( req.argc > 14 ) break;
245 if( ptr ) start = ptr + 1;
250 /* Daten validieren */
251 if( ! Validate_Prefix( Idx, &req, &closed )) return ! closed;
252 if( ! Validate_Command( Idx, &req, &closed )) return ! closed;
253 if( ! Validate_Args( Idx, &req, &closed )) return ! closed;
255 return Handle_Request( Idx, &req );
256 } /* Parse_Request */
260 * Initialize request structure.
261 * @param Req Request structure to be initialized.
264 Init_Request( REQUEST *Req )
266 /* Neue Request-Struktur initialisieren */
270 assert( Req != NULL );
274 for( i = 0; i < 15; Req->argv[i++] = NULL );
280 Validate_Prefix( CONN_ID Idx, REQUEST *Req, bool *Closed )
285 assert( Req != NULL );
289 /* ist ueberhaupt ein Prefix vorhanden? */
290 if( ! Req->prefix ) return true;
292 /* Client-Struktur der Connection ermitteln */
293 client = Conn_GetClient( Idx );
294 assert( client != NULL );
296 /* nur validieren, wenn bereits registrierte Verbindung */
297 if(( Client_Type( client ) != CLIENT_USER ) && ( Client_Type( client ) != CLIENT_SERVER ) && ( Client_Type( client ) != CLIENT_SERVICE ))
299 /* noch nicht registrierte Verbindung.
300 * Das Prefix wird ignoriert. */
305 /* pruefen, ob der im Prefix angegebene Client bekannt ist */
306 c = Client_Search( Req->prefix );
309 /* im Prefix angegebener Client ist nicht bekannt */
310 Log( LOG_ERR, "Invalid prefix \"%s\", client not known (connection %d, command %s)!?", Req->prefix, Idx, Req->command );
311 if( ! Conn_WriteStr( Idx, "ERROR :Invalid prefix \"%s\", client not known!?", Req->prefix )) *Closed = true;
315 /* pruefen, ob der Client mit dem angegebenen Prefix in Richtung
316 * des Senders liegt, d.h. sicherstellen, dass das Prefix nicht
318 if( Client_NextHop( c ) != client )
320 /* das angegebene Prefix ist aus dieser Richtung, also
321 * aus der gegebenen Connection, ungueltig! */
322 Log( LOG_ERR, "Spoofed prefix \"%s\" from \"%s\" (connection %d, command %s)!", Req->prefix, Client_Mask( Conn_GetClient( Idx )), Idx, Req->command );
323 Conn_Close( Idx, NULL, "Spoofed prefix", true);
329 } /* Validate_Prefix */
333 Validate_Command( UNUSED CONN_ID Idx, UNUSED REQUEST *Req, bool *Closed )
336 assert( Req != NULL );
340 } /* Validate_Comman */
344 Validate_Args( UNUSED CONN_ID Idx, UNUSED REQUEST *Req, bool *Closed )
347 assert( Req != NULL );
351 } /* Validate_Args */
354 /* Command is a status code ("numeric") from another server */
356 Handle_Numeric(CLIENT *client, REQUEST *Req)
358 static const struct _NUMERIC Numerics[] = {
359 { 005, IRC_Num_ISUPPORT },
360 { 376, IRC_Num_ENDOFMOTD }
364 CLIENT *prefix, *target = NULL;
366 /* Determine target */
368 target = Client_Search(Req->argv[0]);
371 /* Status code without target!? */
374 "Unknown target for status code %s: \"%s\"",
375 Req->command, Req->argv[0]);
378 "Unknown target for status code %s!",
382 if (target == Client_ThisServer()) {
383 /* This server is the target of the numeric */
384 num = atoi(Req->command);
386 for (i = 0; i < (int) ARRAY_SIZE(Numerics); i++) {
387 if (num == Numerics[i].numeric)
388 return Numerics[i].function(client, Req);
391 LogDebug("Ignored status code %s from \"%s\".",
392 Req->command, Client_ID(client));
396 /* Determine source */
397 if (! Req->prefix[0]) {
398 /* Oops, no prefix!? */
399 Log(LOG_WARNING, "Got status code %s from \"%s\" without prefix!?",
400 Req->command, Client_ID(client));
404 prefix = Client_Search(Req->prefix);
405 if (! prefix) { /* Oops, unknown prefix!? */
406 Log(LOG_WARNING, "Got status code %s from unknown source: \"%s\"", Req->command, Req->prefix);
410 /* Forward status code */
411 strlcpy(str, Req->command, sizeof(str));
412 for (i = 0; i < Req->argc; i++) {
413 if (i < Req->argc - 1)
414 strlcat(str, " ", sizeof(str));
416 strlcat(str, " :", sizeof(str));
417 strlcat(str, Req->argv[i], sizeof(str));
419 return IRC_WriteStrClientPrefix(target, prefix, "%s", str);
424 Handle_Request( CONN_ID Idx, REQUEST *Req )
426 /* Client-Request verarbeiten. Bei einem schwerwiegenden Fehler
427 * wird die Verbindung geschlossen und false geliefert. */
434 assert( Req != NULL );
435 assert( Req->command != NULL );
437 client = Conn_GetClient( Idx );
438 assert( client != NULL );
441 client_type = Client_Type(client);
442 if ((client_type == CLIENT_SERVER ||
443 client_type == CLIENT_UNKNOWNSERVER)
444 && strlen(Req->command) == 3 && atoi(Req->command) > 1)
445 return Handle_Numeric(client, Req);
450 if (strcasecmp(Req->command, cmd->name) != 0) {
455 if (!(client_type & cmd->type))
456 return IRC_WriteStrClient(client, ERR_NOTREGISTERED_MSG, Client_ID(client));
458 /* Command is allowed for this client: call it and count produced bytes */
459 Conn_ResetWCounter();
460 result = (cmd->function)(client, Req);
461 cmd->bytes += Conn_WCounter();
463 /* Adjust counters */
464 if (client_type != CLIENT_SERVER)
471 if (client_type != CLIENT_USER &&
472 client_type != CLIENT_SERVER &&
473 client_type != CLIENT_SERVICE )
476 /* Unknown command and registered connection: generate error: */
477 LogDebug("Connection %d: Unknown command \"%s\", %d %s,%s prefix.",
478 Client_Conn( client ), Req->command, Req->argc,
479 Req->argc == 1 ? "parameter" : "parameters",
480 Req->prefix ? "" : " no" );
482 if (Client_Type(client) != CLIENT_SERVER) {
483 result = IRC_WriteStrClient(client, ERR_UNKNOWNCOMMAND_MSG,
484 Client_ID(client), Req->command);
485 Conn_SetPenalty(Idx, 1);
488 } /* Handle_Request */