summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/OSSL_PARAM_BLD.3ssl
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man3/OSSL_PARAM_BLD.3ssl')
-rw-r--r--upstream/debian-unstable/man3/OSSL_PARAM_BLD.3ssl19
1 files changed, 16 insertions, 3 deletions
diff --git a/upstream/debian-unstable/man3/OSSL_PARAM_BLD.3ssl b/upstream/debian-unstable/man3/OSSL_PARAM_BLD.3ssl
index 8b30b637..56095875 100644
--- a/upstream/debian-unstable/man3/OSSL_PARAM_BLD.3ssl
+++ b/upstream/debian-unstable/man3/OSSL_PARAM_BLD.3ssl
@@ -55,7 +55,7 @@
.\" ========================================================================
.\"
.IX Title "OSSL_PARAM_BLD 3SSL"
-.TH OSSL_PARAM_BLD 3SSL 2024-02-03 3.1.5 OpenSSL
+.TH OSSL_PARAM_BLD 3SSL 2024-04-04 3.2.2-dev OpenSSL
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -121,8 +121,16 @@ OSSL_PARAM objects of the specified size and correct type for the \fIval\fR
argument.
\&\fIval\fR is stored by value and an expression or auto variable can be used.
.PP
+When \fR\f(BITYPE\fR\fB\fR denotes an integer type, signed integer types will normally
+get the OSSL_PARAM type \fBOSSL_PARAM_INTEGER\fR params.
+When \fB\fR\f(BITYPE\fR\fB\fR denotes an unsigned integer type will get the OSSL_PARAM type
+\&\fBOSSL_PARAM_UNSIGNED_INTEGER\fR.
+.PP
\&\fBOSSL_PARAM_BLD_push_BN()\fR is a function that will create an OSSL_PARAM object
that holds the specified BIGNUM \fIbn\fR.
+When the \fIbn\fR is zero or positive, its OSSL_PARAM type becomes
+\&\fBOSSL_PARAM_UNSIGNED_INTEGER\fR.
+When the \fIbn\fR is negative, its OSSL_PARAM type becomes \fBOSSL_PARAM_INTEGER\fR.
If \fIbn\fR is marked as being securely allocated, its OSSL_PARAM representation
will also be securely allocated.
The \fIbn\fR argument is stored by reference and the underlying BIGNUM object
@@ -132,6 +140,9 @@ must exist until after \fBOSSL_PARAM_BLD_to_param()\fR has been called.
that holds the specified BIGNUM \fIbn\fR.
The object will be padded to occupy exactly \fIsz\fR bytes, if insufficient space
is specified an error results.
+When the \fIbn\fR is zero or positive, its OSSL_PARAM type becomes
+\&\fBOSSL_PARAM_UNSIGNED_INTEGER\fR.
+When the \fIbn\fR is negative, its OSSL_PARAM type becomes \fBOSSL_PARAM_INTEGER\fR.
If \fIbn\fR is marked as being securely allocated, its OSSL_PARAM representation
will also be securely allocated.
The \fIbn\fR argument is stored by reference and the underlying BIGNUM object
@@ -172,8 +183,10 @@ All of the OSSL_PARAM_BLD_push_TYPE functions return 1 on success and 0
on error.
.SH NOTES
.IX Header "NOTES"
-\&\fBOSSL_PARAM_BLD_push_BN()\fR and \fBOSSL_PARAM_BLD_push_BN_pad()\fR currently only
-support nonnegative \fBBIGNUM\fRs. They return an error on negative \fBBIGNUM\fRs.
+\&\fBOSSL_PARAM_BLD_push_BN()\fR and \fBOSSL_PARAM_BLD_push_BN_pad()\fR only
+support nonnegative \fBBIGNUM\fRs. They return an error on negative
+\&\fBBIGNUM\fRs.
+To pass signed \fBBIGNUM\fRs, use \fBOSSL_PARAM_BLD_push_signed_BN()\fR.
.SH EXAMPLES
.IX Header "EXAMPLES"
Both examples creating an OSSL_PARAM array that contains an RSA key.