check_rosenberg.c

   1 /*
   2  * Copyright (C) 2011 Dan Carpenter.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
  16  */
  17
  18 /* Does a search for Dan Rosenberg style info leaks */
  19
  20 /* fixme: struct includes a struct with a hole in it */
  21 /* function is called that clears the struct */
  22
  23 #include "scope.h"
  24 #include "smatch.h"
  25 #include "smatch_function_hashtable.h"
  26 #include "smatch_slist.h"
  27 #include "smatch_extra.h"
  28
  29 static int my_whole_id;
  30 static int my_member_id;
  31
  32 STATE(cleared);
  33
  34 static void extra_mod_hook(const char *name, struct symbol *sym, struct smatch_state *state)
  35 {
  36         set_state(my_member_id, name, sym, state);
  37 }
  38
  39 static void print_holey_warning(struct expression *data, const char *member)
  40 {
  41         char *name;
  42
  43         name = expr_to_str(data);
  44         if (member) {
  45                 sm_msg("warn: check that '%s' doesn't leak information (struct has a hole after '%s')",
  46                        name, member);
  47         } else {
  48                 sm_msg("warn: check that '%s' doesn't leak information (struct has holes)",
  49                        name);
  50         }
  51         free_string(name);
  52 }
  53
  54 static int check_struct(struct expression *expr, struct symbol *type)
  55 {
  56         struct symbol *tmp, *base_type;
  57         const char *prev = NULL;
  58         int align;
  59
  60         align = 0;
  61         FOR_EACH_PTR(type->symbol_list, tmp) {
  62                 base_type = get_real_base_type(tmp);
  63                 if (base_type && base_type->type == SYM_STRUCT) {
  64                         if (check_struct(expr, base_type))
  65                                 return 1;
  66                 }
  67                 if (type->ctype.attribute->is_packed)
  68                         continue;
  69
  70                 if (!tmp->ctype.alignment) {
  71                         sm_msg("warn: cannot determine the alignment here\n");
  72                 } else if (align % tmp->ctype.alignment) {
  73                         print_holey_warning(expr, prev);
  74                         return 1;
  75                 }
  76
  77                 if (base_type == &bool_ctype)
  78                         align += 1;
  79                 else if (type_bits(tmp) <= 0)
  80                         align = 0;
  81                 else
  82                         align += type_bytes(tmp);
  83
  84                 if (tmp->ident)
  85                         prev = tmp->ident->name;
  86                 else
  87                         prev = NULL;
  88         } END_FOR_EACH_PTR(tmp);
  89
  90         if (align % type->ctype.alignment) {
  91                 print_holey_warning(expr, prev);
  92                 return 1;
  93         }
  94
  95         return 0;
  96 }
  97
  98 static int warn_on_holey_struct(struct expression *expr)
  99 {
 100         struct symbol *type;
 101         type = get_type(expr);
 102         if (!type || type->type != SYM_STRUCT)
 103                 return 0;
 104
 105         return check_struct(expr, type);
 106 }
 107
 108 static int has_global_scope(struct expression *expr)
 109 {
 110         struct symbol *sym;
 111
 112         if (expr->type != EXPR_SYMBOL)
 113                 return FALSE;
 114         sym = expr->symbol;
 115         return toplevel(sym->scope);
 116 }
 117
 118 static int was_initialized(struct expression *expr)
 119 {
 120         struct symbol *sym;
 121         char *name;
 122
 123         name = expr_to_var_sym(expr, &sym);
 124         if (!name)
 125                 return 0;
 126         if (sym->initializer)
 127                 return 1;
 128         return 0;
 129 }
 130
 131 static void match_clear(const char *fn, struct expression *expr, void *_arg_no)
 132 {
 133         struct expression *ptr;
 134         int arg_no = PTR_INT(_arg_no);
 135
 136         ptr = get_argument_from_call_expr(expr->args, arg_no);
 137         if (!ptr)
 138                 return;
 139         if (ptr->type != EXPR_PREOP || ptr->op != '&')
 140                 return;
 141         ptr = strip_expr(ptr->unop);
 142         set_state_expr(my_whole_id, ptr, &cleared);
 143 }
 144
 145 static int was_memset(struct expression *expr)
 146 {
 147         if (get_state_expr(my_whole_id, expr) == &cleared)
 148                 return 1;
 149         return 0;
 150 }
 151
 152 static int member_initialized(char *name, struct symbol *outer, struct symbol *member, int pointer)
 153 {
 154         char buf[256];
 155         struct symbol *base;
 156
 157         base = get_base_type(member);
 158         if (!base || base->type != SYM_BASETYPE || !member->ident)
 159                 return FALSE;
 160
 161         if (pointer)
 162                 snprintf(buf, 256, "%s->%s", name, member->ident->name);
 163         else
 164                 snprintf(buf, 256, "%s.%s", name, member->ident->name);
 165
 166         if (get_state(my_member_id, buf, outer))
 167                 return TRUE;
 168
 169         return FALSE;
 170 }
 171
 172 static int member_uninitialized(char *name, struct symbol *outer, struct symbol *member, int pointer)
 173 {
 174         char buf[256];
 175         struct symbol *base;
 176         struct sm_state *sm;
 177
 178         base = get_base_type(member);
 179         if (!base || base->type != SYM_BASETYPE || !member->ident)
 180                 return FALSE;
 181
 182         if (pointer)
 183                 snprintf(buf, 256, "%s->%s", name, member->ident->name);
 184         else
 185                 snprintf(buf, 256, "%s.%s", name, member->ident->name);
 186
 187         sm = get_sm_state(my_member_id, buf, outer);
 188         if (sm && !slist_has_state(sm->possible, &undefined))
 189                 return FALSE;
 190
 191         sm_msg("warn: check that '%s' doesn't leak information", buf);
 192         return TRUE;
 193 }
 194
 195 static int check_members_initialized(struct expression *expr)
 196 {
 197         char *name;
 198         struct symbol *outer;
 199         struct symbol *sym;
 200         struct symbol *tmp;
 201         int pointer = 0;
 202         int printed = 0;
 203
 204         sym = get_type(expr);
 205         if (sym && sym->type == SYM_PTR) {
 206                 pointer = 1;
 207                 sym = get_real_base_type(sym);
 208         }
 209         if (!sym)
 210                 return 0;
 211         if (sym->type != SYM_STRUCT)
 212                 return 0;
 213
 214         name = expr_to_var_sym(expr, &outer);
 215
 216         if (get_state(my_member_id, name, outer))
 217                 goto out;
 218
 219         /*
 220          * check that at least one member was set.  If all of them were not set
 221          * it's more likely a problem in the check than a problem in the kernel
 222          * code.
 223          */
 224         FOR_EACH_PTR(sym->symbol_list, tmp) {
 225                 if (member_initialized(name, outer, tmp, pointer))
 226                         goto check;
 227         } END_FOR_EACH_PTR(tmp);
 228         goto out;
 229
 230 check:
 231         FOR_EACH_PTR(sym->symbol_list, tmp) {
 232                 if (member_uninitialized(name, outer, tmp, pointer)) {
 233                         printed = 1;
 234                         goto out;
 235                 }
 236         } END_FOR_EACH_PTR(tmp);
 237 out:
 238         free_string(name);
 239         return printed;
 240 }
 241
 242 static void check_was_initialized(struct expression *data)
 243 {
 244         data = strip_expr(data);
 245         if (!data)
 246                 return;
 247         if (data->type == EXPR_PREOP && data->op == '&')
 248                 data = strip_expr(data->unop);
 249         if (data->type != EXPR_SYMBOL)
 250                 return;
 251
 252         if (has_global_scope(data))
 253                 return;
 254         if (was_initialized(data))
 255                 return;
 256         if (was_memset(data))
 257                 return;
 258         if (warn_on_holey_struct(data))
 259                 return;
 260         check_members_initialized(data);
 261 }
 262
 263 static void match_copy_to_user(const char *fn, struct expression *expr, void *_arg)
 264 {
 265         int arg = PTR_INT(_arg);
 266         struct expression *data;
 267
 268         data = get_argument_from_call_expr(expr->args, arg);
 269         data = strip_expr(data);
 270         if (!data)
 271                 return;
 272         if (data->type != EXPR_PREOP || data->op != '&')
 273                 return;
 274         check_was_initialized(data);
 275 }
 276
 277 static void db_param_cleared(struct expression *expr, int param, char *key, char *value)
 278 {
 279         while (expr->type == EXPR_ASSIGNMENT)
 280                 expr = strip_expr(expr->right);
 281         if (expr->type != EXPR_CALL)
 282                 return;
 283
 284         match_clear(NULL, expr, INT_PTR(param));
 285 }
 286
 287 static void register_clears_argument(void)
 288 {
 289         struct token *token;
 290         const char *func;
 291         int arg;
 292
 293         token = get_tokens_file("kernel.clears_argument");
 294         if (!token)
 295                 return;
 296         if (token_type(token) != TOKEN_STREAMBEGIN)
 297                 return;
 298         token = token->next;
 299         while (token_type(token) != TOKEN_STREAMEND) {
 300                 if (token_type(token) != TOKEN_IDENT)
 301                         return;
 302                 func = show_ident(token->ident);
 303                 token = token->next;
 304                 if (token_type(token) != TOKEN_NUMBER)
 305                         return;
 306                 arg = atoi(token->number);
 307
 308                 add_function_hook(func, &match_clear, INT_PTR(arg));
 309                 token = token->next;
 310         }
 311         clear_token_alloc();
 312 }
 313
 314 static void register_copy_funcs_from_file(void)
 315 {
 316         struct token *token;
 317         const char *func;
 318         int arg;
 319
 320         token = get_tokens_file("kernel.rosenberg_funcs");
 321         if (!token)
 322                 return;
 323         if (token_type(token) != TOKEN_STREAMBEGIN)
 324                 return;
 325         token = token->next;
 326         while (token_type(token) != TOKEN_STREAMEND) {
 327                 if (token_type(token) != TOKEN_IDENT)
 328                         return;
 329                 func = show_ident(token->ident);
 330                 token = token->next;
 331                 if (token_type(token) != TOKEN_NUMBER)
 332                         return;
 333                 arg = atoi(token->number);
 334                 add_function_hook(func, &match_copy_to_user, INT_PTR(arg));
 335                 token = token->next;
 336         }
 337         clear_token_alloc();
 338 }
 339
 340 void check_rosenberg(int id)
 341 {
 342         if (option_project != PROJ_KERNEL)
 343                 return;
 344         my_whole_id = id;
 345
 346         add_function_hook("memset", &match_clear, INT_PTR(0));
 347         add_function_hook("memcpy", &match_clear, INT_PTR(0));
 348         add_function_hook("__memzero", &match_clear, INT_PTR(0));
 349         add_function_hook("memzero", &match_clear, INT_PTR(0));
 350         register_clears_argument();
 351         select_return_states_hook(PARAM_CLEARED, &db_param_cleared);
 352
 353         register_copy_funcs_from_file();
 354 }
 355
 356 void check_rosenberg2(int id)
 357 {
 358         if (option_project != PROJ_KERNEL)
 359                 return;
 360
 361         my_member_id = id;
 362         add_extra_mod_hook(&extra_mod_hook);
 363 }
 364