[svn] gcry - r1143 - trunk/doc
svn author mo
cvs at cvs.gnupg.org
Sun Jan 8 03:10:46 CET 2006
Author: mo
Date: 2006-01-08 03:10:46 +0100 (Sun, 08 Jan 2006)
New Revision: 1143
Modified:
trunk/doc/ChangeLog
trunk/doc/gcrypt.texi
Log:
2006-01-08 Moritz Schulte <moritz at g10code.com>
* gcrypt.texi: Added documentation for more gcry_control commands.
* gcrypt.texi: Fixed several typos; thanks to Tommi Vainikainen.
2005-12-16 Moritz Schulte <moritz at g10code.com>
* gcrypt.texi (MPI formats): Fix return types of functions:
gcry_mpi_scan, gcry_mpi_print, gcry_mpi_aprint.
Modified: trunk/doc/ChangeLog
===================================================================
--- trunk/doc/ChangeLog 2005-12-08 15:34:16 UTC (rev 1142)
+++ trunk/doc/ChangeLog 2006-01-08 02:10:46 UTC (rev 1143)
@@ -1,3 +1,14 @@
+2006-01-08 Moritz Schulte <moritz at g10code.com>
+
+ * gcrypt.texi: Added documentation for more gcry_control commands.
+
+ * gcrypt.texi: Fixed several typos; thanks to Tommi Vainikainen.
+
+2005-12-16 Moritz Schulte <moritz at g10code.com>
+
+ * gcrypt.texi (MPI formats): Fix return types of functions:
+ gcry_mpi_scan, gcry_mpi_print, gcry_mpi_aprint.
+
2005-11-26 Moritz Schulte <moritz at g10code.com>
* gcrypt.texi: New chapter: Prime numbers.
Modified: trunk/doc/gcrypt.texi
===================================================================
--- trunk/doc/gcrypt.texi 2005-12-08 15:34:16 UTC (rev 1142)
+++ trunk/doc/gcrypt.texi 2006-01-08 02:10:46 UTC (rev 1143)
@@ -531,17 +531,40 @@
@item GCRYCTL_DISABLE_SECMEM_WARN
@item GCRYCTL_SUSPEND_SECMEM_WARN
@item GCRYCTL_RESUME_SECMEM_WARN
- at item GCRYCTL_USE_SECURE_RNDPOOL
- at item GCRYCTL_SET_RANDOM_SEED_FILE
- at item GCRYCTL_UPDATE_RANDOM_SEED_FILE
+
+ at item GCRYCTL_USE_SECURE_RNDPOOL; Arguments: none
+
+This command tells the PRNG to store random numbers in secure memory.
+FIXME: what about initialization time?
+
+ at item GCRYCTL_SET_RANDOM_SEED_FILE; Arguments: const char *filename
+
+This command specifies the file, which is to be used as seed file for
+the PRNG. If the seed file is registered prior to initialization of the
+PRNG, the seed file's content (if it exists and seems to be valid) is
+feed into the PRNG pool. After the seed file has been registered, the
+PRNG can be signalled to write out the PRNG pool's content into the seed
+file with the following command.
+
+ at item GCRYCTL_UPDATE_RANDOM_SEED_FILE; Arguments: none
+
+Write out the PRNG pool's content into the registered seed file.
+
@item GCRYCTL_SET_VERBOSITY
+
+
@item GCRYCTL_SET_DEBUG_FLAGS
@item GCRYCTL_CLEAR_DEBUG_FLAGS
@item GCRYCTL_DISABLE_INTERNAL_LOCKING
@item GCRYCTL_ANY_INITIALIZATION_P
@item GCRYCTL_INITIALIZATION_FINISHED_P
@item GCRYCTL_INITIALIZATION_FINISHED
- at item GCRYCTL_SET_THREAD_CBS
+
+ at item GCRYCTL_SET_THREAD_CBS; Arguments: struct ath_ops *ath_ops
+
+This command registers a thread-callback structure. See section ``multi
+threading'' for more information on this command.
+
@item GCRYCTL_FAST_POOL
@end table
@@ -1137,7 +1160,7 @@
AES (Rijndael) with a 128 bit key.
@item GCRY_CIPHER_AES192
- at itemx GCRY_CIPHER_RIJNDAEL128
+ at itemx GCRY_CIPHER_RIJNDAEL192
AES (Rijndael) with a 192 bit key.
@item GCRY_CIPHER_AES256
@@ -1418,7 +1441,7 @@
@var{inlen} is @code{0}, in-place encryption of the data in @var{out} or
length @var{outsize} takes place. With @var{in} being not @code{NULL},
@var{inlen} bytes are encrypted to the buffer @var{out} which must have
-at least a size of @var{inlen}. @var{outlen} must be set to the
+at least a size of @var{inlen}. @var{outsize} must be set to the
allocated size of @var{out}, so that the function can check that there
is sufficient space. Note, that overlapping buffers are not allowed.
@@ -1438,7 +1461,7 @@
@var{inlen} is @code{0}, in-place decryption of the data in @var{out} or
length @var{outsize} takes place. With @var{in} being not @code{NULL},
@var{inlen} bytes are decrypted to the buffer @var{out} which must have
-at least a size of @var{inlen}. @var{outlen} must be set to the
+at least a size of @var{inlen}. @var{outsize} must be set to the
allocated size of @var{out}, so that the function can check that there
is sufficient space. Note, that overlapping buffers are not allowed.
@@ -3022,7 +3045,7 @@
@example
@{
gcry_ac_key_pair_t key_pair;
- gcry_ac_key_spec_rsa rsa_spec;
+ gcry_ac_key_spec_rsa_t rsa_spec;
rsa_spec.e = gcry_mpi_new (0);
gcry_mpi_set_ui (rsa_spec.e, 1)
@@ -3091,7 +3114,7 @@
are then forwared to the cryptographic primitives. Since schemes are
to be used for a special purpose in order to achieve a particular
security goal, there exist ``encryption schemes'' and ``signature
-schemes''. Encoding methods can be used seperately or implicitely
+schemes''. Encoding methods can be used seperately or implicitly
through schemes.
What follows is a description of the cryptographic primitives.
@@ -3390,8 +3413,8 @@
The next argument is expected to be of type @code{char *} and that
string is inserted into the resulting S-expression.
@item %d
-The next argument is expected to be of type @code{int} and its
-value ist inserted into the resulting S-expression.
+The next argument is expected to be of type @code{int} and its value is
+inserted into the resulting S-expression.
@item %b
The next argument is expected to be of type @code{int} directly
followed by an argument of type @code{char *}. This represents a
@@ -3649,7 +3672,7 @@
The following functions are used to convert between an external
representation of an MPI and the internal one of @acronym{Libgcrypt}.
- at deftypefun int gcry_mpi_scan (@w{gcry_mpi_t *@var{r_mpi}}, @w{enum gcry_mpi_format @var{format}}, @w{const unsigned char *@var{buffer}}, @w{size_t @var{buflen}}, @w{size_t *@var{nscanned}})
+ at deftypefun gcry_error_t gcry_mpi_scan (@w{gcry_mpi_t *@var{r_mpi}}, @w{enum gcry_mpi_format @var{format}}, @w{const unsigned char *@var{buffer}}, @w{size_t @var{buflen}}, @w{size_t *@var{nscanned}})
Convert the external representation of an integer stored in @var{buffer}
with a length of @var{buflen} into a newly created MPI returned which
@@ -3686,7 +3709,7 @@
@end deftypefun
- at deftypefun int gcry_mpi_print (@w{enum gcry_mpi_format @var{format}}, @w{unsigned char *@var{buffer}}, @w{size_t @var{buflen}}, @w{size_t *@var{nwritten}}, @w{const gcry_mpi_t @var{a}})
+ at deftypefun gcry_error_t gcry_mpi_print (@w{enum gcry_mpi_format @var{format}}, @w{unsigned char *@var{buffer}}, @w{size_t @var{buflen}}, @w{size_t *@var{nwritten}}, @w{const gcry_mpi_t @var{a}})
Convert the MPI @var{a} into an external representation described by
@var{format} (see above) and store it in the provided @var{buffer}
@@ -3695,7 +3718,7 @@
actually stored in @var{buffer} after a successful operation.
@end deftypefun
- at deftypefun int gcry_mpi_aprint (@w{enum gcry_mpi_format @var{format}}, @w{unsigned char **@var{buffer}}, @w{size_t *@var{nbytes}}, @w{const gcry_mpi_t @var{a}})
+ at deftypefun gcry_error_t gcry_mpi_aprint (@w{enum gcry_mpi_format @var{format}}, @w{unsigned char **@var{buffer}}, @w{size_t *@var{nbytes}}, @w{const gcry_mpi_t @var{a}})
Convert the MPI @var{a} into an external representation described by
@var{format} (see above) and store it in a newly allocated buffer which
More information about the Gnupg-commits
mailing list