2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2008 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.
16 * IRC command parser and validator.
28 #include "conn-func.h"
40 #include "irc-channel.h"
42 #include "irc-login.h"
46 #include "irc-server.h"
47 #include "irc-write.h"
54 bool (*function) PARAMS(( CLIENT *Client, REQUEST *Request ));
58 static COMMAND My_Commands[] =
60 { "ADMIN", IRC_ADMIN, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
61 { "AWAY", IRC_AWAY, CLIENT_USER, 0, 0, 0 },
62 { "CONNECT", IRC_CONNECT, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
63 { "DIE", IRC_DIE, CLIENT_USER, 0, 0, 0 },
64 { "DISCONNECT", IRC_DISCONNECT, CLIENT_USER, 0, 0, 0 },
65 { "ERROR", IRC_ERROR, 0xFFFF, 0, 0, 0 },
66 { "HELP", IRC_HELP, CLIENT_USER, 0, 0, 0 },
67 { "INFO", IRC_INFO, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
68 { "INVITE", IRC_INVITE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
69 { "ISON", IRC_ISON, CLIENT_USER, 0, 0, 0 },
70 { "JOIN", IRC_JOIN, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
71 { "KICK", IRC_KICK, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
72 { "KILL", IRC_KILL, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
73 { "LINKS", IRC_LINKS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
74 { "LIST", IRC_LIST, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
75 { "LUSERS", IRC_LUSERS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
76 { "MODE", IRC_MODE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
77 { "MOTD", IRC_MOTD, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
78 { "NAMES", IRC_NAMES, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
79 { "NICK", IRC_NICK, 0xFFFF, 0, 0, 0 },
80 { "NJOIN", IRC_NJOIN, CLIENT_SERVER, 0, 0, 0 },
81 { "NOTICE", IRC_NOTICE, 0xFFFF, 0, 0, 0 },
82 { "OPER", IRC_OPER, CLIENT_USER, 0, 0, 0 },
83 { "PART", IRC_PART, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
84 { "PASS", IRC_PASS, 0xFFFF, 0, 0, 0 },
85 { "PING", IRC_PING, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
86 { "PONG", IRC_PONG, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
87 { "PRIVMSG", IRC_PRIVMSG, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
88 { "QUIT", IRC_QUIT, 0xFFFF, 0, 0, 0 },
89 { "REHASH", IRC_REHASH, CLIENT_USER, 0, 0, 0 },
90 { "RESTART", IRC_RESTART, CLIENT_USER, 0, 0, 0 },
91 { "SERVER", IRC_SERVER, 0xFFFF, 0, 0, 0 },
92 { "SERVICE", IRC_SERVICE, 0xFFFF, 0, 0, 0 },
93 { "SERVLIST", IRC_SERVLIST, CLIENT_USER, 0, 0, 0 },
94 { "SQUERY", IRC_SQUERY, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
95 { "SQUIT", IRC_SQUIT, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
96 { "STATS", IRC_STATS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
97 { "SUMMON", IRC_SUMMON, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
98 { "TIME", IRC_TIME, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
99 { "TOPIC", IRC_TOPIC, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
100 { "TRACE", IRC_TRACE, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
101 { "USER", IRC_USER, 0xFFFF, 0, 0, 0 },
102 { "USERHOST", IRC_USERHOST, CLIENT_USER, 0, 0, 0 },
103 { "USERS", IRC_USERS, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
104 { "VERSION", IRC_VERSION, CLIENT_USER|CLIENT_SERVER, 0, 0, 0 },
105 { "WALLOPS", IRC_WALLOPS, CLIENT_USER|CLIENT_SERVER, 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 },
110 { "CHANINFO", IRC_CHANINFO, CLIENT_SERVER, 0, 0, 0 },
112 { NULL, NULL, 0x0, 0, 0, 0 } /* Ende-Marke */
115 static void Init_Request PARAMS(( REQUEST *Req ));
117 static bool Validate_Prefix PARAMS(( CONN_ID Idx, REQUEST *Req, bool *Closed ));
118 static bool Validate_Command PARAMS(( CONN_ID Idx, REQUEST *Req, bool *Closed ));
119 static bool Validate_Args PARAMS(( CONN_ID Idx, REQUEST *Req, bool *Closed ));
121 static bool Handle_Request PARAMS(( CONN_ID Idx, REQUEST *Req ));
123 #define ARRAY_SIZE(x) (sizeof(x)/sizeof((x)[0]))
126 * Return the pointer to the global "IRC command structure".
127 * This structure, an array of type "COMMAND" describes all the IRC commands
128 * implemented by ngIRCd and how to handle them.
129 * @return Pointer to the global command structure.
132 Parse_GetCommandStruct( void )
135 } /* Parse_GetCommandStruct */
139 * Parse a command ("request") received from a client.
141 * This function is called after the connection layer received a valid CR+LF
142 * terminated line of text: we asume that this is a valid IRC command and
143 * try to do something useful with it :-)
145 * All errors are reported to the client from which the command has been
146 * received, and if the error is fatal this connection is closed down.
148 * This function is able to parse the syntax as described in RFC 2812,
151 * @param Idx Index of the connection from which the command has been received.
152 * @param Request NULL terminated line of text (the "command").
153 * @return true on success (valid command or "regular" error), false if a
154 * fatal error occured and the connection has been shut down.
157 Parse_Request( CONN_ID Idx, char *Request )
164 assert( Request != NULL );
167 if( NGIRCd_Sniffer ) Log( LOG_DEBUG, " <- connection %d: '%s'.", Idx, Request );
170 Init_Request( &req );
172 /* remove leading & trailing whitespace */
173 ngt_TrimStr( Request );
175 if( Request[0] == ':' )
178 req.prefix = Request + 1;
179 ptr = strchr( Request, ' ' );
182 LogDebug("Connection %d: Parse error: prefix without command!?", Idx);
183 return Conn_WriteStr( Idx, "ERROR :Prefix without command!?" );
187 /* ignore multiple spaces between prefix and command */
188 while( *(ptr + 1) == ' ' ) ptr++;
192 else start = Request;
194 ptr = strchr( start, ' ' );
199 /* ignore multiple spaces between parameters */
200 while( *(ptr + 1) == ' ' ) ptr++;
205 /* Arguments, Parameters */
211 if( start[0] == ':' )
213 req.argv[req.argc] = start + 1;
218 req.argv[req.argc] = start;
219 ptr = strchr( start, ' ' );
224 while( *(ptr + 1) == ' ' ) ptr++;
231 if( start[0] == ':' ) break;
232 if( req.argc > 14 ) break;
234 if( ptr ) start = ptr + 1;
239 if( ! Validate_Prefix( Idx, &req, &closed )) return ! closed;
240 if( ! Validate_Command( Idx, &req, &closed )) return ! closed;
241 if( ! Validate_Args( Idx, &req, &closed )) return ! closed;
243 return Handle_Request( Idx, &req );
244 } /* Parse_Request */
248 * Initialize request structure.
249 * @param Req Request structure to be initialized.
252 Init_Request( REQUEST *Req )
254 /* Neue Request-Struktur initialisieren */
258 assert( Req != NULL );
262 for( i = 0; i < 15; Req->argv[i++] = NULL );
268 Validate_Prefix( CONN_ID Idx, REQUEST *Req, bool *Closed )
273 assert( Req != NULL );
277 if( ! Req->prefix ) return true;
279 client = Conn_GetClient( Idx );
280 assert( client != NULL );
282 /* only validate if this connection is already registered */
283 if(( Client_Type( client ) != CLIENT_USER ) && ( Client_Type( client ) != CLIENT_SERVER ) && ( Client_Type( client ) != CLIENT_SERVICE ))
285 /* not registered, ignore prefix */
290 /* check if client in prefix is known */
291 c = Client_Search( Req->prefix );
294 Log( LOG_ERR, "Invalid prefix \"%s\", client not known (connection %d, command %s)!?", Req->prefix, Idx, Req->command );
295 if( ! Conn_WriteStr( Idx, "ERROR :Invalid prefix \"%s\", client not known!?", Req->prefix )) *Closed = true;
299 /* check if the client named in the prefix is expected
300 * to come from that direction */
301 if( Client_NextHop( c ) != client )
303 Log( LOG_ERR, "Spoofed prefix \"%s\" from \"%s\" (connection %d, command %s)!", Req->prefix, Client_Mask( Conn_GetClient( Idx )), Idx, Req->command );
304 Conn_Close( Idx, NULL, "Spoofed prefix", true);
310 } /* Validate_Prefix */
314 Validate_Command( UNUSED CONN_ID Idx, UNUSED REQUEST *Req, bool *Closed )
317 assert( Req != NULL );
321 } /* Validate_Comman */
326 Validate_Args(CONN_ID Idx, REQUEST *Req, bool *Closed)
328 Validate_Args(UNUSED CONN_ID Idx, UNUSED REQUEST *Req, bool *Closed)
339 assert( Req != NULL );
341 /* CR and LF are never allowed in command parameters.
342 * But since we do accept lines terminated only with CR or LF in
343 * "non-RFC-compliant mode" (besides the correct CR+LF combination),
344 * this check can only trigger in "strict RFC" mode; therefore we
345 * optimize it away otherwise ... */
346 for (i = 0; i < Req->argc; i++) {
347 if (strchr(Req->argv[i], '\r') || strchr(Req->argv[i], '\n')) {
349 "Invalid character(s) in parameter (connection %d, command %s)!?",
351 if (!Conn_WriteStr(Idx,
352 "ERROR :Invalid character(s) in parameter!"))
360 } /* Validate_Args */
363 /* Command is a status code ("numeric") from another server */
365 Handle_Numeric(CLIENT *client, REQUEST *Req)
367 static const struct _NUMERIC Numerics[] = {
368 { 5, IRC_Num_ISUPPORT },
370 { 376, IRC_Num_ENDOFMOTD }
374 CLIENT *prefix, *target = NULL;
376 /* Determine target */
378 if (strcmp(Req->argv[0], "*") != 0)
379 target = Client_Search(Req->argv[0]);
381 target = Client_ThisServer();
385 /* Status code without target!? */
388 "Unknown target for status code %s: \"%s\"",
389 Req->command, Req->argv[0]);
392 "Unknown target for status code %s!",
396 if (target == Client_ThisServer()) {
397 /* This server is the target of the numeric */
398 num = atoi(Req->command);
400 for (i = 0; i < (int) ARRAY_SIZE(Numerics); i++) {
401 if (num == Numerics[i].numeric) {
402 if (!Numerics[i].function)
404 return Numerics[i].function(client, Req);
408 LogDebug("Ignored status code %s from \"%s\".",
409 Req->command, Client_ID(client));
413 /* Determine source */
414 if (! Req->prefix[0]) {
415 /* Oops, no prefix!? */
416 Log(LOG_WARNING, "Got status code %s from \"%s\" without prefix!?",
417 Req->command, Client_ID(client));
421 prefix = Client_Search(Req->prefix);
422 if (! prefix) { /* Oops, unknown prefix!? */
423 Log(LOG_WARNING, "Got status code %s from unknown source: \"%s\"", Req->command, Req->prefix);
427 /* Forward status code */
428 strlcpy(str, Req->command, sizeof(str));
429 for (i = 0; i < Req->argc; i++) {
430 if (i < Req->argc - 1)
431 strlcat(str, " ", sizeof(str));
433 strlcat(str, " :", sizeof(str));
434 strlcat(str, Req->argv[i], sizeof(str));
436 return IRC_WriteStrClientPrefix(target, prefix, "%s", str);
441 Handle_Request( CONN_ID Idx, REQUEST *Req )
449 assert( Req != NULL );
450 assert( Req->command != NULL );
452 client = Conn_GetClient( Idx );
453 assert( client != NULL );
456 client_type = Client_Type(client);
457 if ((client_type == CLIENT_SERVER ||
458 client_type == CLIENT_UNKNOWNSERVER)
459 && strlen(Req->command) == 3 && atoi(Req->command) > 1)
460 return Handle_Numeric(client, Req);
464 if (strcasecmp(Req->command, cmd->name) != 0) {
469 if (!(client_type & cmd->type))
470 return IRC_WriteStrClient(client, ERR_NOTREGISTERED_MSG, Client_ID(client));
472 /* Command is allowed for this client: call it and count produced bytes */
473 Conn_ResetWCounter();
474 result = (cmd->function)(client, Req);
475 cmd->bytes += Conn_WCounter();
477 /* Adjust counters */
478 if (client_type != CLIENT_SERVER)
485 if (client_type != CLIENT_USER &&
486 client_type != CLIENT_SERVER &&
487 client_type != CLIENT_SERVICE )
490 /* Unknown command and registered connection: generate error: */
491 LogDebug("Connection %d: Unknown command \"%s\", %d %s,%s prefix.",
492 Client_Conn( client ), Req->command, Req->argc,
493 Req->argc == 1 ? "parameter" : "parameters",
494 Req->prefix ? "" : " no" );
496 if (Client_Type(client) != CLIENT_SERVER) {
497 result = IRC_WriteStrClient(client, ERR_UNKNOWNCOMMAND_MSG,
498 Client_ID(client), Req->command);
499 Conn_SetPenalty(Idx, 1);
502 } /* Handle_Request */