openssl-ca
名称
openssl-ca – sample minimal CA application
描述
此命令模拟 CA 应用程序。请参阅警告,尤其是在考虑有效使用它时。
它生成带有 X.509 版本 3 的证书。除非另有说明,否则密钥标识符扩展将包含在 x509v3_config(5) 中。
它可用于签署各种形式的证书请求 (CSR) 并生成证书吊销列表 (CRL)。它还维护已颁发证书及其状态的文本数据库。签署证书时,可以使用 -in 选项指定单个请求,或者可以通过在所有选项后指定一组 certreq 文件来处理多个请求。
请注意,还有非常精简的证书生成方法:req 和 x509 命令可用于直接创建证书。有关详细信息,请参阅 openssl-req(1) 和 openssl-x509(1)。
ca 命令选项按不同的用途描述。
概述
openssl ca [-help] [-verbose] [-quiet] [-config filename] [-name section] [-section section] [-gencrl] [-revoke file] [-valid file] [-status serial] [-updatedb] [-crl_reason reason] [-crl_hold instruction] [-crl_compromise time] [-crl_CA_compromise time] [-crl_lastupdate date] [-crl_nextupdate date] [-crldays days] [-crlhours hours] [-crlsec seconds] [-crlexts section] [-startdate date] [-not_before date] [-enddate date] [-not_after date] [-days arg] [-md arg] [-policy arg] [-keyfile filename|uri] [-keyform DER|PEM|P12|ENGINE] [-key arg] [-passin arg] [-cert file] [-certform DER|PEM|P12] [-selfsign] [-in file] [-inform DER|<PEM>] [-out file] [-notext] [-dateopt] [-outdir dir] [-infiles] [-spkac file] [-ss_cert file] [-preserveDN] [-noemailDN] [-batch] [-msie_hack] [-extensions section] [-extfile section] [-subj arg] [-utf8] [-sigopt nm:v] [-vfyopt nm:v] [-create_serial] [-rand_serial] [-multivalue-rdn] [-rand files] [-writerand file] [-engine id] [-provider name] [-provider-path path] [-propquery propq] [certreq...]
通用选项
- -help
帮助
-
-verbose
执行时输出更多的信息
-
-quiet
输出更少的信息,这在批处理和使用管道时很方便,尤其是密钥生成期间抑制进度
.
的输出。 -
-config
指定备用的配置文件,用于替代默认的openssl.cnf
-
-name section, -section section
指定该命令的section name(覆盖 ca section中的 default_ca)
-
-in filename
输入证书请书文件的位置
-
-inform DER|PEM
输入的csr文件格式,默认首先尝试pem格式
-
-ss_cert filename
CA签署的单个自签名证书
-
-spkac filename
CA 将签署的包含单个 Netscape 签名公钥和质询以及其他字段值的文件. See the SPKAC FORMAT section for information on the required input and output format.
-
-infiles
如果存在,这应该是最后一个选项,所有后续参数都被视为包含证书请求的文件的名称。用于批量请定证书请求文件。
-
-out filename
The output file to output certificates to. The default is standard output. The certificate details will also be printed out to this file in PEM format (except that -spkac outputs DER format).
证书输出文件,默认是标准输出,证书内容默认为PEM格式(如果指定-spkac则为DER格式) -
-outdir directory
证书输出目录。证书文件名由十六进制序列号和附加 .pem 组成。
-
-cert filename
与-keyfile匹配的CA证书.
-
-certform DER|PEM|P12
The format of the data in certificate input files
输入文件的证书格式(不应该是证书请求文件吗) -
-keyfile filename|uri
签名用的CA私钥,与-cer指定的证书匹配
-
-keyform DER|PEM|P12|ENGINE
读取私钥时的格式
-
-sigopt nm:v
签名算法的选项,可以多次使用,不同算法有不同的选项
-
-vfyopt nm:v
验证签名时指定签名算法的选项,不同的签名算法选项也不同
这通常也需要在签名时提供,因为证书签名请求(CSR)的自签名是根据所包含的公钥进行验证的,并且该验证可能需要其自己的一组选项。 -
-key password
用于加密私钥的密码。由于在某些系统上命令行参数是可见的(例如,在 Unix 上使用 ps(1) 时),因此应谨慎使用此选项。最好使用 -passin。
-
-passin arg
读取证书或密钥文件的密码
-
-selfsign
表示颁发的证书将使用证书请求签名的密钥进行签名(使用 -keyfile 给出)。使用不同密钥签名的证书请求将被忽略。如果给出了 -spkac、-ss_cert 或 -gencrl,则忽略 -selfsign。
使用 -selfsign 的结果是自签名证书出现在证书数据库的条目中(请参阅配置文件选项database),并使用与使用自签名证书签名的所有其他证书相同的序列号计数器。 -
-notext
输出文件中不包括文本格式的表单.
-
-dateopt
日期的输出格式. Values are: rfc_822 and iso_8601. Defaults to rfc_822.
-
-startdate date, -not_before date
证书生效的起始日期。格式是
YYMMDDHHMMSSZ
或YYYYMMDDHHMMSSZ
,秒SS和时区Z是必须存在的,可以指定today
-
-enddate date, -not_after date
证书的截止日期。格式是
YYMMDDHHMMSSZ
或YYYYMMDDHHMMSSZ
,秒SS和时区Z是必须存在的,可以指定today
,会覆盖 -days options。 -
-days arg
指定证书从现在起算有效天数,默认为30。
如果设置了选项 -not_after,则明确的到期日期优先。 -
-md alg
消息摘要算法,支持的摘要算法可以通过openssl dgst –list命令查看。如果遇到签名算法不支持的alg则会忽略(如ed25519,ed448).这个选项也用于CRL签名
-
-policy arg
此选项定义要使用的 CA“policy”。这是配置文件中的一个部分,它决定哪些字段应该是必填的或与 CA 证书匹配。查看 POLICY FORMAT 部分了解更多信息。
-
-msie_hack
这是一个弃用的选项,可使此命令与非常旧版本的 IE 证书注册控件“certenr3”配合使用。它几乎在所有方面都使用了 UniversalStrings。由于旧控件存在各种安全漏洞,因此强烈建议不要使用它。
-
-preserveDN
通常,证书的 DN 顺序与相关策略部分中字段的顺序相同。设置此选项后,顺序与请求相同。这主要是为了与较旧的 IE 注册控件兼容,该控件仅接受 DN 与请求顺序匹配的证书。Xenroll 不需要这样做。
-
-noemailDN
如果请求 DN 中存在 EMAIL 字段,证书的 DN 可以包含该字段,但是,将电子邮件设置到证书的 altName 扩展中是一种很好的策略。设置此选项后,EMAIL 字段将从证书的主题中删除,并仅设置在最终存在的扩展中。可以在配置文件中使用 email_in_dn 关键字来启用此行为。
-
-batch
非交互模式,在这种模式下,不会询问任何问题,所有证书将自动认证。
-
-extensions section
指定X.509扩展的section,这个section中的证书扩展会在签署证书时添加到证书中(默认是x509_extensions,除非指定了-extfile)
See the x509v3_config(5) manual page for details of the extension section format.
-
-extfile file
从这个文件中读取证书扩展 (using the default section unless the -extensions option is also used).
-
-subj arg
取代证书请求中给出的主题名称。
指定主题的DN,arg的格式为/type0=value0/type1=value1/type2=...
。
特殊字符用\
转义,允许使用空格,单个/
指定空的DN,可以用+
代表/
作为两个RDN之间的分隔符,例如/DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe
,/C=CN/ST=Shanghai/L=Shanghai/CN=hetao/emailAddress=tao@hetao.me/
。 -
-utf8
所有字段的值用UTF8解释,默认是ASCII.这意味着从终端输入和配置文件中的值都要是UTF8
-
-create_serial
如果从配置中指定的文本文件读取序列失败,则指定此选项将创建一个新的随机序列作为下一个序列号。要获取随机序列号,请改用 -rand_serial 标志;这只应用于简单的错误恢复。
-
-rand_serial
生成一个大随机数作为序列号,这将取代命令行和配置文件中的序列号文件方式。
CRL OPTIONS
-
-gencrl
生成CRL基于index file中的信息.
-
-crl_lastupdate time
允许明确设置 CRL 的 lastUpdate 字段的值;如果不存在此选项,则使用当前时间。接受 YYMMDDHHMMSSZ 格式(与 ASN1 UTCTime 结构相同)或 YYYYMMDDHHMMSSZ 格式(与 ASN1 GeneralizedTime 结构相同)的时间。
-
-crl_nextupdate time
允许明确设置 CRL 的 nextUpdate 字段的值;如果存在此选项,则将忽略为 -crldays、-crlhours 和 -crlsec 给出的任何值。接受与 -crl_lastupdate 相同格式的时间。
-
-crldays num
The number of days before the next CRL is due. That is the days from now to place in the CRL nextUpdate field.
下一个 CRL 到期前的天数。即从现在起到 CRL nextUpdate 字段的天数。 -
-crlhours num
The number of hours before the next CRL is due.
-
-crlsec num
The number of seconds before the next CRL is due.
-
-revoke filename
包含要撤销的证书的文件名。.
-
-valid filename
包含证书的文件名,用于添加有效证书(即当前生效的证书)条目。
-
-status serial
显示具有指定序列号的证书的撤销状态并退出。
-
-updatedb
更新数据库索引以清除过期的证书。
-
-crl_reason reason
撤销原因,其中原因为以下之一:未指定、keyCompromise、CACompromise、affiliationChanged、superseded、cessationOfOperation、certificateHold 或 removeFromCRL。原因匹配不区分大小写。设置任何撤销原因都将使 CRL 成为 v2。
实际上,removeFromCRL 并不是特别有用,因为它仅用于当前尚未实现的delta CRLs(增量CRLs)。 -
-crl_hold instruction
CRL revocation reason code设置为 certificateHold时设置这一项,其值为 OID。虽然可以使用任何 OID,但通常只使用 holdInstructionNone(RFC2459 不鼓励使用), holdInstructionCallIssuer 或 holdInstructionReject。
-
-crl_compromise time
CRL revocation reason code设置为 keyCompromise 时设置这一项,并将compromise time设置为time指定的值。时间应采用 GeneralizedTime 格式,即 YYYYMMDDHHMMSSZ。
-
-crl_CA_compromise time
CRL revocation reason code设置为 CACompromise 时设置这一项,格式与 crl_compromise 相同。
-
-crlexts section
配置文件中包含CRL扩展的section,如果没有CRL扩展section指定会使用V1版本的CRL,如果指定CRL扩展 section ,使用V2版本的CRL。指定的 CRL 扩展是 CRL 扩展,而不是 CRL entry扩展。应该注意的是,某些软件(例如 Netscape)无法处理 V2 CRL。有关扩展部分格式的详细信息,请参阅 x509v3_config(5) 手册页。
crl Extensions是X.509 V3版本增加的内容,是CRL证书的扩展字段,与普通证书x509v3扩展的格式是一样的。
CONFIGURATION FILE OPTIONS
The section of the configuration file containing options for this command is found as follows: If the -name command line option is used, then it names the section to be used. Otherwise the section to be used must be named in the default_ca option of the ca section of the configuration file (or in the default section of the configuration file). Besides default_ca, the following options are read directly from the ca section: RANDFILE preserve msie_hack With the exception of RANDFILE, this is probably a bug and may change in future releases.
寻找配置文件中section的方式如下:如果使用 -name 命令行选项,则它指定的section会被使用。否则,必须在配置文件的 ca section(或在配置文件的 default section中)的名为default_ca 选项中指定使用的section。除了 default_ca,以下选项直接从 ca 部分读取:RANDFILE preserve msie_hack 除 RANDFILE 外,这大概是一个bug,可能会在将来的版本中更改。(不知道这里说的所有3选项都是bug,还是RANDFILE以外的是bug)
许多配置文件选项与命令行选项相同。如果选项存在于配置文件和命令行中,则使用命令行值。如果选项被描述为必需的,则它必须存在于配置文件或使用的命令行等效项(如果有)中。
- -oid_file
这指定了一个包含附加OBJECT IDENTIFIERS的文件。文件的每一行都应由对象标识符的numerical,后跟空格,然后是短名称,后跟空格,最后是长名称的形式组成。
-
oid_section
这指定配置文件中包含object identifier的section。每行应由object identifier的短名称后跟 = 和numerical组成。使用此选项时,短名称和长名称相同。
其实 = 后跟 长名称 然后是 逗号,最后是oid的数字表示。可以参考openssl config部分的文档。
例如:[oids] shortName = a very long OID name, 1.2.3.4 newoid1 = 1.2.3.4.1 some_other_oid = 1.2.3.5
- new_certs_dir
与 -outdir 命令行选项相同。它指定放置新证书的目录。必填。
-
certificate
与 -cert 选项相同。它提供包含 CA 证书的文件。必需。
-
private_key
与 -keyfile 选项相同。包含 CA 私钥的文件。必需。
-
RANDFILE
openssl启动时,指定的文件将被加载到随机数生成器中,退出时将向其中写入 256 个字节。
-
default_days
The same as the -days option. The number of days from today to certify a certificate for.
-
default_startdate
The same as the -startdate option. The start date to certify a certificate for. If not set the current time is used.
-
default_enddate
The same as the -enddate option. Either this option or default_days (or the command line equivalents) must be present.
-
default_crl_hours default_crl_days
The same as the -crlhours and the -crldays options. These will only be used if neither command line option is present. At least one of these must be present to generate a CRL.
-
default_md
The same as the -md option. Mandatory except where the signing algorithm does not require a digest (i.e. Ed25519 and Ed448).
-
database
要使用的text database文件。必需。此文件必须存在,尽管最初它是空的。
-
unique_subject
如果指定值为 yes,则数据库中的有效证书必须具有唯一的subject。如果指定值为 no,则多个有效证书可能具有完全相同的subject。默认值为 yes,以与旧版本(0.9.8 之前)的 OpenSSL 兼容。但是,为了使 CA 证书更易于更新,建议使用值 no,尤其是与 -selfsign 命令行选项结合使用时。
请注意,在某些情况下,创建没有任何subject的证书是有效的。如果有多个证书没有主题,则这不算重复。 -
serial
包含下一个要使用的十六进制序列号的文本文件。必需。此文件必须存在且包含有效序列号。
-
crlnumber
包含下一个要使用的 CRL number(十六进制)的文本文件。仅当此文件存在时,才会将 CRL number插入到 CRL 中。如果此文件存在,则它必须包含有效的 CRL number。
CRL number是CRLExtension中的字段 -
x509_extensions
A fallback to the -extensions option.
-
crl_extensions
A fallback to the -crlexts option.
-
preserve
The same as -preserveDN
-
email_in_dn
The same as -noemailDN. If you want the EMAIL field to be removed from the DN of the certificate simply set this to ‘no’. If not present the default is to allow for the EMAIL filed in the certificate’s DN.
-
msie_hack
The same as -msie_hack
-
policy
The same as -policy. Mandatory. See the POLICY FORMAT section for more information.
-
name_opt, cert_opt
这些选项允许指定用户确认签名时显示证书详细信息的格式。openssl x509命令中 -nameopt 和 -certopt 开关支持的所有选项都可以在这里使用,但 no_signame 和 no_sigdump 除外,它们是永久设置的,无法禁用(这是因为证书签名无法显示,因为此时证书尚未签名)。
为方便起见,也可以指定 ca_default 值以产生合理的输出。
如果不存在这个选项,则使用早期版本的 OpenSSL 中使用的格式。强烈建议不要使用旧格式,因为它仅显示策略部分中提到的字段,错误处理多字节字符串类型并且不显示扩展。 -
copy_extensions
Determines how extensions in certificate requests should be handled. If set to none or this option is not present then extensions are ignored and not copied to the certificate. If set to copy then any extensions present in the request that are not already present are copied to the certificate. If set to copyall then all extensions in the request are copied to the certificate: if the extension is already present in the certificate it is deleted first. See the WARNINGS section before using this option.
The main use of this option is to allow a certificate request to supply values for certain extensions such as subjectAltName.
确定如何处理证书请求中的扩展。如果设置为 none 或此选项不存在,则将忽略扩展,而不会将其复制到证书中。如果设置为 copy,则请求中存在但配置文件中不存在的任何扩展都将复制到证书中。如果设置为 copyall,则请求中的所有扩展都将复制到证书中并且会覆盖本地配置中已存在的扩展。使用此选项之前,请参阅“警告”部分。(但是英文中说的是会覆盖现有证书的中扩展,这解释不通)
此选项的主要用途是允许证书请求为某些扩展提供值,例如 subjectAltName。
POLICY FORMAT
策略section由一组与证书 DN 字段相对应的变量集组成。如果值为“match”,则字段值必须与 CA 证书中的相同字段匹配。如果值为“supplied”,则必须存在。如果值为“optional”,则可能存在。策略部分中未提及的任何字段都会被默删除,除非设置了 -preserveDN 选项,但这可以看作是一种怪癖,而不是预期的行为。
SPKAC FORMAT
-spkac filename 命令行选项的输入是 Netscape 签名的公钥和质询。这通常来自 HTML 表单中的 KEYGEN 标记,用于创建新的私钥。但是,可以使用 openssl-spkac(1) 创建 SPKAC。
该文件应包含 SPKAC 变量以及所需的 DN 组件作为name value对。如果您需要两次包含相同的组件,则可以在其前面加上数字和“.”。
处理 SPKAC 格式时,如果使用 -out 标志,则输出为 DER,但如果发送到 stdout 或使用 -outdir 标志,则输出为 PEM 格式。
文件
注意:所有文件的位置都可以通过编译时选项、配置文件条目、环境变量或命令行选项进行更改。以下值反映默认值。
/usr/local/ssl/lib/openssl.cnf – master configuration file
./demoCA – main CA directory
./demoCA/cacert.pem – CA certificate
./demoCA/private/cakey.pem – CA private key
./demoCA/serial – CA serial number file
./demoCA/serial.old – CA serial number backup file
./demoCA/index.txt – CA text database file
./demoCA/index.txt.old – CA text database backup file
./demoCA/certs – certificate output file
限制
text database索引文件是该过程的关键部分,如果损坏,则很难修复。理论上可以从所有已颁发的证书和当前 CRL 重建索引文件:但是没有选项可以这样做。
目前不支持delta CRLs 等 V2 CRL 的功能。
虽然可以一次输入和处理多个请求,但只能包含一个 SPKAC 或 自签名证书。
bug
此命令很古怪,有时甚至非常不友好。
当存在大量证书时,使用内存中的文本数据库可能会导致问题,因为顾名思义,数据库必须保存在内存中(爆内存吗)。
此命令确实需要重写或在命令或interface级别公开所需的功能,以便更用户友好的替代品可以正确处理事情。脚本 CA.pl 有一点帮助,但不是很多。但是有一些商业的CA服务工具,比如smallstep,ejbca。
请求中任何未在策略中出现的字段(DN字段)都会被默默删除。如果使用 -preserveDN 选项,则不会发生这种情况。要强制 DN 中不存在 EMAIL 字段(如 RFC 所建议的那样),无论请求主题的内容如何,都可以使用 -noemailDN 选项。这种处理方式应该更友好且可配置。
Canceling some commands by refusing to certify a certificate can create an empty file.
签署证书被拒绝而使一些命令中止会创建一个空文件
警告
此命令最初旨在作为如何在 CA 中执行操作的示例。其代码不具备生产质量。它本身不应用作完整的 CA,尽管有些人至少在内部将其用于此目的。在这样做时,应特别注意正确保护用于签署证书的私钥。建议将它们保存在安全的硬件存储中,例如智能卡或 HSM,并通过合适的引擎或加密提供程序访问它们。
此命令实际上是一个单用户命令:不会对各个文件进行锁定,并且尝试在同一数据库上运行多个 openssl ca 命令可能会产生不可预测的结果。
应谨慎使用 copy_extensions 选项。如果不小心,则可能存在安全风险。例如,如果证书请求包含带有 CA:TRUE 的 basicConstraints 扩展,并且 copy_extensions 值设置为 copyall,并且用户在显示证书时没有发现这一点,那么这将向请求者提供有效的 CA 证书。可以通过将 copy_extensions 设置为 copy 并在配置文件中包含带有 CA:FALSE 的 basicConstraints 来避免这种情况。这时,如果请求包含 basicConstraints 扩展,它将被忽略。
建议还包括其他扩展的值(例如 keyUsage),以防止请求提供自己的值。
可以对 CA 证书本身施加其他限制。例如,如果 CA 证书具有:
“`openssl cnf
basicConstraints = CA:TRUE, pathlen:0
“`
那么即使证书是用 CA:TRUE 颁发的,它也不会有效。(pathlen:0表示不允许有子CA证书)
历史
自 OpenSSL 1.1.1 起,该程序遵循 RFC5280。具体来说,如果日期早于 2049 年(含),则证书有效期(由 -startdate、-enddate 和 -days 中的任意一个指定)和 CRL 上次/下次更新时间(由 -crl_lastupdate、-crl_nextupdate、-crldays、-crlhours 和 -crlsec 中的任意一个指定)将被编码为 UTCTime,如果日期在 2050 年或之后,则将被编码为 GeneralizedTime。
OpenSSL 1.1.1 引入了一个新的随机生成器 (CSPRNG),并改进了seeding机制。新的seeding机制使得无需定义 RANDFILE 来保存和恢复随机性。保留此选项主要出于兼容性原因。
-section 选项是在 OpenSSL 3.0.0 中添加的。
-multivalue-rdn 选项在 OpenSSL 3.0.0 中已过时,并且无效。
-engine 选项在 OpenSSL 3.0 中已弃用。
自 OpenSSL 3.2 起,生成的证书带有 X.509 版本 3,并且默认包含key identifier扩展。
Views: 0