5 Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
7 Copyright (C) 1997 - 2000 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.
22 #include "silcincludes.h"
23 #include "silccommand.h"
25 /******************************************************************************
29 ******************************************************************************/
31 /* Command Payload structure. Contents of this structure is parsed
33 struct SilcCommandPayloadStruct {
36 SilcArgumentPayload args;
39 /* Length of the command payload */
40 #define SILC_COMMAND_PAYLOAD_LEN 6
42 /* Parses command payload returning new command payload structure */
44 SilcCommandPayload silc_command_payload_parse(SilcBuffer buffer)
46 SilcCommandPayload new;
47 unsigned char args_num;
48 unsigned short payload_len;
51 SILC_LOG_DEBUG(("Parsing command payload"));
53 new = silc_calloc(1, sizeof(*new));
55 /* Parse the Command Payload */
56 ret = silc_buffer_unformat(buffer,
57 SILC_STR_UI_SHORT(&payload_len),
58 SILC_STR_UI_CHAR(&new->cmd),
59 SILC_STR_UI_CHAR(&args_num),
60 SILC_STR_UI_SHORT(&new->ident),
67 if (payload_len != buffer->len) {
68 SILC_LOG_ERROR(("Incorrect command payload in packet, packet dropped"));
78 silc_buffer_pull(buffer, SILC_COMMAND_PAYLOAD_LEN);
80 new->args = silc_argument_payload_parse(buffer, args_num);
86 silc_buffer_push(buffer, SILC_COMMAND_PAYLOAD_LEN);
91 /* Encodes Command Payload returning it to SilcBuffer. */
93 SilcBuffer silc_command_payload_encode(SilcCommand cmd,
96 unsigned int *argv_lens,
97 unsigned int *argv_types,
101 SilcBuffer args = NULL;
102 unsigned int len = 0;
104 SILC_LOG_DEBUG(("Encoding command payload"));
107 args = silc_argument_payload_encode(argc, argv, argv_lens, argv_types);
111 len += SILC_COMMAND_PAYLOAD_LEN;
112 buffer = silc_buffer_alloc(len);
113 silc_buffer_pull_tail(buffer, SILC_BUFFER_END(buffer));
115 /* Create Command payload */
116 silc_buffer_format(buffer,
117 SILC_STR_UI_SHORT(len),
118 SILC_STR_UI_CHAR(cmd),
119 SILC_STR_UI_CHAR(argc),
120 SILC_STR_UI_SHORT(ident),
125 silc_buffer_pull(buffer, SILC_COMMAND_PAYLOAD_LEN);
126 silc_buffer_format(buffer,
127 SILC_STR_UI_XNSTRING(args->data, args->len),
129 silc_buffer_push(buffer, SILC_COMMAND_PAYLOAD_LEN);
136 /* Same as above but encode the buffer from SilcCommandPayload structure
137 instead of raw data. */
139 SilcBuffer silc_command_payload_encode_payload(SilcCommandPayload payload)
142 SilcBuffer args = NULL;
143 unsigned int len = 0;
144 unsigned int argc = 0;
146 SILC_LOG_DEBUG(("Encoding command payload"));
149 args = silc_argument_payload_encode_payload(payload->args);
151 argc = silc_argument_get_arg_num(payload->args);
154 len += SILC_COMMAND_PAYLOAD_LEN;
155 buffer = silc_buffer_alloc(len);
156 silc_buffer_pull_tail(buffer, SILC_BUFFER_END(buffer));
158 /* Create Command payload */
159 silc_buffer_format(buffer,
160 SILC_STR_UI_SHORT(len),
161 SILC_STR_UI_CHAR(payload->cmd),
162 SILC_STR_UI_CHAR(argc),
163 SILC_STR_UI_SHORT(payload->ident),
168 silc_buffer_pull(buffer, SILC_COMMAND_PAYLOAD_LEN);
169 silc_buffer_format(buffer,
170 SILC_STR_UI_XNSTRING(args->data, args->len),
172 silc_buffer_push(buffer, SILC_COMMAND_PAYLOAD_LEN);
179 /* Encodes Command payload with variable argument list. The arguments
180 must be: unsigned int, unsigned char *, unsigned int, ... One
181 {unsigned int, unsigned char * and unsigned int} forms one argument,
182 thus `argc' in case when sending one {unsigned int, unsigned char *
183 and unsigned int} equals one (1) and when sending two of those it
184 equals two (2), and so on. This has to be preserved or bad things
185 will happen. The variable arguments is: {type, data, data_len}. */
187 SilcBuffer silc_command_payload_encode_va(SilcCommand cmd,
188 unsigned short ident,
189 unsigned int argc, ...)
192 unsigned char **argv;
193 unsigned int *argv_lens = NULL, *argv_types = NULL;
202 argv = silc_calloc(argc, sizeof(unsigned char *));
203 argv_lens = silc_calloc(argc, sizeof(unsigned int));
204 argv_types = silc_calloc(argc, sizeof(unsigned int));
206 for (i = 0; i < argc; i++) {
207 x_type = va_arg(ap, unsigned int);
208 x = va_arg(ap, unsigned char *);
209 x_len = va_arg(ap, unsigned int);
211 argv[i] = silc_calloc(x_len + 1, sizeof(unsigned char));
212 memcpy(argv[i], x, x_len);
213 argv_lens[i] = x_len;
214 argv_types[i] = x_type;
217 buffer = silc_command_payload_encode(cmd, argc, argv,
218 argv_lens, argv_types, ident);
220 for (i = 0; i < argc; i++)
223 silc_free(argv_lens);
224 silc_free(argv_types);
229 /* Same as above but with va_list. */
231 SilcBuffer silc_command_payload_encode_vap(SilcCommand cmd,
232 unsigned short ident,
233 unsigned int argc, va_list ap)
235 unsigned char **argv;
236 unsigned int *argv_lens = NULL, *argv_types = NULL;
243 argv = silc_calloc(argc, sizeof(unsigned char *));
244 argv_lens = silc_calloc(argc, sizeof(unsigned int));
245 argv_types = silc_calloc(argc, sizeof(unsigned int));
247 for (i = 0; i < argc; i++) {
248 x_type = va_arg(ap, unsigned int);
249 x = va_arg(ap, unsigned char *);
250 x_len = va_arg(ap, unsigned int);
252 argv[i] = silc_calloc(x_len + 1, sizeof(unsigned char));
253 memcpy(argv[i], x, x_len);
254 argv_lens[i] = x_len;
255 argv_types[i] = x_type;
258 buffer = silc_command_payload_encode(cmd, argc, argv,
259 argv_lens, argv_types, ident);
261 for (i = 0; i < argc; i++)
264 silc_free(argv_lens);
265 silc_free(argv_types);
270 /* Same as above except that this is used to encode strictly command
271 reply packets. The command status message to be returned is sent as
272 extra argument to this function. The `argc' must not count `status'
276 silc_command_reply_payload_encode_va(SilcCommand cmd,
277 SilcCommandStatus status,
278 unsigned short ident,
279 unsigned int argc, ...)
282 unsigned char **argv;
283 unsigned int *argv_lens = NULL, *argv_types = NULL;
284 unsigned char status_data[2];
294 argv = silc_calloc(argc, sizeof(unsigned char *));
295 argv_lens = silc_calloc(argc, sizeof(unsigned int));
296 argv_types = silc_calloc(argc, sizeof(unsigned int));
298 SILC_PUT16_MSB(status, status_data);
299 argv[0] = silc_calloc(sizeof(status_data) + 1, sizeof(unsigned char));
300 memcpy(argv[0], status_data, sizeof(status_data));
301 argv_lens[0] = sizeof(status_data);
304 for (i = 1; i < argc; i++) {
305 x_type = va_arg(ap, unsigned int);
306 x = va_arg(ap, unsigned char *);
307 x_len = va_arg(ap, unsigned int);
309 argv[i] = silc_calloc(x_len + 1, sizeof(unsigned char));
310 memcpy(argv[i], x, x_len);
311 argv_lens[i] = x_len;
312 argv_types[i] = x_type;
315 buffer = silc_command_payload_encode(cmd, argc, argv,
316 argv_lens, argv_types, ident);
318 for (i = 0; i < argc; i++)
321 silc_free(argv_lens);
322 silc_free(argv_types);
327 /* Free's Command Payload */
329 void silc_command_free_payload(SilcCommandPayload payload)
332 silc_argument_payload_free(payload->args);
337 /* Returns command */
339 SilcCommand silc_command_get(SilcCommandPayload payload)
344 /* Retuns arguments payload */
346 SilcArgumentPayload silc_command_get_args(SilcCommandPayload payload)
348 return payload->args;
351 /* Returns identifier */
353 unsigned short silc_command_get_ident(SilcCommandPayload payload)
355 return payload->ident;
358 /* Function to set identifier to already allocated Command Payload. Command
359 payloads are frequentlly resent in SILC and thusly this makes it easy
360 to set the identifier. */
362 void silc_command_set_ident(SilcCommandPayload payload, unsigned short ident)
364 payload->ident = ident;
367 /* Function to set the command to already allocated Command Payload. */
369 void silc_command_set_command(SilcCommandPayload payload, SilcCommand command)
371 payload->cmd = command;