Current File : //usr/man/man3sasl/sasl_erasebuffer.3sasl

'\" te
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.TH sasl_erasebuffer 3SASL "16 Sep 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
.SH NAME
sasl_erasebuffer \- erase buffer
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
#include <sasl/saslutil.h>

\fBvoid\fR \fBsasl_erasebuffer\fR(\fBchar *\fR\fIpass\fR, \fBunsigned\fR \fIlen\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Use the \fBsasl_erasebuffer()\fR interface to erase a security sensitive buffer or password. The implementation may use recovery-resistant erase logic.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIpass\fR\fR
.ad
.RS 8n
.rt  
A password
.RE

.sp
.ne 2
.mk
.na
\fB\fIlen\fR\fR
.ad
.RS 8n
.rt  
The length of the password
.RE

.SH RETURN VALUES
.sp
.LP
The \fBsasl_erasebuffer()\fR interface returns no return values.
.SH ERRORS
.sp
.LP
None.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilitysystem/library/security/libsasl
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBattributes\fR(5)