curl/docs/cmdline-opts/key.d

Long: key
Arg: <key>
Protocols: TLS SSH
Help: Private key file name
Category: tls ssh
---
Private key file name. Allows you to provide your private key in this separate
file. For SSH, if not specified, curl tries the following candidates in order:
\&'~/.ssh/id_rsa', '~/.ssh/id_dsa', './id_rsa', './id_dsa'.

If curl is built against OpenSSL library, and the engine pkcs11 is available,
then a PKCS#11 URI (RFC 7512) can be used to specify a private key located in a
PKCS#11 device. A string beginning with "pkcs11:" will be interpreted as a
PKCS#11 URI. If a PKCS#11 URI is provided, then the --engine option will be set
as "pkcs11" if none was provided and the --key-type option will be set as
"ENG" if none was provided.

If this option is used several times, the last one will be used.
cmdline-docs: more options converted over 2016-11-15 17:44:58 -05:00			`Long: key`
			`Arg: <key>`
			`Protocols: TLS SSH`
			`Help: Private key file name`
docs: add categories to all cmdline opts Adapted gen.pl with 'listcats' This commit is a part of "--help me if you can" Closes #5680 2020-07-13 08:15:04 -04:00			`Category: tls ssh`
cmdline-docs: more options converted over 2016-11-15 17:44:58 -05:00			`---`
			`Private key file name. Allows you to provide your private key in this separate`
			`file. For SSH, if not specified, curl tries the following candidates in order:`
docs: Fix missing lines caused by undefined macros - Escape apostrophes at line start. Some lines begin with a "'" (apostrophe, single quote), which is then interpreted as a control character in *roff. Such lines are interpreted as being a call to a macro, and if undefined, the lines are removed from the output. Bug: https://bugs.debian.org/926352 Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is> Submitted-by: Alessandro Ghedini Closes https://github.com/curl/curl/pull/4111 2019-04-02 17:55:11 -04:00			`\&'~/.ssh/id_rsa', '~/.ssh/id_dsa', './id_rsa', './id_dsa'.`
cmdline-docs: more options converted over 2016-11-15 17:44:58 -05:00
ssl: set engine implicitly when a PKCS#11 URI is provided This allows the use of PKCS#11 URI for certificates and keys without setting the corresponding type as "ENG" and the engine as "pkcs11" explicitly. If a PKCS#11 URI is provided for certificate, key, proxy_certificate or proxy_key, the corresponding type is set as "ENG" if not provided and the engine is set to "pkcs11" if not provided. Acked-by: Nikos Mavrogiannopoulos Closes #2333 2018-02-19 08:31:06 -05:00			`If curl is built against OpenSSL library, and the engine pkcs11 is available,`
			`then a PKCS#11 URI (RFC 7512) can be used to specify a private key located in a`
			`PKCS#11 device. A string beginning with "pkcs11:" will be interpreted as a`
			`PKCS#11 URI. If a PKCS#11 URI is provided, then the --engine option will be set`
			`as "pkcs11" if none was provided and the --key-type option will be set as`
			`"ENG" if none was provided.`

cmdline-docs: more options converted over 2016-11-15 17:44:58 -05:00			`If this option is used several times, the last one will be used.`