已弃用: 不再推荐使用该特性。虽然一些浏览器仍然支持它,但也许已从相关的 web 标准中移除,也许正准备移除或出于兼容性而保留。请尽量不要使用该特性,并更新现有的代码;参见本页面底部的兼容性表格以指导你作出决定。请注意,该特性随时可能无法正常工作。

HTML <keygen> 元素是为了方便生成密钥材料和提交作为 HTML form 的一部分的公钥。这种机制被用于设计基于 Web 的证书管理系统。按照预想,<keygen> 元素将用于 HTML 表单与其他的所需信息一起构造一个证书请求,该处理的结果将是一个带有签名的证书。

备注: There is currently discussion among Web browser makers whether to keep this feature or not. Until a decision is reached, it is better to continue to consider this feature as deprecated and going away.

Content categories (en-US) Flow content (en-US), phrasing content (en-US), interactive content, listed (en-US), labelable (en-US), submittable (en-US), resettable (en-US) form-associated element (en-US), palpable content.
Permitted content None, it is an empty element.
Tag omission Must have a start tag and must not have an end tag.
Permitted parent elements Any element that accepts phrasing content (en-US).
DOM interface HTMLKeygenElement


This element includes the global attributes (en-US).


This Boolean attribute lets you specify that the control should have input focus when the page loads, unless the user overrides it, for example by typing in a different control. Only one form element in a document can have the autofocus attribute, which is a Boolean.


A challenge string that is submitted along with the public key. Defaults to an empty string if not specified.


This Boolean attribute indicates that the form control is not available for interaction.


The form element that this element is associated with (its form owner). The value of the attribute must be an id of a <form> element in the same document. If this attribute is not specified, this element must be a descendant of a <form> element. This attribute enables you to place <keygen> elements anywhere within a document, not just as descendants of their form elements.


The type of key generated. The default value is RSA.


The name of the control, which is submitted with the form data.

The element is written as follows:

<keygen name="name" challenge="challenge string" keytype="type" keyparams="pqg-params">

The keytype parameter is used to specify what type of key is to be generated. Valid values are "RSA", which is the default, "DSA" and "EC". The name and challenge attributes are required in all cases. The keytype attribute is optional for RSA key generation and required for DSA and EC key generation. The keyparams attribute is required for DSA and EC key generation and ignored for RSA key generation. PQG is a synonym for keyparams. That is, you may specify keyparams="pqg-params" or pqg="pqg-params".

For RSA keys, the keyparams parameter is not used (ignored if present). The user may be given a choice of RSA key strengths. Currently, the user is given a choice between "high" strength (2048 bits) and "medium" strength (1024 bits).

For DSA keys, the keyparams parameter specifies the DSA PQG parameters which are to be used in the keygen process. The value of the pqg parameter is the the BASE64 encoded, DER encoded Dss-Parms as specified in IETF RFC 3279. The user may be given a choice of DSA key sizes, allowing the user to choose one of the sizes defined in the DSA standard.

For EC keys, the keyparams parameter specifies the name of the elliptic curve on which the key will be generated. It is normally a string from the table in nsKeygenHandler.cpp. (Note that only a subset of the curves named there may actually be supported in any particular browser.) If the keyparams parameter string is not a recognized curve name string, then a curve is chosen according to the user's chosen key strength (low, medium, high), using the curve named "secp384r1" for high, and the curve named "secp256r1" for medium keys. (Note: choice of the number of key strengths, default values for each strength, and the UI by which the user is offered a choice, are outside of the scope of this specification.)

The <keygen> element is only valid within an HTML form. It will cause some sort of selection to be presented to the user for selecting key size. The UI for the selection may be a menu, radio buttons, or possibly something else. The browser presents several possible key strengths. Currently, two strengths are offered, high and medium. If the user's browser is configured to support cryptographic hardware (e.g. "smart cards") the user may also be given a choice of where to generate the key, i.e., in a smart card or in software and stored on disk.

When the submit button is pressed, a key pair of the selected size is generated. The private key is encrypted and stored in the local key database.

   PublicKeyAndChallenge ::= SEQUENCE {
       spki SubjectPublicKeyInfo,
       challenge IA5STRING
   SignedPublicKeyAndChallenge ::= SEQUENCE {
       publicKeyAndChallenge PublicKeyAndChallenge,
       signatureAlgorithm AlgorithmIdentifier,
       signature BIT STRING

The public key and challenge string are DER encoded as PublicKeyAndChallenge, and then digitally signed with the private key to produce a SignedPublicKeyAndChallenge. The SignedPublicKeyAndChallenge is Base64 encoded, and the ASCII data is finally submitted to the server as the value of a form name/value pair, where the name is name as specified by the name attribute of the keygen element. If no challenge string is provided, then it will be encoded as an IA5STRING of length zero.

Here is an example form submission as it would be delivered to a CGI program by the HTTP server:





Browser compatibility

BCD tables only load in the browser