2006-01-08 Moritz Schulte <moritz@g10code.com>
authorMoritz Schulte <mo@g10code.com>
Sun, 8 Jan 2006 02:10:46 +0000 (02:10 +0000)
committerMoritz Schulte <mo@g10code.com>
Sun, 8 Jan 2006 02:10:46 +0000 (02:10 +0000)
* gcrypt.texi: Added documentation for more gcry_control commands.

* gcrypt.texi: Fixed several typos; thanks to Tommi Vainikainen.

2005-12-16  Moritz Schulte  <moritz@g10code.com>

* gcrypt.texi (MPI formats): Fix return types of functions:
gcry_mpi_scan, gcry_mpi_print, gcry_mpi_aprint.

doc/ChangeLog
doc/gcrypt.texi

index 8656217..797396d 100644 (file)
@@ -1,3 +1,14 @@
+2006-01-08  Moritz Schulte  <moritz@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@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@g10code.com>
 
        * gcrypt.texi: New chapter: Prime numbers.
index e194bd4..907f7bb 100644 (file)
@@ -531,17 +531,40 @@ This command disables the use of secure memory.  FIXME.
 @item GCRYCTL_DISABLE_SECMEM_WARN
 @item GCRYCTL_SUSPEND_SECMEM_WARN
 @item GCRYCTL_RESUME_SECMEM_WARN
-@item GCRYCTL_USE_SECURE_RNDPOOL
-@item GCRYCTL_SET_RANDOM_SEED_FILE
-@item GCRYCTL_UPDATE_RANDOM_SEED_FILE
+
+@item GCRYCTL_USE_SECURE_RNDPOOL; Arguments: none
+
+This command tells the PRNG to store random numbers in secure memory.
+FIXME: what about initialization time?
+
+@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.
+
+@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
-@item GCRYCTL_SET_THREAD_CBS
+
+@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 @@ Reserved and not currently implemented.
 AES (Rijndael) with a 128 bit key.
 
 @item  GCRY_CIPHER_AES192     
-@itemx GCRY_CIPHER_RIJNDAEL128
+@itemx GCRY_CIPHER_RIJNDAEL192
 AES (Rijndael) with a 192 bit key.
 
 @item  GCRY_CIPHER_AES256 
@@ -1418,7 +1441,7 @@ ways to use the function: If @var{in} is passed as @code{NULL} and
 @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 @@ ways to use the function: If @var{in} is passed as @code{NULL} and
 @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 code:
 @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 @@ responsible for converting the provided octet strings into MPIs, which
 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 @@ its value is inserted into the resulting S-expression.
 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 @@ Swap the values of @var{a} and @var{b}.
 The following functions are used to convert between an external
 representation of an MPI and the internal one of @acronym{Libgcrypt}.
 
-@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}})
+@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 @@ format (MSB first).
 @end deftypefun
 
 
-@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}})
+@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 @@ which has a usable length of at least the @var{buflen} bytes. If
 actually stored in @var{buffer} after a successful operation.
 @end deftypefun
 
-@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}})
+@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