diff options
| author | tb <> | 2023-04-25 17:23:08 +0000 |
|---|---|---|
| committer | tb <> | 2023-04-25 17:23:08 +0000 |
| commit | 654be25edbd733f47d6293cd28d93b9ab7b49954 (patch) | |
| tree | 42d93bd83bedcfb3d9889addde20656edb8e10a6 /src/lib/libcrypto/man | |
| parent | 294313b17b59243c43003e0e6aeb1aa5cbb0a3c4 (diff) | |
| download | openbsd-654be25edbd733f47d6293cd28d93b9ab7b49954.tar.gz openbsd-654be25edbd733f47d6293cd28d93b9ab7b49954.tar.bz2 openbsd-654be25edbd733f47d6293cd28d93b9ab7b49954.zip | |
Remove BN_init() documentation
Diffstat (limited to 'src/lib/libcrypto/man')
| -rw-r--r-- | src/lib/libcrypto/man/BN_new.3 | 42 |
1 files changed, 2 insertions, 40 deletions
diff --git a/src/lib/libcrypto/man/BN_new.3 b/src/lib/libcrypto/man/BN_new.3 index 7e3432770f..94b1884817 100644 --- a/src/lib/libcrypto/man/BN_new.3 +++ b/src/lib/libcrypto/man/BN_new.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: BN_new.3,v 1.22 2022/11/21 22:04:04 schwarze Exp $ | 1 | .\" $OpenBSD: BN_new.3,v 1.23 2023/04/25 17:23:08 tb Exp $ |
| 2 | .\" full merge up to: OpenSSL man3/BN_new 2457c19d Mar 6 08:43:36 2004 +0000 | 2 | .\" full merge up to: OpenSSL man3/BN_new 2457c19d Mar 6 08:43:36 2004 +0000 |
| 3 | .\" selective merge up to: man3/BN_new 681acb31 Sep 29 13:10:34 2017 +0200 | 3 | .\" selective merge up to: man3/BN_new 681acb31 Sep 29 13:10:34 2017 +0200 |
| 4 | .\" full merge up to: OpenSSL man7/bn 05ea606a May 20 20:52:46 2016 -0400 | 4 | .\" full merge up to: OpenSSL man7/bn 05ea606a May 20 20:52:46 2016 -0400 |
| @@ -50,12 +50,11 @@ | |||
| 50 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 50 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 51 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 51 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
| 52 | .\" | 52 | .\" |
| 53 | .Dd $Mdocdate: November 21 2022 $ | 53 | .Dd $Mdocdate: April 25 2023 $ |
| 54 | .Dt BN_NEW 3 | 54 | .Dt BN_NEW 3 |
| 55 | .Os | 55 | .Os |
| 56 | .Sh NAME | 56 | .Sh NAME |
| 57 | .Nm BN_new , | 57 | .Nm BN_new , |
| 58 | .Nm BN_init , | ||
| 59 | .Nm BN_clear , | 58 | .Nm BN_clear , |
| 60 | .Nm BN_free , | 59 | .Nm BN_free , |
| 61 | .Nm BN_clear_free | 60 | .Nm BN_clear_free |
| @@ -67,10 +66,6 @@ | |||
| 67 | .Fa void | 66 | .Fa void |
| 68 | .Fc | 67 | .Fc |
| 69 | .Ft void | 68 | .Ft void |
| 70 | .Fo BN_init | ||
| 71 | .Fa "BIGNUM *" | ||
| 72 | .Fc | ||
| 73 | .Ft void | ||
| 74 | .Fo BN_clear | 69 | .Fo BN_clear |
| 75 | .Fa "BIGNUM *a" | 70 | .Fa "BIGNUM *a" |
| 76 | .Fc | 71 | .Fc |
| @@ -108,12 +103,6 @@ The security-relevant flag | |||
| 108 | .Dv BN_FLG_CONSTTIME | 103 | .Dv BN_FLG_CONSTTIME |
| 109 | is not set by default. | 104 | is not set by default. |
| 110 | .Pp | 105 | .Pp |
| 111 | .Fn BN_init | ||
| 112 | initializes an existing uninitialized | ||
| 113 | .Vt BIGNUM . | ||
| 114 | It is deprecated and dangerous: see | ||
| 115 | .Sx CAVEATS . | ||
| 116 | .Pp | ||
| 117 | .Fn BN_clear | 106 | .Fn BN_clear |
| 118 | is used to destroy sensitive data such as keys when they are no longer | 107 | is used to destroy sensitive data such as keys when they are no longer |
| 119 | needed. | 108 | needed. |
| @@ -180,30 +169,3 @@ and | |||
| 180 | .Fn BN_clear_free | 169 | .Fn BN_clear_free |
| 181 | first appeared in SSLeay 0.5.1 and have been available since | 170 | first appeared in SSLeay 0.5.1 and have been available since |
| 182 | .Ox 2.4 . | 171 | .Ox 2.4 . |
| 183 | .Pp | ||
| 184 | .Fn BN_init | ||
| 185 | first appeared in SSLeay 0.9.1 and has been available since | ||
| 186 | .Ox 2.6 . | ||
| 187 | .Sh CAVEATS | ||
| 188 | .Fn BN_init | ||
| 189 | must not be called on a | ||
| 190 | .Vt BIGNUM | ||
| 191 | that was used and contains an actual number, or the memory | ||
| 192 | used for storing the number is leaked immediately. | ||
| 193 | Besides, it must not be called on a number allocated with | ||
| 194 | .Fn BN_new , | ||
| 195 | or the | ||
| 196 | .Vt BIGNUM | ||
| 197 | structure itself will likely be leaked later on. | ||
| 198 | It can only be used on static | ||
| 199 | .Vt BIGNUM | ||
| 200 | structures, on | ||
| 201 | .Vt BIGNUM | ||
| 202 | structures on the stack, or on | ||
| 203 | .Vt BIGNUM | ||
| 204 | structures | ||
| 205 | .Xr malloc 3 Ap ed | ||
| 206 | manually, but all of these options are discouraged because they | ||
| 207 | will no longer work once the | ||
| 208 | .Vt BIGNUM | ||
| 209 | data type is made opaque. | ||
