src/test/test_keygen.sh

   1 #!/bin/sh
   2
   3 # Note: some of this code is lifted from zero_length_keys.sh, and could be
   4 # unified.
   5
   6 umask 077
   7 set -e
   8
   9 if [ $# -eq 0 ] || [ ! -f ${1} ] || [ ! -x ${1} ]; then
  10   if [ "$TESTING_TOR_BINARY" = "" ] ; then
  11     echo "Usage: ${0} PATH_TO_TOR [case-number]"
  12     exit 1
  13   fi
  14 fi
  15
  16 if [ $# -ge 1 ]; then
  17   TOR_BINARY="${1}"
  18   shift
  19 else
  20   TOR_BINARY="${TESTING_TOR_BINARY}"
  21 fi
  22
  23
  24
  25   if [ $# -ge 1 ]; then
  26       dflt=0
  27   else
  28       dflt=1
  29   fi
  30
  31   CASE2A=$dflt
  32   CASE2B=$dflt
  33   CASE3A=$dflt
  34   CASE3B=$dflt
  35   CASE3C=$dflt
  36   CASE4=$dflt
  37   CASE5=$dflt
  38   CASE6=$dflt
  39   CASE7=$dflt
  40   CASE8=$dflt
  41   CASE9=$dflt
  42   CASE10=$dflt
  43
  44   if [ $# -ge 1 ]; then
  45      eval "CASE${1}"=1
  46   fi
  47
  48
  49 dump() { xxd -p "$1" | tr -d '\n '; }
  50 die() { echo "$1" >&2 ; exit 5; }
  51 check_dir() { [ -d "$1" ] || die "$1 did not exist"; }
  52 check_file() { [ -e "$1" ] || die "$1 did not exist"; }
  53 check_no_file() { [ -e "$1" ] && die "$1 was not supposed to exist" || true; }
  54 check_files_eq() { cmp "$1" "$2" || die "$1 and $2 did not match: `dump $1` vs `dump $2`"; }
  55 check_keys_eq() { check_files_eq "${SRC}/keys/${1}" "${ME}/keys/${1}"; }
  56
  57 DATA_DIR=`mktemp -d -t tor_keygen_tests.XXXXXX`
  58 if [ -z "$DATA_DIR" ]; then
  59   echo "Failure: mktemp invocation returned empty string" >&2
  60   exit 3
  61 fi
  62 if [ ! -d "$DATA_DIR" ]; then
  63   echo "Failure: mktemp invocation result doesn't point to directory" >&2
  64   exit 3
  65 fi
  66 trap "rm -rf '$DATA_DIR'" 0
  67
  68 # Use an absolute path for this or Tor will complain
  69 DATA_DIR=`cd "${DATA_DIR}" && pwd`
  70
  71 touch "${DATA_DIR}/empty_torrc"
  72
  73 QUIETLY="--hush"
  74 SILENTLY="--quiet"
  75 TOR="${TOR_BINARY} ${QUIETLY} --DisableNetwork 1 --ShutdownWaitLength 0 --ORPort 12345 --ExitRelay 0 -f ${DATA_DIR}/empty_torrc"
  76
  77 ##### SETUP
  78 #
  79 # Here we create three sets of keys: one using "tor", one using "tor
  80 # --keygen", and one using "tor --keygen" and encryption.  We'll be
  81 # copying them into different keys directories in order to simulate
  82 # different kinds of configuration problems/issues.
  83
  84 # Step 1: Start Tor with --list-fingerprint --quiet.  Make sure everything is there.
  85 mkdir "${DATA_DIR}/orig"
  86 ${TOR} --DataDirectory "${DATA_DIR}/orig" --list-fingerprint ${SILENTLY} > /dev/null
  87
  88 check_dir "${DATA_DIR}/orig/keys"
  89 check_file "${DATA_DIR}/orig/keys/ed25519_master_id_public_key"
  90 check_file "${DATA_DIR}/orig/keys/ed25519_master_id_secret_key"
  91 check_file "${DATA_DIR}/orig/keys/ed25519_signing_cert"
  92 check_file "${DATA_DIR}/orig/keys/ed25519_signing_secret_key"
  93
  94 # Step 2: Start Tor with --keygen.  Make sure everything is there.
  95 mkdir "${DATA_DIR}/keygen"
  96 ${TOR} --DataDirectory "${DATA_DIR}/keygen" --keygen --no-passphrase 2>"${DATA_DIR}/keygen/stderr"
  97 grep "Not encrypting the secret key" "${DATA_DIR}/keygen/stderr" >/dev/null || die "Tor didn't declare that there would be no encryption"
  98
  99 check_dir "${DATA_DIR}/keygen/keys"
 100 check_file "${DATA_DIR}/keygen/keys/ed25519_master_id_public_key"
 101 check_file "${DATA_DIR}/keygen/keys/ed25519_master_id_secret_key"
 102 check_file "${DATA_DIR}/keygen/keys/ed25519_signing_cert"
 103 check_file "${DATA_DIR}/keygen/keys/ed25519_signing_secret_key"
 104
 105 # Step 3: Start Tor with --keygen and a passphrase.
 106 #         Make sure everything is there.
 107 mkdir "${DATA_DIR}/encrypted"
 108 echo "passphrase" | ${TOR} --DataDirectory "${DATA_DIR}/encrypted" --keygen --passphrase-fd 0
 109
 110 check_dir "${DATA_DIR}/encrypted/keys"
 111 check_file "${DATA_DIR}/encrypted/keys/ed25519_master_id_public_key"
 112 check_file "${DATA_DIR}/encrypted/keys/ed25519_master_id_secret_key_encrypted"
 113 check_file "${DATA_DIR}/encrypted/keys/ed25519_signing_cert"
 114 check_file "${DATA_DIR}/encrypted/keys/ed25519_signing_secret_key"
 115
 116
 117 echo "=== Starting keygen tests."
 118
 119 #
 120 # The "case X" numbers below come from s7r's email on
 121 #   https://lists.torproject.org/pipermail/tor-dev/2015-August/009204.html
 122
 123
 124 # Case 2a: Missing secret key, public key exists, start tor.
 125
 126 if [ "$CASE2A" = 1 ]; then
 127
 128 ME="${DATA_DIR}/case2a"
 129 SRC="${DATA_DIR}/orig"
 130 mkdir -p "${ME}/keys"
 131 cp "${SRC}/keys/ed25519_master_id_public_key" "${ME}/keys/"
 132 ${TOR} --DataDirectory "${ME}" --list-fingerprint > "${ME}/stdout" && die "Somehow succeeded when missing secret key, certs: `cat ${ME}/stdout`" || true
 133 check_files_eq "${SRC}/keys/ed25519_master_id_public_key" "${ME}/keys/ed25519_master_id_public_key"
 134
 135 grep "We needed to load a secret key.*but couldn't find it" "${ME}/stdout" >/dev/null || die "Tor didn't declare that it was missing a secret key"
 136
 137 echo "==== Case 2A ok"
 138 fi
 139
 140 # Case 2b: Encrypted secret key, public key exists, start tor.
 141
 142 if [ "$CASE2B" = 1 ]; then
 143
 144 ME="${DATA_DIR}/case2b"
 145 SRC="${DATA_DIR}/encrypted"
 146
 147 mkdir -p "${ME}/keys"
 148 cp "${SRC}/keys/ed25519_master_id_public_key" "${ME}/keys/"
 149 cp "${SRC}/keys/ed25519_master_id_secret_key_encrypted" "${ME}/keys/"
 150 ${TOR} --DataDirectory "${ME}" --list-fingerprint > "${ME}/stdout" && dir "Somehow succeeded with encrypted secret key, missing certs"
 151
 152 check_files_eq "${SRC}/keys/ed25519_master_id_public_key" "${ME}/keys/ed25519_master_id_public_key"
 153 check_files_eq "${SRC}/keys/ed25519_master_id_secret_key_encrypted" "${ME}/keys/ed25519_master_id_secret_key_encrypted"
 154
 155 grep "We needed to load a secret key.*but it was encrypted.*--keygen" "${ME}/stdout" >/dev/null || die "Tor didn't declare that it was missing a secret key and suggest --keygen."
 156
 157 echo "==== Case 2B ok"
 158
 159 fi
 160
 161 # Case 3a: Start Tor with only master key.
 162
 163 if [ "$CASE3A" = 1 ]; then
 164
 165 ME="${DATA_DIR}/case3a"
 166 SRC="${DATA_DIR}/orig"
 167
 168 mkdir -p "${ME}/keys"
 169 cp "${SRC}/keys/ed25519_master_id_"* "${ME}/keys/"
 170 ${TOR} --DataDirectory "${ME}" --list-fingerprint ${SILENTLY} >/dev/null || die "Tor failed when starting with only master key"
 171 check_files_eq "${SRC}/keys/ed25519_master_id_public_key" "${ME}/keys/ed25519_master_id_public_key"
 172 check_files_eq "${SRC}/keys/ed25519_master_id_secret_key" "${ME}/keys/ed25519_master_id_secret_key"
 173 check_file "${ME}/keys/ed25519_signing_cert"
 174 check_file "${ME}/keys/ed25519_signing_secret_key"
 175
 176 echo "==== Case 3A ok"
 177
 178 fi
 179
 180 # Case 3b: Call keygen with only unencrypted master key.
 181
 182 if [ "$CASE3B" = 1 ]; then
 183
 184 ME="${DATA_DIR}/case3b"
 185 SRC="${DATA_DIR}/orig"
 186
 187 mkdir -p "${ME}/keys"
 188 cp "${SRC}/keys/ed25519_master_id_"* "${ME}/keys/"
 189 ${TOR} --DataDirectory "${ME}" --keygen || die "Keygen failed with only master key"
 190 check_files_eq "${SRC}/keys/ed25519_master_id_public_key" "${ME}/keys/ed25519_master_id_public_key"
 191 check_files_eq "${SRC}/keys/ed25519_master_id_secret_key" "${ME}/keys/ed25519_master_id_secret_key"
 192 check_file "${ME}/keys/ed25519_signing_cert"
 193 check_file "${ME}/keys/ed25519_signing_secret_key"
 194
 195 echo "==== Case 3B ok"
 196
 197 fi
 198
 199 # Case 3c: Call keygen with only encrypted master key.
 200
 201 if [ "$CASE3C" = 1 ]; then
 202
 203 ME="${DATA_DIR}/case3c"
 204 SRC="${DATA_DIR}/encrypted"
 205
 206 mkdir -p "${ME}/keys"
 207 cp "${SRC}/keys/ed25519_master_id_"* "${ME}/keys/"
 208 echo "passphrase" | ${TOR} --DataDirectory "${ME}" --keygen --passphrase-fd 0 || die "Keygen failed with only encrypted master key"
 209 check_files_eq "${SRC}/keys/ed25519_master_id_public_key" "${ME}/keys/ed25519_master_id_public_key"
 210 check_files_eq "${SRC}/keys/ed25519_master_id_secret_key_encrypted" "${ME}/keys/ed25519_master_id_secret_key_encrypted"
 211 check_file "${ME}/keys/ed25519_signing_cert"
 212 check_file "${ME}/keys/ed25519_signing_secret_key"
 213
 214 echo "==== Case 3C ok"
 215
 216 fi
 217
 218 # Case 4: Make a new data directory with only an unencrypted secret key.
 219 #         Then start tor.  The rest should become correct.
 220
 221 if [ "$CASE4" = 1 ]; then
 222
 223 ME="${DATA_DIR}/case4"
 224 SRC="${DATA_DIR}/orig"
 225
 226 mkdir -p "${ME}/keys"
 227 cp "${SRC}/keys/ed25519_master_id_secret_key" "${ME}/keys/"
 228 ${TOR} --DataDirectory "${ME}" --list-fingerprint ${SILENTLY} > "${ME}/fp1" || die "Tor wouldn't start with only unencrypted secret key"
 229 check_file "${ME}/keys/ed25519_master_id_public_key"
 230 check_file "${ME}/keys/ed25519_signing_cert"
 231 check_file "${ME}/keys/ed25519_signing_secret_key"
 232 ${TOR} --DataDirectory "${ME}" --list-fingerprint ${SILENTLY} > "${ME}/fp2" || die "Tor wouldn't start again after starting once with only unencrypted secret key."
 233
 234 check_files_eq "${ME}/fp1" "${ME}/fp2"
 235
 236 echo "==== Case 4 ok"
 237
 238 fi
 239
 240 # Case 5: Make a new data directory with only an encrypted secret key.
 241
 242 if [ "$CASE5" = 1 ]; then
 243
 244 ME="${DATA_DIR}/case5"
 245 SRC="${DATA_DIR}/encrypted"
 246
 247 mkdir -p "${ME}/keys"
 248 cp "${SRC}/keys/ed25519_master_id_secret_key_encrypted" "${ME}/keys/"
 249 ${TOR} --DataDirectory "${ME}" --list-fingerprint >"${ME}/stdout" && die "Tor started with only encrypted secret key!"
 250 check_no_file "${ME}/keys/ed25519_master_id_public_key"
 251 check_no_file "${ME}/keys/ed25519_master_id_public_key"
 252
 253 grep "but not public key file" "${ME}/stdout" >/dev/null || die "Tor didn't declare it couldn't find a public key."
 254
 255 echo "==== Case 5 ok"
 256
 257 fi
 258
 259 # Case 6: Make a new data directory with encrypted secret key and public key
 260
 261 if [ "$CASE6" = 1 ]; then
 262
 263 ME="${DATA_DIR}/case6"
 264 SRC="${DATA_DIR}/encrypted"
 265
 266 mkdir -p "${ME}/keys"
 267 cp "${SRC}/keys/ed25519_master_id_secret_key_encrypted" "${ME}/keys/"
 268 cp "${SRC}/keys/ed25519_master_id_public_key" "${ME}/keys/"
 269 ${TOR} --DataDirectory "${ME}" --list-fingerprint > "${ME}/stdout" && die "Tor started with encrypted secret key and no certs" || true
 270 check_no_file "${ME}/keys/ed25519_signing_cert"
 271 check_no_file "${ME}/keys/ed25519_signing_secret_key"
 272
 273 grep "but it was encrypted" "${ME}/stdout" >/dev/null || die "Tor didn't declare that the secret key was encrypted."
 274
 275 echo "==== Case 6 ok"
 276
 277 fi
 278
 279 # Case 7: Make a new data directory with unencrypted secret key and
 280 # certificates; missing master public.
 281
 282 if [ "$CASE7" = 1 ]; then
 283
 284 ME="${DATA_DIR}/case7"
 285 SRC="${DATA_DIR}/keygen"
 286
 287 mkdir -p "${ME}/keys"
 288 cp "${SRC}/keys/ed25519_master_id_secret_key" "${ME}/keys/"
 289 cp "${SRC}/keys/ed25519_signing_cert" "${ME}/keys/"
 290 cp "${SRC}/keys/ed25519_signing_secret_key" "${ME}/keys/"
 291
 292 ${TOR} --DataDirectory "${ME}" --list-fingerprint ${SILENTLY} >/dev/null || die "Failed when starting with missing public key"
 293 check_keys_eq ed25519_master_id_secret_key
 294 check_keys_eq ed25519_master_id_public_key
 295 check_keys_eq ed25519_signing_secret_key
 296 check_keys_eq ed25519_signing_cert
 297
 298 echo "==== Case 7 ok"
 299
 300 fi
 301
 302 # Case 8: offline master secret key.
 303
 304 if [ "$CASE8" = 1 ]; then
 305
 306 ME="${DATA_DIR}/case8"
 307 SRC="${DATA_DIR}/keygen"
 308
 309 mkdir -p "${ME}/keys"
 310 cp "${SRC}/keys/ed25519_master_id_public_key" "${ME}/keys/"
 311 cp "${SRC}/keys/ed25519_signing_cert" "${ME}/keys/"
 312 cp "${SRC}/keys/ed25519_signing_secret_key" "${ME}/keys/"
 313
 314 ${TOR} --DataDirectory "${ME}" --list-fingerprint ${SILENTLY} >/dev/null || die "Failed when starting with offline secret key"
 315 check_no_file "${ME}/keys/ed25519_master_id_secret_key"
 316 check_keys_eq ed25519_master_id_public_key
 317 check_keys_eq ed25519_signing_secret_key
 318 check_keys_eq ed25519_signing_cert
 319
 320 echo "==== Case 8 ok"
 321
 322 fi
 323
 324 # Case 9: signing cert and secret key provided; could infer master key.
 325
 326 if [ "$CASE9" = 1 ]; then
 327
 328 ME="${DATA_DIR}/case9"
 329 SRC="${DATA_DIR}/keygen"
 330
 331 mkdir -p "${ME}/keys"
 332 cp "${SRC}/keys/ed25519_signing_cert" "${ME}/keys/"
 333 cp "${SRC}/keys/ed25519_signing_secret_key" "${ME}/keys/"
 334
 335 ${TOR} --DataDirectory "${ME}" --list-fingerprint ${SILENTLY} >/dev/null || die "Failed when starting with only signing material"
 336 check_no_file "${ME}/keys/ed25519_master_id_secret_key"
 337 check_file "${ME}/keys/ed25519_master_id_public_key"
 338 check_keys_eq ed25519_signing_secret_key
 339 check_keys_eq ed25519_signing_cert
 340
 341 echo "==== Case 9 ok"
 342
 343 fi
 344
 345
 346 # Case 10: master key mismatch.
 347
 348 if [ "$CASE10" = 1 ]; then
 349
 350 ME="${DATA_DIR}/case10"
 351 SRC="${DATA_DIR}/keygen"
 352 OTHER="${DATA_DIR}/orig"
 353
 354 mkdir -p "${ME}/keys"
 355 cp "${SRC}/keys/ed25519_master_id_public_key" "${ME}/keys/"
 356 cp "${OTHER}/keys/ed25519_master_id_secret_key" "${ME}/keys/"
 357
 358 ${TOR} --DataDirectory "${ME}" --list-fingerprint >"${ME}/stdout" && die "Successfully started with mismatched keys!?" || true
 359
 360 grep "public_key does not match.*secret_key" "${ME}/stdout" >/dev/null || die "Tor didn't declare that there was a key mismatch"
 361
 362 echo "==== Case 10 ok"
 363
 364 fi
 365
 366
 367 # Check cert-only.
 368