summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorPauli <paul.dale@oracle.com>2020-04-07 15:50:02 +1000
committerPauli <paul.dale@oracle.com>2020-04-08 18:00:36 +1000
commit82e1fc1bc06a87278b2dada07e40a4296e6898c7 (patch)
tree01fb2180640953a5727a30266eda57ab7c147325 /include
parent069165d10646a22000c596095cc04d43bbf1f807 (diff)
params: add a warning about the PTR types.
The warning is deter the unsure -- if in doubt the PTR type is almost certainly NOT what you should be using. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/11480)
Diffstat (limited to 'include')
-rw-r--r--include/openssl/core.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/include/openssl/core.h b/include/openssl/core.h
index 5959a31880..e5a4b9266a 100644
--- a/include/openssl/core.h
+++ b/include/openssl/core.h
@@ -124,6 +124,9 @@ struct ossl_param_st {
*
* WARNING! Using these is FRAGILE, as it assumes that the actual
* data and its location are constant.
+ *
+ * EXTRA WARNING! If you are not completely sure you most likely want
+ * to use the OSSL_PARAM_UTF8_STRING type.
*/
# define OSSL_PARAM_UTF8_PTR 6
/*-
@@ -140,6 +143,9 @@ struct ossl_param_st {
*
* WARNING! Using these is FRAGILE, as it assumes that the actual
* data and its location are constant.
+ *
+ * EXTRA WARNING! If you are not completely sure you most likely want
+ * to use the OSSL_PARAM_OCTET_STRING type.
*/
# define OSSL_PARAM_OCTET_PTR 7