EC_POINT_is_on_curve does not return a boolean
[openssl.git] / crypto / ec / ec_lib.c
index 9156943e200a0275a6ab5d5ca07f957cb2e93087..3ddaa5d8fba016d3bb8d353adb43f22047a2e882 100644 (file)
@@ -949,6 +949,13 @@ int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *point)
     return group->meth->is_at_infinity(group, point);
 }
 
+/*
+ * Check whether an EC_POINT is on the curve or not. Note that the return
+ * value for this function should NOT be treated as a boolean. Return values:
+ *  1: The point is on the curve
+ *  0: The point is not on the curve
+ * -1: An error occurred
+ */
 int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point,
                          BN_CTX *ctx)
 {