shellpki/shellpki

1107 lines
31 KiB
Plaintext
Raw Normal View History

2010-10-06 17:34:30 +02:00
#!/bin/sh
2018-01-17 12:21:39 +01:00
#
2020-05-04 23:12:56 +02:00
# shellpki is a wrapper around OpenSSL to manage a small PKI
2018-01-17 12:21:39 +01:00
#
2010-10-06 17:34:30 +02:00
2020-05-05 23:20:36 +02:00
set -u
VERSION="22.04"
show_version() {
cat <<END
shellpki version ${VERSION}
2022-03-29 18:48:45 +02:00
Copyright 2010-2022 Evolix <info@evolix.fr>,
Thomas Martin <tmartin@evolix.fr>,
Gregory Colpart <reg@evolix.fr>,
Romain Dessort <rdessort@evolix.fr>,
Benoit Série <bserie@evolix.fr>,
Victor Laborie <vlaborie@evolix.fr>,
Daniel Jakots <djakots@evolix.fr>,
Patrick Marchand <pmarchand@evolix.fr>,
2022-03-29 18:48:45 +02:00
Jérémy Lecour <jlecour@evolix.fr>,
Jérémy Dubois <jdubois@evolix.fr>
and others.
shellpki comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.
See the MIT Licence for details.
END
}
2022-03-11 14:09:58 +01:00
show_usage() {
cat <<EOF
Usage: ${0} <subcommand> [options] [CommonName]
2022-03-29 18:10:47 +02:00
Warning: [options] always must be before [CommonName] and after <subcommand>
2022-03-11 14:09:58 +01:00
EOF
show_usage_init
show_usage_create
show_usage_revoke
show_usage_list
show_usage_check
show_usage_ocsp
cat <<EOF
Show version :
${0} --version
Show help :
${0} --help
EOF
}
show_usage_init() {
cat <<EOF
Initialize PKI (create CA key and self-signed certificate) :
2022-03-11 14:09:58 +01:00
2022-03-29 18:10:47 +02:00
${0} init [options] <commonName_for_CA>
2022-03-11 14:09:58 +01:00
Options
--non-interactive do not prompt the user, and exit if an error occurs
2022-03-11 14:09:58 +01:00
EOF
}
show_usage_create() {
cat <<EOF
Create a client certificate with key and CSR directly generated on server :
2022-03-11 14:09:58 +01:00
2022-03-29 18:10:47 +02:00
${0} create [options] <commonName>
2022-03-11 14:09:58 +01:00
Options
-f, --file, --csr-file create a client certificate from a CSR (doesn't need key)
-p, --password prompt the user for a password to set on the client key
--password-file if provided with a path to a readable file, the first line is read and set as password on the client key
--days specify how many days the certificate should be valid
--end-date specify until which date the certificate should be valid, in "YYYY/MM/DD hh:mm:ss" format, UTC +0
--non-interactive do not prompt the user, and exit if an error occurs
--replace-existing if the certificate already exists, revoke it before creating a new one
2022-03-11 14:09:58 +01:00
EOF
}
show_usage_revoke() {
cat <<EOF
Revoke a client certificate :
2022-03-11 14:09:58 +01:00
2022-03-29 18:10:47 +02:00
${0} revoke [options] <commonName>
2022-03-11 14:09:58 +01:00
Options
--non-interactive do not prompt the user, and exit if an error occurs
2022-03-11 14:09:58 +01:00
EOF
}
show_usage_list() {
cat <<EOF
List certificates :
2022-03-11 14:09:58 +01:00
${0} list <options>
2022-03-11 14:09:58 +01:00
Options
2022-03-29 18:17:03 +02:00
-a, --all list all certificates: valid and revoked ones
-v, --valid list all valid certificates
-r, --revoked list all revoked certificates
2022-03-11 14:09:58 +01:00
EOF
}
show_usage_check() {
cat <<EOF
2022-03-11 14:09:58 +01:00
Check expiration date of valid certificates :
${0} check
EOF
}
show_usage_ocsp() {
cat <<EOF
Run OCSP_D server :
${0} ocsp <ocsp_uri:ocsp_port>
2022-03-11 14:09:58 +01:00
EOF
}
error() {
echo "${1}" >&2
exit 1
}
warning() {
echo "${1}" >&2
}
verify_ca_password() {
"${OPENSSL_BIN}" rsa \
-in "${CA_KEY}" \
-passin pass:"${CA_PASSWORD}" \
>/dev/null 2>&1
}
get_real_path() {
# --canonicalize is supported on Linux
# -f is supported on Linux and OpenBSD
readlink -f -- "${1}"
}
ask_ca_password() {
attempt=${1:-0}
max_attempts=3
trap 'unset CA_PASSWORD' 0
if [ ! -f "${CA_KEY}" ]; then
error "You must initialize your PKI with \`shellpki init' !"
fi
if [ "${attempt}" -gt 0 ]; then
warning "Invalid password, retry."
fi
if [ "${attempt}" -ge "${max_attempts}" ]; then
error "Maximum number of attempts reached (${max_attempts})."
fi
if [ -z "${CA_PASSWORD:-}" ]; then
if [ "${non_interactive}" -eq 1 ]; then
error "In non-interactive mode, you must pass CA_PASSWORD as environment variable"
fi
stty -echo
printf "Password for CA key: "
read -r CA_PASSWORD
stty echo
printf "\n"
fi
if [ -z "${CA_PASSWORD:-}" ] || ! verify_ca_password; then
unset CA_PASSWORD
attempt=$(( attempt + 1 ))
ask_ca_password "${attempt}"
fi
}
ask_user_password() {
trap 'unset PASSWORD' 0
if [ -z "${PASSWORD:-}" ]; then
if [ "${non_interactive}" -eq 1 ]; then
error "In non-interactive mode, you must pass PASSWORD as environment variable or use --password-file"
fi
stty -echo
printf "Password for user key: "
read -r PASSWORD
stty echo
printf "\n"
fi
if [ -z "${PASSWORD:-}" ]; then
warning "Warning: empty password from input"
fi
}
replace_existing_or_abort() {
cn=${1:?}
if [ "${non_interactive}" -eq 1 ]; then
if [ "${replace_existing}" -eq 1 ]; then
revoke --non-interactive "${cn}"
2022-03-11 14:09:58 +01:00
else
error "${cn} already exists, use \`--replace-existing' to force"
fi
else
if [ "${replace_existing}" -eq 1 ]; then
revoke "${cn}"
2022-03-11 14:09:58 +01:00
else
printf "%s already exists, do you want to revoke and recreate it ? [y/N] " "${cn}"
read -r REPLY
resp=$(echo "${REPLY}" | tr 'Y' 'y')
if [ "${resp}" = "y" ]; then
revoke "${cn}"
else
error "Aborted"
fi
2022-03-11 14:09:58 +01:00
fi
fi
}
2010-10-06 17:34:30 +02:00
init() {
2018-01-17 12:21:39 +01:00
umask 0177
2010-10-06 17:34:30 +02:00
2020-05-04 18:16:07 +02:00
[ -d "${CA_DIR}" ] || mkdir -m 0750 "${CA_DIR}"
[ -d "${CRT_DIR}" ] || mkdir -m 0750 "${CRT_DIR}"
[ -f "${INDEX_FILE}" ] || touch "${INDEX_FILE}"
2018-06-27 11:45:03 +02:00
[ -f "${CRL}" ] || touch "${CRL}"
2018-01-31 12:43:18 +01:00
[ -f "${SERIAL}" ] || echo "01" > "${SERIAL}"
2018-01-17 12:21:39 +01:00
non_interactive=0
# Parse options
# based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
while :; do
2022-03-11 14:10:32 +01:00
case ${1:-} in
--non-interactive)
non_interactive=1
;;
--)
# End of all options.
shift
break
;;
-?*)
# ignore unknown options
warning "Warning: unknown option (ignored): \`$1'"
;;
*)
# Default case: If no more options then break out of the loop.
break
;;
esac
shift
done
2018-06-27 11:45:03 +02:00
cn="${1:-}"
if [ -z "${cn}" ]; then
show_usage_init >&2
exit 1
fi
2018-06-27 11:45:03 +02:00
2020-05-04 18:16:07 +02:00
if [ -f "${CA_KEY}" ]; then
2022-03-11 14:10:32 +01:00
if [ "${non_interactive}" -eq 1 ]; then
error "${CA_KEY} already exists, erase it manually if you want to start over."
else
printf "%s already exists, do you really want to erase it ? [y/N] " "${CA_KEY}"
read -r REPLY
resp=$(echo "${REPLY}" | tr 'Y' 'y')
if [ "${resp}" = "y" ]; then
rm -f "${CA_KEY}" "${CA_CERT}"
fi
2020-05-04 18:07:20 +02:00
fi
2018-06-27 11:45:03 +02:00
fi
2022-03-11 14:10:32 +01:00
passout_arg=""
if [ -n "${CA_PASSWORD:-}" ]; then
passout_arg="-passout pass:${CA_PASSWORD}"
elif [ "${non_interactive}" -eq 1 ]; then
error "In non-interactive mode, you must pass CA_PASSWORD as environment variable."
2022-03-11 14:10:32 +01:00
fi
2020-05-04 18:16:07 +02:00
if [ ! -f "${CA_KEY}" ]; then
"${OPENSSL_BIN}" genrsa \
-out "${CA_KEY}" \
2022-03-11 14:10:32 +01:00
${passout_arg} \
2020-05-06 00:00:00 +02:00
-aes256 \
2022-03-11 11:44:09 +01:00
"${CA_KEY_LENGTH}" \
2020-05-04 18:07:20 +02:00
>/dev/null 2>&1
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
2020-05-05 15:24:06 +02:00
error "Error generating the CA key"
fi
2020-05-04 18:07:20 +02:00
fi
2018-06-27 11:45:03 +02:00
2020-05-04 18:16:07 +02:00
if [ -f "${CA_CERT}" ]; then
if [ "${non_interactive}" -eq 1 ]; then
error "${CA_CERT} already exists, erase it manually if you want to start over."
else
printf "%s already exists, do you really want to erase it ? [y/N] " "${CA_CERT}"
read -r REPLY
resp=$(echo "${REPLY}" | tr 'Y' 'y')
if [ "${resp}" = "y" ]; then
rm "${CA_CERT}"
fi
2020-05-04 18:07:20 +02:00
fi
2018-06-27 11:45:03 +02:00
fi
2020-05-04 18:16:07 +02:00
if [ ! -f "${CA_CERT}" ]; then
2020-05-04 18:07:20 +02:00
ask_ca_password 0
fi
2018-06-27 11:45:03 +02:00
2020-05-04 18:16:07 +02:00
if [ ! -f "${CA_CERT}" ]; then
"${OPENSSL_BIN}" req \
2020-05-04 18:07:20 +02:00
-new \
-batch \
-sha512 \
-x509 \
-days 3650 \
-extensions v3_ca \
2022-03-11 11:44:09 +01:00
-passin pass:"${CA_PASSWORD}" \
2020-05-04 18:16:07 +02:00
-key "${CA_KEY}" \
-out "${CA_CERT}" \
2020-05-04 18:07:20 +02:00
-config /dev/stdin <<EOF
2020-05-04 18:16:07 +02:00
$(cat "${CONF_FILE}")
2018-06-27 11:45:03 +02:00
commonName_default = ${cn}
EOF
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
2020-05-05 15:24:06 +02:00
error "Error generating the CA certificate"
fi
2022-04-04 18:13:37 +02:00
"${OPENSSL_BIN}" ca \
-config "${CONF_FILE}" \
-passin pass:${CA_PASSWORD} \
-gencrl \
-out "${CRL}"
2022-04-14 15:51:07 +02:00
fi
2018-01-17 12:21:39 +01:00
}
2010-10-06 17:34:30 +02:00
2018-06-27 12:52:20 +02:00
ocsp() {
umask 0177
ocsp_uri="${1:-}"
if [ -z "${ocsp_uri}" ]; then
show_usage_ocsp >&2
exit 1
fi
2020-05-05 00:28:00 +02:00
ocsp_csr_file="${CSR_DIR}/ocsp.csr"
2018-06-27 12:52:20 +02:00
2020-05-04 18:07:20 +02:00
url=$(echo "${ocsp_uri}" | cut -d':' -f1)
port=$(echo "${ocsp_uri}" | cut -d':' -f2)
2018-06-27 12:52:20 +02:00
2020-05-04 18:16:07 +02:00
if [ ! -f "${OCSP_KEY}" ]; then
"${OPENSSL_BIN}" genrsa \
-out "${OCSP_KEY}" \
2022-03-11 11:44:09 +01:00
"${KEY_LENGTH}" \
2020-05-04 18:07:20 +02:00
>/dev/null 2>&1
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
2020-05-05 15:24:06 +02:00
error "Error generating the OCSP key"
fi
2020-05-04 18:07:20 +02:00
fi
2018-06-27 12:52:20 +02:00
2020-05-04 18:16:07 +02:00
"${OPENSSL_BIN}" req \
2020-05-04 18:07:20 +02:00
-batch \
-new \
2020-05-04 18:16:07 +02:00
-key "${OCSP_KEY}" \
2020-05-05 00:28:00 +02:00
-out "${ocsp_csr_file}" \
2018-06-27 12:52:20 +02:00
-config /dev/stdin <<EOF
2020-05-04 18:16:07 +02:00
$(cat "${CONF_FILE}")
2018-06-27 12:52:20 +02:00
commonName_default = ${url}
[ usr_cert ]
authorityInfoAccess = OCSP;URI:http://${ocsp_uri}
EOF
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
2020-05-05 15:24:06 +02:00
error "Error generating the OCSP request"
fi
2018-06-27 12:52:20 +02:00
2020-05-04 18:16:07 +02:00
if [ ! -f "${OCSP_CERT}" ]; then
2020-05-04 18:07:20 +02:00
ask_ca_password 0
fi
2018-06-27 12:52:20 +02:00
2020-05-04 18:16:07 +02:00
if [ ! -f "${OCSP_CERT}" ]; then
"${OPENSSL_BIN}" ca \
2020-05-04 18:07:20 +02:00
-extensions v3_ocsp \
2020-05-05 00:28:00 +02:00
-in "${ocsp_csr_file}" \
2020-05-04 18:16:07 +02:00
-out "${OCSP_CERT}" \
2022-03-11 11:44:09 +01:00
-passin pass:"${CA_PASSWORD}" \
2020-05-04 18:16:07 +02:00
-config "${CONF_FILE}"
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
2020-05-05 15:24:06 +02:00
error "Error generating the OCSP certificate"
fi
2020-05-04 18:07:20 +02:00
fi
2018-06-27 12:52:20 +02:00
2020-05-04 18:16:07 +02:00
exec "${OPENSSL_BIN}" ocsp \
2020-05-04 18:07:20 +02:00
-ignore_err \
2020-05-04 18:16:07 +02:00
-index "${INDEX_FILE}" \
2020-05-04 18:07:20 +02:00
-port "${port}" \
2020-05-04 18:16:07 +02:00
-rsigner "${OCSP_CERT}" \
-rkey "${OCSP_KEY}" \
-CA "${CA_CERT}" \
2020-05-04 18:07:20 +02:00
-text
2018-06-27 12:52:20 +02:00
}
2018-01-23 16:52:42 +01:00
create() {
2020-05-04 14:21:58 +02:00
from_csr=0
2020-05-04 17:58:13 +02:00
ask_pass=0
non_interactive=0
replace_existing=0
2020-05-05 23:20:36 +02:00
days=""
end_date=""
days_set=0
end_date_set=0
password_set=0
password_file_set=0
2018-01-23 16:52:42 +01:00
2020-05-04 14:21:58 +02:00
# Parse options
# based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
while :; do
case ${1:-} in
2020-05-04 14:21:58 +02:00
-f|--file|--csr-file)
# csr-file option, with value separated by space
if [ -n "$2" ]; then
from_csr=1
csr_file=$(get_real_path "${2}")
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
2020-05-05 15:24:06 +02:00
if [ "$?" -ne 0 ]; then
error "Error accessing file \`${2}'"
fi
2020-05-04 14:21:58 +02:00
shift
else
error "Argument error: \`--csr-file' requires a value"
2020-05-04 14:21:58 +02:00
fi
;;
--file=?*|--csr-file=?*)
from_csr=1
# csr-file option, with value separated by =
csr_file=$(get_real_path "${1#*=}")
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
2020-05-05 15:24:06 +02:00
if [ "$?" -ne 0 ]; then
error "Error accessing file \`${1#*=}'"
fi
2020-05-04 14:21:58 +02:00
;;
--file=|--csr-file=)
# csr-file options, without value
error "Argument error: \`--csr-file' requires a value"
2020-05-04 14:21:58 +02:00
;;
-p|--password)
2020-05-04 14:21:58 +02:00
ask_pass=1
password_set=1
2020-05-04 14:21:58 +02:00
;;
--password-file)
# password-file option, with value separated by space
if [ -n "$2" ]; then
password_file=$(get_real_path "${2}")
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
2020-05-05 15:24:06 +02:00
if [ "$?" -ne 0 ]; then
error "Error accessing file \`${2}'"
fi
password_file_set=1
2020-05-04 14:21:58 +02:00
shift
else
error "Argument error: \`--password-file' requires a value"
2020-05-04 14:21:58 +02:00
fi
;;
--password-file=?*)
# password-file option, with value separated by =
password_file=$(get_real_path "${1#*=}")
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
2020-05-05 15:24:06 +02:00
if [ "$?" -ne 0 ]; then
error "Error accessing file \`${1#*=}'"
fi
password_file_set=1
2020-05-04 14:21:58 +02:00
;;
--password-file=)
# password-file options, without value
error "Argument error: \`--password-file' requires a value"
2020-05-04 14:21:58 +02:00
;;
--days)
# days option, with value separated by space
if [ -n "$2" ]; then
days=${2}
days_set=1
shift
else
error "Argument error: \`--days' requires a value"
fi
;;
--days=?*)
# days option, with value separated by =
days=${1#*=}
days_set=1
;;
--days=)
# days options, without value
error "Argument error: \`--days' requires a value"
;;
--end-date)
# end-date option, with value separated by space
if [ -n "$2" ]; then
end_date=${2}
end_date_set=1
shift
else
error "Argument error: \`--end-date' requires a value"
fi
;;
--end-date=?*)
# end-date option, with value separated by =
end_date=${1#*=}
end_date_set=1
;;
--end-date=)
# end-date options, without value
error "Argument error: \`--end-date' requires a value"
;;
--non-interactive)
non_interactive=1
;;
--replace-existing)
replace_existing=1
;;
--)
2020-05-04 14:21:58 +02:00
# End of all options.
shift
2020-05-04 14:21:58 +02:00
break
;;
-?*)
2020-05-04 14:21:58 +02:00
# ignore unknown options
warning "Warning: unknown option (ignored): \`$1'"
2020-05-04 14:21:58 +02:00
;;
*)
2020-05-04 14:21:58 +02:00
# Default case: If no more options then break out of the loop.
break
;;
2018-01-23 16:52:42 +01:00
esac
2020-05-04 14:21:58 +02:00
shift
2018-01-23 16:52:42 +01:00
done
if [ "${days_set}" -eq 1 ] && [ "${end_date_set}" -eq 1 ]; then
error "Argument error: \`--end-date' and \`--days' cannot be used together."
fi
if [ "${password_set}" -eq 1 ] && [ "${password_file_set}" -eq 1 ]; then
error "Argument error: \`--password' and \`--password-file' cannot be used together."
fi
# The name of the certificate
2018-01-23 16:52:42 +01:00
cn="${1:-}"
# Set expiration argument
crt_expiration_arg=""
if [ -n "${days}" ]; then
if [ "${days}" -gt 0 ]; then
crt_expiration_arg="-days ${days}"
else
error "Argument error: \"${days}\" is not a valid value for \`--days'."
fi
fi
if [ -n "${end_date}" ]; then
if [ "${SYSTEM}" = "linux" ]; then
cert_end_date=$(TZ=:Zulu date --date "${end_date}" +"%Y%m%d%H%M%SZ" 2> /dev/null)
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
error "Invalid end date format: \`${end_date}' can't be parsed by date(1). Expected format: YYYY/MM/DD [hh[:mm[:ss]]]."
else
crt_expiration_arg="-enddate ${cert_end_date}"
fi
elif [ "${SYSTEM}" = "openbsd" ]; then
cert_end_date=$(TZ=:Zulu date -f "%C%y/%m/%d %H:%M:%S" -j "${end_date}" +"%Y%m%d%H%M%SZ" 2> /dev/null)
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
error "Invalid end date format: \`${end_date}' can't be parsed by date(1). Expected format: YYYY/MM/DD hh:mm:ss."
else
crt_expiration_arg="-enddate ${cert_end_date}"
fi
else
error "System ${SYSTEM} not supported."
fi
fi
if [ "${non_interactive}" -eq 1 ]; then
batch_arg="-batch"
else
batch_arg=""
fi
2020-05-04 14:21:58 +02:00
if [ "${from_csr}" -eq 1 ]; then
2020-05-04 18:07:20 +02:00
if [ "${ask_pass}" -eq 1 ]; then
warning "Warning: -p|--password is ignored with -f|--file|--crt-file"
fi
2020-10-12 23:27:24 +02:00
if [ -n "${password_file:-}" ]; then
2020-05-04 18:07:20 +02:00
warning "Warning: --password-file is ignored with -f|--file|--crt-file"
fi
2018-01-23 16:52:42 +01:00
2020-05-05 00:28:00 +02:00
crt_file="${CRT_DIR}/${cn}.crt"
2018-01-23 16:52:42 +01:00
# ask for CA passphrase
ask_ca_password 0
# check if csr_file is a CSR
2020-05-04 18:16:07 +02:00
"${OPENSSL_BIN}" req \
2020-05-04 23:08:19 +02:00
-noout \
-subject \
2020-05-04 18:07:20 +02:00
-in "${csr_file}" \
2020-05-04 23:06:51 +02:00
>/dev/null 2>&1
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
2020-05-04 23:06:51 +02:00
if [ "$?" -ne 0 ]; then
error "${csr_file} is not a valid CSR !"
fi
2018-01-23 16:52:42 +01:00
# check if csr_file contain a CN
2020-05-04 18:16:07 +02:00
"${OPENSSL_BIN}" req \
2020-05-04 23:08:19 +02:00
-noout \
-subject \
2020-05-04 18:07:20 +02:00
-in "${csr_file}" \
| grep -Eo "CN\s*=[^,/]*" \
2020-05-04 23:06:51 +02:00
>/dev/null 2>&1
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
2020-05-04 23:06:51 +02:00
if [ "$?" -ne 0 ]; then
error "${csr_file} doesn't contain a CommonName !"
fi
2018-01-23 16:52:42 +01:00
# get CN from CSR
2020-05-04 18:16:07 +02:00
cn=$("${OPENSSL_BIN}" req -noout -subject -in "${csr_file}" | grep -Eo "CN\s*=[^,/]*" | cut -d'=' -f2 | xargs)
2018-01-23 16:52:42 +01:00
# check if CN already exists
if [ -f "${crt_file}" ]; then
replace_existing_or_abort "${cn}"
2020-05-04 18:07:20 +02:00
fi
2018-01-23 16:52:42 +01:00
# ca sign and generate cert
if [ "${non_interactive}" -eq 1 ]; then
batch_arg="-batch"
else
batch_arg=""
fi
"${OPENSSL_BIN}" ca \
${batch_arg} \
2020-05-04 18:16:07 +02:00
-config "${CONF_FILE}" \
2020-05-04 18:07:20 +02:00
-in "${csr_file}" \
2022-03-11 11:44:09 +01:00
-passin pass:"${CA_PASSWORD}" \
2020-05-05 00:28:00 +02:00
-out "${crt_file}" \
${crt_expiration_arg}
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
2020-05-05 15:24:06 +02:00
error "Error generating the certificate"
else
echo "The certificate file is available at \`${crt_file}'"
fi
2018-01-23 16:52:42 +01:00
else
if [ -z "${cn}" ]; then
show_usage_create >&2
exit 1
fi
2020-05-05 00:28:00 +02:00
csr_file="${CSR_DIR}/${cn}-${SUFFIX}.csr"
crt_file="${CRT_DIR}/${cn}.crt"
key_file="${KEY_DIR}/${cn}-${SUFFIX}.key"
ovpn_file="${OVPN_DIR}/${cn}-${SUFFIX}.ovpn"
pkcs12_file="${PKCS12_DIR}/${cn}-${SUFFIX}.p12"
2018-01-23 16:52:42 +01:00
# ask for CA passphrase
ask_ca_password 0
if [ "${ask_pass}" -eq 1 ]; then
2020-05-05 10:47:09 +02:00
ask_user_password
2018-01-23 16:52:42 +01:00
fi
# check if CN already exists
if [ -f "${crt_file}" ]; then
replace_existing_or_abort "${cn}"
fi
2018-01-23 16:52:42 +01:00
# generate private key
2020-05-05 23:20:54 +02:00
pass_args=""
2020-10-12 23:27:24 +02:00
if [ -n "${password_file:-}" ]; then
2020-05-05 23:20:54 +02:00
pass_args="-aes256 -passout file:${password_file}"
2020-10-12 23:27:24 +02:00
elif [ -n "${PASSWORD:-}" ]; then
2020-05-05 23:20:54 +02:00
pass_args="-aes256 -passout pass:${PASSWORD}"
2018-01-23 16:52:42 +01:00
fi
"${OPENSSL_BIN}" genrsa \
2020-05-05 09:42:54 +02:00
-out "${key_file}" \
2020-05-05 23:20:54 +02:00
${pass_args} \
2022-03-11 11:44:09 +01:00
"${KEY_LENGTH}" \
>/dev/null 2>&1
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
2020-05-06 00:39:23 +02:00
if [ "$?" -eq 0 ]; then
echo "The KEY file is available at \`${key_file}'"
else
2020-05-05 15:24:06 +02:00
error "Error generating the private key"
fi
2018-01-23 16:52:42 +01:00
2020-05-05 09:42:54 +02:00
# generate csr req
2020-05-05 23:20:54 +02:00
pass_args=""
2020-10-12 23:27:24 +02:00
if [ -n "${password_file:-}" ]; then
2020-05-05 23:20:54 +02:00
pass_args="-passin file:${password_file}"
2020-10-12 23:27:24 +02:00
elif [ -n "${PASSWORD:-}" ]; then
2020-05-05 23:20:54 +02:00
pass_args="-passin pass:${PASSWORD}"
2020-05-05 09:42:54 +02:00
fi
"${OPENSSL_BIN}" req \
2020-05-05 09:42:54 +02:00
-batch \
-new \
-key "${key_file}" \
-out "${csr_file}" \
2020-05-05 23:20:54 +02:00
${pass_args} \
2020-05-05 09:42:54 +02:00
-config /dev/stdin <<EOF
2020-05-04 18:16:07 +02:00
$(cat "${CONF_FILE}")
2018-01-23 16:52:42 +01:00
commonName_default = ${cn}
EOF
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
2020-05-05 15:24:06 +02:00
error "Error generating the CSR"
fi
2018-01-23 16:52:42 +01:00
# ca sign and generate cert
"${OPENSSL_BIN}" ca \
${batch_arg} \
2020-05-04 18:16:07 +02:00
-config "${CONF_FILE}" \
-passin pass:${CA_PASSWORD} \
2020-05-05 00:28:00 +02:00
-in "${csr_file}" \
-out "${crt_file}" \
${crt_expiration_arg}
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
2020-05-05 15:24:06 +02:00
error "Error generating the certificate"
fi
2018-01-23 16:52:42 +01:00
# check if CRT is a valid
2020-05-04 18:16:07 +02:00
"${OPENSSL_BIN}" x509 \
2020-05-04 18:07:20 +02:00
-noout \
-subject \
2020-05-05 00:28:00 +02:00
-in "${crt_file}" \
2020-05-04 23:06:51 +02:00
>/dev/null 2>&1
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
2020-05-04 23:06:51 +02:00
if [ "$?" -ne 0 ]; then
2020-05-05 00:28:00 +02:00
rm -f "${crt_file}"
2020-05-04 23:06:51 +02:00
fi
2020-05-05 00:28:00 +02:00
if [ ! -f "${crt_file}" ]; then
2020-05-04 18:07:20 +02:00
error "Error in CSR creation"
fi
2018-01-23 16:52:42 +01:00
2020-05-05 00:28:00 +02:00
chmod 640 "${crt_file}"
2018-01-23 16:52:42 +01:00
2020-05-05 00:28:00 +02:00
echo "The CRT file is available in ${crt_file}"
2018-01-23 16:52:42 +01:00
# generate pkcs12 format
2020-05-05 23:20:54 +02:00
pass_args=""
2020-10-12 23:27:24 +02:00
if [ -n "${password_file:-}" ]; then
# Hack for pkcs12 :
# If passin and passout files are the same path, it expects 2 lines
# so we make a temporary copy of the password file
password_file_out=$(mktemp)
cp "${password_file}" "${password_file_out}"
2020-05-05 23:20:54 +02:00
pass_args="-passin file:${password_file} -passout file:${password_file_out}"
2020-10-12 23:27:24 +02:00
elif [ -n "${PASSWORD:-}" ]; then
2020-05-05 23:20:54 +02:00
pass_args="-passin pass:${PASSWORD} -passout pass:${PASSWORD}"
2018-01-23 16:52:42 +01:00
else
2020-05-05 23:20:54 +02:00
pass_args="-passout pass:"
2018-01-23 16:52:42 +01:00
fi
"${OPENSSL_BIN}" pkcs12 \
2020-05-05 09:42:54 +02:00
-export \
-nodes \
-inkey "${key_file}" \
-in "${crt_file}" \
-out "${pkcs12_file}" \
2020-05-05 23:20:54 +02:00
${pass_args}
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
if [ "$?" -ne 0 ]; then
2020-05-05 15:24:06 +02:00
error "Error generating the pkcs12 file"
fi
2018-01-23 16:52:42 +01:00
2020-10-12 23:27:24 +02:00
if [ -n "${password_file_out:-}" ]; then
# Hack for pkcs12 :
# Destroy the temporary file
rm -f "${password_file_out}"
fi
2020-05-05 00:28:00 +02:00
chmod 640 "${pkcs12_file}"
echo "The PKCS12 config file is available at \`${pkcs12_file}'"
2018-01-31 12:43:18 +01:00
2018-01-23 16:52:42 +01:00
# generate openvpn format
2020-05-04 18:16:07 +02:00
if [ -e "${CA_DIR}/ovpn.conf" ]; then
2020-05-05 00:28:00 +02:00
cat "${CA_DIR}/ovpn.conf" - > "${ovpn_file}" <<EOF
2014-12-05 16:28:56 +01:00
<ca>
2020-05-04 18:16:07 +02:00
$(cat "${CA_CERT}")
2014-12-05 16:28:56 +01:00
</ca>
2010-10-06 17:34:30 +02:00
2014-12-05 16:28:56 +01:00
<cert>
2020-05-05 00:28:00 +02:00
$(cat "${crt_file}")
2014-12-05 16:28:56 +01:00
</cert>
<key>
2020-05-05 00:28:00 +02:00
$(cat "${key_file}")
2014-12-05 16:28:56 +01:00
</key>
2018-01-17 12:21:39 +01:00
EOF
2020-05-05 00:28:00 +02:00
chmod 640 "${ovpn_file}"
echo "The OpenVPN config file is available at \`${ovpn_file}'"
2018-01-23 16:52:42 +01:00
fi
2020-05-06 00:40:36 +02:00
# Copy files if destination exists
if [ -d "${COPY_DIR}" ]; then
for file in "${crt_file}" "${key_file}" "${pkcs12_file}" "${ovpn_file}"; do
if [ -f "${file}" ]; then
new_file="${COPY_DIR}/$(basename "${file}")"
if [ "${replace_existing}" -eq 1 ]; then
cp -f "${file}" "${COPY_DIR}/"
else
if [ "${non_interactive}" -eq 1 ]; then
if [ -f "${new_file}" ]; then
echo "File \`${file}' has not been copied to \`${new_file}', it already exists" >&2
continue
else
cp "${file}" "${COPY_DIR}/"
fi
else
cp -i "${file}" "${COPY_DIR}/"
fi
fi
echo "File \`${file}' has been copied to \`${new_file}'"
fi
done
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2086
2020-05-06 00:40:36 +02:00
chown -R ${PKI_USER}:${PKI_USER} "${COPY_DIR}/"
chmod -R u=rwX,g=rwX,o= "${COPY_DIR}/"
fi
2018-01-17 12:21:39 +01:00
fi
2010-10-06 17:34:30 +02:00
}
2018-01-23 16:52:42 +01:00
revoke() {
non_interactive=0
# Parse options
# based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
while :; do
case ${1:-} in
--non-interactive)
non_interactive=1
;;
--)
# End of all options.
shift
break
;;
-?*)
# ignore unknown options
warning "Warning: unknown option (ignored): \`$1'"
;;
*)
# Default case: If no more options then break out of the loop.
break
;;
esac
shift
done
# The name of the certificate
cn="${1:-}"
if [ -z "${cn}" ]; then
show_usage_revoke >&2
exit 1
fi
2010-10-06 17:34:30 +02:00
crt_file="${CRT_DIR}/${cn}.crt"
2018-01-23 16:52:42 +01:00
# check if CRT exists
2020-05-05 00:28:00 +02:00
if [ ! -f "${crt_file}" ]; then
2022-03-29 18:17:03 +02:00
error "Unknow CN: ${cn} (\`${crt_file}' not found)"
2020-05-04 18:07:20 +02:00
fi
2010-10-06 17:34:30 +02:00
2018-01-23 16:52:42 +01:00
# check if CRT is a valid
2020-05-04 18:16:07 +02:00
"${OPENSSL_BIN}" x509 \
2020-05-04 18:07:20 +02:00
-noout \
-subject \
2020-05-05 00:28:00 +02:00
-in "${crt_file}" \
2020-05-04 23:06:51 +02:00
>/dev/null 2>&1
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
2020-05-04 23:06:51 +02:00
if [ "$?" -ne 0 ]; then
2020-05-05 00:28:00 +02:00
error "${crt_file} is not a valid CRT, you must delete it !"
2020-05-04 23:06:51 +02:00
fi
2010-10-06 17:34:30 +02:00
2018-01-23 16:52:42 +01:00
# ask for CA passphrase
ask_ca_password 0
2010-10-06 17:34:30 +02:00
2020-05-05 00:28:00 +02:00
echo "Revoke certificate ${crt_file} :"
"${OPENSSL_BIN}" ca \
2020-05-04 18:16:07 +02:00
-config "${CONF_FILE}" \
2022-03-11 11:44:09 +01:00
-passin pass:"${CA_PASSWORD}" \
2020-05-05 00:28:00 +02:00
-revoke "${crt_file}"
2022-03-11 11:44:09 +01:00
# shellcheck disable=SC2181
2020-05-05 00:28:00 +02:00
if [ "$?" -eq 0 ]; then
rm "${crt_file}"
fi
2010-10-06 17:34:30 +02:00
"${OPENSSL_BIN}" ca \
2020-05-04 18:16:07 +02:00
-config "${CONF_FILE}" \
2022-03-11 11:44:09 +01:00
-passin pass:"${CA_PASSWORD}" \
2020-05-05 00:28:00 +02:00
-gencrl \
-out "${CRL}"
2010-10-06 17:34:30 +02:00
}
2018-01-17 12:21:39 +01:00
list() {
2020-05-04 18:16:07 +02:00
if [ ! -f "${INDEX_FILE}" ]; then
2020-05-04 18:07:20 +02:00
exit 0
fi
if [ -z "${1:-}" ]; then
show_usage_list >&2
2020-10-12 23:49:45 +02:00
exit 1
fi
while :; do
case "${1:-}" in
-a|--all)
list_valid=0
list_revoked=0
2022-03-14 11:03:36 +01:00
;;
-v|--valid)
list_valid=0
list_revoked=1
2022-03-14 11:03:36 +01:00
;;
-r|--revoked)
list_valid=1
list_revoked=0
2022-03-14 11:03:36 +01:00
;;
-?*)
warning "unknow option ${1} (ignored)"
2022-03-14 11:03:36 +01:00
;;
*)
2022-03-14 11:03:36 +01:00
break
;;
esac
2022-03-14 11:03:36 +01:00
shift
done
2020-05-04 18:07:20 +02:00
if [ "${list_valid}" -eq 0 ]; then
2020-05-04 18:16:07 +02:00
certs=$(grep "^V" "${INDEX_FILE}")
2020-05-04 18:07:20 +02:00
fi
2020-05-04 18:07:20 +02:00
if [ "${list_revoked}" -eq 0 ]; then
2020-05-04 18:16:07 +02:00
certs=$(grep "^R" "${INDEX_FILE}")
2020-05-04 18:07:20 +02:00
fi
2020-05-04 18:07:20 +02:00
if [ "${list_valid}" -eq 0 ] && [ "${list_revoked}" -eq 0 ]; then
2020-05-04 18:16:07 +02:00
certs=$(cat "${INDEX_FILE}")
2020-05-04 18:07:20 +02:00
fi
echo "${certs}" | grep -Eo "CN\s*=[^,/]*" | cut -d'=' -f2 | xargs -n1
2018-01-17 12:21:39 +01:00
}
2010-10-06 17:34:30 +02:00
2020-05-04 23:12:48 +02:00
cert_end_date() {
"${OPENSSL_BIN}" x509 -noout -enddate -in "${1}" | cut -d'=' -f2
}
check() {
# default expiration alert
2022-03-29 18:17:03 +02:00
# TODO: permit override with parameters
min_day=90
cur_epoch=$(date -u +'%s')
2022-03-11 11:44:09 +01:00
for cert in "${CRT_DIR}"/*; do
2020-05-04 23:12:48 +02:00
end_date=$(cert_end_date "${cert}")
end_epoch=$(date -ud "${end_date}" +'%s')
2020-05-04 23:08:19 +02:00
diff_epoch=$(( end_epoch - cur_epoch ))
diff_day=$(( diff_epoch / 60 / 60 / 24 ))
if [ "${diff_day}" -lt "${min_day}" ]; then
if [ "${diff_day}" -le 0 ]; then
echo "${cert} has expired"
else
echo "${cert} expire in ${diff_day} days"
fi
fi
done
}
is_user() {
getent passwd "${1}" >/dev/null
}
is_group() {
getent group "${1}" >/dev/null
}
2018-01-17 12:21:39 +01:00
main() {
# Know what system we are on, because OpenBSD and Linux do not implement date(1) in the same way
SYSTEM=$(uname | tr '[:upper:]' '[:lower:]')
2018-01-31 12:43:18 +01:00
# default config
2022-03-29 18:17:03 +02:00
# TODO: override with /etc/default/shellpki
2020-05-04 18:16:07 +02:00
CONF_FILE="/etc/shellpki/openssl.cnf"
2020-05-04 14:21:58 +02:00
if [ "$(uname)" = "OpenBSD" ]; then
2020-05-04 18:16:07 +02:00
PKI_USER="_shellpki"
2020-05-04 14:21:58 +02:00
else
2020-05-04 18:16:07 +02:00
PKI_USER="shellpki"
2020-05-04 14:21:58 +02:00
fi
2018-01-31 12:43:18 +01:00
2020-05-04 18:16:07 +02:00
if [ "${USER}" != "root" ] && [ "${USER}" != "${PKI_USER}" ]; then
2020-05-04 17:42:01 +02:00
error "Please become root before running ${0} !"
fi
2018-06-27 14:48:11 +02:00
2018-01-31 12:43:18 +01:00
# retrieve CA path from config file
2020-05-04 18:16:07 +02:00
CA_DIR=$(grep -E "^dir" "${CONF_FILE}" | cut -d'=' -f2 | xargs -n1)
CA_KEY=$(grep -E "^private_key" "${CONF_FILE}" | cut -d'=' -f2 | xargs -n1 | sed "s~\$dir~${CA_DIR}~")
CA_CERT=$(grep -E "^certificate" "${CONF_FILE}" | cut -d'=' -f2 | xargs -n1 | sed "s~\$dir~${CA_DIR}~")
OCSP_KEY="${CA_DIR}/ocsp.key"
OCSP_CERT="${CA_DIR}/ocsp.pem"
CRT_DIR=$(grep -E "^certs" "${CONF_FILE}" | cut -d'=' -f2 | xargs -n1 | sed "s~\$dir~${CA_DIR}~")
TMP_DIR=$(grep -E "^new_certs_dir" "${CONF_FILE}" | cut -d'=' -f2 | xargs -n1 | sed "s~\$dir~${CA_DIR}~")
INDEX_FILE=$(grep -E "^database" "${CONF_FILE}" | cut -d'=' -f2 | xargs -n1 | sed "s~\$dir~${CA_DIR}~")
SERIAL=$(grep -E "^serial" "${CONF_FILE}" | cut -d'=' -f2 | xargs -n1 | sed "s~\$dir~${CA_DIR}~")
CRL=$(grep -E "^crl" "${CONF_FILE}" | cut -d'=' -f2 | xargs -n1 | sed "s~\$dir~${CA_DIR}~")
2018-01-31 12:43:18 +01:00
# directories for clients key, csr, crt
2020-05-04 18:16:07 +02:00
KEY_DIR="${CA_DIR}/private"
CSR_DIR="${CA_DIR}/requests"
PKCS12_DIR="${CA_DIR}/pkcs12"
OVPN_DIR="${CA_DIR}/openvpn"
2018-01-31 12:43:18 +01:00
2020-05-06 00:40:36 +02:00
COPY_DIR="$(dirname "${CONF_FILE}")/copy_output"
CA_KEY_LENGTH=4096
if [ "${CA_KEY_LENGTH}" -lt 4096 ]; then
error "CA key must be at least 4096 bits long."
fi
2020-05-04 18:16:07 +02:00
KEY_LENGTH=2048
if [ "${KEY_LENGTH}" -lt 2048 ]; then
error "User key must be at least 2048 bits long."
fi
2018-01-17 12:21:39 +01:00
2020-05-04 18:16:07 +02:00
OPENSSL_BIN=$(command -v openssl)
SUFFIX=$(TZ=:Zulu /bin/date +"%Y%m%d%H%M%SZ")
2020-05-04 18:16:07 +02:00
if ! is_user "${PKI_USER}" || ! is_group "${PKI_USER}"; then
2020-05-04 18:16:07 +02:00
error "You must create ${PKI_USER} user and group !"
2018-01-17 12:21:39 +01:00
fi
2014-12-05 16:28:56 +01:00
2020-05-04 18:16:07 +02:00
if [ ! -e "${CONF_FILE}" ]; then
error "${CONF_FILE} is missing"
2020-05-04 18:07:20 +02:00
fi
2010-10-06 17:34:30 +02:00
2020-05-04 18:16:07 +02:00
mkdir -p "${CA_DIR}" "${CRT_DIR}" "${KEY_DIR}" "${CSR_DIR}" "${PKCS12_DIR}" "${OVPN_DIR}" "${TMP_DIR}"
2018-01-17 12:21:39 +01:00
2018-01-23 16:52:42 +01:00
command=${1:-help}
case "${command}" in
2018-01-17 12:21:39 +01:00
init)
2018-01-23 16:52:42 +01:00
shift
2018-06-27 11:45:03 +02:00
init "$@"
2018-01-17 12:21:39 +01:00
;;
2018-06-27 12:52:20 +02:00
ocsp)
shift
ocsp "$@"
;;
2018-01-17 12:21:39 +01:00
create)
2018-01-23 16:52:42 +01:00
shift
create "$@"
2018-01-17 12:21:39 +01:00
;;
revoke)
2018-01-23 16:52:42 +01:00
shift
revoke "$@"
2018-01-17 12:21:39 +01:00
;;
list)
2018-01-23 16:52:42 +01:00
shift
list "$@"
2018-01-17 12:21:39 +01:00
;;
check)
shift
check "$@"
;;
version|--version)
show_version
exit 0
;;
help|--help)
show_usage
exit 0
;;
2018-01-17 12:21:39 +01:00
*)
show_usage >&2
2018-01-17 12:21:39 +01:00
exit 1
;;
esac
2018-01-31 12:43:18 +01:00
# fix right
2020-05-04 18:16:07 +02:00
chown -R "${PKI_USER}":"${PKI_USER}" "${CA_DIR}"
chmod 750 "${CA_DIR}" "${CRT_DIR}" "${KEY_DIR}" "${CSR_DIR}" "${PKCS12_DIR}" "${OVPN_DIR}" "${TMP_DIR}"
chmod 600 "${INDEX_FILE}"* "${SERIAL}"* "${CA_KEY}" "${CRL}"
chmod 640 "${CA_CERT}"
2018-01-17 12:21:39 +01:00
}
2010-10-06 17:34:30 +02:00
2018-01-17 12:21:39 +01:00
main "$@"