5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1997 - 2001 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
21 /****h* silccore/SilcCommandAPI
25 * Implementation of the Command Payload. The Command Payload is used to
26 * send commands and also command replies usually between client and
34 /****f* silccore/SilcCommandAPI/SilcCommandCb
38 * typedef void (*SilcCommandCb)(void *context, void *context2);
42 * Command function callback. The actual command function pointer.
43 * This is generic command callback that the application may choose to
44 * use with its command routines. However, none of the generic
45 * routines depend on this callback so application may freely define
46 * their own command callback if desired.
49 typedef void (*SilcCommandCb)(void *context, void *context2);
51 /****s* silccore/SilcCommandAPI/SilcCommandPayload
55 * typedef struct SilcCommandPayloadStruct *SilcCommandPayload;
59 * This context is the actual Command Payload and is allocated
60 * by silc_command_payload_parse and given as argument usually to
61 * all silc_command_payload_* functions. It is freed by the
62 * silc_command_payload_free function.
65 typedef struct SilcCommandPayloadStruct *SilcCommandPayload;
67 /****d* silccore/SilcCommandAPI/SilcCommandFlags
71 * typedef enum { ... } SilcCommandFlags;
75 * Command flags that set how the commands behave on different
76 * situations. These can be OR'es together to set multiple flags.
77 * The application is resoponsible of implementing the behaviour
78 * of these flags. These are here just to define generic flags.
79 * The server usually makes use of these flags.
86 /* Command may only be used once per (about) 2 seconds. Bursts up
87 to 5 commands are allowed though. */
88 SILC_CF_LAG = (1L << 1),
90 /* Command may only be used once per (about) 2 seconds. No bursts
91 are allowed at all. */
92 SILC_CF_LAG_STRICT = (1L << 2),
94 /* Command is available for registered connections (connections
95 whose ID has been created. */
96 SILC_CF_REG = (1L << 3),
98 /* Command is available only for server operators */
99 SILC_CF_OPER = (1L << 4),
101 /* Command is available only for SILC (router) operators. If this
102 is set SILC_CF_OPER is not necessary to be set. */
103 SILC_CF_SILC_OPER = (1L << 5),
108 /****d* silccore/SilcCommandAPI/SilcCommand
112 * typedef unsigned char SilcCommand;
116 * The SilcCommand type definition and the commands. The commands
117 * listed here are the official SILC Commands and they have client
118 * and server counterparts.
122 typedef unsigned char SilcCommand;
124 /* All SILC commands. These are commands that have client and server
126 #define SILC_COMMAND_NONE 0
127 #define SILC_COMMAND_WHOIS 1
128 #define SILC_COMMAND_WHOWAS 2
129 #define SILC_COMMAND_IDENTIFY 3
130 #define SILC_COMMAND_NICK 4
131 #define SILC_COMMAND_LIST 5
132 #define SILC_COMMAND_TOPIC 6
133 #define SILC_COMMAND_INVITE 7
134 #define SILC_COMMAND_QUIT 8
135 #define SILC_COMMAND_KILL 9
136 #define SILC_COMMAND_INFO 10
137 #define SILC_COMMAND_CONNECT 11
138 #define SILC_COMMAND_PING 12
139 #define SILC_COMMAND_OPER 13
140 #define SILC_COMMAND_JOIN 14
141 #define SILC_COMMAND_MOTD 15
142 #define SILC_COMMAND_UMODE 16
143 #define SILC_COMMAND_CMODE 17
144 #define SILC_COMMAND_CUMODE 18
145 #define SILC_COMMAND_KICK 19
146 #define SILC_COMMAND_BAN 20
147 #define SILC_COMMAND_CLOSE 21
148 #define SILC_COMMAND_SHUTDOWN 22
149 #define SILC_COMMAND_SILCOPER 23
150 #define SILC_COMMAND_LEAVE 24
151 #define SILC_COMMAND_USERS 25
152 #define SILC_COMMAND_GETKEY 26
155 #define SILC_COMMAND_RESERVED 255
158 /****d* silccore/SilcCommandAPI/SilcCommandStatus
162 * typedef uint16 SilcCommandStatus;
166 * The SilcCommandStatus type definition and the status defines.
167 * The server returns a status in each Command Payload indicating
168 * the status of the command.
172 typedef uint16 SilcCommandStatus;
174 /* Command Status messages */
175 #define SILC_STATUS_OK 0
176 #define SILC_STATUS_LIST_START 1
177 #define SILC_STATUS_LIST_ITEM 2
178 #define SILC_STATUS_LIST_END 3
179 #define SILC_STATUS_ERR_NO_SUCH_NICK 10
180 #define SILC_STATUS_ERR_NO_SUCH_CHANNEL 11
181 #define SILC_STATUS_ERR_NO_SUCH_SERVER 12
182 #define SILC_STATUS_ERR_TOO_MANY_TARGETS 13
183 #define SILC_STATUS_ERR_NO_RECIPIENT 14
184 #define SILC_STATUS_ERR_UNKNOWN_COMMAND 15
185 #define SILC_STATUS_ERR_WILDCARDS 16
186 #define SILC_STATUS_ERR_NO_CLIENT_ID 17
187 #define SILC_STATUS_ERR_NO_CHANNEL_ID 18
188 #define SILC_STATUS_ERR_NO_SERVER_ID 19
189 #define SILC_STATUS_ERR_BAD_CLIENT_ID 20
190 #define SILC_STATUS_ERR_BAD_CHANNEL_ID 21
191 #define SILC_STATUS_ERR_NO_SUCH_CLIENT_ID 22
192 #define SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID 23
193 #define SILC_STATUS_ERR_NICKNAME_IN_USE 24
194 #define SILC_STATUS_ERR_NOT_ON_CHANNEL 25
195 #define SILC_STATUS_ERR_USER_NOT_ON_CHANNEL 26
196 #define SILC_STATUS_ERR_USER_ON_CHANNEL 27
197 #define SILC_STATUS_ERR_NOT_REGISTERED 28
198 #define SILC_STATUS_ERR_NOT_ENOUGH_PARAMS 29
199 #define SILC_STATUS_ERR_TOO_MANY_PARAMS 30
200 #define SILC_STATUS_ERR_PERM_DENIED 31
201 #define SILC_STATUS_ERR_BANNED_FROM_SERVER 32
202 #define SILC_STATUS_ERR_BAD_PASSWORD 33
203 #define SILC_STATUS_ERR_CHANNEL_IS_FULL 34
204 #define SILC_STATUS_ERR_NOT_INVITED 35
205 #define SILC_STATUS_ERR_BANNED_FROM_CHANNEL 36
206 #define SILC_STATUS_ERR_UNKNOWN_MODE 37
207 #define SILC_STATUS_ERR_NOT_YOU 38
208 #define SILC_STATUS_ERR_NO_CHANNEL_PRIV 39
209 #define SILC_STATUS_ERR_NO_CHANNEL_FOPRIV 40
210 #define SILC_STATUS_ERR_NO_SERVER_PRIV 41
211 #define SILC_STATUS_ERR_NO_ROUTER_PRIV 42
212 #define SILC_STATUS_ERR_BAD_NICKNAME 43
213 #define SILC_STATUS_ERR_BAD_CHANNEL 44
214 #define SILC_STATUS_ERR_AUTH_FAILED 45
215 #define SILC_STATUS_ERR_UNKNOWN_ALGORITHM 46
216 #define SILC_STATUS_ERR_NO_SUCH_SERVER_ID 47
221 /****f* silccore/SilcCommandAPI/silc_command_payload_parse
226 * silc_command_payload_parse(const unsigned char *payload,
227 * uint32 payload_len);
231 * Parses command payload returning new command payload structure. The
232 * `buffer' is the raw payload.
235 SilcCommandPayload silc_command_payload_parse(const unsigned char *payload,
238 /****f* silccore/SilcCommandAPI/silc_command_payload_encode
242 * SilcBuffer silc_command_payload_encode(SilcCommand cmd,
244 * unsigned char **argv,
246 * uint32 *argv_types,
251 * Encodes Command Payload returning it to SilcBuffer.
254 SilcBuffer silc_command_payload_encode(SilcCommand cmd,
256 unsigned char **argv,
261 /****f* silccore/SilcCommandAPI/silc_command_payload_encode_payload
266 * silc_command_payload_encode_payload(SilcCommandPayload payload);
270 * Same as silc_command_payload_encode but encodes the buffer from
271 * SilcCommandPayload structure instead of raw data.
274 SilcBuffer silc_command_payload_encode_payload(SilcCommandPayload payload);
276 /****f* silccore/SilcCommandAPI/silc_command_payload_encode_va
280 * SilcBuffer silc_command_payload_encode_va(SilcCommand cmd,
286 * Encodes Command payload with variable argument list. The arguments
287 * must be: uint32, unsigned char *, unsigned int, ... One
288 * {uint32, unsigned char * and unsigned int} forms one argument,
289 * thus `argc' in case when sending one {uint32, unsigned char *
290 * and uint32} equals one (1) and when sending two of those it
291 * equals two (2), and so on. This has to be preserved or bad things
292 * will happen. The variable arguments is: {type, data, data_len}.
295 SilcBuffer silc_command_payload_encode_va(SilcCommand cmd,
299 /****f* silccore/SilcCommandAPI/silc_command_payload_encode_vap
303 * SilcBuffer silc_command_payload_encode_vap(SilcCommand cmd,
305 * uint32 argc, va_list ap);
309 * This is equivalent to the silc_command_payload_encode_va except
310 * takes the va_list as argument.
313 SilcBuffer silc_command_payload_encode_vap(SilcCommand cmd,
315 uint32 argc, va_list ap);
317 /****f* silccore/SilcCommandAPI/silc_command_reply_payload_encode_va
322 * silc_command_reply_payload_encode_va(SilcCommand cmd,
323 * SilcCommandStatus status,
329 * Same as silc_command_payload_encode_va except that this is used to
330 * encode strictly command reply packets. The command status message
331 * to be returned is sent as extra argument to this function. The `argc'
332 * must not count `status' as on argument.
336 silc_command_reply_payload_encode_va(SilcCommand cmd,
337 SilcCommandStatus status,
341 /****f* silccore/SilcCommandAPI/silc_command_reply_payload_encode_vap
346 * silc_command_reply_payload_encode_vap(SilcCommand cmd,
347 * SilcCommandStatus status,
348 * uint16 ident, uint32 argc,
353 * This is equivalent to the silc_command_reply_payload_encode_va except
354 * takes the va_list as argument.
358 silc_command_reply_payload_encode_vap(SilcCommand cmd,
359 SilcCommandStatus status,
360 uint16 ident, uint32 argc,
363 /****f* silccore/SilcCommandAPI/silc_command_free
367 * void silc_command_payload_free(SilcCommandPayload payload);
371 * Frees the Command Payload and all data in it.
374 void silc_command_payload_free(SilcCommandPayload payload);
376 /****f* silccore/SilcCommandAPI/silc_command_get
380 * SilcCommand silc_command_get(SilcCommandPayload payload);
384 * Return the command from the payload.
387 SilcCommand silc_command_get(SilcCommandPayload payload);
389 /****f* silccore/SilcCommandAPI/silc_command_get_args
393 * SilcArgumentPayload silc_command_get_args(SilcCommandPayload payload);
397 * Return the Arguments Payload containing the arguments from the
398 * Command Payload. The caller must not free it.
401 SilcArgumentPayload silc_command_get_args(SilcCommandPayload payload);
403 /****f* silccore/SilcCommandAPI/silc_command_get_ident
407 * uint16 silc_command_get_ident(SilcCommandPayload payload);
411 * Return the command identifier from the payload. The identifier can
412 * be used to identify which command reply belongs to which command.
413 * The client sets the identifier to the payload and server must return
414 * the same identifier in the command reply.
417 uint16 silc_command_get_ident(SilcCommandPayload payload);
419 /****f* silccore/SilcCommandAPI/silc_command_set_ident
423 * void silc_command_set_ident(SilcCommandPayload payload, uint16 ident);
427 * Function to set identifier to already allocated Command Payload. Command
428 * payloads are frequentlly resent in SILC and thusly this makes it easy
429 * to set the identifier without encoding new Command Payload.
432 void silc_command_set_ident(SilcCommandPayload payload, uint16 ident);
434 /****f* silccore/SilcCommandAPI/silc_command_set_command
438 * void silc_command_set_command(SilcCommandPayload payload,
439 * SilcCommand command);
443 * Function to set the command to already allocated Command Payload. This
444 * makes it easy to change the command in the payload without encoding new
448 void silc_command_set_command(SilcCommandPayload payload, SilcCommand command);