cmdline: check size of result buffer to avoid overflow
[libcmdline.git] / src / extension_example / parse_obj_list.c
1 /*
2  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of the University of California, Berkeley nor the
13  *       names of its contributors may be used to endorse or promote products
14  *       derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #include <stdio.h>
29 #include <inttypes.h>
30 #include <ctype.h>
31 #include <string.h>
32 #include <netinet/in.h>
33
34 #include <cmdline_parse_ipaddr.h>
35 #include <cmdline_parse.h>
36
37 #include "parse_obj_list.h"
38
39 /* This file is an example of extension of libcmdline. It provides an
40  * example of objects stored in a list. */
41
42 struct cmdline_token_ops token_obj_list_ops = {
43         .parse = parse_obj_list,
44         .complete_get_nb = complete_get_nb_obj_list,
45         .complete_get_elt = complete_get_elt_obj_list,
46         .get_help = get_help_obj_list,
47 };
48
49 int
50 parse_obj_list(cmdline_parse_token_hdr_t *tk, const char *buf, void *res,
51                unsigned ressize)
52 {
53         struct token_obj_list *tk2 = (struct token_obj_list *)tk;
54         struct token_obj_list_data *tkd = &tk2->obj_list_data;
55         struct object *o;
56         unsigned int token_len = 0;
57
58         if (res && ressize < sizeof(struct object *))
59                 return -1;
60
61         token_len = strlen(buf);
62
63         SLIST_FOREACH(o, tkd->list, next) {
64                 if (strcmp(buf, o->name))
65                         continue;
66                 break;
67         }
68         if (!o) /* not found */
69                 return -1;
70
71         /* store the address of object in structure */
72         if (res)
73                 *(struct object **)res = o;
74
75         return token_len;
76 }
77
78 int complete_get_nb_obj_list(cmdline_parse_token_hdr_t *tk)
79 {
80         struct token_obj_list *tk2 = (struct token_obj_list *)tk;
81         struct token_obj_list_data *tkd = &tk2->obj_list_data;
82         struct object *o;
83         int ret = 0;
84
85         SLIST_FOREACH(o, tkd->list, next) {
86                 ret ++;
87         }
88         return ret;
89 }
90
91 int complete_get_elt_obj_list(cmdline_parse_token_hdr_t *tk, int idx,
92                               char *dstbuf, unsigned int size)
93 {
94         struct token_obj_list *tk2 = (struct token_obj_list *)tk;
95         struct token_obj_list_data *tkd = &tk2->obj_list_data;
96         struct object *o;
97         unsigned int i = 0, len;
98
99         SLIST_FOREACH(o, tkd->list, next) {
100                 if (i++ == idx)
101                         break;
102         }
103         if (!o)
104                 return -1;
105
106         len = strlen(o->name) + 1;
107         if (len > size)
108                 return -1;
109
110         strcpy(dstbuf, o->name);
111         return 0;
112 }
113
114
115 int get_help_obj_list(cmdline_parse_token_hdr_t *tk, char *dstbuf, unsigned int size)
116 {
117         snprintf(dstbuf, size, "Obj-List");
118         return 0;
119 }