GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Document that gpgme_op_genkey() parms parameter is not XML.

Browse Source 
* doc/gpgme.texi (GnupgKeyParms): document that input format is not
true XML.

--

Please see discussion at
https://lists.gnupg.org/pipermail/gnupg-devel/2017-January/032507.html

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
This commit is contained in:
Daniel Kahn Gillmor 2017-01-26 18:36:39 -05:00
parent 51bd69f216
commit ad22bee538
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/gpgme.texi
View File

@ -3874,11 +3874,18 @@ and return a certificate request in @var{public}, which then needs to
be signed by the certification authority and imported before it can be be signed by the certification authority and imported before it can be
used. GpgSM does not make the fingerprint available. used. GpgSM does not make the fingerprint available.
The argument @var{parms} specifies parameters for the key in an XML The argument @var{parms} specifies parameters for the key in an string
string. The details about the format of @var{parms} are specific to that looks something like XML. The details about the format of
the crypto engine used by @var{ctx}. Here is an example for GnuPG as @var{parms} are specific to the crypto engine used by @var{ctx}. The
the crypto engine (all parameters of OpenPGP key generation are first line of the parameters must be @code{<GnupgKeyParams
documented in the GPG manual): format="internal">} and the last line must be
@code{</GnupgKeyParams>}. Every line in between the first and last
lines is treated as a Header: Value pair. In particular, no XML
escaping is necessary if you need to include the characters @code{<},
@code{>}, or @code{&}.
Here is an example for GnuPG as the crypto engine (all parameters of
OpenPGP key generation are documented in the GPG manual):
@example @example
<GnupgKeyParms format="internal"> <GnupgKeyParms format="internal">
@ -3914,9 +3921,10 @@ retrieved with @code{gpgme_op_genkey_result}.
The function returns the error code @code{GPG_ERR_NO_ERROR} if the The function returns the error code @code{GPG_ERR_NO_ERROR} if the
operation could be started successfully, @code{GPG_ERR_INV_VALUE} if operation could be started successfully, @code{GPG_ERR_INV_VALUE} if
@var{parms} is not a valid XML string, @code{GPG_ERR_NOT_SUPPORTED} if @var{parms} is not a well-formed string (e.g. does not have the
@var{public} or @var{secret} is not valid, and @code{GPG_ERR_GENERAL} expected tag-like headers and footers), @code{GPG_ERR_NOT_SUPPORTED}
if no key was created by the backend. if @var{public} or @var{secret} is not valid, and
@code{GPG_ERR_GENERAL} if no key was created by the backend.
@end deftypefun @end deftypefun
@deftypefun gpgme_error_t gpgme_op_genkey_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{parms}}, @w{gpgme_data_t @var{public}}, @w{gpgme_data_t @var{secret}}) @deftypefun gpgme_error_t gpgme_op_genkey_start (@w{gpgme_ctx_t @var{ctx}}, @w{const char *@var{parms}}, @w{gpgme_data_t @var{public}}, @w{gpgme_data_t @var{secret}})