lib/libcrypto/man/OPENSSL_cleanse.3

   1 .\"     $OpenBSD: OPENSSL_cleanse.3,v 1.2 2016/11/29 21:29:19 jmc Exp $
   2 .\"
   3 .\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate: November 29 2016 $
  18 .Dt OPENSSL_CLEANSE 3
  19 .Os
  20 .Sh NAME
  21 .Nm OPENSSL_cleanse
  22 .Nd OpenSSL memory cleaning operation
  23 .Sh SYNOPSIS
  24 .In openssl/crypto.h
  25 .Ft void
  26 .Fo OPENSSL_cleanse
  27 .Fa "void *ptr"
  28 .Fa "size_t len"
  29 .Fc
  30 .Sh DESCRIPTION
  31 Do not use the interface documented here.
  32 It is provided purely for compatibility with legacy application code.
  33 .Pp
  34 .Fn OPENSSL_cleanse
  35 has the same semantics as, and is a wrapper around,
  36 .Xr explicit_bzero 3 .