2003-08-08 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 except for a
33   these gcry_control operations:
34      GCRYCTL_SUSPEND_SECMEM_WARN
35      GCRYCTL_DISABLE_INTERNAL_LOCKING
36
37
38 * Handles
39
40   gcry_cipher_open and gcry_md_open do now return an error code
41   instead of a NULL handle; the handle is now returned by
42   asigning it to the first argument.  Example on how to change your
43   code:
44
45   Old:
46
47     hd = gcry_md_open (algo, flags);
48     if (!hd)
49       {
50          fprintf (stderr, "md_open failed: %s\n", gcry_errno (-1));
51          ....
52
53   New:
54
55     rc = gcry_md_open (&hd, algo, flags);
56     if (rc)
57       {
58          fprintf (stderr, "md_open failed: %s\n", gcry_strerror (rc));
59          ....
60
61   If you are not interested in the error code, you can do it in a
62   simplified way:
63  
64     gcry_md_open (&hd, algo, flags);
65     if (!hd)
66         abort ();
67
68   i.e. the function makes sure that HD points to NULL in case of an error.
69   The required change for gcry_cipher_open is similar.
70
71 * Message Digests
72
73   The order of the arguments to gcry_md_copy has been changed in order
74   to be more consistent with other functions of this type.  This means
75   that the new message digest handle will be a copy of the message
76   handle specified by the second argument and stored at the address
77   pointed to by the first argument.
78
79 * Error codes
80
81   gcry_errno () has been removed because it is hard to use in
82   multi-threaded environment.  You need to save the error code
83   returned by the functions and use it either numerical or passing it
84   to gcry_strerror (since gcry_strerror is a wrapper function for
85   gpg_strerror, the latter function can also be used).
86
87   Instead of using the error codes GCRYERR_*, you have to use the
88   GPG_ERR_* names. 
89
90 * S-expressions
91
92   gcry_sexp_canon_len used to return a `historical' error code in
93   `errcode', this is not the case anymore; the value returned in
94   `errcode' is now a standard Libgcrypt (i.e. gpg-error) error code.
95
96 * MPI
97
98   gcry_mpi_scan and gcry_mpi_print need the size of a provided buffer
99   as input and return the number of bytes actually scanned/printed to
100   the user.  The old API used a single size_t Pointer for both tasks,
101   the new API distinguishes between the input and the output values.
102
103 * Public Key cryptography
104
105   gcry_pk_decrypt used to return a `simple S-expression part' that
106   contains a single MPI value.  In case the `data' S-expression
107   contains a `flags' element, the result S-expression is filled with a
108   complete S-expression of the following format:
109
110     (value PLAINTEXT)
111