blob: 6ca097af3ab0bdc15eeabf0411364e2d27c6e022 [file] [log] [blame] [view]
Gilles Peskine2c770142025-06-25 15:39:10 +02001## Private declarations
2
3Sample programs have not been fully updated yet and some of them might still
4use APIs that are no longer public. You can recognize them by the fact that they
5define the macro `MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS` (or
6`MBEDTLS_ALLOW_PRIVATE_ACCESS`) at the very top (before including headers). When
7you see one of these two macros in a sample program, be aware it has not been
8updated and parts of it do not demonstrate current practice.
9
10We strongly recommend against defining `MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS` or
11`MBEDTLS_ALLOW_PRIVATE_ACCESS` in your own application. If you do so, your code
12may not compile or work with future minor releases. If there's something you
13want to do that you feel can only be achieved by using one of these two macros,
14please reach out on github or the mailing list.