share/man/man3sasl/sasl_erasebuffer.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_ERASEBUFFER 3SASL "Sep 16, 2003"
   9 .SH NAME
  10 sasl_erasebuffer \- erase buffer
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/saslutil.h>
  16
  17 \fBvoid\fR \fBsasl_erasebuffer\fR(\fBchar *\fR\fIpass\fR, \fBunsigned\fR \fIlen\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 Use the \fBsasl_erasebuffer()\fR interface to erase a security sensitive buffer
  24 or password. The implementation may use recovery-resistant erase logic.
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIpass\fR\fR
  30 .ad
  31 .RS 8n
  32 A password
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fIlen\fR\fR
  39 .ad
  40 .RS 8n
  41 The length of the password
  42 .RE
  43
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 The \fBsasl_erasebuffer()\fR interface returns no return values.
  48 .SH ERRORS
  49 .sp
  50 .LP
  51 None.
  52 .SH ATTRIBUTES
  53 .sp
  54 .LP
  55 See \fBattributes\fR(5) for descriptions of the following attributes:
  56 .sp
  57
  58 .sp
  59 .TS
  60 box;
  61 c | c
  62 l | l .
  63 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  64 _
  65 Interface Stability     Evolving
  66 _
  67 MT-Level        MT-Safe
  68 .TE
  69
  70 .SH SEE ALSO
  71 .sp
  72 .LP
  73 \fBattributes\fR(5)