commit d171e78b4691dba2d976021faffebabc3dcefec8
author Gilles Peskine <Gilles.Peskine@arm.com> Thu Nov 15 17:46:21 2018 +0100
committer Gilles Peskine <Gilles.Peskine@arm.com> Thu Nov 15 17:48:15 2018 +0100
tree 1d9a29ab2855712698b4a73b93f06a06e4063c83
parent 6c6a023f9994ca1854cada3d51be237e57680712

Document the peer_key format for psa_key_agreement

include/psa/crypto.h

diff --git a/include/psa/crypto.h b/include/psa/crypto.h
index 6e5bbe0..a2191c6 100644
--- a/include/psa/crypto.h
+++ b/include/psa/crypto.h
@@ -3241,7 +3241,11 @@
  *                                \c PSA_CRYPTO_GENERATOR_INIT or
  *                                psa_crypto_generator_init().
  * \param private_key             Slot containing the private key to use.
- * \param[in] peer_key            Public key of the peer.
+ * \param[in] peer_key            Public key of the peer. It must be
+ *                                in the same format that psa_import_key()
+ *                                accepts. The standard formats for public
+ *                                keys are documented in the documentation
+ *                                of psa_export_public_key().
  * \param peer_key_length         Size of \p peer_key in bytes.
  * \param alg                     The key agreement algorithm to compute
  *                                (\c PSA_ALG_XXX value such that