Document that o2i_SCT_signature can leave the SCT in an inconsistent state

Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>

diff --git a/crypto/ct/ct_locl.h b/crypto/ct/ct_locl.h
index b65df5a57d8ad552052d107662eb47589ff08ee5..7adc4961b3cf9b0feb21c608cb1d9b16531c7e39 100644 (file)
--- a/crypto/ct/ct_locl.h
+++ b/crypto/ct/ct_locl.h
@@ -192,6 +192,8 @@ __owur int i2o_SCT_signature(const SCT *sct, unsigned char **out);
 * |in| will be advanced to the end of the signature if parsing succeeds.
 * |len| should be the length of the signature in |in|.
 * Returns the number of bytes parsed, or a negative integer if an error occurs.
 * |in| will be advanced to the end of the signature if parsing succeeds.
 * |len| should be the length of the signature in |in|.
 * Returns the number of bytes parsed, or a negative integer if an error occurs.

+* If an error occurs, the SCT's signature NID may be updated whilst the
+* signature field itself remains unset.

 */
 __owur int o2i_SCT_signature(SCT *sct, const unsigned char **in, size_t len);
 
 */
 __owur int o2i_SCT_signature(SCT *sct, const unsigned char **in, size_t len);