Document the stability of PSA interfaces #93

New issue

Closed

opened 2019-04-12 12:42:43 -05:00 by gilles-peskine-arm · 3 comments

gilles-peskine-arm commented

2019-04-12 12:42:43 -05:00

(Migrated from github.com)

Description

As the PSA interfaces are stabilizing, we should document what we'll maintain backward compatibility for and what we won't.

Public APIs that haven't completely stabilized yet, but we'll provide a short transition period if we make changes: include/crypto/crypto.h, include/crypto/crypto_types.h, include/crypto/crypto_values.h (only the macros that have Doxygen documentation), include/crypto/crypto_extra.h. We should also note that even if the interfaces stabilize, that doesn't mean that the implementation is production-quality yet.
Internal definitions that are platform-dependent and may change without notice: include/crypto/crypto_platform.h, include/crypto/crypto_struct.h
File storage for persistent keys
Driver HAL: not stable yet.

Where to document it: in the comment at the top of each header, in README.md, in the Doxygen documentation, …

Issue request type

[ ] Question
[x] Enhancement
[ ] Bug

### Description As the PSA interfaces are stabilizing, we should document what we'll maintain backward compatibility for and what we won't. * Public APIs that haven't completely stabilized yet, but we'll provide a short transition period if we make changes: `include/crypto/crypto.h`, `include/crypto/crypto_types.h`, `include/crypto/crypto_values.h` (only the macros that have Doxygen documentation), `include/crypto/crypto_extra.h`. We should also note that even if the interfaces stabilize, that doesn't mean that the implementation is production-quality yet. * Internal definitions that are platform-dependent and may change without notice: `include/crypto/crypto_platform.h`, `include/crypto/crypto_struct.h` * File storage for persistent keys * Driver HAL: not stable yet. Where to document it: in the comment at the top of each header, in `README.md`, in the Doxygen documentation, … ### Issue request type [ ] Question [x] Enhancement [ ] Bug

ciarmcom commented

2019-04-12 15:45:58 -05:00

(Migrated from github.com)