common/env_common.c

   1 /*
   2  * (C) Copyright 2000-2010
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   6  * Andreas Heppel <aheppel@sysgo.de>
   7  *
   8  * SPDX-License-Identifier:     GPL-2.0+
   9  */
  10
  11 #include <common.h>
  12 #include <command.h>
  13 #include <environment.h>
  14 #include <linux/stddef.h>
  15 #include <search.h>
  16 #include <errno.h>
  17 #include <malloc.h>
  18
  19 DECLARE_GLOBAL_DATA_PTR;
  20
  21 /************************************************************************
  22  * Default settings to be used when no valid environment is found
  23  */
  24 #include <env_default.h>
  25
  26 struct hsearch_data env_htab = {
  27         .change_ok = env_flags_validate,
  28 };
  29
  30 static uchar __env_get_char_spec(int index)
  31 {
  32         return *((uchar *)(gd->env_addr + index));
  33 }
  34 uchar env_get_char_spec(int)
  35         __attribute__((weak, alias("__env_get_char_spec")));
  36
  37 static uchar env_get_char_init(int index)
  38 {
  39         /* if crc was bad, use the default environment */
  40         if (gd->env_valid)
  41                 return env_get_char_spec(index);
  42         else
  43                 return default_environment[index];
  44 }
  45
  46 uchar env_get_char_memory(int index)
  47 {
  48         return *env_get_addr(index);
  49 }
  50
  51 uchar env_get_char(int index)
  52 {
  53         /* if relocated to RAM */
  54         if (gd->flags & GD_FLG_RELOC)
  55                 return env_get_char_memory(index);
  56         else
  57                 return env_get_char_init(index);
  58 }
  59
  60 const uchar *env_get_addr(int index)
  61 {
  62         if (gd->env_valid)
  63                 return (uchar *)(gd->env_addr + index);
  64         else
  65                 return &default_environment[index];
  66 }
  67
  68 /*
  69  * Read an environment variable as a boolean
  70  * Return -1 if variable does not exist (default to true)
  71  */
  72 int getenv_yesno(const char *var)
  73 {
  74         char *s = getenv(var);
  75
  76         if (s == NULL)
  77                 return -1;
  78         return (*s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T') ?
  79                 1 : 0;
  80 }
  81
  82 /*
  83  * Look up the variable from the default environment
  84  */
  85 char *getenv_default(const char *name)
  86 {
  87         char *ret_val;
  88         unsigned long really_valid = gd->env_valid;
  89         unsigned long real_gd_flags = gd->flags;
  90
  91         /* Pretend that the image is bad. */
  92         gd->flags &= ~GD_FLG_ENV_READY;
  93         gd->env_valid = 0;
  94         ret_val = getenv(name);
  95         gd->env_valid = really_valid;
  96         gd->flags = real_gd_flags;
  97         return ret_val;
  98 }
  99
 100 void set_default_env(const char *s)
 101 {
 102         int flags = 0;
 103
 104         if (sizeof(default_environment) > ENV_SIZE) {
 105                 puts("*** Error - default environment is too large\n\n");
 106                 return;
 107         }
 108
 109         if (s) {
 110                 if (*s == '!') {
 111                         printf("*** Warning - %s, "
 112                                 "using default environment\n\n",
 113                                 s + 1);
 114                 } else {
 115                         flags = H_INTERACTIVE;
 116                         puts(s);
 117                 }
 118         } else {
 119                 puts("Using default environment\n\n");
 120         }
 121
 122         if (himport_r(&env_htab, (char *)default_environment,
 123                         sizeof(default_environment), '\0', flags,
 124                         0, NULL) == 0)
 125                 error("Environment import failed: errno = %d\n", errno);
 126
 127         gd->flags |= GD_FLG_ENV_READY;
 128 }
 129
 130
 131 /* [re]set individual variables to their value in the default environment */
 132 int set_default_vars(int nvars, char * const vars[])
 133 {
 134         /*
 135          * Special use-case: import from default environment
 136          * (and use \0 as a separator)
 137          */
 138         return himport_r(&env_htab, (const char *)default_environment,
 139                                 sizeof(default_environment), '\0',
 140                                 H_NOCLEAR | H_INTERACTIVE, nvars, vars);
 141 }
 142
 143 #ifdef CONFIG_ENV_AES
 144 #include <aes.h>
 145 /**
 146  * env_aes_cbc_get_key() - Get AES-128-CBC key for the environment
 147  *
 148  * This function shall return 16-byte array containing AES-128 key used
 149  * to encrypt and decrypt the environment. This function must be overriden
 150  * by the implementer as otherwise the environment encryption will not
 151  * work.
 152  */
 153 __weak uint8_t *env_aes_cbc_get_key(void)
 154 {
 155         return NULL;
 156 }
 157
 158 static int env_aes_cbc_crypt(env_t *env, const int enc)
 159 {
 160         unsigned char *data = env->data;
 161         uint8_t *key;
 162         uint8_t key_exp[AES_EXPAND_KEY_LENGTH];
 163         uint32_t aes_blocks;
 164
 165         key = env_aes_cbc_get_key();
 166         if (!key)
 167                 return -EINVAL;
 168
 169         /* First we expand the key. */
 170         aes_expand_key(key, key_exp);
 171
 172         /* Calculate the number of AES blocks to encrypt. */
 173         aes_blocks = ENV_SIZE / AES_KEY_LENGTH;
 174
 175         if (enc)
 176                 aes_cbc_encrypt_blocks(key_exp, data, data, aes_blocks);
 177         else
 178                 aes_cbc_decrypt_blocks(key_exp, data, data, aes_blocks);
 179
 180         return 0;
 181 }
 182 #else
 183 static inline int env_aes_cbc_crypt(env_t *env, const int enc)
 184 {
 185         return 0;
 186 }
 187 #endif
 188
 189 /*
 190  * Check if CRC is valid and (if yes) import the environment.
 191  * Note that "buf" may or may not be aligned.
 192  */
 193 int env_import(const char *buf, int check)
 194 {
 195         env_t *ep = (env_t *)buf;
 196         int ret;
 197
 198         if (check) {
 199                 uint32_t crc;
 200
 201                 memcpy(&crc, &ep->crc, sizeof(crc));
 202
 203                 if (crc32(0, ep->data, ENV_SIZE) != crc) {
 204                         set_default_env("!bad CRC");
 205                         return 0;
 206                 }
 207         }
 208
 209         /* Decrypt the env if desired. */
 210         ret = env_aes_cbc_crypt(ep, 0);
 211         if (ret) {
 212                 error("Failed to decrypt env!\n");
 213                 set_default_env("!import failed");
 214                 return ret;
 215         }
 216
 217         if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0,
 218                         0, NULL)) {
 219                 gd->flags |= GD_FLG_ENV_READY;
 220                 return 1;
 221         }
 222
 223         error("Cannot import environment: errno = %d\n", errno);
 224
 225         set_default_env("!import failed");
 226
 227         return 0;
 228 }
 229
 230 /* Emport the environment and generate CRC for it. */
 231 int env_export(env_t *env_out)
 232 {
 233         char *res;
 234         ssize_t len;
 235         int ret;
 236
 237         res = (char *)env_out->data;
 238         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
 239         if (len < 0) {
 240                 error("Cannot export environment: errno = %d\n", errno);
 241                 return 1;
 242         }
 243
 244         /* Encrypt the env if desired. */
 245         ret = env_aes_cbc_crypt(env_out, 1);
 246         if (ret)
 247                 return ret;
 248
 249         env_out->crc = crc32(0, env_out->data, ENV_SIZE);
 250
 251         return 0;
 252 }
 253
 254 void env_relocate(void)
 255 {
 256 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 257         env_reloc();
 258         env_htab.change_ok += gd->reloc_off;
 259 #endif
 260         if (gd->env_valid == 0) {
 261 #if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
 262                 /* Environment not changable */
 263                 set_default_env(NULL);
 264 #else
 265                 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
 266                 set_default_env("!bad CRC");
 267 #endif
 268         } else {
 269                 env_relocate_spec();
 270         }
 271 }
 272
 273 #if defined(CONFIG_AUTO_COMPLETE) && !defined(CONFIG_SPL_BUILD)
 274 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
 275 {
 276         ENTRY *match;
 277         int found, idx;
 278
 279         idx = 0;
 280         found = 0;
 281         cmdv[0] = NULL;
 282
 283         while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
 284                 int vallen = strlen(match->key) + 1;
 285
 286                 if (found >= maxv - 2 || bufsz < vallen)
 287                         break;
 288
 289                 cmdv[found++] = buf;
 290                 memcpy(buf, match->key, vallen);
 291                 buf += vallen;
 292                 bufsz -= vallen;
 293         }
 294
 295         qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
 296
 297         if (idx)
 298                 cmdv[found++] = "...";
 299
 300         cmdv[found] = NULL;
 301         return found;
 302 }
 303 #endif