2003-07-30 Moritz Schulte <moritz@g10code.com>
[libgcrypt.git] / README.apichanges
1 README.apichanges 2003-07-28
2
3
4 We decided to change a couple of annoying things in Libgcrypt and to
5 cleanup the API.  The new API better fits into a multi-threaded
6 environment and is more consistent.  One import change is that all
7 functions return error codes from a set of error codes shared between
8 GnuPG, GPGME and Libgcrypt.
9
10 This file contains some hints on how to port your application from
11 libgcrypt <= 1.1.12 to the current API as of 1.1.42.  We hope that
12 there won't be another need for such a major change.
13
14
15 * Types
16
17   All types definitions changed to a foo_t scheme; for some time we
18   will support the old names but you better start to rename them:
19
20   s/GCRY_MPI/gcry_mpi_t/
21   s/GcryMPI/gcry_mpi_t/
22   s/GCRY_SEXP/gcry_sexp_t/
23   s/GcrySexp/gcry_sexp_t/
24   s/GCRY_CIPHER_HD/gcry_cipher_hd_t/
25   s/GcryCipherHd/gcry_cipher_hd_t/
26   s/GCRY_MD_HD/gcry_md_hd_t/
27   s/GcryMDHd/gcry_md_hd_t/
28
29 * Initialization
30
31   For proper initialization of the library, you must call
32   gcry_check_version() before calling any other function.
33
34 * Handles
35
36   gcry_cipher_open and gcry_md_open do now return an error code
37   instead of a NULL handle; the handle is now returned by
38   asigning it to the first argument.  Example on how to change your
39   code:
40
41   Old:
42
43     hd = gcry_md_open (algo, flags);
44     if (!hd)
45       {
46          fprintf (stderr, "md_open failed: %s\n", gcry_errno (-1));
47          ....
48
49   New:
50
51     rc = gcry_md_open (&hd, algo, flags);
52     if (rc)
53       {
54          fprintf (stderr, "md_open failed: %s\n", gcry_strerror (rc));
55          ....
56
57   If you are not interested in the error code, you can do it in a
58   simplified way:
59  
60     gcry_md_open (&hd, algo, flags);
61     if (!hd)
62         abort ();
63
64   i.e. the function makes sure that HD points to NULL in case of an error.
65   The required change for gcry_cipher_open is similar.
66
67 * Message Digests
68
69   The order of the arguments to gcry_md_copy has been changed in order
70   to be more consistent with other functions of this type.  This means
71   that the new message digest handle will be a copy of the message
72   handle specified by the second argument and stored at the address
73   pointed to by the first argument.
74
75 * Error codes
76
77   gcry_errno () has been removed because it is hard to use in
78   multi-threaded environment.  You need to save the error code
79   returned by the functions and use it either numerical or passing it
80   to gcry_strerror (since gcry_strerror is a wrapper function for
81   gpg_strerror, the latter function can also be used).
82
83   Instead of using the error codes GCRYERR_*, you have to use the
84   GPG_ERR_* names.
85
86 * S-expressions
87
88   gcry_sexp_canon_len used to return a `historical' error code in
89   `errcode', this is not the case anymore; the value returned in
90   `errcode' is a simple Libgcrypt error code.
91
92 * MPI
93
94   gcry_mpi_scan and gcry_mpi_print need the size of a provided buffer
95   as input and return the number of bytes actually scanned/printed to
96   the user.  The old API used a single size_t Pointer for both tasks,
97   the new API distinguishes between the input and the output values.
98
99 * Public Key cryptography
100
101   gcry_pk_decrypt used to return a `simple S-expression part' that
102   contains a single MPI value.  In case the `data' S-expression
103   contains a `flags' element, the result S-expression is filled with a
104   complete S-expression of the following format:
105
106     (value PLAINTEXT)