cert.sh 13.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
#!/usr/bin/env bash

scriptPath=${0%/*}
. "$scriptPath"/../../libs/bashhelper.sh
. "$scriptPath"/../../libs/shflags

check_tools "cryfs openssl"

usage() {
    echo "
usage:
Janek Bevendorff's avatar
Janek Bevendorff committed
12
    $(basename "$0") issue|revoke [OPTIONS]
13 14

description:
Janek Bevendorff's avatar
Janek Bevendorff committed
15
    Manage VPN client, server, and ICA certificates.
16 17 18 19 20 21 22 23 24 25 26 27 28

"
    exit 1
}

CMD="$1"
shift

# Define command line arguments and parse them.
if [ "$CMD" == "issue" ]; then
    DEFINE_string "cryfs_dir" "" "CryFS base dir containing the encrypted certificates." "d"
    DEFINE_string "root_cn" "" "CN of the root certificate for signing (optional)" "r"
    DEFINE_string "type" "client" "Certificate type (client | server | ca)" "t"
29 30 31
    DEFINE_string "common_name" "" "Common Name (CN) for the certificate (e.g., username)" "c"
    DEFINE_string "full_name" "" "User's full name" "f"
    DEFINE_string "default_subj" "/C=DE/ST=Thuringia/L=Weimar/O=Webis/" "Default Subj fields (optional)" "s"
32
    DEFINE_string "organizational_unit" "" "Organizational Unit (OU) for the certificate (optional)" "u"
33
    DEFINE_string "email" "" "E-Mail address for the certificate" "e"
34
    DEFINE_boolean "no_password" false "Do not encrypt private key" "n"
35
    DEFINE_boolean "overwrite" false "Overwrite existing certificates instead of incrementing filename (use with caution!)" "x"
36 37
    DEFINE_string "csr" "" "CSR file (optional)" "i"
    DEFINE_string "out" "/dev/stdout" "OpenVPN .ovpn config file to generate (optional)" "o"
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
elif [ "$CMD" == "revoke" ]; then
    DEFINE_string "cryfs_dir" "" "CryFS base dir containing the encrypted certificates." "d"
    DEFINE_string "root_cn" "" "CN of the root certificate for signing (optional)" "r"
    DEFINE_string "type" "" "Certificate type (client | server | ca)" "t"
    DEFINE_string "cert_cn" "" "CN of the certificate to revoke" "c"
fi

FLAGS_HELP=$(usage)
export FLAGS_HELP
FLAGS "$@" || exit 1  # Parse command line arguments.
eval set -- "${FLAGS_ARGV}"

export MOUNT_DIR
trap "cleanup ${MOUNT_DIR}; exit $?" INT TERM EXIT


CONF="$(dirname $0)/openssl.conf"


# ===========================================================================
#                              helper commands
# ===========================================================================

# Usage: cleanup MOUNT_DIR
cleanup() {
    if [ ! -d "$1" ]; then
        return
    fi
    logInfo "Unmounting CryFS..."
    fusermount -u "$1" &> /dev/null
    rmdir "$1"
}

71 72 73 74 75 76 77 78
# Usage: update_repository BASE_DIR
pull_repository() {
    if [ ! -d "${1}/.git" ]; then
        logError "CryFS directory is not a Git repository!"
        exit 1
    fi

    logInfo "Updating Git repository..."
79
    if ! (cd "$1" && git pull >&2); then
80 81 82 83 84 85 86 87
        logError "Git update failed!"
        exit 1
    fi
}

# Usage: commit_changes BASE_DIR
commit_changes() {
    logInfo "Committing changes to Git..."
88
    if (cd "$1" && git add -A && git commit -m "-" >&2); then
89 90
        logInfo "Changes committed. Please push the repository now (git push)."
    else
91 92 93 94
        logError "Committing changes failed!"
    fi
}

95 96
# Usage: mount_cryfs BASE_DIR MOUNT_DIR
mount_cryfs() {
97 98 99 100 101
    if [ ! -d "$1" ]; then
        logError "CryFS directory '$1' does not exist!"
        exit 1
    fi

102
    logInfo "Mounting CryFS..."
103
    mkdir -p "$2"
104
    if ! cryfs "$1" "$2" >&2; then
105
        logError "Failed to mount CryFS volume!"
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
        cleanup "$2"
        exit 1
    fi
}

# Usage: choose_root_cert MOUNT_DIR
choose_root_cert() {
    echo -e "\n\nPlease choose a root certificate:" >&2
    root_certs=()
    i=0
    for c in $(find "${1}/ca/" -name "*.pem"); do
        if grep -q "PRIVATE KEY" "$c"; then
            root_certs[$i]="$c"
            printf "  [%2d] $(basename $c | sed 's/\.pem$//')\n" $i >&2
            i=$(($i +1))
        fi
    done

    echo -en "\nYour choice: " >&2
    read root_cert_choice
    while [ "${root_certs[$root_cert_choice]}" == "" ]; do
        logError "Invalid choice, please enter a valid number."
        echo -en "\nYour choice: " >&2
        read root_cert_choice
    done
    echo "${root_certs[$root_cert_choice]}"
}

# Usage: generate_key OUT_FILE BITS
generate_key() {
    logInfo "Generating private key..."
    openssl genrsa -out "$1" "$2"
}

140
# Usage: generate_csr CONF CERT_TYPE KEY_FILE OUT_FILE DEFAULT_SUBJ ORG_UNIT CLIENT_CN CLIENT_FULL_NAME CLIENT_EMAIL
141 142 143
generate_csr() {
    logInfo "Generating CSR..."
    openssl req -config "$1" -new -key "$3" -out "$4" -reqexts "v3_req_${2}" \
144 145
        -subj "${5}OU=${6}/CN=${7}/emailAddress=${9}"
#        -addext "subjectAltName = otherName:${8}"
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
}

# Usage: revoke_cert CONF CERT CA_KEY CA_CERT
revoke_cert() {
    logInfo "Revoking certificate..."
    openssl ca -config "$1" -revoke "$2" -keyfile "$3" -cert "$4"
}

# Usage: generate_crl CONF CRL_OUT CA_KEY CA_CERT
generate_crl() {
    logInfo "Creating / updating CRL..."
    openssl ca -config "$1" -gencrl -out "$2" -keyfile "$3" -cert "$4" -updatedb
    logInfo "CRL '$2' updated."
}

# Usage: sign_csr CONF CSR_IN CERT_OUT CA_KEY CA_CERT CERT_TYPE
sign_csr() {
    local validity=730
    # certificate validity in days
    if [ "$6" == "server" ]; then
        validity=1825
    elif [ "$6" == "ca" ]; then
        validity=3650
    fi

    openssl ca -config "$1" -in "$2" -out "$3" -keyfile "$4" -cert "$5" -create_serial \
        -days "$validity" -extensions "v3_cert_${6}" -notext -batch -updatedb
}

# Usage: ensure_ca_base_dir DATA_DIR
ensure_ca_base_dir() {
    if [ ! -d "$1" ]; then
        logInfo "Creating CA data dir..."
        mkdir -p "${1}/certs"
        touch "${1}/index.txt"
        echo 1000 > "${1}/crlnumber.txt"
    fi
}

# Usage: CA_CERT
resolve_ca_chain() {
    local cert_file="$1"
    local issuer

    while : ; do
        if [ ! -f "$cert_file" ]; then
            logError "Unable to find certificate for '${issuer}', CA chain may be incomplete!"
            break
        fi

        cat "$cert_file"

        issuer="$(openssl x509 -in "${cert_file}" -noout -issuer | grep -Po '(?<=CN = )[^,]+')"
        local issuer_cert_file="$(dirname "$cert_file")/${issuer}.crt"
        if [ "$(realpath $cert_file)" == "$(realpath $issuer_cert_file)" ]; then
            break
        fi
        cert_file="$issuer_cert_file"
    done
}

207
# Usage: OUT_FILE CERT CA_CERT [KEY] [NO_PASSWORD]
208
generate_ovpn_file() {
209 210 211 212 213 214 215 216
    if [ "$4" != "" ] && [ "$5" -eq 0 ]; then
        local pem="$(cat "$4")"
    elif [ "$4" != "" ]; then
        local extra_param=""
        if ! tty -s; then
            # non-interactive shell, get password from env
            extra_param="-passout env:PK_PASS"
        fi
217
        echo "Password to encrypt private key in .ovpn config file: " >&2
218 219
        local pem="$(openssl rsa -aes256 -in $4 $extra_param)"
        local counter=0
220 221
        while [ "$pem" == "" ]; do
            logError "Invalid passphrase, please try again."
222 223 224 225 226 227 228
            local pem="$(openssl rsa -aes256 -in $4 $extra_param)"

            counter=$(($counter + 1))
            if [ $counter -ge 10 ]; then
                logError "Too many input failures."
                return 1
            fi
229
        done
230
    fi
231

232 233
    local out_file="$1"

234 235 236 237 238 239 240 241
    cat <<EOL > "$out_file"
client
remote vpn.webis.de
dev tun
proto udp
port 1194
remote-cert-tls server

242 243 244
# Cipher is set on the server, this is only to avoid warnings
cipher AES-256-GCM

245 246 247 248 249
<key>
$pem
</key>

<cert>
250
$(cat "$2")
251 252 253
</cert>

<ca>
254
$(resolve_ca_chain "$3")
255 256 257 258
</ca>
EOL

    logInfo "OpenVPN config file has been written to '$1'."
259
    return 0
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
}


# ===========================================================================
#                               issue command
# ===========================================================================
issue() {
    if [ "$FLAGS_cryfs_dir" == "" ]; then
        logError "--cryfs_dir is required"
        exit 1;
    fi
    if [ "$FLAGS_type" != "client" ] && [ "$FLAGS_type" != "server" ] && [ "$FLAGS_type" != "ca" ]; then
        logError "Invalid certificate type: ${FLAGS_type}"
        exit 1
    fi
    if [ "$FLAGS_common_name" == "" ]; then
        logError "--common_name is required"
        exit 1;
    fi
279 280
    if [ "$FLAGS_full_name" == "" ]; then
        logError "--full_name is required"
281 282
        exit 1;
    fi
283 284
    if [ "$FLAGS_email" == "" ]; then
        logError "--email is required"
285 286 287
        exit 1;
    fi

288 289
    pull_repository "${FLAGS_cryfs_dir}"

290 291 292
    MOUNT_DIR="${FLAGS_cryfs_dir}_mount.${RANDOM}"
    mount_cryfs "$FLAGS_cryfs_dir" "$MOUNT_DIR"

293 294
    ROOT_KEY="${MOUNT_DIR}/ca/${FLAGS_root_cn}.pem"
    if [ "$FLAGS_root_cn" == "" ] || [ ! -f "$ROOT_KEY" ]; then
295 296 297 298 299 300 301 302 303 304 305 306 307
        ROOT_KEY="$(choose_root_cert "$MOUNT_DIR")"
        logInfo "Using '$(basename "${ROOT_KEY}" | sed 's/\.pem$//')' as the root certificate..."
    fi
    ROOT_CERT="$(echo -n "$ROOT_KEY" | sed 's/\.pem$/.crt/')"
    export CA_BASE_DIR="$(echo "$ROOT_CERT" | sed 's/\.crt$//')_Data"
    ensure_ca_base_dir "$CA_BASE_DIR"

    BITS=2048

    # use provided CSR or generate new one
    CSR="$FLAGS_csr"
    DELETE_KEY=false
    DELETE_CSR=false
308

309 310
    local cert_filename="$FLAGS_common_name"
    CERT="${MOUNT_DIR}/${FLAGS_type}/${cert_filename}.crt"
311 312 313
    local counter_suffix=0
    while [ $FLAGS_overwrite -eq 1 ] && [ -f "$CERT" ]; do
        counter_suffix=$(($counter_suffix + 1))
314
        CERT="${MOUNT_DIR}/${FLAGS_type}/${cert_filename}_${counter_suffix}.crt"
315 316
    done
    if [ $counter_suffix -gt 0 ]; then
317 318
        logWarn "Certificate file '${FLAGS_type}/${cert_filename}.crt' already exists, saving as '${FLAGS_type}/${cert_filename}_${counter_suffix}.crt'."
        cert_filename="${cert_filename}_${counter_suffix}"
319 320
    fi

321
    if [ "$CSR" == "" ] || [ ! -f "$CSR" ]; then
322
        KEY="${MOUNT_DIR}/${FLAGS_type}/${cert_filename}.pem"
323
        if [ $FLAGS_overwrite -eq 1 ] && [ -f "$KEY" ]; then
324 325 326 327 328 329
            logError "Key file ${KEY} already exists!"
            cleanup "$MOUNT_DIR"
            exit 1
        fi
        generate_key "$KEY" "$BITS"

330
        CSR="${MOUNT_DIR}/${FLAGS_type}/${cert_filename}.csr"
331
        if [ $FLAGS_overwrite -eq 1 ] && [ -f "$CSR" ]; then
332 333 334 335
            logError "CSR file ${CSR} already exists!"
            cleanup "$MOUNT_DIR"
            exit 1
        fi
336
        if ! generate_csr "$CONF" "$FLAGS_type" "$KEY" "$CSR" "$FLAGS_default_subj" "$FLAGS_organizational_unit" "$FLAGS_common_name" "$FLAGS_full_name" "$FLAGS_email"; then
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
            logError "CSR generation failed!"
            cleanup "$MOUNT_DIR"
            exit 1
        fi

        if [ "$FLAGS_type" == "client" ]; then
            DELETE_KEY=true
        fi
        DELETE_CSR=true
    fi

    logInfo "Signing client certificate..."
    if ! sign_csr "$CONF" "$CSR" "$CERT" "$ROOT_KEY" "$ROOT_CERT" "$FLAGS_type"; then
        logError "Signing failed!"
        cleanup "$MOUNT_DIR"
        exit 1
    fi

    if [ "$FLAGS_type" == "client" ]; then
        logInfo "Writing .ovpn file..."
        ROOT_CA_CERT="$(dirname $ROOT_CERT)/Webis_Root_CA.crt"
358 359 360 361
        if ! generate_ovpn_file "$FLAGS_out" "$CERT" "$ROOT_CERT" "$KEY" $FLAGS_no_password; then
            cleanup "$MOUNT_DIR"
            exit 1
        fi
362 363
    fi
    if $DELETE_KEY; then
Janek Bevendorff's avatar
Janek Bevendorff committed
364
        # delete private key after generating ovpn file
365 366 367 368
        logInfo "Deleting temporary private key..."
        rm "$KEY"
    fi
    if $DELETE_CSR; then
Janek Bevendorff's avatar
Janek Bevendorff committed
369
        # delete CSR after generating ovpn file
370 371 372 373 374 375 376 377
        logInfo "Deleting temporary CSR..."
        rm "$CSR"
    fi

    CRL="$(echo -n "$ROOT_KEY" | sed 's/\.pem$/.crl/')"
    generate_crl "$CONF" "$CRL" "$ROOT_KEY" "$ROOT_CERT"

    cleanup "$MOUNT_DIR"
378
    commit_changes "${FLAGS_cryfs_dir}"
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
}


# ===========================================================================
#                               revoke command
# ===========================================================================

revoke() {
    if [ "$FLAGS_cryfs_dir" == "" ]; then
        logError "--cryfs_dir is required"
        exit 1;
    fi
    if [ "$FLAGS_cert_cn" == "" ]; then
        logError "--cert_cn is required"
        exit 1;
    fi
    if [ "$FLAGS_type" == "" ]; then
        logError "--type is required"
        exit 1;
    fi

400 401
    pull_repository "${FLAGS_cryfs_dir}"

402 403 404
    MOUNT_DIR="${FLAGS_cryfs_dir}_mount.${RANDOM}"
    mount_cryfs "$FLAGS_cryfs_dir" "$MOUNT_DIR"

405 406
    ROOT_KEY="${MOUNT_DIR}/ca/${FLAGS_root_cn}.pem"
    if [ "$FLAGS_root_cn" == "" ] || [ ! -f "$ROOT_KEY" ]; then
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
        ROOT_KEY="$(choose_root_cert "$MOUNT_DIR")"
        logInfo "Using '$(basename "${ROOT_KEY}" | sed 's/\.pem$//')' as the root certificate..."
    fi
    ROOT_CERT="$(echo -n "$ROOT_KEY" | sed 's/\.pem$/.crt/')"
    export CA_BASE_DIR="$(echo "$ROOT_CERT" | sed 's/\.crt$//')_Data"
    ensure_ca_base_dir "$CA_BASE_DIR"

    CERT="${MOUNT_DIR}/${FLAGS_type}/${FLAGS_cert_cn}.crt"
    if [ ! -f "$CERT" ]; then
        logError "Certificate '${CERT}' does not exist."
        cleanup "$MOUNT_DIR"
        exit 1
    fi

    echo -n "Are you sure you want to revoke the ${FLAGS_type} certificate '${FLAGS_cert_cn}'? [y/N] "
    read answer
    if [ "$answer" != "y" ] && [ "$answer" != "Y" ]; then
        logError "Revocation aborted."
        cleanup "$MOUNT_DIR"
        exit 1
    fi
    if ! revoke_cert "$CONF" "$CERT" "$ROOT_KEY" "$ROOT_CERT"; then
        logError "Certificate revocation failed!"
        cleanup "$MOUNT_DIR"
        exit 1
    fi

    CRL="$(echo -n "$ROOT_KEY" | sed 's/\.pem$/.crl/')"
    generate_crl "$CONF" "$CRL" "$ROOT_KEY" "$ROOT_CERT"

    cleanup "$MOUNT_DIR"
438
    commit_changes "${FLAGS_cryfs_dir}"
439 440 441 442 443 444 445 446 447 448 449 450 451
}

# ===========================================================================
#                                 bootstrap
# ===========================================================================

if [ "$CMD" == "issue" ] || [ "$CMD" == "revoke" ]; then
    $CMD "$@"
else
    logError "Invalid command '$CMD'."
    usage
    exit 1
fi