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

2003-04-25 Marcus Brinkmann <marcus@g10code.de>

Browse Source 
* gpgme.texi (Generating Keys): Fix documentation of ppublic and
	secret arguments.
This commit is contained in:
Marcus Brinkmann 2003-04-25 12:48:48 +00:00
parent 66be7f23a1
commit a6c92323b6
2 changed files with 26 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/ChangeLog
View File

@ -1,3 +1,8 @@
2003-04-25 Marcus Brinkmann <marcus@g10code.de>
* gpgme.texi (Generating Keys): Fix documentation of ppublic and
secret arguments.
2003-04-24 Marcus Brinkmann <marcus@g10code.de> 2003-04-24 Marcus Brinkmann <marcus@g10code.de>
* gpgme.texi (Generating Keys): Document changed gpgme_op_genkey * gpgme.texi (Generating Keys): Document changed gpgme_op_genkey

44
doc/gpgme.texi
View File

@ -2115,24 +2115,21 @@ The function @code{gpgme_key_release} is an alias for
@cindex key, creation @cindex key, creation
@cindex key ring, add @cindex key ring, add
@deftypefun GpgmeError gpgme_op_genkey (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{parms}}, @w{GpgmeData @var{pubkey}}, @w{GpgmeData @var{seckey}}) @deftypefun GpgmeError gpgme_op_genkey (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{parms}}, @w{GpgmeData @var{public}}, @w{GpgmeData @var{secret}})
The function @code{gpgme_op_genkey} generates a new key pair in the The function @code{gpgme_op_genkey} generates a new key pair in the
context @var{ctx} and puts it into the standard key ring if both context @var{ctx}. The meaning of @var{public} and @var{secret}
@var{pubkey} and @var{seckey} are @code{NULL}. In this case the depends on the crypto backend.
function returns immediately after starting the operation, and does
not wait for it to complete. If @var{pubkey} is not @code{NULL} it
should be the handle for an empty (newly created) data object, and
upon successful completion the data object will contain the public
key. If @var{seckey} is not @code{NULL} it should be the handle for
an empty (newly created) data object, and upon successful completion
the data object will contain the secret key.
Note that not all crypto engines support this interface equally. GnuPG does not support @var{public} and @var{secret}, they should be
GnuPG does not support @var{pubkey} and @var{subkey}, they should be @code{NULL}. GnuPG will generate a key pair and add it to the
both @code{NULL}, and the key pair will be added to the standard key standard key ring. The fingerprint of the generated key is available
ring. GpgSM only supports @var{pubkey}, the secret key will be stored with @code{gpgme_op_genkey_result}.
by @command{gpg-agent}. GpgSM expects @var{pubkey} being not
@code{NULL}. GpgSM requires @var{public} to be a writable data object. GpgSM will
generate a secret key (which will be stored by @command{gpg-agent},
and return a certificate request in @var{public}, which then needs to
be signed by the certification authority and imported before it can be
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 XML
string. The details about the format of @var{parms} are specific to string. The details about the format of @var{parms} are specific to
@ -2154,6 +2151,7 @@ Passphrase: abc
@end example @end example
Here is an example for GpgSM as the crypto engine: Here is an example for GpgSM as the crypto engine:
@example @example
<GnupgKeyParms format="internal"> <GnupgKeyParms format="internal">
Key-Type: RSA Key-Type: RSA
@ -2165,28 +2163,28 @@ Name-Email: joe@@foo.bar
Strings should be given in UTF-8 encoding. The only format supported Strings should be given in UTF-8 encoding. The only format supported
for now is ``internal''. The content of the @code{GnupgKeyParms} for now is ``internal''. The content of the @code{GnupgKeyParms}
container is passed verbatim to GnuPG. Control statements are not container is passed verbatim to the crypto backend. Control
allowed. statements are not allowed.
After the operation completed successfully, the result can be After the operation completed successfully, the result can be
retrieved with @code{gpgme_op_genkey_result}. retrieved with @code{gpgme_op_genkey_result}.
The function returns @code{GPGME_No_Error} if the operation could be The function returns @code{GPGME_No_Error} if the operation could be
started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not
a valid XML string, @code{GPGME_Not_Supported} if @var{pubkey} or a valid XML string, @code{GPGME_Not_Supported} if @var{public} or
@var{seckey} is not valid, and @code{GPGME_General_Error} if no key @var{secret} is not valid, and @code{GPGME_General_Error} if no key
was created by the backend. was created by the backend.
@end deftypefun @end deftypefun
@deftypefun GpgmeError gpgme_op_genkey_start (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{parms}}, @w{GpgmeData @var{pubkey}}, @w{GpgmeData @var{seckey}}) @deftypefun GpgmeError gpgme_op_genkey_start (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{parms}}, @w{GpgmeData @var{public}}, @w{GpgmeData @var{secret}})
The function @code{gpgme_op_genkey_start} initiates a The function @code{gpgme_op_genkey_start} initiates a
@code{gpgme_op_genkey} operation. It can be completed by calling @code{gpgme_op_genkey} operation. It can be completed by calling
@code{gpgme_wait} on the context. @xref{Waiting For Completion}. @code{gpgme_wait} on the context. @xref{Waiting For Completion}.
The function returns @code{GPGME_No_Error} if the operation could be The function returns @code{GPGME_No_Error} if the operation could be
started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not
a valid XML string, and @code{GPGME_Not_Supported} if @var{pubkey} or a valid XML string, and @code{GPGME_Not_Supported} if @var{public} or
@var{seckey} is not @code{NULL}. @var{secret} is not @code{NULL}.
@end deftypefun @end deftypefun
@deftp {Data type} {GpgmeGenKeyResult} @deftp {Data type} {GpgmeGenKeyResult}