diff options
| author | Werner Koch <wk@gnupg.org> | 2003-07-18 11:44:42 +0000 |
|---|---|---|
| committer | Werner Koch <wk@gnupg.org> | 2003-07-18 11:44:42 +0000 |
| commit | a73817c56a01b5d68e82dfa8c21cb91ab10a6fec (patch) | |
| tree | e986d21491fa6f58d8543b7c5e3017101a2c65f3 /doc | |
| parent | 42329a8b9a77cc273e3bf734aea71fba0fd8e4d7 (diff) | |
| download | libgcrypt-a73817c56a01b5d68e82dfa8c21cb91ab10a6fec.tar.gz | |
* gcrypt.texi (Misc): Add a warning on the use of opaque values.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/gcrypt.texi | 5 |
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index b9fd328c..6a5fdf1a 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2003-07-18 Werner Koch <wk@gnupg.org> + + * gcrypt.texi (Misc): Add a warning on the use of opaque values. + 2003-07-14 Moritz Schulte <moritz@g10code.com> * gcrypt.texi (Overview): Mention the non-thread-safe-nature of diff --git a/doc/gcrypt.texi b/doc/gcrypt.texi index cfd78d83..78edd668 100644 --- a/doc/gcrypt.texi +++ b/doc/gcrypt.texi @@ -3245,6 +3245,11 @@ Store @var{nbits} of the value @var{p} points to in @var{a} and mark @var{a} as an opaque value (i.e. an value that can't be used for any math calculation and is only used to store an arbitrary bit pattern in @var{a}. + +WARNING: Never use an opaque MPI for actual math operations. The only +valid fucntions are gcry_mpi_get_opaque and gcry_mpi_release. Use +gcry_mpi_scan to convert a string of arbitrary bytes into an MPI. + @end deftypefun @deftypefun {void *} gcry_mpi_get_opaque (@w{gcry_mpi_t @var{a}}, @w{unsigned int *@var{nbits}}) |