xref: /openbsd-src/lib/libcrypto/man/CRYPTO_get_mem_functions.3 (revision 00d4e240f8bc13ba4eb25bb93cda95111d7d1a88)
1*00d4e240Sschwarze.\"	$OpenBSD: CRYPTO_get_mem_functions.3,v 1.7 2019/06/10 09:49:48 schwarze Exp $
2f0fb19c4Sderaadt.\"
3f0fb19c4Sderaadt.\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
4f0fb19c4Sderaadt.\"
5f0fb19c4Sderaadt.\" Permission to use, copy, modify, and distribute this software for any
6f0fb19c4Sderaadt.\" purpose with or without fee is hereby granted, provided that the above
7f0fb19c4Sderaadt.\" copyright notice and this permission notice appear in all copies.
8f0fb19c4Sderaadt.\"
9f0fb19c4Sderaadt.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10f0fb19c4Sderaadt.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11f0fb19c4Sderaadt.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12f0fb19c4Sderaadt.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13f0fb19c4Sderaadt.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14f0fb19c4Sderaadt.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15f0fb19c4Sderaadt.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16f0fb19c4Sderaadt.\"
17*00d4e240Sschwarze.Dd $Mdocdate: June 10 2019 $
18c1e72858Sjmc.Dt CRYPTO_GET_MEM_FUNCTIONS 3
19f0fb19c4Sderaadt.Os
20f0fb19c4Sderaadt.Sh NAME
21f0fb19c4Sderaadt.Nm CRYPTO_get_mem_functions ,
22f0fb19c4Sderaadt.Nm CRYPTO_set_mem_functions ,
23f0fb19c4Sderaadt.Nm CRYPTO_mem_ctrl ,
24f0fb19c4Sderaadt.Nm CRYPTO_mem_leaks ,
25db0ea4abSschwarze.Nm CRYPTO_mem_leaks_fp ,
26db0ea4abSschwarze.Nm CRYPTO_mem_leaks_cb
27f0fb19c4Sderaadt.Nd legacy OpenSSL memory allocation control
28f0fb19c4Sderaadt.Sh SYNOPSIS
29f0fb19c4Sderaadt.In openssl/crypto.h
30f0fb19c4Sderaadt.Ft void
31f0fb19c4Sderaadt.Fo CRYPTO_get_mem_functions
32f0fb19c4Sderaadt.Fa "void *(**m)(size_t)"
33f0fb19c4Sderaadt.Fa "void *(**r)(void *, size_t)"
34f0fb19c4Sderaadt.Fa "void (**f)(void *)"
35f0fb19c4Sderaadt.Fc
36f0fb19c4Sderaadt.Ft int
37f0fb19c4Sderaadt.Fo CRYPTO_set_mem_functions
38f0fb19c4Sderaadt.Fa "void *(*m)(size_t)"
39f0fb19c4Sderaadt.Fa "void *(*r)(void *, size_t)"
40f0fb19c4Sderaadt.Fa "void (*f)(void *)"
41f0fb19c4Sderaadt.Fc
42f0fb19c4Sderaadt.Ft int
43f0fb19c4Sderaadt.Fo CRYPTO_mem_ctrl
44f0fb19c4Sderaadt.Fa "int mode"
45f0fb19c4Sderaadt.Fc
463ba2e78bStb.Ft int
47f0fb19c4Sderaadt.Fo CRYPTO_mem_leaks
48f0fb19c4Sderaadt.Fa "BIO *b"
49f0fb19c4Sderaadt.Fc
503ba2e78bStb.Ft int
51f0fb19c4Sderaadt.Fo CRYPTO_mem_leaks_fp
52f0fb19c4Sderaadt.Fa "FILE *fp"
53f0fb19c4Sderaadt.Fc
543ba2e78bStb.Ft typedef int *
55db0ea4abSschwarze.Fo CRYPTO_MEM_LEAK_CB
56db0ea4abSschwarze.Fa "unsigned long"
57db0ea4abSschwarze.Fa "const char *"
58db0ea4abSschwarze.Fa int
59db0ea4abSschwarze.Fa int
60db0ea4abSschwarze.Fa "void *"
61db0ea4abSschwarze.Fc
623ba2e78bStb.Ft int
63db0ea4abSschwarze.Fo CRYPTO_mem_leaks_cb
64db0ea4abSschwarze.Fa "CRYPTO_MEM_LEAK_CB *cb"
65db0ea4abSschwarze.Fc
66f0fb19c4Sderaadt.Sh DESCRIPTION
67f0fb19c4SderaadtDo not use any of the interfaces documented here.
68f0fb19c4SderaadtThey are provided purely for compatibility with legacy application code.
69f0fb19c4Sderaadt.Pp
70f0fb19c4Sderaadt.Fn CRYPTO_get_mem_functions
71f0fb19c4Sderaadtassigns pointers to the C library functions
72f0fb19c4Sderaadt.Xr malloc 3 ,
73f0fb19c4Sderaadt.Xr realloc 3 ,
74f0fb19c4Sderaadtand
75f0fb19c4Sderaadt.Xr free 3
76f0fb19c4Sderaadtto those of its arguments that are not
77f0fb19c4Sderaadt.Dv NULL .
78f0fb19c4Sderaadt.Pp
79f0fb19c4Sderaadt.Fn CRYPTO_set_mem_functions ,
80f0fb19c4Sderaadt.Fn CRYPTO_mem_ctrl ,
81f0fb19c4Sderaadt.Fn CRYPTO_mem_leaks ,
82db0ea4abSschwarze.Fn CRYPTO_mem_leaks_fp ,
83f0fb19c4Sderaadtand
84db0ea4abSschwarze.Fn CRYPTO_mem_leaks_cb
85f0fb19c4Sderaadthave no effect.
86f0fb19c4Sderaadt.Sh RETURN VALUES
87f0fb19c4Sderaadt.Fn CRYPTO_set_mem_functions
88f0fb19c4Sderaadtalways returns 0.
89f0fb19c4Sderaadt.Pp
90f0fb19c4Sderaadt.Fn CRYPTO_mem_ctrl
91f0fb19c4Sderaadtalways returns
92f0fb19c4Sderaadt.Dv CRYPTO_MEM_CHECK_OFF .
933ba2e78bStb.Pp
943ba2e78bStb.Fn CRYPTO_mem_leaks ,
953ba2e78bStb.Fn CRYPTO_mem_leaks_fp ,
963ba2e78bStband
973ba2e78bStb.Fn CRYPTO_mem_leaks_cb
983ba2e78bStbalways return -1.
99*00d4e240Sschwarze.Sh SEE ALSO
100*00d4e240Sschwarze.Xr crypto 3
1014e4b836fSschwarze.Sh HISTORY
10210e00d17Sschwarze.Fn CRYPTO_mem_ctrl ,
10310e00d17Sschwarze.Fn CRYPTO_mem_leaks ,
10410e00d17Sschwarzeand
10510e00d17Sschwarze.Fn CRYPTO_mem_leaks_fp
10610e00d17Sschwarzefirst appeared in SSLeay 0.6.4.
10710e00d17Sschwarze.Fn CRYPTO_get_mem_functions
10810e00d17Sschwarzeand
10910e00d17Sschwarze.Fn CRYPTO_set_mem_functions
11010e00d17Sschwarzefirst appeared in SSLeay 0.6.5.
11110e00d17Sschwarze.Fn CRYPTO_mem_leaks_cb
11210e00d17Sschwarzefirst appeared in SSLeay 0.6.6.
11310e00d17SschwarzeAll these functions have all been available since
1144e4b836fSschwarze.Ox 2.4 .
115